mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-06 15:20:36 +00:00
ce8c6b3ae0
* Change 'add' to add to .gitignore by default. Also add _message() function and improve output from 'git-secret-add', alter tests for new code behavior, and update docs. * change tests since 'add' always adds to .gitignore * improve output: prepend more message with 'git-secret:'. * update man page for git-secret-add
262 lines
6.6 KiB
Bash
262 lines
6.6 KiB
Bash
#!/usr/bin/env bats
|
|
|
|
load _test_base
|
|
|
|
FILE_TO_HIDE="$TEST_DEFAULT_FILENAME"
|
|
FILE_CONTENTS="hidden content юникод"
|
|
|
|
|
|
function setup {
|
|
install_fixture_key "$TEST_DEFAULT_USER"
|
|
|
|
set_state_initial
|
|
set_state_git
|
|
set_state_secret_init
|
|
set_state_secret_tell "$TEST_DEFAULT_USER"
|
|
set_state_secret_add "$FILE_TO_HIDE" "$FILE_CONTENTS"
|
|
}
|
|
|
|
|
|
function teardown {
|
|
rm "$FILE_TO_HIDE"
|
|
|
|
uninstall_fixture_key $TEST_DEFAULT_USER
|
|
unset_current_state
|
|
}
|
|
|
|
|
|
@test "run 'hide' normally" {
|
|
run git secret hide
|
|
|
|
#echo "$output" | sed "s/^/# '$BATS_TEST_DESCRIPTION' output: /" >&3
|
|
|
|
# Command must execute normally:
|
|
[ "$status" -eq 0 ]
|
|
[ "$output" = "git-secret: done. 1 of 1 files are hidden." ]
|
|
|
|
# New files should be created:
|
|
local encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
|
|
[ -f "$encrypted_file" ]
|
|
}
|
|
|
|
@test "run 'hide' normally with SECRETS_VERBOSE=1" {
|
|
SECRETS_VERBOSE=1 run git secret hide
|
|
|
|
# Command must execute normally.
|
|
[ "$status" -eq 0 ]
|
|
[[ "$output" == "git-secret: done. 1 of 1 files are hidden." ]]
|
|
}
|
|
|
|
@test "run 'hide' with '-P'" {
|
|
|
|
# attempt to alter permissions on input file
|
|
chmod o-rwx "$FILE_TO_HIDE"
|
|
|
|
run git secret hide -P
|
|
|
|
#echo "$output" | sed "s/^/# '$BATS_TEST_DESCRIPTION' output: /" >&3
|
|
|
|
# Command must execute normally:
|
|
[ "$status" -eq 0 ]
|
|
[ "$output" = "git-secret: done. 1 of 1 files are hidden." ]
|
|
|
|
# New files should be created:
|
|
local encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
|
|
[ -f "$encrypted_file" ]
|
|
|
|
# permissions should match. We don't have access to SECRETS_OCTAL_PERMS_COMMAND here
|
|
local secret_perm
|
|
local file_perm
|
|
secret_perm=$(ls -l "$encrypted_file" | cut -d' ' -f1)
|
|
file_perm=$(ls -l "$FILE_TO_HIDE" | cut -d' ' -f1)
|
|
|
|
# text prefixed with '# ' and sent to file descriptor 3 is 'diagnostic' (debug) output for devs
|
|
#echo "# '$BATS_TEST_DESCRIPTION': $secret_perm, file_perm: $file_perm" >&3
|
|
|
|
[ "$secret_perm" = "$file_perm" ]
|
|
|
|
}
|
|
|
|
@test "run 'hide' from inside subdirectory" {
|
|
|
|
if [[ "$BATS_RUNNING_FROM_GIT" -eq 1 ]]; then
|
|
# See #334 for more about this
|
|
skip "this test is skipped while 'git commit'"
|
|
fi
|
|
|
|
# Preparations:
|
|
local root_dir='test_sub_dir'
|
|
mkdir -p "$root_dir"
|
|
local second_file="$root_dir/second_file.txt"
|
|
local second_content="some content"
|
|
set_state_secret_add "$second_file" "$second_content"
|
|
|
|
# Verify that the second file is there:
|
|
[ -f "$second_file" ]
|
|
|
|
# cd into the subdir
|
|
cd "$root_dir"
|
|
|
|
# Now it should hide 2 files:
|
|
run git secret hide
|
|
[ "$status" -eq 0 ]
|
|
|
|
# cd back
|
|
cd ".."
|
|
}
|
|
|
|
@test "run 'hide' with missing file" {
|
|
# Preparations:
|
|
local second_file="$TEST_SECOND_FILENAME"
|
|
local second_content="some content"
|
|
set_state_secret_add "$second_file" "$second_content"
|
|
|
|
# now remove the second file to cause failure
|
|
rm -f "$second_file"
|
|
|
|
# Now it should return an error because one file can't be found
|
|
run git secret hide
|
|
[ "$status" -ne 0 ]
|
|
[ "$output" != "git-secret: done. 2 of 2 files are hidden." ]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with multiple files" {
|
|
# Preparations:
|
|
local second_file="$TEST_SECOND_FILENAME"
|
|
local second_content="some content"
|
|
set_state_secret_add "$second_file" "$second_content"
|
|
|
|
# Now it should hide 2 files:
|
|
run git secret hide
|
|
#echo "$output" | sed "s/^/# '$BATS_TEST_DESCRIPTION' output: /" >&3
|
|
[ "$status" -eq 0 ]
|
|
[ "$output" = "git-secret: done. 2 of 2 files are hidden." ]
|
|
|
|
# Cleaning up:
|
|
rm "$second_file"
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-m'" {
|
|
run git secret hide -m
|
|
|
|
# Command must execute normally:
|
|
[ "$status" -eq 0 ]
|
|
# 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..." ]
|
|
|
|
# New files should be created:
|
|
local encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
|
|
[ -f "$encrypted_file" ]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-m' twice" {
|
|
local path_mappings
|
|
path_mappings=$(_get_secrets_dir_paths_mapping)
|
|
run git secret hide -m
|
|
|
|
#echo "$output" | sed "s/^/# '$BATS_TEST_DESCRIPTION' output: /" >&3
|
|
|
|
# Command must execute normally:
|
|
[ "$status" -eq 0 ]
|
|
# 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..." ]
|
|
# back path mappings
|
|
cp "${path_mappings}" "${path_mappings}.bak"
|
|
# run hide again
|
|
run git secret hide -m
|
|
# compare
|
|
[ "$status" -eq 0 ]
|
|
[[ "${#lines[@]}" -eq 1 ]]
|
|
|
|
# output says 0 of 1 files are hidden because checksum didn't change and we didn't need to hide it again.
|
|
[ "$output" = "git-secret: done. 0 of 1 files are hidden." ]
|
|
# no changes should occur to path_mappings files
|
|
cmp -s "${path_mappings}" "${path_mappings}.bak"
|
|
|
|
# New files should be created:
|
|
local encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
|
|
[ -f "$encrypted_file" ]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-c' and '-v'" {
|
|
# Preparations:
|
|
local encrypted_filename=$(_get_encrypted_filename "$FILE_TO_HIDE")
|
|
set_state_secret_hide # so it would be data to clean
|
|
|
|
run git secret hide -v -c
|
|
[ "$status" -eq 0 ]
|
|
|
|
# File should be still there (it is not deletion):
|
|
[ -f "$FILE_TO_HIDE" ]
|
|
|
|
# Output should be verbose:
|
|
[[ "$output" == *"cleaning"* ]]
|
|
[[ "$output" == *"$encrypted_filename"* ]]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-d'" {
|
|
run git secret hide -d
|
|
[ "$status" -eq 0 ]
|
|
|
|
# File must be removed:
|
|
[ ! -f "$FILE_TO_HIDE" ]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-d' and '-v'" {
|
|
run git secret hide -v -d
|
|
[ "$status" -eq 0 ]
|
|
|
|
# File must be removed:
|
|
[ ! -f "$FILE_TO_HIDE" ]
|
|
|
|
# It should be verbose:
|
|
[[ "$output" == *"removing unencrypted files"* ]]
|
|
[[ "$output" == *"$FILE_TO_HIDE"* ]]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with '-d' and '-v' and files in subdirectories" {
|
|
# Preparations:
|
|
local root_dir='test_sub_dir'
|
|
mkdir -p "$root_dir"
|
|
local second_file="$root_dir/$TEST_SECOND_FILENAME"
|
|
local second_content="some content"
|
|
set_state_secret_add "$second_file" "$second_content"
|
|
|
|
# Verify that the second file is there:
|
|
[ -f "$second_file" ]
|
|
|
|
# Now it should hide 2 files:
|
|
run git secret hide -v -d
|
|
[ "$status" -eq 0 ]
|
|
|
|
# File must be removed:
|
|
[ ! -f "$FILE_TO_HIDE" ]
|
|
[ ! -f "$second_file" ]
|
|
|
|
# It should be verbose:
|
|
[[ "$output" == *"removing unencrypted files"* ]]
|
|
[[ "$output" == *"$FILE_TO_HIDE"* ]]
|
|
[[ "$output" == *"$second_file"* ]]
|
|
}
|
|
|
|
|
|
@test "run 'hide' with multiple users" {
|
|
install_fixture_key "$TEST_SECOND_USER"
|
|
set_state_secret_tell "$TEST_SECOND_USER"
|
|
|
|
run git secret hide
|
|
[ "$status" -eq 0 ]
|
|
[ "$output" = "git-secret: done. 1 of 1 files are hidden." ]
|
|
}
|