You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
git-secret/tests/test_hide.bats

334 lines
8.3 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 file must be created:
local new_file
new_file="$(_get_encrypted_filename "$FILE_TO_HIDE")"
[ -f "$new_file" ]
# File must be a binary:
local mime
mime="$(file --mime-type --mime-encoding "$new_file" | grep 'charset=binary')"
[ -n "$mime" ]
}
@test "run 'hide' with SECRETS_GPG_ARMOR=1" {
SECRETS_GPG_ARMOR=1 run git secret hide
# Command must execute normally:
[ "$status" -eq 0 ]
[[ "$output" == *"git-secret: done. 1 of 1 files are hidden."* ]]
# New file must be created:
local new_file
new_file="$(_get_encrypted_filename "$FILE_TO_HIDE")"
[ -f "$new_file" ]
# File must be a text:
local mime
mime="$(file --mime-type --mime-encoding "$new_file" | grep 'charset=us-ascii')"
[ -n "$mime" ]
}
@test "run 'hide' with extra filename" {
run git secret hide extra_filename
[ "$status" -ne 0 ]
}
@test "run 'hide' with bad arg" {
run git secret hide -Z
[ "$status" -ne 0 ]
}
@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
encrypted_file=$(_get_encrypted_filename "$FILE_TO_HIDE")
[ -f "$encrypted_file" ]
## permissions should match.
local secret_perm
local file_perm
file_perm=$($SECRETS_OCTAL_PERMS_COMMAND "$FILE_TO_HIDE")
secret_perm=$($SECRETS_OCTAL_PERMS_COMMAND "$encrypted_file")
# 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" ]
( # start subshell for following commands
# cd into the subdir
cd "$root_dir"
# Now it should hide 2 files:
run git secret hide
[ "$status" -eq 0 ]
) # end subshell, return to ..
# clean up
rm -rf "$root_dir"
}
@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: uses temp file so cleaning should take place,
# but we only show tmp file cleanup in VERBOSE mode
[[ "$output" == *"git-secret: done. 1 of 1 files are hidden."* ]]
# New files should be created:
[ -f "$(_get_encrypted_filename "$FILE_TO_HIDE")" ]
}
@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 temp file so cleaning should take place,
# but we only show tmp file cleanup in VERBOSE mode
[[ "$output" == *"git-secret: done. 1 of 1 files are hidden."* ]]
# 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:
[ -f "$(_get_encrypted_filename "$FILE_TO_HIDE")" ]
}
@test "run 'hide' without then with '-m'" {
local path_mappings
path_mappings=$(_get_secrets_dir_paths_mapping)
run git secret hide
#echo "$output" | sed "s/^/# '$BATS_TEST_DESCRIPTION' output: /" >&3
# Command must execute normally:
[ "$status" -eq 0 ]
# git secret hide -m: uses temp file so cleaning should take place,
# but we only show tmp file cleanup in VERBOSE mode
[[ "$output" == *"git-secret: done. 1 of 1 files are hidden."* ]]
# 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:
[ -f "$(_get_encrypted_filename "$FILE_TO_HIDE")" ]
}
@test "run 'hide' with '-c' and '-v'" {
# Preparations:
local encrypted_filename
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" == *"deleted:"* ]]
[[ "$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"* ]]
rm -rf "$root_dir"
}
@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."* ]]
}