bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

[Jim Porter]

[-- Attachment #1: Type: text/plain, Size: 1008 bytes --]

I tried to use 'ert-remote-temporary-file-directory' in a test for an 
external package, but it ended up breaking some existing tests simply by 
requiring both tramp and ert-x. These tests indirectly used 'cd' (by way 
of 'compilation-start'), which triggered the failure.

Steps to reproduce:

   $ mkdir -p ~/src
   $ emacs -Q --batch -l tramp -l ert-x --eval '(cd "~/src/")'

Result:

   Error: error ("No such directory: ~/src/")
     mapbacktrace(#f(compiled-function (evald func args flags) 
#<bytecode 0xc43976fdbae86a5>))
     debug-early-backtrace()
     debug-early(error (error "No such directory: ~/src/"))
     error("No such directory: %s" "~/src/")
     cd("~/src")
     eval((cd "~/src") t)
     command-line-1(("-l" "tramp" "-l" "ert-x" "--eval" "(cd \"~/src/\")"))
     command-line()
     normal-top-level()
   No such directory: ~/src/

Looking at ert-x.el, I think this is because 
'ert-remote-temporary-file-directory' does some fixup on $HOME, but it 
was too aggressive. See attached.

[-- Attachment #2: 0001-Fix-logic-of-HOME-adjustment-for-ert-remote-temporar.patch --]
[-- Type: text/plain, Size: 1123 bytes --]

From 5ef9bce106dbc78c0e29b3c0e1baf0ee47859ece Mon Sep 17 00:00:00 2001
From: Jim Porter <jporterbugs@gmail.com>
Date: Sun, 2 Oct 2022 18:19:56 -0700
Subject: [PATCH] ; Fix logic of $HOME adjustment for
 'ert-remote-temporary-file-directory'

* lisp/emacs-lisp/ert-x.el (ert-remote-temporary-file-directory): Only
adjust $HOME when it doesn't exist.
---
 lisp/emacs-lisp/ert-x.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/ert-x.el b/lisp/emacs-lisp/ert-x.el
index bfd796586d..a891f068a7 100644
--- a/lisp/emacs-lisp/ert-x.el
+++ b/lisp/emacs-lisp/ert-x.el
@@ -568,7 +568,7 @@ ert-remote-temporary-file-directory
          `("\\`mock\\'" nil ,(system-name)))
         ;; Emacs's Makefile sets $HOME to a nonexistent value.  Needed
         ;; in batch mode only, therefore.
-        (unless (and (null noninteractive) (file-directory-p "~/"))
+        (when (and noninteractive (not (file-directory-p "~/")))
           (setenv "HOME" temporary-file-directory))
         (format "/mock::%s" temporary-file-directory))))
     "Temporary directory for remote file tests.")
-- 
2.25.1

bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

[Jim Porter]

On 10/2/2022 6:32 PM, Jim Porter wrote:
>    Error: error ("No such directory: ~/src/")
>      mapbacktrace(#f(compiled-function (evald func args flags) 
> #<bytecode 0xc43976fdbae86a5>))
>      debug-early-backtrace()
>      debug-early(error (error "No such directory: ~/src/"))
>      error("No such directory: %s" "~/src/")
>      cd("~/src")
>      eval((cd "~/src") t)

Whoops, I tried to shorten the path that I was using to test in the 
backtrace but messed up in a couple spots here. Pretend these are 
"~/src/" too. :)

>      command-line-1(("-l" "tramp" "-l" "ert-x" "--eval" "(cd \"~/src/\")"))
>      command-line()
>      normal-top-level()
>    No such directory: ~/src/

bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

[Lars Ingebrigtsen]

Jim Porter <jporterbugs@gmail.com> writes:

> Looking at ert-x.el, I think this is because
> 'ert-remote-temporary-file-directory' does some fixup on $HOME, but it
> was too aggressive. See attached.

Looks good to me; please go ahead and push.

bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

[Jim Porter]

On 10/3/2022 2:17 AM, Lars Ingebrigtsen wrote:
> Jim Porter <jporterbugs@gmail.com> writes:
> 
>> Looking at ert-x.el, I think this is because
>> 'ert-remote-temporary-file-directory' does some fixup on $HOME, but it
>> was too aggressive. See attached.
> 
> Looks good to me; please go ahead and push.

Thanks. Pushed as 43eaa05ff2265ae33f71b73670a8a150a7a716ae. Closing this 
bug now.

bug#58265: 29.0.50; [PATCH] $HOME adjustment for 'ert-remote-temporary-file-directory' is wrong

[Michael Albinus]

Jim Porter <jporterbugs@gmail.com> writes:

Hi Jim,

> Looking at ert-x.el, I think this is because
> 'ert-remote-temporary-file-directory' does some fixup on $HOME, but it
> was too aggressive. See attached.
>
> diff --git a/lisp/emacs-lisp/ert-x.el b/lisp/emacs-lisp/ert-x.el
> index bfd796586d..a891f068a7 100644
> --- a/lisp/emacs-lisp/ert-x.el
> +++ b/lisp/emacs-lisp/ert-x.el
> @@ -568,7 +568,7 @@ ert-remote-temporary-file-directory
>           `("\\`mock\\'" nil ,(system-name)))
>          ;; Emacs's Makefile sets $HOME to a nonexistent value.  Needed
>          ;; in batch mode only, therefore.
> -        (unless (and (null noninteractive) (file-directory-p "~/"))
> +        (when (and noninteractive (not (file-directory-p "~/")))
>            (setenv "HOME" temporary-file-directory))
>          (format "/mock::%s" temporary-file-directory))))
>      "Temporary directory for remote file tests.")

IIRC, I've applied the original setting due to problems on hydra or emba
(don't remember exactly). Let's see how your patch works there.

Best regards, Michael.