libretic
/
etherpad-lite
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tests: Clean up Travis runner scripts 

* Avoid bashisms.
  * Simplify `sed` of `settings.json`.
  * Wrap long lines.
  * Define and use the conventional log functions.
  * Quote variable expansions.
This commit is contained in:
Richard Hansen 2020-11-20 19:19:39 -05:00 committed by John McLear
parent c9eb4c72a5
commit 1d491c0059
4 changed files with 130 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
tests/frontend/travis/runner.sh
View File

@ -1,50 +1,45 @@
#!/bin/bash #!/bin/sh
if [ -z "${SAUCE_USERNAME}" ]; then echo "SAUCE_USERNAME is unset - exiting"; exit 1; fi
if [ -z "${SAUCE_ACCESS_KEY}" ]; then echo "SAUCE_ACCESS_KEY is unset - exiting"; exit 1; fi
# do not continue if there is an error pecho() { printf %s\\n "$*"; }
set -eu log() { pecho "$@"; }
error() { log "ERROR: $@" >&2; }
fatal() { error "$@"; exit 1; }
try() { "$@" || fatal "'$@' failed"; }
# source: https://stackoverflow.com/questions/59895/get-the-source-directory-of-a-bash-script-from-within-the-script-itself#246128 [ -n "${SAUCE_USERNAME}" ] || fatal "SAUCE_USERNAME is unset - exiting"
MY_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )" [ -n "${SAUCE_ACCESS_KEY}" ] || fatal "SAUCE_ACCESS_KEY is unset - exiting"
MY_DIR=$(try cd "${0%/*}" && try pwd) || exit 1
# reliably move to the etherpad base folder before running it # reliably move to the etherpad base folder before running it
cd "${MY_DIR}/../../../" try cd "${MY_DIR}/../../../"
# start Etherpad, assuming all dependencies are already installed. log "Assuming bin/installDeps.sh has already been run"
#
# This is possible because the "install" section of .travis.yml already contains
# a call to bin/installDeps.sh
echo "Running Etherpad directly, assuming bin/installDeps.sh has already been run"
node node_modules/ep_etherpad-lite/node/server.js --experimental-worker "${@}" & node node_modules/ep_etherpad-lite/node/server.js --experimental-worker "${@}" &
ep_pid=$! ep_pid=$!
echo "Now I will try for 15 seconds to connect to Etherpad on http://localhost:9001" log "Waiting for Etherpad to accept connections (http://localhost:9001)..."
connected=false
# wait for at most 15 seconds until Etherpad starts accepting connections can_connect() {
# curl -sSfo /dev/null http://localhost:9001/ || return 1
# modified from: connected=true
# https://unix.stackexchange.com/questions/5277/how-do-i-tell-a-script-to-wait-for-a-process-to-start-accepting-requests-on-a-po#349138 }
# now() { date +%s; }
(timeout 15 bash -c 'until echo > /dev/tcp/localhost/9001; do sleep 0.5; done') || \ start=$(now)
(echo "Could not connect to Etherpad on http://localhost:9001" ; exit 1) while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
sleep 1
echo "Successfully connected to Etherpad on http://localhost:9001" done
[ "$connected" = true ] \
# On the Travis VM, remote_runner.js is found at || fatal "Timed out waiting for Etherpad to accept connections"
# /home/travis/build/ether/[secure]/tests/frontend/travis/remote_runner.js log "Successfully connected to Etherpad on http://localhost:9001"
# which is the same directory that contains this script.
# Let's move back there.
#
# Probably remote_runner.js is injected by Saucelabs.
cd "${MY_DIR}"
# start the remote runner # start the remote runner
echo "Now starting the remote runner" try cd "${MY_DIR}"
log "Starting the remote runner..."
node remote_runner.js node remote_runner.js
exit_code=$? exit_code=$?
kill $(cat /tmp/sauce.pid) kill "$(cat /tmp/sauce.pid)"
kill "$ep_pid" && wait "$ep_pid" kill "$ep_pid" && wait "$ep_pid"
log "Done."
exit $exit_code exit "$exit_code"

71
tests/frontend/travis/runnerBackend.sh
View File

