[PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[Morgan Smith]

Previously, when trying to run the tests in a container limited to the
org repository, it fails because it can't create the directory
"~/.emacs.d/.org-id-locations".

* testing/org-test.el (org-test-load): Move setting
'org-id-locations-file' from here ...
org-test-update-id-locations: ... to here
---

Hello!  This fix allows me to run the tests without giving it access to the
filesystem outside of the repository.  I have no clue what org-id-locations are
and I'm hoping someone else does so I don't have to learn.  I'm not sure if
this is the best fix, but it works.

 testing/org-test.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/testing/org-test.el b/testing/org-test.el
index 47687b9f7..3f086f30c 100644
--- a/testing/org-test.el
+++ b/testing/org-test.el
@@ -387,8 +387,6 @@ Tramp related features.  We mostly follow
 (defun org-test-load ()
   "Load up the Org test suite."
   (interactive)
-  (setq org-id-locations-file
-        (expand-file-name ".test-org-id-locations" org-test-dir))
   (cl-flet ((rld (base)
 	         ;; Recursively load all files, if files throw errors
 	         ;; then silently ignore the error and continue to the
@@ -447,6 +445,8 @@ Tramp related features.  We mostly follow
       (when (buffer-live-p b) (kill-buffer b)))))
 
 (defun org-test-update-id-locations ()
+  (setq org-id-locations-file
+        (expand-file-name ".test-org-id-locations" org-test-dir))
   (org-id-update-id-locations
    (directory-files
     org-test-example-dir 'full
-- 
2.41.0

Re: [PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[Ihor Radchenko]

Morgan Smith <Morgan.J.Smith@outlook.com> writes:

> Previously, when trying to run the tests in a container limited to the
> org repository, it fails because it can't create the directory
> "~/.emacs.d/.org-id-locations".
>
> * testing/org-test.el (org-test-load): Move setting
> 'org-id-locations-file' from here ...
> org-test-update-id-locations: ... to here
> ---
>
> Hello!  This fix allows me to run the tests without giving it access to the
> filesystem outside of the repository.  I have no clue what org-id-locations are
> and I'm hoping someone else does so I don't have to learn.  I'm not sure if
> this is the best fix, but it works.

The whole

(defconst org-test-dir
  (expand-file-name (file-name-directory (or load-file-name buffer-file-name))))

is fishy when users attempt to run tests from normal Emacs session.

If you had issues with this variable from batch invocation, something
should be fixed in the defconst, I think.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[Ihor Radchenko]

Morgan Smith <Morgan.J.Smith@outlook.com> writes:

> Hello!  This fix allows me to run the tests without giving it access to the
> filesystem outside of the repository.  I have no clue what org-id-locations are
> and I'm hoping someone else does so I don't have to learn.  I'm not sure if
> this is the best fix, but it works.

In the absence of clear understanding what went wrong, I cannot accept
this patch, unfortunately.
Canceled.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[Max Nikulin]

On 12/08/2023 16:29, Ihor Radchenko wrote:
> Morgan Smith writes:
> 
>> Hello!  This fix allows me to run the tests without giving it access to the
>> filesystem outside of the repository.  I have no clue what org-id-locations are
>> and I'm hoping someone else does so I don't have to learn.  I'm not sure if
>> this is the best fix, but it works.
> 
> In the absence of clear understanding what went wrong, I cannot accept
> this patch, unfortunately.

mkdir ~/hide
mv -i ~/.emacs* ~/hide
make test-dirty BTEST_RE=test-org-link

Finding ID locations (26/26 files): 
/home/ubuntu/src/org-mode/testing/examples/agenda-file.org
Opening output file: No such file or directory, 
/home/ubuntu/.emacs.d/.org-id-locations
make: *** [mk/targets.mk:100: test-dirty] Error 255

I have not looked closely into the proposed patch, but I find it 
reasonable expectation that tests should not write to ~/.emacs.d/

Re: [PATCH] Testing: Ensure 'org-id-locations-file' is set before updating

[Ihor Radchenko]

Max Nikulin <manikulin@gmail.com> writes:

>> In the absence of clear understanding what went wrong, I cannot accept
>> this patch, unfortunately.
>
> mkdir ~/hide
> mv -i ~/.emacs* ~/hide
> make test-dirty BTEST_RE=test-org-link
>
> Finding ID locations (26/26 files): 
> /home/ubuntu/src/org-mode/testing/examples/agenda-file.org
> Opening output file: No such file or directory, 
> /home/ubuntu/.emacs.d/.org-id-locations
> make: *** [mk/targets.mk:100: test-dirty] Error 255
>
> I have not looked closely into the proposed patch, but I find it 
> reasonable expectation that tests should not write to ~/.emacs.d/

Thanks for the reproducer!
Fixed, on main.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=a0830f94e

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>