Better temp dir and output

.gitignore

@@ -133,6 +133,6 @@ build/
 *.deb
 *.fpm
 
-# Kithcne files
+# Kitchen files
 Gemfile.lock
 .kitchen/

src/_utils/_git_secret_tools.sh

@@ -189,14 +189,14 @@ function _file_has_line {
 
 
 
-# this sets the global variable 'filename'
-# currently this function is only used by 'hide'
+# this sets the global variable 'temporary_filename'
+# currently this function is only used by 'hide' and below in _gawk_inplace
 function _temporary_file {
  # This function creates temporary file
  # which will be removed on system exit.
- filename=$(_os_based __temp_file) # is not `local` on purpose.
+ temporary_filename=$(_os_based __temp_file) # is not `local` on purpose.
 
- trap 'echo "git-secret: cleaning up..."; rm -f "$filename";' EXIT
+ trap 'echo "git-secret: cleaning up: $temporary_filename"; rm -f "$temporary_filename";' EXIT
 }
 
 
@@ -208,10 +208,10 @@ function _gawk_inplace {
  local dest_file
  dest_file="$(echo "$parms" | gawk -v RS="'" -v FS="'" 'END{ gsub(/^\s+/,""); print $1 }')"
 
- _temporary_file
+ _temporary_file # sets $temporary_filename
 
- bash -c "gawk ${parms}" > "$filename"
- mv "$filename" "$dest_file"
+ bash -c "gawk ${parms}" > "$temporary_filename"
+ mv "$temporary_filename" "$dest_file"
 }
 
 
@@ -292,14 +292,7 @@ function _check_ignore {
  local filename="$1" # required
 
  local result
- result="$(git add -n "$filename" > /dev/null 2>&1; echo $?)"
- # when ignored
- if [[ "$result" -ne 0 ]]; then
- result=0
- else
- result=1
- fi
- # returns 1 when not ignored, and 0 when ignored
+ result="$(git check-ignore -q "$filename"; echo $?)"
  echo "$result"
 }
 
@@ -361,6 +354,9 @@ function _is_tracked_in_git {
 }
 
 
+# THIS CAN GIVE WRONG .git DIR IF WE ARE TESTING IN A SUBDIR of src/git-secret.
+# for example, if we're testing in ~/src/git-secret/tempdir and there's no .git dir in that directory,
+# this function will return ~/src/git-secret/ -- WHICH IS THE WRONG DIR
 function _get_git_root_path {
  # We need this function to get the location of the `.git` folder,
  # since `.gitsecret` (or value set by SECRETS_DIR env var) must be on the same level.
@@ -476,7 +472,7 @@ function _find_and_clean_formatted {
  local pattern="$1" # can be any string pattern
 
  if [[ -n "$_SECRETS_VERBOSE" ]]; then
- echo && echo "git-secret: cleaning:"
+ echo && _message "cleaning:"
  fi
 
  _find_and_clean "$pattern"
@@ -527,17 +523,8 @@ function _secrets_dir_is_not_ignored {
  local git_secret_dir
  git_secret_dir=$(_get_secrets_dir)
 
- # Create git_secret_dir required for check
- local cleanup=0
- if [[ ! -d "$git_secret_dir" ]]; then
- mkdir "$git_secret_dir"
- cleanup=1
- fi
  local ignores
  ignores=$(_check_ignore "$git_secret_dir")
- if [[ "$cleanup" == 1 ]]; then
- rmdir "$git_secret_dir"
- fi
 
  if [[ ! $ignores -eq 1 ]]; then
  _abort "'$git_secret_dir' is in .gitignore"

src/commands/git_secret_init.sh

@@ -69,7 +69,7 @@ function init {
  mkdir "$git_secret_dir" "$(_get_secrets_dir_keys)" "$(_get_secrets_dir_path)"
  touch "$(_get_secrets_dir_keys_mapping)" "$(_get_secrets_dir_paths_mapping)"
 
- _message "'$git_secret_dir/' created."
+ _message "init created: '$git_secret_dir/'"
 
  local random_seed_file
  random_seed_file="${_SECRETS_DIR}/keys/random_seed"

src/commands/git_secret_tell.sh

@@ -71,10 +71,10 @@ function tell {
  local start_key_cnt
  start_key_cnt=$(get_gpg_key_count)
  for email in "${emails[@]}"; do
- # This file will be removed automatically:
- _temporary_file # note, that `_temporary_file` will export `filename` var.
+ # This temporary file will be removed automatically:
+ _temporary_file # note that `_temporary_file` will set `temporary_filename` var.
  # shellcheck disable=2154
- local keyfile="$filename"
+ local keyfile="$temporary_filename"
 
  local exit_code
  if [[ -z "$homedir" ]]; then

tests/_test_base.bash

@@ -101,9 +101,18 @@ function get_gpg_fingerprint_by_email {
 function install_fixture_key {
  local public_key="$BATS_TMPDIR/public-${1}.key"
 
+ echo "# in install_fixture_key: exporting public_key to $public_key" >&3
+
  cp "$FIXTURES_DIR/gpg/${1}/public.key" "$public_key"
- $GPGTEST --import "$public_key" > /dev/null 2>&1
- rm -f "$public_key"
+ local import_output
+ import_output=$($GPGTEST --verbose --import "$public_key" 2>&1)
+
+ echo "# output of key import: $import_output" >&3
+ if [ -f "$public_key" ]; then
+ rm -f "$public_key"
+ else
+ echo "# in install_fixture_key: can't find exported public key: $public_key" >&3
+ fi
 }
 
 

tests/test_hide.bats

@@ -146,7 +146,7 @@ function teardown {
  # git secret hide -m, use temp file so cleaning should take place
  [[ "${#lines[@]}" -eq 2 ]]
  [ "${lines[0]}" = "git-secret: done. 1 of 1 files are hidden." ]
- [ "${lines[1]}" = "git-secret: cleaning up..." ]
+ [[ "${lines[1]}" == "git-secret: cleaning up:"* ]]
 
  # New files should be created:
  local encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
@@ -166,7 +166,7 @@ function teardown {
  # git secret hide -m, uses a temp file so cleaning should take place
  [[ "${#lines[@]}" -eq 2 ]]
  [ "${lines[0]}" = "git-secret: done. 1 of 1 files are hidden." ]
- [ "${lines[1]}" = "git-secret: cleaning up..." ]
+ [[ "${lines[1]}" == "git-secret: cleaning up:"* ]]
  # back path mappings
  cp "${path_mappings}" "${path_mappings}.bak"
  # run hide again

tests/test_main.bats

@@ -36,10 +36,6 @@ function teardown {
  # We will break things apart, so normally it won't run:
  rm -r "./.git"
 
- # This must fail:
- run git secret usage
- [ "$status" -eq 1 ]
-
  # Dry run won't fail:
  run git secret --dry-run
  [ "$status" -eq 0 ]

tests/test_usage.bats

@@ -20,9 +20,10 @@ function teardown {
 }
 
 
-@test "run 'usage' without '.git/'" {
+@test "run 'usage' without '.git'" {
  remove_git_repository
 
+ # It's ok for 'usage' to succeed when there's no .git directory, but it doesn't
  run git secret usage
  [ "$status" -eq 1 ]
 }
@@ -36,6 +37,7 @@ function teardown {
  #echo "# clear-line-output" >&3
  #echo "# SECRETS_DIR is ${_SECRETS_DIR}" >&3
 
+ # It's ok for 'usage' to succeed when the .gitsecret directory is ignored, but it doesn't
  run git secret usage
  #echo "# git secret usage -> status $status" >&3
 

utils/tests.sh

@@ -4,16 +4,25 @@
 
 set -e
 
-# Running all the bats-tests in a dir with spaces:
-cd "${SECRET_PROJECT_ROOT}"; rm -rf 'tempdir with spaces'; mkdir 'tempdir with spaces'; cd 'tempdir with spaces';
+#TEST_DIR="/tmp/tempdir with spaces"
+TEST_DIR="/tmp/tempdir"
+
+rm -rf "${TEST_DIR}" 
+mkdir "${TEST_DIR}"
+chmod 0700 "${TEST_DIR}"
+cd "${TEST_DIR}"
 
 # test with non-standard SECRETS_DIR (normally .gitsecret) and SECRETS_EXTENSION (normally .secret)
 export SECRETS_DIR=.gitsecret-testdir
 export SECRETS_EXTENSION=.secret2
 #export SECRETS_VERBOSE=''
 
+export TMPDIR="${TEST_DIR}"
+echo "# TMPDIR is $TMPDIR" 
+
 # bats expects diagnostic lines to be sent to fd 3, matching regex '^ #' (IE, like: `echo '# message here' >&3`)
 # bats ... 3>&1 shows diagnostic output when errors occur.
 bats "${SECRET_PROJECT_ROOT}/tests/" 3>&1
 
-rm -rf 'tempdir with spaces'
+cd ..; rm -rf "${TEST_DIR}"
+trap 'echo "# git-secret: cleaning up ${TEST_DIR}"; rm -rf "${TEST_DIR}";' EXIT