@ -1,48 +1,47 @@
#!/bin/bash #!/bin/sh
# do not continue if there is an error pecho() { printf %s\\n "$*"; }
set -u log() { pecho "$@"; }
error() { log "ERROR: $@" >&2; }
fatal() { error "$@"; exit 1; }
try() { "$@" || fatal "'$@' failed"; }
# source: https://stackoverflow.com/questions/59895/get-the-source-directory-of-a-bash-script-from-within-the-script-itself#246128 MY_DIR=$(try cd "${0%/*}" && try pwd) || fatal "failed to find script directory"
MY_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
# reliably move to the etherpad base folder before running it # reliably move to the etherpad base folder before running it
cd "${MY_DIR}/../../../" try cd "${MY_DIR}/../../../"
# Set soffice to /usr/bin/soffice try sed -e '
sed 's#\"soffice\": null,#\"soffice\":\"/usr/bin/soffice\",#g' settings.json.template > settings.json.soffice s!"soffice":[^,]*!"soffice": "/usr/bin/soffice"!
# Reduce rate limit aggressiveness
s!"max":[^,]*!"max": 100!
s!"points":[^,]*!"points": 1000!
' settings.json.template >settings.json
# Set "max": 10 to 100 to not agressively rate limit log "Assuming bin/installDeps.sh has already been run"
sed 's/\"max\": 10/\"max\": 100/g' settings.json.soffice > settings.json.rateLimit
# Set "points": 10 to 1000 to not agressively rate limit commits
sed 's/\"points\": 10/\"points\": 1000/g' settings.json.rateLimit > settings.json
# start Etherpad, assuming all dependencies are already installed.
#
# This is possible because the "install" section of .travis.yml already contains
# a call to bin/installDeps.sh
echo "Running Etherpad directly, assuming bin/installDeps.sh has already been run"
node node_modules/ep_etherpad-lite/node/server.js "${@}" & node node_modules/ep_etherpad-lite/node/server.js "${@}" &
ep_pid=$! ep_pid=$!
echo "Now I will try for 15 seconds to connect to Etherpad on http://localhost:9001" log "Waiting for Etherpad to accept connections (http://localhost:9001)..."
connected=false
can_connect() {
curl -sSfo /dev/null http://localhost:9001/ || return 1
connected=true
}
now() { date +%s; }
start=$(now)
while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
sleep 1
done
[ "$connected" = true ] \
|| fatal "Timed out waiting for Etherpad to accept connections"
log "Successfully connected to Etherpad on http://localhost:9001"
# wait for at most 15 seconds until Etherpad starts accepting connections log "Running the backend tests..."
# try cd src
# modified from: npm test
# https://unix.stackexchange.com/questions/5277/how-do-i-tell-a-script-to-wait-for-a-process-to-start-accepting-requests-on-a-po#349138 exit_code=$?
#
(timeout 15 bash -c 'until echo > /dev/tcp/localhost/9001; do sleep 0.5; done') || \
(echo "Could not connect to Etherpad on http://localhost:9001" ; exit 1)
echo "Successfully connected to Etherpad on http://localhost:9001"
# run the backend tests
echo "Now run the backend tests"
cd src
failed=0
npm run test || failed=1
kill "$ep_pid" && wait "$ep_pid" kill "$ep_pid" && wait "$ep_pid"
exit $failed log "Done."
exit "$exit_code"

69
tests/frontend/travis/runnerLoadTest.sh
View File

@ -1,52 +1,51 @@
#!/bin/bash #!/bin/sh
# do not continue if there is an error pecho() { printf %s\\n "$*"; }
set -eu log() { pecho "$@"; }
error() { log "ERROR: $@" >&2; }
fatal() { error "$@"; exit 1; }
try() { "$@" || fatal "'$@' failed"; }
# source: https://stackoverflow.com/questions/59895/get-the-source-directory-of-a-bash-script-from-within-the-script-itself#246128 MY_DIR=$(try cd "${0%/*}" && try pwd) || exit 1
MY_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
# reliably move to the etherpad base folder before running it # reliably move to the etherpad base folder before running it
cd "${MY_DIR}/../../../" try cd "${MY_DIR}/../../../"
# Set "points": 10 to 1000 to not agressively rate limit commits try sed -e '
sed 's/\"points\": 10/\"points\": 1000/g' settings.json.template > settings.json.points s!"loadTest":[^,]*!"loadTest": true!
# And enable loadTest # Reduce rate limit aggressiveness
sed 's/\"loadTest\": false,/\"loadTest\": true,/g' settings.json.points > settings.json s!"points":[^,]*!"points": 1000!
' settings.json.template >settings.json
# start Etherpad, assuming all dependencies are already installed. log "Assuming bin/installDeps.sh has already been run"
# node node_modules/ep_etherpad-lite/node/server.js "${@}" >/dev/null &
# This is possible because the "install" section of .travis.yml already contains
# a call to bin/installDeps.sh
echo "Running Etherpad directly, assuming bin/installDeps.sh has already been run"
node node_modules/ep_etherpad-lite/node/server.js "${@}" &
ep_pid=$! ep_pid=$!
echo "Now I will try for 15 seconds to connect to Etherpad on http://localhost:9001" log "Waiting for Etherpad to accept connections (http://localhost:9001)..."
connected=false
can_connect() {
curl -sSfo /dev/null http://localhost:9001/ || return 1
connected=true
}
now() { date +%s; }
start=$(now)
while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
sleep 1
done
[ "$connected" = true ] \
|| fatal "Timed out waiting for Etherpad to accept connections"
log "Successfully connected to Etherpad on http://localhost:9001"
# wait for at most 15 seconds until Etherpad starts accepting connections # Build the minified files
# try curl http://localhost:9001/p/minifyme -f -s >/dev/null
# modified from:
# https://unix.stackexchange.com/questions/5277/how-do-i-tell-a-script-to-wait-for-a-process-to-start-accepting-requests-on-a-po#349138
#
(timeout 15 bash -c 'until echo > /dev/tcp/localhost/9001; do sleep 0.5; done') || \
(echo "Could not connect to Etherpad on http://localhost:9001" ; exit 1)
echo "Successfully connected to Etherpad on http://localhost:9001"
# Build the minified files?
curl http://localhost:9001/p/minifyme -f -s > /dev/null
# just in case, let's wait for another 10 seconds before going on # just in case, let's wait for another 10 seconds before going on
sleep 10 sleep 10
# run the backend tests log "Running the load tests..."
echo "Now run the load tests for 25 seconds and if it stalls before 100 then error"
etherpad-loadtest -d 25 etherpad-loadtest -d 25
exit_code=$? exit_code=$?
kill "$ep_pid" && wait "$ep_pid" kill "$ep_pid" && wait "$ep_pid"
sleep 5 log "Done."
exit "$exit_code"
exit $exit_code

