From a274973ff3ec0a1ab5ecde5a63b1bb33996fecb4 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 17:46:48 +0000 Subject: realpath -> readlink I have an exteremely retarded work machine which bundles its own realpath for no reason. A quick fix is to use readlink instead. --- links-chmod | 2 +- links-remove | 2 +- links-update | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/links-chmod b/links-chmod index c0cf71e..889a316 100755 --- a/links-chmod +++ b/links-chmod @@ -13,7 +13,7 @@ shopt -s lastpipe script_name="$( basename -- "${BASH_SOURCE[0]}" )" readonly script_name -script_path="$( realpath --canonicalize-existing -- "${BASH_SOURCE[0]}" )" +script_path="$( readlink --canonicalize-existing -- "${BASH_SOURCE[0]}" )" readonly script_path script_dir="$( dirname -- "$script_path" )" readonly script_dir diff --git a/links-remove b/links-remove index 2efc46d..15a33ef 100755 --- a/links-remove +++ b/links-remove @@ -13,7 +13,7 @@ shopt -s lastpipe script_name="$( basename -- "${BASH_SOURCE[0]}" )" readonly script_name -script_path="$( realpath --canonicalize-existing -- "${BASH_SOURCE[0]}" )" +script_path="$( readlink --canonicalize-existing -- "${BASH_SOURCE[0]}" )" readonly script_path script_dir="$( dirname -- "$script_path" )" readonly script_dir diff --git a/links-update b/links-update index 322cd49..0d0630c 100755 --- a/links-update +++ b/links-update @@ -25,7 +25,7 @@ shopt -s lastpipe script_name="$( basename -- "${BASH_SOURCE[0]}" )" readonly script_name -script_path="$( realpath --canonicalize-existing -- "${BASH_SOURCE[0]}" )" +script_path="$( readlink --canonicalize-existing -- "${BASH_SOURCE[0]}" )" readonly script_path script_dir="$( dirname -- "$script_path" )" readonly script_dir -- cgit v1.2.3 From 89ccc2b233822409c7f104facac9d3293252eea4 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 20:08:00 +0200 Subject: test: shuffle files around --- Makefile | 2 +- test/docker-compose.yml | 2 +- test/integration/test.sh | 91 ------- test/linux-home/test.sh | 91 +++++++ test/local/dirs/dest/1.txt | 1 + test/local/dirs/dest/bar/3.txt | 1 + test/local/dirs/src/%DEST%/1.txt | 1 + test/local/dirs/src/%DEST%/bar/3.txt | 1 + test/local/dirs/src/%DEST%/bar/baz/4.txt | 1 + test/local/dirs/src/%DEST%/foo/2.txt | 1 + test/local/test.sh | 449 +++++++++++++++++++++++++++++++ test/unit/dest/1.txt | 1 - test/unit/dest/bar/3.txt | 1 - test/unit/src/%DEST%/1.txt | 1 - test/unit/src/%DEST%/bar/3.txt | 1 - test/unit/src/%DEST%/bar/baz/4.txt | 1 - test/unit/src/%DEST%/foo/2.txt | 1 - test/unit/test.sh | 449 ------------------------------- 18 files changed, 548 insertions(+), 548 deletions(-) delete mode 100755 test/integration/test.sh create mode 100755 test/linux-home/test.sh create mode 100644 test/local/dirs/dest/1.txt create mode 100644 test/local/dirs/dest/bar/3.txt create mode 100644 test/local/dirs/src/%DEST%/1.txt create mode 100644 test/local/dirs/src/%DEST%/bar/3.txt create mode 100644 test/local/dirs/src/%DEST%/bar/baz/4.txt create mode 100644 test/local/dirs/src/%DEST%/foo/2.txt create mode 100755 test/local/test.sh delete mode 100644 test/unit/dest/1.txt delete mode 100644 test/unit/dest/bar/3.txt delete mode 100644 test/unit/src/%DEST%/1.txt delete mode 100644 test/unit/src/%DEST%/bar/3.txt delete mode 100644 test/unit/src/%DEST%/bar/baz/4.txt delete mode 100644 test/unit/src/%DEST%/foo/2.txt delete mode 100755 test/unit/test.sh diff --git a/Makefile b/Makefile index 054e75b..56340ea 100644 --- a/Makefile +++ b/Makefile @@ -34,7 +34,7 @@ test/all: test/local test/docker .PHONY: test/local test/local: - ./test/unit/test.sh + ./test/local/test.sh test/docker/%: DO cd test && \ diff --git a/test/docker-compose.yml b/test/docker-compose.yml index 76546c4..3acdef7 100644 --- a/test/docker-compose.yml +++ b/test/docker-compose.yml @@ -10,4 +10,4 @@ services: command: - sh - -c - - /src/test/unit/test.sh && /src/test/integration/test.sh + - /src/test/local/test.sh && /src/test/linux-home/test.sh diff --git a/test/integration/test.sh b/test/integration/test.sh deleted file mode 100755 index f4b1028..0000000 --- a/test/integration/test.sh +++ /dev/null @@ -1,91 +0,0 @@ -#!/usr/bin/env bash - -set -o errexit -o nounset -o pipefail -shopt -s inherit_errexit 2> /dev/null || true -shopt -s lastpipe - -script_dir="$( dirname -- "${BASH_SOURCE[0]}" )" -script_dir="$( cd -- "$script_dir" && pwd )" -readonly script_dir -script_name="$( basename -- "${BASH_SOURCE[0]}" )" -readonly script_name - -root_dir="$( git -C "$script_dir" rev-parse --show-toplevel )" -readonly root_dir - -src_name='linux-home' -readonly src_name -src_url="https://github.com/egor-tensin/$src_name.git" -readonly src_url - -test_root_dir= -test_src_dir= - -new_test() { - local test_name= - [ "${#FUNCNAME[@]}" -gt 1 ] && test_name="${FUNCNAME[1]}" - [ "$#" -gt 0 ] && test_name="$1" - - echo - echo ====================================================================== - echo "New test: $test_name" - - test_root_dir="$( mktemp -d )" - # mktemp returns /var/..., which is actually in /private/var/... on macOS. - test_root_dir="$( readlink -e -- "$test_root_dir" )" - test_src_dir="$test_root_dir/$src_name" - - echo "Root directory: $test_root_dir" - echo "Shared directory: $test_src_dir" - echo ====================================================================== - - git clone -q -- "$src_url" "$test_src_dir" - cd -- "$test_src_dir" -} - -call_bin_script() { - echo - echo -n 'Executing script:' - - printf -- ' %q' "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" - printf -- '\n' - - echo - "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" -} - -call_update() { - call_bin_script "$root_dir/links-update" "$@" -} - -call_remove() { - call_bin_script "$root_dir/links-remove" -} - -call_chmod() { - call_bin_script "$root_dir/links-chmod" "$@" -} - -test_my_dotfiles_work() { - new_test - call_update - # Again: - call_update -} - -show_env() { - echo - echo ====================================================================== - echo Environment - echo ====================================================================== - - bash --version -} - -main() { - show_env - - test_my_dotfiles_work -} - -main diff --git a/test/linux-home/test.sh b/test/linux-home/test.sh new file mode 100755 index 0000000..f4b1028 --- /dev/null +++ b/test/linux-home/test.sh @@ -0,0 +1,91 @@ +#!/usr/bin/env bash + +set -o errexit -o nounset -o pipefail +shopt -s inherit_errexit 2> /dev/null || true +shopt -s lastpipe + +script_dir="$( dirname -- "${BASH_SOURCE[0]}" )" +script_dir="$( cd -- "$script_dir" && pwd )" +readonly script_dir +script_name="$( basename -- "${BASH_SOURCE[0]}" )" +readonly script_name + +root_dir="$( git -C "$script_dir" rev-parse --show-toplevel )" +readonly root_dir + +src_name='linux-home' +readonly src_name +src_url="https://github.com/egor-tensin/$src_name.git" +readonly src_url + +test_root_dir= +test_src_dir= + +new_test() { + local test_name= + [ "${#FUNCNAME[@]}" -gt 1 ] && test_name="${FUNCNAME[1]}" + [ "$#" -gt 0 ] && test_name="$1" + + echo + echo ====================================================================== + echo "New test: $test_name" + + test_root_dir="$( mktemp -d )" + # mktemp returns /var/..., which is actually in /private/var/... on macOS. + test_root_dir="$( readlink -e -- "$test_root_dir" )" + test_src_dir="$test_root_dir/$src_name" + + echo "Root directory: $test_root_dir" + echo "Shared directory: $test_src_dir" + echo ====================================================================== + + git clone -q -- "$src_url" "$test_src_dir" + cd -- "$test_src_dir" +} + +call_bin_script() { + echo + echo -n 'Executing script:' + + printf -- ' %q' "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" + printf -- '\n' + + echo + "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" +} + +call_update() { + call_bin_script "$root_dir/links-update" "$@" +} + +call_remove() { + call_bin_script "$root_dir/links-remove" +} + +call_chmod() { + call_bin_script "$root_dir/links-chmod" "$@" +} + +test_my_dotfiles_work() { + new_test + call_update + # Again: + call_update +} + +show_env() { + echo + echo ====================================================================== + echo Environment + echo ====================================================================== + + bash --version +} + +main() { + show_env + + test_my_dotfiles_work +} + +main diff --git a/test/local/dirs/dest/1.txt b/test/local/dirs/dest/1.txt new file mode 100644 index 0000000..3a2e3f4 --- /dev/null +++ b/test/local/dirs/dest/1.txt @@ -0,0 +1 @@ +-1 diff --git a/test/local/dirs/dest/bar/3.txt b/test/local/dirs/dest/bar/3.txt new file mode 100644 index 0000000..a83d1d5 --- /dev/null +++ b/test/local/dirs/dest/bar/3.txt @@ -0,0 +1 @@ +-3 diff --git a/test/local/dirs/src/%DEST%/1.txt b/test/local/dirs/src/%DEST%/1.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/test/local/dirs/src/%DEST%/1.txt @@ -0,0 +1 @@ +1 diff --git a/test/local/dirs/src/%DEST%/bar/3.txt b/test/local/dirs/src/%DEST%/bar/3.txt new file mode 100644 index 0000000..00750ed --- /dev/null +++ b/test/local/dirs/src/%DEST%/bar/3.txt @@ -0,0 +1 @@ +3 diff --git a/test/local/dirs/src/%DEST%/bar/baz/4.txt b/test/local/dirs/src/%DEST%/bar/baz/4.txt new file mode 100644 index 0000000..b8626c4 --- /dev/null +++ b/test/local/dirs/src/%DEST%/bar/baz/4.txt @@ -0,0 +1 @@ +4 diff --git a/test/local/dirs/src/%DEST%/foo/2.txt b/test/local/dirs/src/%DEST%/foo/2.txt new file mode 100644 index 0000000..0cfbf08 --- /dev/null +++ b/test/local/dirs/src/%DEST%/foo/2.txt @@ -0,0 +1 @@ +2 diff --git a/test/local/test.sh b/test/local/test.sh new file mode 100755 index 0000000..99b426f --- /dev/null +++ b/test/local/test.sh @@ -0,0 +1,449 @@ +#!/usr/bin/env bash + +set -o errexit -o nounset -o pipefail +shopt -s inherit_errexit 2> /dev/null || true +shopt -s lastpipe + +script_dir="$( dirname -- "${BASH_SOURCE[0]}" )" +script_dir="$( cd -- "$script_dir" && pwd )" +readonly script_dir +script_name="$( basename -- "${BASH_SOURCE[0]}" )" +readonly script_name + +root_dir="$( git -C "$script_dir" rev-parse --show-toplevel )" +readonly root_dir + +readonly src_dir_name='src' +readonly dest_dir_name='dest' +readonly alt_dest_dir_name='alt_dest' + +src_dir_path="$script_dir/dirs/$src_dir_name" +readonly src_dir_path +dest_dir_path="$script_dir/dirs/$dest_dir_name" +readonly dest_dir_path + +test_root_dir= +test_src_dir= +test_dest_dir= +test_alt_dest_dir= + +new_test() { + local test_name= + [ "${#FUNCNAME[@]}" -gt 1 ] && test_name="${FUNCNAME[1]}" + [ "$#" -gt 0 ] && test_name="$1" + + echo + echo ====================================================================== + echo "New test: $test_name" + + test_root_dir="$( mktemp -d )" + # mktemp returns /var/..., which is actually in /private/var/... on macOS. + test_root_dir="$( readlink -e -- "$test_root_dir" )" + test_src_dir="$test_root_dir/$src_dir_name" + test_dest_dir="$test_root_dir/$dest_dir_name" + test_alt_dest_dir="$test_root_dir/$alt_dest_dir_name" + + echo "Root directory: $test_root_dir" + echo "Shared directory: $test_src_dir" + echo "%DEST% directory: $test_dest_dir" + echo "%ALT_DEST% directory: $test_alt_dest_dir" + echo ====================================================================== + + cp -r -- "$src_dir_path" "$test_src_dir" + cp -r -- "$dest_dir_path" "$test_dest_dir" + cp -r -- "$dest_dir_path" "$test_alt_dest_dir" +} + +call_bin_script() { + echo + echo -n 'Executing script:' + + printf -- ' %q' "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" + printf -- '\n' + + echo + DEST="$test_dest_dir" ALT_DEST="$test_alt_dest_dir" "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" +} + +call_update() { + call_bin_script "$root_dir/links-update" "$@" +} + +call_remove() { + call_bin_script "$root_dir/links-remove" +} + +call_chmod() { + call_bin_script "$root_dir/links-chmod" "$@" +} + +verify_output() { + if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then + echo "usage: ${FUNCNAME[0]} EXPECTED_OUTPUT [DEST_DIR]" >&2 + return 1 + fi + + local expected_output="$1" + echo + echo 'Expected directory structure:' + echo "$expected_output" + + local dest_dir="$test_dest_dir" + [ "$#" -ge 2 ] && dest_dir="$2" + + local actual_output + actual_output="$( find "$dest_dir" -printf '%h/%f->%l\n' | sort )" + echo + echo 'Actual directory structure:' + echo "$actual_output" + echo + + if [ "$actual_output" = "$expected_output" ]; then + echo "... They match!" + else + echo "... The actual directory structure does not match the expected directory structure!" >&2 + return 1 + fi +} + +verify_mode() { + if [ "$#" -ne 2 ]; then + echo "usage: ${FUNCNAME[0]} EXPECTED_MODE FILE" >&2 + return 1 + fi + + local expected_mode="$1" + local path="$2" + + echo + echo "Checking permissions for file: $path" + echo "Expected mode: $expected_mode" + + local actual_mode + actual_mode="$( stat -c '%a' -- "$path" )" + actual_mode="0$actual_mode" + + echo "Actual mode: $actual_mode" + + if [ "$actual_mode" = "$expected_mode" ]; then + echo "... They match!" + else + echo "... They don't match." + return 1 + fi +} + +test_update_works() { + # Basic test to make sure that links-update actually creates the proper + # symlinks. + + new_test + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + + verify_output "$expected_output" +} + +test_remove_works() { + # Basic test to make sure links-remove actually removes the created + # symlinks. + + new_test + call_update + call_remove + + local expected_output="$test_dest_dir->" + verify_output "$expected_output" +} + +test_remove_does_not_overwrite_files() { + # Check that if a user overwrites a symlink with his own file, links-remove + # keeps it. + + new_test + call_update + + # Simulate a user overwriting one of the symlinks with his own file. + rm -- "$test_dest_dir/bar/3.txt" + echo 'User content' > "$test_dest_dir/bar/3.txt" + + call_remove + + # 3.txt must be kept: + local expected_output="$test_dest_dir-> +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->" + + verify_output "$expected_output" +} + +test_remove_does_not_delete_used_dirs() { + # Check that if a user adds a file to a destination directory, it's not + # deleted by links-remove. + + new_test + call_update + + # User adds his own file to the directory: + echo 'User content' > "$test_dest_dir/bar/my-file" + + call_remove + + # bar/ and bar/my-file must be kept: + local expected_output="$test_dest_dir-> +$test_dest_dir/bar-> +$test_dest_dir/bar/my-file->" + + verify_output "$expected_output" +} + +new_test_dir_symlink() { + new_test "${FUNCNAME[1]}" + + # Files will get symlinks in the directory pointed to by $DEST, as well as + # by $ALT_DEST. + ln -s -- '%DEST%' "$test_src_dir/%ALT_DEST%" +} + +test_dir_symlink_update_works() { + # We can symlink files to multiple directories by creating symlinks inside + # --shared-dir. + + new_test_dir_symlink + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + + verify_output "$expected_output" + + expected_output="$test_alt_dest_dir-> +$test_alt_dest_dir/1.txt->$test_src_dir/%ALT_DEST%/1.txt +$test_alt_dest_dir/bar-> +$test_alt_dest_dir/bar/3.txt->$test_src_dir/%ALT_DEST%/bar/3.txt +$test_alt_dest_dir/bar/baz-> +$test_alt_dest_dir/bar/baz/4.txt->$test_src_dir/%ALT_DEST%/bar/baz/4.txt +$test_alt_dest_dir/foo-> +$test_alt_dest_dir/foo/2.txt->$test_src_dir/%ALT_DEST%/foo/2.txt" + + verify_output "$expected_output" "$test_alt_dest_dir" +} + +test_dir_symlink_remove_works() { + # Test that links-remove works for directory symlinks inside --shared-dir. + + new_test_dir_symlink + call_update + call_remove + + local expected_output="$test_dest_dir->" + verify_output "$expected_output" + + expected_output="$test_alt_dest_dir->" + verify_output "$expected_output" "$test_alt_dest_dir" +} + +test_dir_symlink_remove_shared_file() { + # If we remove a shared file, both of the symlinks should be removed. + + new_test_dir_symlink + call_update + + # Remove a random shared file: + rm -- "$test_src_dir/%DEST%/bar/3.txt" + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + + verify_output "$expected_output" + + expected_output="$test_alt_dest_dir-> +$test_alt_dest_dir/1.txt->$test_src_dir/%ALT_DEST%/1.txt +$test_alt_dest_dir/bar-> +$test_alt_dest_dir/bar/baz-> +$test_alt_dest_dir/bar/baz/4.txt->$test_src_dir/%ALT_DEST%/bar/baz/4.txt +$test_alt_dest_dir/foo-> +$test_alt_dest_dir/foo/2.txt->$test_src_dir/%ALT_DEST%/foo/2.txt" + + verify_output "$expected_output" "$test_alt_dest_dir" +} + +test_dir_symlink_remove_dir_symlink() { + # If we remove a directory symlink in --shared-dir, all the symlinks + # accessible through this directory symlink should be removed. + + new_test_dir_symlink + call_update + + # Remove the directory symlink: + rm -- "$test_src_dir/%ALT_DEST%" + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + + verify_output "$expected_output" + + expected_output="$test_alt_dest_dir->" + verify_output "$expected_output" "$test_alt_dest_dir" +} + +new_test_symlink() { + new_test "${FUNCNAME[1]}" + + # Create a stupid symlink. + ln -s -- 'bar/3.txt' "$test_src_dir/%DEST%/3_copy.txt" +} + +test_symlink_update_works() { + # Shared files can also be symlinks, pointing to something else. + + new_test_symlink + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/3_copy.txt->$test_src_dir/%DEST%/3_copy.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + + verify_output "$expected_output" + + echo + echo 'Verifying 3_copy.txt (the symlink) is valid...' + + local copy_target + copy_target="$( readlink -- "$test_dest_dir/3_copy.txt" )" + test "$copy_target" = "$test_src_dir/%DEST%/3_copy.txt" + + local copy_content + copy_content="$( cat -- "$test_dest_dir/3_copy.txt" )" + test "$copy_content" = '3' +} + +test_symlink_remove_works() { + # Verify that links-remove doesn't delete shared symlinks. + + new_test_symlink + call_update + call_remove + + local expected_output="$test_dest_dir->" + verify_output "$expected_output" + + echo + echo 'Verifying 3_copy.txt (the shared file) is valid...' + + local copy_target + copy_target="$( readlink -e -- "$test_src_dir/%DEST%/3_copy.txt" )" + test "$copy_target" = "$test_src_dir/%DEST%/bar/3.txt" + + local copy_content + copy_content="$( cat -- "$test_src_dir/%DEST%/3_copy.txt" )" + test "$copy_content" = '3' +} + +test_chmod_works() { + # Test that links-chmod works. + + new_test + call_update + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + verify_output "$expected_output" + + echo + echo 'Verifying 1.txt (the shared file) permissions...' + + verify_mode 0644 "$test_src_dir/%DEST%/1.txt" + call_chmod 0600 + verify_mode 0600 "$test_src_dir/%DEST%/1.txt" +} + +test_update_chmod() { + # Test that links-update --mode works. + + new_test + local expected_mode='0622' + call_update --mode "$expected_mode" + + local expected_output="$test_dest_dir-> +$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt +$test_dest_dir/bar-> +$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt +$test_dest_dir/bar/baz-> +$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt +$test_dest_dir/foo-> +$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" + verify_output "$expected_output" + + verify_mode "$expected_mode" "$test_src_dir/%DEST%/1.txt" +} + +show_env() { + echo + echo ====================================================================== + echo Environment + echo ====================================================================== + + bash --version +} + +main() { + show_env + + test_update_works + test_remove_works + test_remove_does_not_overwrite_files + test_remove_does_not_delete_used_dirs + + test_dir_symlink_update_works + test_dir_symlink_remove_works + test_dir_symlink_remove_shared_file + test_dir_symlink_remove_dir_symlink + + test_symlink_update_works + test_symlink_remove_works + + test_chmod_works + test_update_chmod +} + +main diff --git a/test/unit/dest/1.txt b/test/unit/dest/1.txt deleted file mode 100644 index 3a2e3f4..0000000 --- a/test/unit/dest/1.txt +++ /dev/null @@ -1 +0,0 @@ --1 diff --git a/test/unit/dest/bar/3.txt b/test/unit/dest/bar/3.txt deleted file mode 100644 index a83d1d5..0000000 --- a/test/unit/dest/bar/3.txt +++ /dev/null @@ -1 +0,0 @@ --3 diff --git a/test/unit/src/%DEST%/1.txt b/test/unit/src/%DEST%/1.txt deleted file mode 100644 index d00491f..0000000 --- a/test/unit/src/%DEST%/1.txt +++ /dev/null @@ -1 +0,0 @@ -1 diff --git a/test/unit/src/%DEST%/bar/3.txt b/test/unit/src/%DEST%/bar/3.txt deleted file mode 100644 index 00750ed..0000000 --- a/test/unit/src/%DEST%/bar/3.txt +++ /dev/null @@ -1 +0,0 @@ -3 diff --git a/test/unit/src/%DEST%/bar/baz/4.txt b/test/unit/src/%DEST%/bar/baz/4.txt deleted file mode 100644 index b8626c4..0000000 --- a/test/unit/src/%DEST%/bar/baz/4.txt +++ /dev/null @@ -1 +0,0 @@ -4 diff --git a/test/unit/src/%DEST%/foo/2.txt b/test/unit/src/%DEST%/foo/2.txt deleted file mode 100644 index 0cfbf08..0000000 --- a/test/unit/src/%DEST%/foo/2.txt +++ /dev/null @@ -1 +0,0 @@ -2 diff --git a/test/unit/test.sh b/test/unit/test.sh deleted file mode 100755 index f693aa1..0000000 --- a/test/unit/test.sh +++ /dev/null @@ -1,449 +0,0 @@ -#!/usr/bin/env bash - -set -o errexit -o nounset -o pipefail -shopt -s inherit_errexit 2> /dev/null || true -shopt -s lastpipe - -script_dir="$( dirname -- "${BASH_SOURCE[0]}" )" -script_dir="$( cd -- "$script_dir" && pwd )" -readonly script_dir -script_name="$( basename -- "${BASH_SOURCE[0]}" )" -readonly script_name - -root_dir="$( git -C "$script_dir" rev-parse --show-toplevel )" -readonly root_dir - -readonly src_dir_name='src' -readonly dest_dir_name='dest' -readonly alt_dest_dir_name='alt_dest' - -src_dir_path="$script_dir/$src_dir_name" -readonly src_dir_path -dest_dir_path="$script_dir/$dest_dir_name" -readonly dest_dir_path - -test_root_dir= -test_src_dir= -test_dest_dir= -test_alt_dest_dir= - -new_test() { - local test_name= - [ "${#FUNCNAME[@]}" -gt 1 ] && test_name="${FUNCNAME[1]}" - [ "$#" -gt 0 ] && test_name="$1" - - echo - echo ====================================================================== - echo "New test: $test_name" - - test_root_dir="$( mktemp -d )" - # mktemp returns /var/..., which is actually in /private/var/... on macOS. - test_root_dir="$( readlink -e -- "$test_root_dir" )" - test_src_dir="$test_root_dir/$src_dir_name" - test_dest_dir="$test_root_dir/$dest_dir_name" - test_alt_dest_dir="$test_root_dir/$alt_dest_dir_name" - - echo "Root directory: $test_root_dir" - echo "Shared directory: $test_src_dir" - echo "%DEST% directory: $test_dest_dir" - echo "%ALT_DEST% directory: $test_alt_dest_dir" - echo ====================================================================== - - cp -r -- "$src_dir_path" "$test_src_dir" - cp -r -- "$dest_dir_path" "$test_dest_dir" - cp -r -- "$dest_dir_path" "$test_alt_dest_dir" -} - -call_bin_script() { - echo - echo -n 'Executing script:' - - printf -- ' %q' "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" - printf -- '\n' - - echo - DEST="$test_dest_dir" ALT_DEST="$test_alt_dest_dir" "$@" --shared-dir "$test_src_dir" --database "$test_root_dir/links.bin" -} - -call_update() { - call_bin_script "$root_dir/links-update" "$@" -} - -call_remove() { - call_bin_script "$root_dir/links-remove" -} - -call_chmod() { - call_bin_script "$root_dir/links-chmod" "$@" -} - -verify_output() { - if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; then - echo "usage: ${FUNCNAME[0]} EXPECTED_OUTPUT [DEST_DIR]" >&2 - return 1 - fi - - local expected_output="$1" - echo - echo 'Expected directory structure:' - echo "$expected_output" - - local dest_dir="$test_dest_dir" - [ "$#" -ge 2 ] && dest_dir="$2" - - local actual_output - actual_output="$( find "$dest_dir" -printf '%h/%f->%l\n' | sort )" - echo - echo 'Actual directory structure:' - echo "$actual_output" - echo - - if [ "$actual_output" = "$expected_output" ]; then - echo "... They match!" - else - echo "... The actual directory structure does not match the expected directory structure!" >&2 - return 1 - fi -} - -verify_mode() { - if [ "$#" -ne 2 ]; then - echo "usage: ${FUNCNAME[0]} EXPECTED_MODE FILE" >&2 - return 1 - fi - - local expected_mode="$1" - local path="$2" - - echo - echo "Checking permissions for file: $path" - echo "Expected mode: $expected_mode" - - local actual_mode - actual_mode="$( stat -c '%a' -- "$path" )" - actual_mode="0$actual_mode" - - echo "Actual mode: $actual_mode" - - if [ "$actual_mode" = "$expected_mode" ]; then - echo "... They match!" - else - echo "... They don't match." - return 1 - fi -} - -test_update_works() { - # Basic test to make sure that links-update actually creates the proper - # symlinks. - - new_test - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - - verify_output "$expected_output" -} - -test_remove_works() { - # Basic test to make sure links-remove actually removes the created - # symlinks. - - new_test - call_update - call_remove - - local expected_output="$test_dest_dir->" - verify_output "$expected_output" -} - -test_remove_does_not_overwrite_files() { - # Check that if a user overwrites a symlink with his own file, links-remove - # keeps it. - - new_test - call_update - - # Simulate a user overwriting one of the symlinks with his own file. - rm -- "$test_dest_dir/bar/3.txt" - echo 'User content' > "$test_dest_dir/bar/3.txt" - - call_remove - - # 3.txt must be kept: - local expected_output="$test_dest_dir-> -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->" - - verify_output "$expected_output" -} - -test_remove_does_not_delete_used_dirs() { - # Check that if a user adds a file to a destination directory, it's not - # deleted by links-remove. - - new_test - call_update - - # User adds his own file to the directory: - echo 'User content' > "$test_dest_dir/bar/my-file" - - call_remove - - # bar/ and bar/my-file must be kept: - local expected_output="$test_dest_dir-> -$test_dest_dir/bar-> -$test_dest_dir/bar/my-file->" - - verify_output "$expected_output" -} - -new_test_dir_symlink() { - new_test "${FUNCNAME[1]}" - - # Files will get symlinks in the directory pointed to by $DEST, as well as - # by $ALT_DEST. - ln -s -- '%DEST%' "$test_src_dir/%ALT_DEST%" -} - -test_dir_symlink_update_works() { - # We can symlink files to multiple directories by creating symlinks inside - # --shared-dir. - - new_test_dir_symlink - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - - verify_output "$expected_output" - - expected_output="$test_alt_dest_dir-> -$test_alt_dest_dir/1.txt->$test_src_dir/%ALT_DEST%/1.txt -$test_alt_dest_dir/bar-> -$test_alt_dest_dir/bar/3.txt->$test_src_dir/%ALT_DEST%/bar/3.txt -$test_alt_dest_dir/bar/baz-> -$test_alt_dest_dir/bar/baz/4.txt->$test_src_dir/%ALT_DEST%/bar/baz/4.txt -$test_alt_dest_dir/foo-> -$test_alt_dest_dir/foo/2.txt->$test_src_dir/%ALT_DEST%/foo/2.txt" - - verify_output "$expected_output" "$test_alt_dest_dir" -} - -test_dir_symlink_remove_works() { - # Test that links-remove works for directory symlinks inside --shared-dir. - - new_test_dir_symlink - call_update - call_remove - - local expected_output="$test_dest_dir->" - verify_output "$expected_output" - - expected_output="$test_alt_dest_dir->" - verify_output "$expected_output" "$test_alt_dest_dir" -} - -test_dir_symlink_remove_shared_file() { - # If we remove a shared file, both of the symlinks should be removed. - - new_test_dir_symlink - call_update - - # Remove a random shared file: - rm -- "$test_src_dir/%DEST%/bar/3.txt" - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - - verify_output "$expected_output" - - expected_output="$test_alt_dest_dir-> -$test_alt_dest_dir/1.txt->$test_src_dir/%ALT_DEST%/1.txt -$test_alt_dest_dir/bar-> -$test_alt_dest_dir/bar/baz-> -$test_alt_dest_dir/bar/baz/4.txt->$test_src_dir/%ALT_DEST%/bar/baz/4.txt -$test_alt_dest_dir/foo-> -$test_alt_dest_dir/foo/2.txt->$test_src_dir/%ALT_DEST%/foo/2.txt" - - verify_output "$expected_output" "$test_alt_dest_dir" -} - -test_dir_symlink_remove_dir_symlink() { - # If we remove a directory symlink in --shared-dir, all the symlinks - # accessible through this directory symlink should be removed. - - new_test_dir_symlink - call_update - - # Remove the directory symlink: - rm -- "$test_src_dir/%ALT_DEST%" - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - - verify_output "$expected_output" - - expected_output="$test_alt_dest_dir->" - verify_output "$expected_output" "$test_alt_dest_dir" -} - -new_test_symlink() { - new_test "${FUNCNAME[1]}" - - # Create a stupid symlink. - ln -s -- 'bar/3.txt' "$test_src_dir/%DEST%/3_copy.txt" -} - -test_symlink_update_works() { - # Shared files can also be symlinks, pointing to something else. - - new_test_symlink - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/3_copy.txt->$test_src_dir/%DEST%/3_copy.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - - verify_output "$expected_output" - - echo - echo 'Verifying 3_copy.txt (the symlink) is valid...' - - local copy_target - copy_target="$( readlink -- "$test_dest_dir/3_copy.txt" )" - test "$copy_target" = "$test_src_dir/%DEST%/3_copy.txt" - - local copy_content - copy_content="$( cat -- "$test_dest_dir/3_copy.txt" )" - test "$copy_content" = '3' -} - -test_symlink_remove_works() { - # Verify that links-remove doesn't delete shared symlinks. - - new_test_symlink - call_update - call_remove - - local expected_output="$test_dest_dir->" - verify_output "$expected_output" - - echo - echo 'Verifying 3_copy.txt (the shared file) is valid...' - - local copy_target - copy_target="$( readlink -e -- "$test_src_dir/%DEST%/3_copy.txt" )" - test "$copy_target" = "$test_src_dir/%DEST%/bar/3.txt" - - local copy_content - copy_content="$( cat -- "$test_src_dir/%DEST%/3_copy.txt" )" - test "$copy_content" = '3' -} - -test_chmod_works() { - # Test that links-chmod works. - - new_test - call_update - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - verify_output "$expected_output" - - echo - echo 'Verifying 1.txt (the shared file) permissions...' - - verify_mode 0644 "$test_src_dir/%DEST%/1.txt" - call_chmod 0600 - verify_mode 0600 "$test_src_dir/%DEST%/1.txt" -} - -test_update_chmod() { - # Test that links-update --mode works. - - new_test - local expected_mode='0622' - call_update --mode "$expected_mode" - - local expected_output="$test_dest_dir-> -$test_dest_dir/1.txt->$test_src_dir/%DEST%/1.txt -$test_dest_dir/bar-> -$test_dest_dir/bar/3.txt->$test_src_dir/%DEST%/bar/3.txt -$test_dest_dir/bar/baz-> -$test_dest_dir/bar/baz/4.txt->$test_src_dir/%DEST%/bar/baz/4.txt -$test_dest_dir/foo-> -$test_dest_dir/foo/2.txt->$test_src_dir/%DEST%/foo/2.txt" - verify_output "$expected_output" - - verify_mode "$expected_mode" "$test_src_dir/%DEST%/1.txt" -} - -show_env() { - echo - echo ====================================================================== - echo Environment - echo ====================================================================== - - bash --version -} - -main() { - show_env - - test_update_works - test_remove_works - test_remove_does_not_overwrite_files - test_remove_does_not_delete_used_dirs - - test_dir_symlink_update_works - test_dir_symlink_remove_works - test_dir_symlink_remove_shared_file - test_dir_symlink_remove_dir_symlink - - test_symlink_update_works - test_symlink_remove_works - - test_chmod_works - test_update_chmod -} - -main -- cgit v1.2.3 From 3af293cba20c02b5ab8d8d26fe670af82ff1b78d Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 20:17:11 +0200 Subject: t/d: move docker-compose.yml to docker/ --- Makefile | 6 +++++- test/docker-compose.yml | 13 ------------- test/docker/Dockerfile | 8 +++++++- test/docker/docker-compose.yml | 8 ++++++++ 4 files changed, 20 insertions(+), 15 deletions(-) delete mode 100644 test/docker-compose.yml create mode 100644 test/docker/docker-compose.yml diff --git a/Makefile b/Makefile index 56340ea..fa67f31 100644 --- a/Makefile +++ b/Makefile @@ -36,8 +36,12 @@ test/all: test/local test/docker test/local: ./test/local/test.sh +.PHONY: test/linux-home +test/linux-home: + ./test/linux-home/test.sh + test/docker/%: DO - cd test && \ + cd test/docker && \ DISTRO='$*' docker-compose build --pull && \ docker-compose run --rm test && \ docker-compose down -v diff --git a/test/docker-compose.yml b/test/docker-compose.yml deleted file mode 100644 index 3acdef7..0000000 --- a/test/docker-compose.yml +++ /dev/null @@ -1,13 +0,0 @@ -version: '3' -services: - test: - build: - context: docker/ - args: - DISTRO: "${DISTRO:-xenial}" - volumes: - - ../:/src - command: - - sh - - -c - - /src/test/local/test.sh && /src/test/linux-home/test.sh diff --git a/test/docker/Dockerfile b/test/docker/Dockerfile index 5d4d016..04e66da 100644 --- a/test/docker/Dockerfile +++ b/test/docker/Dockerfile @@ -4,6 +4,12 @@ FROM ubuntu:$DISTRO RUN apt-get update && \ DEBIAN_FRONTEND=noninteractive \ - apt-get install -y --no-install-recommends ca-certificates git + apt-get install -y --no-install-recommends ca-certificates git make RUN git config --global --add safe.directory /src + +COPY [".", "/src"] + +WORKDIR /src + +CMD ["make", "test/local", "test/linux-home"] diff --git a/test/docker/docker-compose.yml b/test/docker/docker-compose.yml new file mode 100644 index 0000000..552fadb --- /dev/null +++ b/test/docker/docker-compose.yml @@ -0,0 +1,8 @@ +version: '3' +services: + test: + build: + context: ../.. + dockerfile: test/docker/Dockerfile + args: + DISTRO: "${DISTRO:-xenial}" -- cgit v1.2.3 From a87914970bb985176ad09c422f0942908492de0f Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 20:23:16 +0200 Subject: t/l: fail unless $CI is set --- test/docker/docker-compose.yml | 2 ++ test/linux-home/test.sh | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/test/docker/docker-compose.yml b/test/docker/docker-compose.yml index 552fadb..0689ad3 100644 --- a/test/docker/docker-compose.yml +++ b/test/docker/docker-compose.yml @@ -6,3 +6,5 @@ services: dockerfile: test/docker/Dockerfile args: DISTRO: "${DISTRO:-xenial}" + environment: + CI: y diff --git a/test/linux-home/test.sh b/test/linux-home/test.sh index f4b1028..edb2d5b 100755 --- a/test/linux-home/test.sh +++ b/test/linux-home/test.sh @@ -83,8 +83,12 @@ show_env() { } main() { - show_env + if [ -z "${CI:+x}" ]; then + echo "$script_name: please don't run it outside of CI runs" >&2 + exit 1 + fi + show_env test_my_dotfiles_work } -- cgit v1.2.3 From f9f0b361414b17d28de889de8d7d7212976d350a Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 20:26:40 +0200 Subject: use `--progress plain` with docker-compose build --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index fa67f31..23de6d3 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,7 @@ test/linux-home: test/docker/%: DO cd test/docker && \ - DISTRO='$*' docker-compose build --pull && \ + DISTRO='$*' docker-compose build --force-rm --progress plain --pull -q && \ docker-compose run --rm test && \ docker-compose down -v -- cgit v1.2.3 From 89159d00dd4449d9e503495607f2c0a381902211 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 21 May 2023 20:33:48 +0200 Subject: move comments from links-update to README --- README.md | 10 ++++++++++ links-update | 12 ------------ 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9c04c05..df919a6 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,16 @@ macOS is supported on a basic level. GNU coreutils and findutils are required, which you can install using Homebrew. Don't forget to add them to PATH! +Cygwin +------ + +These scripts rely on the availability of native symlinks. +On Windows/NTFS, they require Administrator privileges. + +Remember that in order to force `ln` to use native NTFS symlinks, your `CYGWIN` +environment variable **must** include either `winsymlinks:native` or +`winsymlinks:nativestrict`. + License ------- diff --git a/links-update b/links-update index 0d0630c..c95530d 100755 --- a/links-update +++ b/links-update @@ -5,18 +5,6 @@ # For details, see https://github.com/egor-tensin/config-links. # Distributed under the MIT License. -# This script relies on the availability of native symlinks. -# Those are indeed supported by NTFS, but require Administrator privileges for -# creation. -# It likely won't bother you as long as you don't use the functions defined in -# this file. -# In any case, you will see `ln` complaining about some access being denied in -# case something goes wrong. -# -# Remember that in order to force `ln` to use native NTFS symlinks, your -# `CYGWIN` Windows environment variable value **must** include either -# `winsymlinks:native` or `winsymlinks:nativestrict`! - # usage: ./links-update [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-m|--mode MODE] [-n|--dry-run] set -o errexit -o nounset -o pipefail -- cgit v1.2.3