Change default values: .env => .autoenv.zsh etc

This changes the defaults: - AUTOENV_FILE_ENTER: .env => .autoenv.zsh - AUTOENV_FILE_LEAVE: .env_leave => .autoenv_leave.zsh `.env` is usually used only for key-value pairs for environment settings, e.g. with foreman. We do not want to interfere with this. This also renames the setting/variable AUTOENV_ENV_FILENAME to AUTOENV_AUTH_FILE, and uses the [XDG spec](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables) for the default location. The new default location for the auth file will be ~/.local/share/autoenv_auth. When the old setting is used, or the previous default exists, a warning is given with instructions. Fixes https://github.com/Tarrasch/zsh-autoenv/issues/31. Closes https://github.com/Tarrasch/zsh-autoenv/pull/32.
2025-12-14 18:25:12 +02:00 · 2015-05-21 23:58:26 +02:00
parent 631ea30440
commit e68a914487
8 changed files with 117 additions and 93 deletions
--- a/tests/_autoenv_utils.t
+++ b/tests/_autoenv_utils.t
@@ -21,27 +21,27 @@ Tests for _autoenv_authorize. {{{
 Auth file is empty.

  $ cd ../..
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE

 Failed authorization should keep the auth file empty.

  $ _autoenv_authorize does-not-exist
  Missing file argument for _autoenv_hash_pair!
  [1]
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE

 Now adding some auth pair.

  $ echo first > first
  $ _autoenv_authorize first
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE
  :/tmp/cramtests-*/_autoenv_utils.t/first:271ac93c44ac198d92e706c6d6f1d84aefcfa337:1 (glob)

 And a second one.

  $ echo second > second
  $ _autoenv_authorize second
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE
  :/tmp/cramtests-*/_autoenv_utils.t/first:271ac93c44ac198d92e706c6d6f1d84aefcfa337:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/second:7bee8f3b184e1e141ff76efe369c3b8bfc50e64c:1 (glob)

@@ -49,7 +49,7 @@ And a third.

  $ echo third > third
  $ _autoenv_authorize third
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE
  :/tmp/cramtests-*/_autoenv_utils.t/first:271ac93c44ac198d92e706c6d6f1d84aefcfa337:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/second:7bee8f3b184e1e141ff76efe369c3b8bfc50e64c:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/third:ad180453bf8a374a15df3e90a78c180230146a7c:1 (glob)
@@ -57,7 +57,7 @@ And a third.
 Re-add the second one, with the same hash.

  $ _autoenv_authorize second
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE
  :/tmp/cramtests-*/_autoenv_utils.t/first:271ac93c44ac198d92e706c6d6f1d84aefcfa337:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/third:ad180453bf8a374a15df3e90a78c180230146a7c:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/second:7bee8f3b184e1e141ff76efe369c3b8bfc50e64c:1 (glob)
@@ -66,7 +66,7 @@ Re-add the first one, with a new hash.

  $ echo one more line >> first
  $ _autoenv_authorize first
-  $ cat $AUTOENV_ENV_FILENAME
+  $ cat $AUTOENV_AUTH_FILE
  :/tmp/cramtests-*/_autoenv_utils.t/third:ad180453bf8a374a15df3e90a78c180230146a7c:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/second:7bee8f3b184e1e141ff76efe369c3b8bfc50e64c:1 (glob)
  :/tmp/cramtests-*/_autoenv_utils.t/first:65eb010197b73ddc109b7210080f97a87f53451e:1 (glob)
--- a/tests/autoenv.t
+++ b/tests/autoenv.t
@@ -1,23 +1,23 @@
  $ source $TESTDIR/setup.zsh || return 1

-Lets set a simple .env action
+Lets set a simple .autoenv.zsh action

-  $ echo 'echo ENTERED' > .env
+  $ echo 'echo ENTERED' > .autoenv.zsh

 Manually create auth file

-  $ test_autoenv_add_to_env $PWD/.env
+  $ test_autoenv_add_to_env $PWD/.autoenv.zsh
  $ cd .
  ENTERED

 Now try to make it accept it

  $ _autoenv_stack_entered=()
-  $ rm $AUTOENV_ENV_FILENAME
+  $ rm $AUTOENV_AUTH_FILE
  $ _autoenv_ask_for_yes() { echo "yes" }
  $ cd .
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/autoenv.t/.env (glob)
+  -* /tmp/cramtests-*/autoenv.t/.autoenv.zsh (glob)
  
  **********************************************
  
@@ -38,11 +38,11 @@ Now lets see that it actually checks the shasum value.
  ENTERED

  $ _autoenv_stack_entered=()
-  $ rm $AUTOENV_ENV_FILENAME
-  $ test_autoenv_add_to_env $PWD/.env mischief
+  $ rm $AUTOENV_AUTH_FILE
+  $ test_autoenv_add_to_env $PWD/.autoenv.zsh mischief
  $ cd .
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/autoenv.t/.env (glob)
+  -* /tmp/cramtests-*/autoenv.t/.autoenv.zsh (glob)
  
  **********************************************
  
@@ -57,11 +57,11 @@ Now lets see that it actually checks the shasum value.
 Now, will it take no for an answer?

  $ _autoenv_stack_entered=()
-  $ rm $AUTOENV_ENV_FILENAME
+  $ rm $AUTOENV_AUTH_FILE
  $ _autoenv_ask_for_yes() { echo "no"; return 1 }
  $ cd .
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/autoenv.t/.env (glob)
+  -* /tmp/cramtests-*/autoenv.t/.autoenv.zsh (glob)
  
  **********************************************
  
@@ -77,7 +77,7 @@ Lets also try one more time to ensure it didn't add it.
  $ _autoenv_ask_for_yes() { echo "yes"; return 0 }
  $ cd .
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/autoenv.t/.env (glob)
+  -* /tmp/cramtests-*/autoenv.t/.autoenv.zsh (glob)
  
  **********************************************
  
--- a/tests/cwd.t
+++ b/tests/cwd.t
@@ -7,8 +7,8 @@ Setup env actions / output.
  $ AUTOENV_LOOK_UPWARDS=1
  $ mkdir -p sub/sub2
  $ cd sub
-  $ echo 'echo ENTERED: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .env
-  $ echo 'echo LEFT: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .env_leave
+  $ echo 'echo ENTERED: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .autoenv.zsh
+  $ echo 'echo LEFT: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .autoenv_leave.zsh

 Manually create auth files.

--- a/tests/leave.t
+++ b/tests/leave.t
@@ -1,18 +1,18 @@
  $ source $TESTDIR/setup.zsh || return 1

-Lets set a simple .env action
+Lets set a simple .autoenv.zsh action

  $ mkdir sub
  $ cd sub
-  $ echo 'echo ENTERED' > .env
-  $ echo 'echo LEFT' > .env_leave
+  $ echo 'echo ENTERED' > .autoenv.zsh
+  $ echo 'echo LEFT' > .autoenv_leave.zsh

 Change to the directory.

  $ _autoenv_ask_for_yes() { echo "yes"; return 0 }
  $ cd .
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/leave.t/sub/.env (glob)
+  -* /tmp/cramtests-*/leave.t/sub/.autoenv.zsh (glob)
  
  **********************************************
  
@@ -29,7 +29,7 @@ Leave the directory and answer "no".
  $ _autoenv_ask_for_yes() { echo "no"; return 1 }
  $ cd ..
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/leave.t/sub/.env_leave (glob)
+  -* /tmp/cramtests-*/leave.t/sub/.autoenv_leave.zsh (glob)
  
  **********************************************
  
@@ -45,7 +45,7 @@ Leave the directory and answer "no".
  $ _autoenv_ask_for_yes() { echo "yes"; return 0 }
  $ cd ..
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/leave.t/sub/.env_leave (glob)
+  -* /tmp/cramtests-*/leave.t/sub/.autoenv_leave.zsh (glob)
  
  **********************************************
  
@@ -80,7 +80,7 @@ Now check with subdirs, not looking at parent dirs.
  LEFT


-Test that .env is sourced only once with AUTOENV_HANDLE_LEAVE=0.
+Test that .autoenv.zsh is sourced only once with AUTOENV_HANDLE_LEAVE=0.

  $ unset _autoenv_stack_entered
  $ AUTOENV_HANDLE_LEAVE=0
@@ -97,8 +97,8 @@ Test that "leave" is not triggered when entering an outside dir via symlink.
  LEFT
  $ mkdir outside
  $ cd outside
-  $ echo 'echo ENTERED outside: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .env
-  $ echo 'echo LEFT outside: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .env_leave
+  $ echo 'echo ENTERED outside: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .autoenv.zsh
+  $ echo 'echo LEFT outside: PWD:${PWD:t} pwd:${${"$(pwd)"}:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t} event:${autoenv_event}' > .autoenv_leave.zsh
  $ test_autoenv_auth_env_files

  $ cd ..
@@ -117,7 +117,7 @@ Test that "leave" is not triggered when entering an outside dir via symlink.
 $autoenv_env_file should be reset when leaving.

  $ echo $autoenv_env_file
-  */leave.t/sub/symlink/.env (glob)
+  */leave.t/sub/symlink/.autoenv.zsh (glob)
  $ cd ../..
  LEFT outside: PWD:leave.t pwd:leave.t from:symlink to:leave.t event:leave
  $ echo ${autoenv_env_file:-empty}
--- a/tests/recurse-upwards.t
+++ b/tests/recurse-upwards.t
@@ -1,4 +1,4 @@
-Test recursing into parent .env files.
+Test recursing into parent .autoenv.zsh files.

  $ source $TESTDIR/setup.zsh || return 1

@@ -8,8 +8,8 @@ Setup env actions / output.

 Create env files in root dir.

-  $ echo 'echo ENTERED_root: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .env
-  $ echo 'echo LEFT_root: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .env_leave
+  $ echo 'echo ENTERED_root: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .autoenv.zsh
+  $ echo 'echo LEFT_root: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .autoenv_leave.zsh
  $ test_autoenv_auth_env_files

 Create env files in sub dir.
@@ -18,8 +18,8 @@ Create env files in sub dir.
  $ cd sub
  ENTERED_root: PWD:sub from:recurse-upwards.t to:sub

-  $ echo 'echo ENTERED_sub: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .env
-  $ echo 'echo LEFT_sub: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .env_leave
+  $ echo 'echo ENTERED_sub: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .autoenv.zsh
+  $ echo 'echo LEFT_sub: PWD:${PWD:t} from:${autoenv_from_dir:t} to:${autoenv_to_dir:t}' > .autoenv_leave.zsh
  $ test_autoenv_auth_env_files

 The actual tests.
@@ -35,45 +35,45 @@ The actual tests.

  $ cd ..

-Changing the .env file should re-source it.
+Changing the .autoenv.zsh file should re-source it.

-  $ echo 'echo ENTER2' >> .env
+  $ echo 'echo ENTER2' >> .autoenv.zsh

 Set timestamp of auth file into the past, so it gets seen as new below.

-  $ touch -t 201401010101 .env
+  $ touch -t 201401010101 .autoenv.zsh

  $ test_autoenv_auth_env_files
  $ cd .
  ENTERED_sub: PWD:sub from:sub to:sub
  ENTER2

-Add sub/sub2/.env file, with a call to autoenv_source_parent.
+Add sub/sub2/.autoenv.zsh file, with a call to autoenv_source_parent.

-  $ echo "echo autoenv_source_parent_from_sub2:\nautoenv_source_parent\necho done_sub2\n" > sub2/.env
-  $ test_autoenv_add_to_env sub2/.env
+  $ echo "echo autoenv_source_parent_from_sub2:\nautoenv_source_parent\necho done_sub2\n" > sub2/.autoenv.zsh
+  $ test_autoenv_add_to_env sub2/.autoenv.zsh
  $ cd sub2
  autoenv_source_parent_from_sub2:
  ENTERED_sub: PWD:sub2 from:sub to:sub2
  ENTER2
  done_sub2

-Move sub/.env away, now the root .env file should get sourced.
+Move sub/.autoenv.zsh away, now the root .autoenv.zsh file should get sourced.

-  $ mv ../.env ../.env.out
-  $ touch -t 201401010102 .env
+  $ mv ../.autoenv.zsh ../.autoenv.zsh.out
+  $ touch -t 201401010102 .autoenv.zsh
  $ cd .
  autoenv_source_parent_from_sub2:
  ENTERED_root: PWD:sub2 from:sub2 to:sub2
  done_sub2
-  $ mv ../.env.out ../.env
+  $ mv ../.autoenv.zsh.out ../.autoenv.zsh

-Prepend call to autoenv_source_parent to sub/.env file.
+Prepend call to autoenv_source_parent to sub/.autoenv.zsh file.

  $ cd ..
-  $ sed -i -e "1s/^/echo autoenv_source_parent_from_sub:\nautoenv_source_parent\n/" .env
-  $ echo "echo done_sub" >> .env
-  $ touch -t 201401010103 .env
+  $ sed -i -e "1s/^/echo autoenv_source_parent_from_sub:\nautoenv_source_parent\n/" .autoenv.zsh
+  $ echo "echo done_sub" >> .autoenv.zsh
+  $ touch -t 201401010103 .autoenv.zsh
  $ test_autoenv_auth_env_files

  $ cd .
@@ -84,10 +84,10 @@ Prepend call to autoenv_source_parent to sub/.env file.
  done_sub


-Add sub/sub2/.env file.
+Add sub/sub2/.autoenv.zsh file.

-  $ echo -e "echo autoenv_source_parent_from_sub2:\nautoenv_source_parent\necho done_sub2\n" >| sub2/.env
-  $ test_autoenv_add_to_env sub2/.env
+  $ echo -e "echo autoenv_source_parent_from_sub2:\nautoenv_source_parent\necho done_sub2\n" >| sub2/.autoenv.zsh
+  $ test_autoenv_add_to_env sub2/.autoenv.zsh
  $ cd sub2
  autoenv_source_parent_from_sub2:
  autoenv_source_parent_from_sub:
@@ -105,16 +105,17 @@ autoenv_source_parent already.
  LEFT_sub: PWD:recurse-upwards.t from:sub2 to:recurse-upwards.t


-Changing the root .env should trigger re-authentication via autoenv_source_parent.
+Changing the root .autoenv.zsh should trigger re-authentication via
+autoenv_source_parent.

 First, let's answer "no".

-  $ echo "echo NEW" >| .env
+  $ echo "echo NEW" >| .autoenv.zsh
  $ _autoenv_ask_for_yes() { echo "no"; return 1 }
  $ cd sub
  autoenv_source_parent_from_sub:
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/recurse-upwards.t/.env (glob)
+  -* /tmp/cramtests-*/recurse-upwards.t/.autoenv.zsh (glob)
  
  **********************************************
  
@@ -128,18 +129,18 @@ First, let's answer "no".
  done_sub

 Now with "yes".
-This currently does not trigger re-execution of the .env file.
+This currently does not trigger re-execution of the .autoenv.zsh file.

  $ _autoenv_ask_for_yes() { echo "yes"; return 0 }
  $ cd .

-Touching the .env file will now source the parent env file.
+Touching the .autoenv.zsh file will now source the parent env file.

-  $ touch -t 201401010104 .env
+  $ touch -t 201401010104 .autoenv.zsh
  $ cd .
  autoenv_source_parent_from_sub:
  Attempting to load unauthorized env file!
-  -* /tmp/cramtests-*/recurse-upwards.t/.env (glob)
+  -* /tmp/cramtests-*/recurse-upwards.t/.autoenv.zsh (glob)
  
  **********************************************
  
--- a/tests/setup.zsh
+++ b/tests/setup.zsh
@@ -2,17 +2,17 @@
 #
 # It returns 1 in case of errors, and no tests should be run then!
 #
-# Ensure we have our mocked out AUTOENV_ENV_FILENAME
+# Ensure we have our mocked out AUTOENV_AUTH_FILE
 # (via .zshenv).

 # Treat unset variables as errors.
 # Not handled in varstash yet.
 # setopt nounset

-export AUTOENV_ENV_FILENAME="$CRAMTMP/.env_auth"
+export AUTOENV_AUTH_FILE="$CRAMTMP/.autoenv_auth"

-if [[ $AUTOENV_ENV_FILENAME[0,4] != '/tmp' ]]; then
-  echo "AUTOENV_ENV_FILENAME is not in /tmp. Aborting."
+if [[ $AUTOENV_AUTH_FILE[0,4] != '/tmp' ]]; then
+  echo "AUTOENV_AUTH_FILE is not in /tmp. Aborting."
  return 1
 fi

@@ -24,11 +24,11 @@ set -e
 $TEST_SOURCE_AUTOENV

 # Reset any authentication.
-echo -n >| $AUTOENV_ENV_FILENAME
+echo -n >| $AUTOENV_AUTH_FILE

 # Add file $1 (with optional hash $2) to authentication file.
 test_autoenv_add_to_env() {
-  _autoenv_hash_pair $1 ${2:-} >>| $AUTOENV_ENV_FILENAME
+  _autoenv_hash_pair $1 ${2:-} >>| $AUTOENV_AUTH_FILE
 }

 # Add enter and leave env files to authentication file.