46
tests/frontend/travis/sauce_tunnel.sh
View File

@ -1,23 +1,37 @@
#!/bin/bash #!/bin/sh
pecho() { printf %s\\n "$*"; }
log() { pecho "$@"; }
error() { log "ERROR: $@" >&2; }
fatal() { error "$@"; exit 1; }
try() { "$@" || fatal "'$@' failed"; }
[ -n "${SAUCE_USERNAME}" ] || fatal "SAUCE_USERNAME is unset - exiting"
[ -n "${SAUCE_ACCESS_KEY}" ] || fatal "SAUCE_ACCESS_KEY is unset - exiting"
# download and unzip the sauce connector # download and unzip the sauce connector
# #
# ACHTUNG: as of 2019-12-21, downloading sc-latest-linux.tar.gz does not work. # ACHTUNG: as of 2019-12-21, downloading sc-latest-linux.tar.gz does not work.
# It is necessary to explicitly download a specific version, for # It is necessary to explicitly download a specific version, for example
# example https://saucelabs.com/downloads/sc-4.5.4-linux.tar.gz # https://saucelabs.com/downloads/sc-4.5.4-linux.tar.gz Supported versions are
# Supported versions are currently listed at: # currently listed at:
# https://wiki.saucelabs.com/display/DOCS/Downloading+Sauce+Connect+Proxy # https://wiki.saucelabs.com/display/DOCS/Downloading+Sauce+Connect+Proxy
if [ -z "${SAUCE_USERNAME}" ]; then echo "SAUCE_USERNAME is unset - exiting"; exit 1; fi try curl -o /tmp/sauce.tar.gz \
if [ -z "${SAUCE_ACCESS_KEY}" ]; then echo "SAUCE_ACCESS_KEY is unset - exiting"; exit 1; fi https://saucelabs.com/downloads/sc-4.6.2-linux.tar.gz
try tar zxf /tmp/sauce.tar.gz --directory /tmp
try mv /tmp/sc-*-linux /tmp/sauce_connect
curl https://saucelabs.com/downloads/sc-4.6.2-linux.tar.gz > /tmp/sauce.tar.gz # start the sauce connector in background and make sure it doesn't output the
tar zxf /tmp/sauce.tar.gz --directory /tmp # secret key
mv /tmp/sc-*-linux /tmp/sauce_connect try rm -f /tmp/tunnel
/tmp/sauce_connect/bin/sc \
# start the sauce connector in background and make sure it doesn't output the secret key --user "${SAUCE_USERNAME}" \
(/tmp/sauce_connect/bin/sc --user "${SAUCE_USERNAME}" --key "${SAUCE_ACCESS_KEY}" -i "${TRAVIS_JOB_NUMBER}" --pidfile /tmp/sauce.pid --readyfile /tmp/tunnel > /dev/null )& --key "${SAUCE_ACCESS_KEY}" \
-i "${TRAVIS_JOB_NUMBER}" \
--pidfile /tmp/sauce.pid \
--readyfile /tmp/tunnel >/dev/null &
# wait for the tunnel to build up # wait for the tunnel to build up
while [ ! -e "/tmp/tunnel" ] while ! [ -e "/tmp/tunnel" ]; do
do sleep 1
sleep 1
done done