-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: disable automatic runner updates (#1088)
* Add env variable to configure `disablupdate` flag * Write test for entrypoint disable update * Rename flag, update docs for DISABLE_RUNNER_UPDATE * chore: bump runner version in makefile Co-authored-by: Callum Tait <15716903+toast-gear@users.noreply.github.com>
- Loading branch information
1 parent
b652a8f
commit 1b91174
Showing
9 changed files
with
150 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
#!/bin/bash | ||
|
||
export LIGHTGREEN='\e[0;32m' | ||
export LIGHTRED='\e[0;31m' | ||
export WHITE='\e[0;97m' | ||
export RESET='\e[0m' | ||
|
||
log(){ | ||
printf "\t${WHITE}$@${RESET}\n" 2>&1 | ||
} | ||
|
||
success(){ | ||
printf "\t${LIGHTGREEN}$@${RESET}\n" 2>&1 | ||
} | ||
|
||
error(){ | ||
printf "\t${LIGHTRED}$@${RESET}\n" 2>&1 | ||
} | ||
|
||
success "I'm configured normally" | ||
touch .runner | ||
echo "$*" > runner_config | ||
success "created a dummy config file" | ||
success | ||
# Adding a counter to see how many times we've gone through the configuration step | ||
count=`cat counter 2>/dev/null|| echo "0"` | ||
count=$((count + 1)) | ||
echo ${count} > counter | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
#!/bin/bash | ||
|
||
set -euo pipefail | ||
|
||
export LIGHTGREEN='\e[0;32m' | ||
export LIGHTRED='\e[0;31m' | ||
export WHITE='\e[0;97m' | ||
export RESET='\e[0m' | ||
|
||
log(){ | ||
printf "\t${WHITE}$@${RESET}\n" 2>&1 | ||
} | ||
|
||
success(){ | ||
printf "\t${LIGHTGREEN}$@${RESET}\n" 2>&1 | ||
} | ||
|
||
error(){ | ||
printf "\t${LIGHTRED}$@${RESET}\n" 2>&1 | ||
exit 1 | ||
} | ||
|
||
success "" | ||
success "Running the service..." | ||
# test if --once is present as a parameter | ||
echo "$*" | grep -q 'once' || error "Should include --once in the parameters"j | ||
success "...successful" | ||
touch runsvc_ran | ||
success "" | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
#!/bin/bash | ||
|
||
# UNITTEST: should work disable update | ||
# Will simulate a scneario where disableupdate=true. expects: | ||
# - the configuration step to be run exactly once | ||
# - the entrypoint script to exit with no error | ||
# - the config.sh script to run with the --disableupdate flag set to 'true'. | ||
|
||
source ../logging.sh | ||
|
||
entrypoint_log() { | ||
while read I; do | ||
printf "\tentrypoint.sh: $I\n" | ||
done | ||
} | ||
|
||
log "Setting up the test" | ||
export UNITTEST=true | ||
export RUNNER_HOME=localhome | ||
export RUNNER_NAME="example_runner_name" | ||
export RUNNER_REPO="myorg/myrepo" | ||
export RUNNER_TOKEN="xxxxxxxxxxxxx" | ||
export DISABLE_RUNNER_UPDATE="true" | ||
|
||
mkdir -p ${RUNNER_HOME}/bin | ||
# add up the config.sh and runsvc.sh | ||
ln -s ../config.sh ${RUNNER_HOME}/config.sh | ||
ln -s ../../runsvc.sh ${RUNNER_HOME}/bin/runsvc.sh | ||
|
||
cleanup() { | ||
rm -rf ${RUNNER_HOME} | ||
unset UNITTEST | ||
unset RUNNERHOME | ||
unset RUNNER_NAME | ||
unset RUNNER_REPO | ||
unset RUNNER_TOKEN | ||
} | ||
|
||
trap cleanup SIGINT SIGTERM SIGQUIT EXIT | ||
|
||
log "Running the entrypoint" | ||
log "" | ||
|
||
../../../runner/entrypoint.sh 2> >(entrypoint_log) | ||
|
||
if [ "$?" != "0" ]; then | ||
error "==========================" | ||
error "Test completed with errors" | ||
exit 1 | ||
fi | ||
|
||
log "Testing if the configuration step was run only once" | ||
count=`cat ${RUNNER_HOME}/counter || echo "not_found"` | ||
if [ ${count} != "1" ]; then | ||
error "===============================================" | ||
error "The configuration step was not run exactly once" | ||
exit 1 | ||
fi | ||
success "The configuration ran ${count} time(s)" | ||
|
||
log "Testing if the configuration included the --disableupdate flag" | ||
if ! grep -q -- '--disableupdate' ${RUNNER_HOME}/runner_config; then | ||
error "===============================================" | ||
error "The configuration should not include the --disableupdate flag" | ||
exit 1 | ||
fi | ||
|
||
log "Testing if runsvc ran" | ||
if [ ! -f "${RUNNER_HOME}/runsvc_ran" ]; then | ||
error "==============================" | ||
error "The runner service has not run" | ||
exit 1 | ||
fi | ||
|
||
success "The service ran" | ||
success "" | ||
success "===========================" | ||
success "Test completed successfully" |