Reference paths relative to project root (#1800)

* Reference paths relative to the current script or project root

Before this PR:
- some scripts change the current working directory and use relative paths
- different approaches are taken to know which directory a script is running in
- paths are sometimes relative, sometimes absolute, sometimes traversing directories

After this PR:
- scripts do neither change nor care much about the current working directory
- a unified approach determines the directory of the current script
- paths are always relative to the project root

This should resolve an issue I already tried to fix with #1798,
where the contents of `./sentry` were not copied
into the built container image,
thus `enhance-image.sh` did not apply.

Co-authored-by: Amin Vakil <[email protected]>

Author: spawnia

.pre-commit-config.yaml

@@ -17,7 +17,6 @@ repos:
   hooks:
   - id: check-case-conflict
   - id: check-executables-have-shebangs
-    exclude: ^(install/|_unit-test/_test_setup.sh)
   - id: check-merge-conflict
   - id: check-symlinks
   - id: end-of-file-fixer

_integration-test/custom-ca-roots/setup.sh

@@ -1,10 +1,8 @@
-#! /usr/bin/env bash
 set -e
+export COMPOSE_FILE=docker-compose.yml:_integration-test/custom-ca-roots/docker-compose.test.yml
 
-export COMPOSE_FILE="../docker-compose.yml:./custom-ca-roots/docker-compose.test.yml"
-
-TEST_NGINX_CONF_PATH="./custom-ca-roots/nginx"
-CUSTOM_CERTS_PATH="../certificates"
+TEST_NGINX_CONF_PATH=_integration-test/custom-ca-roots/nginx
+CUSTOM_CERTS_PATH=certificates
 
 # generate tightly constrained CA
 # NB: `-addext` requires LibreSSL 3.1.0+, or OpenSSL (brew install openssl)
@@ -42,6 +40,6 @@ openssl req -x509 -newkey rsa:2048 -nodes -days 1 -keyout $TEST_NGINX_CONF_PATH/
 
 # openssl x509 -in nginx/fake.test.crt -text -noout
 
-cp ./custom-ca-roots/test.py ../sentry/test-custom-ca-roots.py
+cp _integration-test/custom-ca-roots/test.py sentry/test-custom-ca-roots.py
 
 $dc up -d fixture-custom-ca-roots

_integration-test/custom-ca-roots/teardown.sh

@@ -1,4 +1,3 @@
-#!/usr/bin/env bash
 $dc rm -s -f -v fixture-custom-ca-roots
-rm -f ../certificates/test-custom-ca-roots.crt ../sentry/test-custom-ca-roots.py
+rm -f certificates/test-custom-ca-roots.crt sentry/test-custom-ca-roots.py
 unset COMPOSE_FILE

_integration-test/ensure-customizations-not-present.sh

@@ -1,9 +1,8 @@
 #!/usr/bin/env bash
 set -ex
 
-source "$(dirname $0)/../install/_lib.sh"
-
-source ../install/dc-detect-version.sh
+source install/_lib.sh
+source install/dc-detect-version.sh
 
 # Negated version of ensure-customizations-work.sh, make changes in sync
 echo "${_group}Ensure customizations not present"

_integration-test/ensure-customizations-work.sh

@@ -1,9 +1,8 @@
 #!/usr/bin/env bash
 set -ex
 
-source "$(dirname $0)/../install/_lib.sh"
-
-source ../install/dc-detect-version.sh
+source install/_lib.sh
+source install/dc-detect-version.sh
 
 # Negated version of ensure-customizations-not-present.sh, make changes in sync
 echo "${_group}Ensure customizations work"

_integration-test/run.sh

@@ -1,9 +1,8 @@
 #!/usr/bin/env bash
 set -ex
 
-source "$(dirname $0)/../install/_lib.sh"
-
-source ../install/dc-detect-version.sh
+source install/_lib.sh
+source install/dc-detect-version.sh
 
 echo "${_group}Setting up variables and helpers ..."
 export SENTRY_TEST_HOST="${SENTRY_TEST_HOST:-http://localhost:9000}"
@@ -51,14 +50,14 @@ echo "${_endgroup}"
 
 echo "${_group}Running tests ..."
 get_csrf_token() { awk '$6 == "sc" { print $7 }' $COOKIE_FILE; }
-sentry_api_request() { curl -s -H 'Accept: application/json; charset=utf-8' -H "Referer: $SENTRY_TEST_HOST" -H 'Content-Type: application/json' -H "X-CSRFToken: $(get_csrf_token)" -b "$COOKIE_FILE" -c "$COOKIE_FILE" "$SENTRY_TEST_HOST/$1" ${@:2}; }
+sentry_api_request() { curl -s -H 'Accept: application/json; charset=utf-8' -H "Referer: $SENTRY_TEST_HOST" -H 'Content-Type: application/json' -H "X-CSRFToken: $(get_csrf_token)" -b "$COOKIE_FILE" -c "$COOKIE_FILE" "$SENTRY_TEST_HOST/$1" "${@:2}"; }
 
 login() {
   INITIAL_AUTH_REDIRECT=$(curl -sL -o /dev/null $SENTRY_TEST_HOST -w %{url_effective})
   if [ "$INITIAL_AUTH_REDIRECT" != "$SENTRY_TEST_HOST/auth/login/sentry/" ]; then
     echo "Initial /auth/login/ redirect failed, exiting..."
     echo "$INITIAL_AUTH_REDIRECT"
-    exit -1
+    exit 1
   fi
 
   CSRF_TOKEN_FOR_LOGIN=$(curl $SENTRY_TEST_HOST -sL -c "$COOKIE_FILE" | awk -F "['\"]" '
@@ -78,7 +77,7 @@ declare -a LOGIN_TEST_STRINGS=(
 )
 for i in "${LOGIN_TEST_STRINGS[@]}"; do
   echo "Testing '$i'..."
-  echo "$LOGIN_RESPONSE" | grep "$i[,}]" >&/dev/null
+  echo "$LOGIN_RESPONSE" | grep "${i}[,}]" >&/dev/null
   echo "Pass."
 done
 echo "${_endgroup}"
@@ -117,7 +116,7 @@ declare -a EVENT_TEST_STRINGS=(
 )
 for i in "${EVENT_TEST_STRINGS[@]}"; do
   echo "Testing '$i'..."
-  echo "$EVENT_RESPONSE" | grep "$i[,}]" >&/dev/null
+  echo "$EVENT_RESPONSE" | grep "${i}[,}]" >&/dev/null
   echo "Pass."
 done
 echo "${_endgroup}"
@@ -145,16 +144,16 @@ SCOPES=$(jq -n -c --argjson scopes '["event:admin", "event:read", "member:read",
 SENTRY_AUTH_TOKEN=$(sentry_api_request "api/0/api-tokens/" -X POST --data "$SCOPES" | jq -r '.token')
 SENTRY_DSN=$(sentry_api_request "api/0/projects/sentry/native/keys/" | jq -r '.[0].dsn.secret')
 # Then upload the symbols to that project (note the container mounts pwd to /work)
-SENTRY_URL="$SENTRY_TEST_HOST" sentry-cli upload-dif --org "$SENTRY_ORG" --project "$SENTRY_PROJECT" --auth-token "$SENTRY_AUTH_TOKEN" windows.sym
+SENTRY_URL="$SENTRY_TEST_HOST" sentry-cli upload-dif --org "$SENTRY_ORG" --project "$SENTRY_PROJECT" --auth-token "$SENTRY_AUTH_TOKEN" _integration-test/windows.sym
 # Get public key for minidump upload
 PUBLIC_KEY=$(sentry_api_request "api/0/projects/sentry/native/keys/" | jq -r '.[0].public')
 # Upload the minidump to be processed, this returns the event ID of the crash dump
-EVENT_ID=$(sentry_api_request "api/$NATIVE_PROJECT_ID/minidump/?sentry_key=$PUBLIC_KEY" -X POST -F '[email protected]' | sed 's/\-//g')
+EVENT_ID=$(sentry_api_request "api/$NATIVE_PROJECT_ID/minidump/?sentry_key=$PUBLIC_KEY" -X POST -F 'upload_file_minidump=@_integration-test/windows.dmp' | sed 's/\-//g')
 # We have to wait for the item to be processed
 for i in {0..60..10}; do
   EVENT_PROCESSED=$(sentry_api_request "api/0/projects/$SENTRY_ORG/$SENTRY_PROJECT/events/" | jq -r '.[]|select(.id == "'"$EVENT_ID"'")|.id')
   if [ -z "$EVENT_PROCESSED" ]; then
-    sleep $i
+    sleep "$i"
   else
     break
   fi
@@ -167,9 +166,9 @@ fi
 echo "${_endgroup}"
 
 echo "${_group}Test custom CAs work ..."
-source ./custom-ca-roots/setup.sh
+source _integration-test/custom-ca-roots/setup.sh
 $dcr --no-deps web python3 /etc/sentry/test-custom-ca-roots.py
-source ./custom-ca-roots/teardown.sh
+source _integration-test/custom-ca-roots/teardown.sh
 echo "${_endgroup}"
 
 # Table formatting based on https://stackoverflow.com/a/39144364

_unit-test/_test_setup.sh

@@ -1,27 +1,29 @@
 set -euo pipefail
-source "$(dirname $0)/../install/_lib.sh"
+
+source install/_lib.sh
+
+_ORIGIN=$(pwd)
 
 rm -rf /tmp/sentry-self-hosted-test-sandbox.*
 _SANDBOX="$(mktemp -d /tmp/sentry-self-hosted-test-sandbox.XXX)"
 
-source "$basedir/install/detect-platform.sh"
-docker build -t sentry-self-hosted-jq-local --platform=$DOCKER_PLATFORM "$basedir/jq"
+source install/detect-platform.sh
+docker build -t sentry-self-hosted-jq-local --platform="$DOCKER_PLATFORM" jq
 
 report_success() {
   echo "$(basename $0) - Success 👍"
 }
 
 teardown() {
   test "${DEBUG:-}" || rm -rf "$_SANDBOX"
+  cd "$_ORIGIN"
 }
 
 setup() {
-  cd ..
-
   # Clone the local repo into a temp dir. FWIW `git clone --local` breaks for
   # me because it depends on hard-linking, which doesn't work across devices,
   # and I happen to have my workspace and /tmp on separate devices.
-  git -c advice.detachedHead=false clone --depth=1 "file://$(pwd)" "$_SANDBOX"
+  git -c advice.detachedHead=false clone --depth=1 "file://$_ORIGIN" "$_SANDBOX"
 
   # Now propagate any local changes from the working copy to the sandbox. This
   # provides a pretty nice dev experience: edit the files in the working copy,
@@ -47,7 +49,7 @@ setup() {
     esac
   done
 
-  cd "$_SANDBOX/install"
+  cd "$_SANDBOX"
 
   trap teardown EXIT
 }

_unit-test/create-docker-volumes-test.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
-source "$(dirname $0)/_test_setup.sh"
+
+source _unit-test/_test_setup.sh
 
 get_volumes() {
   # If grep returns no strings, we still want to return without error
@@ -20,9 +21,9 @@ before=$(get_volumes)
 
 test "$before" == "" || test "$before" == "$expected_volumes"
 
-source create-docker-volumes.sh
-source create-docker-volumes.sh
-source create-docker-volumes.sh
+source install/create-docker-volumes.sh
+source install/create-docker-volumes.sh
+source install/create-docker-volumes.sh
 
 after=$(get_volumes)
 test "$after" == "$expected_volumes"

_unit-test/ensure-relay-credentials-test.sh

@@ -1,25 +1,26 @@
 #!/usr/bin/env bash
-source "$(dirname $0)/_test_setup.sh"
-source dc-detect-version.sh
+
+source _unit-test/_test_setup.sh
+source install/dc-detect-version.sh
 
 # using _file format for these variables since there is a creds defined in dc-detect-version.sh
-cfg_file="../relay/config.yml"
-creds_file="../relay/credentials.json"
+cfg_file=relay/config.yml
+creds_file=relay/credentials.json
 
 # Relay files don't exist in a clean clone.
 test ! -f $cfg_file
 test ! -f $creds_file
 
 # Running the install script adds them.
-source ensure-relay-credentials.sh
+source install/ensure-relay-credentials.sh
 test -f $cfg_file
 test -f $creds_file
-test "$(jq -r 'keys[2]' $creds_file)" = "secret_key"
+test "$(jq -r 'keys[2]' "$creds_file")" = "secret_key"
 
 # If the files exist we don't touch it.
 echo GARBAGE >$cfg_file
 echo MOAR GARBAGE >$creds_file
-source ensure-relay-credentials.sh
+source install/ensure-relay-credentials.sh
 test "$(cat $cfg_file)" = "GARBAGE"
 test "$(cat $creds_file)" = "MOAR GARBAGE"
 

_unit-test/error-handling-test.sh

@@ -1,12 +1,13 @@
 #!/usr/bin/env bash
-source "$(dirname $0)/_test_setup.sh"
+
+source _unit-test/_test_setup.sh
 
 export REPORT_SELF_HOSTED_ISSUES=1
 
 # This is set up in dc-detect-version.sh, but for
 # our purposes we don't care about proxies.
 dbuild="docker build"
-source error-handling.sh
+source install/error-handling.sh
 
 # mock send_envelope
 send_envelope() {
@@ -15,15 +16,15 @@ send_envelope() {
 
 export -f send_envelope
 echo "Testing initial send_event"
-export log_path="$basedir/test_log.txt"
-echo "Test Logs" >"$log_path"
-echo "Error Msg" >>"$log_path"
+export log_file=test_log.txt
+echo "Test Logs" >"$log_file"
+echo "Error Msg" >>"$log_file"
 breadcrumbs=$(generate_breadcrumb_json | sed '$d' | $jq -s -c)
 SEND_EVENT_RESPONSE=$(send_event "12345123451234512345123451234512" "Test exited with status 1" "{\"ignore\": \"me\"}" "$breadcrumbs")
-rm "$log_path"
+rm "$log_file"
 test "$SEND_EVENT_RESPONSE" == 'Test Sending sentry-envelope-12345123451234512345123451234512'
 ENVELOPE_CONTENTS=$(cat /tmp/sentry-envelope-12345123451234512345123451234512)
-test "$ENVELOPE_CONTENTS" == "$(cat "$basedir/_unit-test/snapshots/sentry-envelope-12345123451234512345123451234512")"
+test "$ENVELOPE_CONTENTS" == "$(cat _unit-test/snapshots/sentry-envelope-12345123451234512345123451234512)"
 echo "Pass."
 
 echo "Testing send_event duplicate"
@@ -36,10 +37,10 @@ echo "Testing cleanup without minimizing downtime"
 export REPORT_SELF_HOSTED_ISSUES=0
 export MINIMIZE_DOWNTIME=''
 export dc=':'
-echo "Test Logs" >"$log_path"
+echo "Test Logs" >"$log_file"
 CLEANUP_RESPONSE=$(cleanup ERROR)
-rm "$log_path"
-test "$CLEANUP_RESPONSE" == 'Error in ./_unit-test/error-handling-test.sh:40.
+rm "$log_file"
+test "$CLEANUP_RESPONSE" == 'Error in _unit-test/error-handling-test.sh:41.
 '\''local cmd="${BASH_COMMAND}"'\'' exited with status 0
 
 Cleaning up...'
@@ -48,10 +49,10 @@ echo "Pass."
 echo "Testing cleanup while minimizing downtime"
 export REPORT_SELF_HOSTED_ISSUES=0
 export MINIMIZE_DOWNTIME=1
-echo "Test Logs" >"$log_path"
+echo "Test Logs" >"$log_file"
 CLEANUP_RESPONSE=$(cleanup ERROR)
-rm "$log_path"
-test "$CLEANUP_RESPONSE" == 'Error in ./_unit-test/error-handling-test.sh:52.
+rm "$log_file"
+test "$CLEANUP_RESPONSE" == 'Error in _unit-test/error-handling-test.sh:53.
 '\''local cmd="${BASH_COMMAND}"'\'' exited with status 0
 
 *NOT* cleaning up, to clean your environment run "docker compose stop".'