mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
test: Validate/test all default configs
* chore: add base script to test-run all configs * chore: job for test-deploy * chore: fine-tuning config validation * chore: config validation fully functional * chore: fix https-file-cli validation (missing var) * fix: generate self-signed CA through openSSL * chore: streamlining test script + review * chore: validate-configs accepts config args * chore: cleanup and best-practices * chore: test-configs as precond + needs consistency * chore: changes after review * chore: fix argument variable expansion * chore: more tweaks to script
This commit is contained in:
Jasper Vaneessen
GitHub
parent
50469e2c1f
commit
6dd77cf8d8
27
.github/workflows/ci.yml
vendored
27
.github/workflows/ci.yml
vendored
@ -58,8 +58,6 @@ jobs:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
flag-name: test-unit-${{ matrix.node-version }}-${{ matrix.operating-system }}
|
||||
parallel: true
|
||||
- name: Run deployment tests
|
||||
run: npm run test:deploy
|
||||
|
||||
test-integration:
|
||||
runs-on: ubuntu-latest
|
||||
@ -118,6 +116,27 @@ jobs:
|
||||
- name: Run integration tests
|
||||
run: npm run test:integration
|
||||
|
||||
test-configs:
|
||||
runs-on: ubuntu-latest
|
||||
services:
|
||||
sparql-endpoint:
|
||||
image: tenforce/virtuoso
|
||||
env:
|
||||
SPARQL_UPDATE: true
|
||||
ports:
|
||||
- 4000:8890
|
||||
steps:
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: '16.x'
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v3
|
||||
- name: Install dependencies and run build scripts
|
||||
run: npm ci
|
||||
- name: Run deploy tests
|
||||
run: npm run test:deploy
|
||||
|
||||
coveralls:
|
||||
needs: test-unit
|
||||
runs-on: ubuntu-latest
|
||||
@ -134,6 +153,7 @@ jobs:
|
||||
- test-unit
|
||||
- test-integration
|
||||
- test-integration-windows
|
||||
- test-configs
|
||||
# Only run on tag push events starting with v prefix for now OR main branch push events
|
||||
if: startsWith(github.ref, 'refs/tags/v') || (github.ref == 'refs/heads/main')
|
||||
runs-on: ubuntu-latest
|
||||
@ -175,6 +195,7 @@ jobs:
|
||||
- test-unit
|
||||
- test-integration
|
||||
- test-integration-windows
|
||||
- test-configs
|
||||
# Only run on push events on a versions/* branch (ASSUMPTION: THERE SHOULD ONLY BE ONE THERE!)
|
||||
if: startsWith(github.ref, 'refs/heads/versions/')
|
||||
runs-on: ubuntu-latest
|
||||
@ -231,6 +252,8 @@ jobs:
|
||||
- lint
|
||||
- test-unit
|
||||
- test-integration
|
||||
- test-integration-windows
|
||||
- test-configs
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
|
||||
@ -54,7 +54,7 @@
|
||||
"start": "node ./bin/server.js",
|
||||
"start:file": "node ./bin/server.js -c config/file.json -f ./data",
|
||||
"test": "npm run test:ts && npm run jest",
|
||||
"test:deploy": "test/deploy/validate-package.sh",
|
||||
"test:deploy": "test/deploy/validate-configs.sh",
|
||||
"test:ts": "tsc -p test --noEmit",
|
||||
"test:integration": "jest --coverageReporters text-summary -- test/integration",
|
||||
"test:unit": "jest --config=./jest.coverage.config.js test/unit",
|
||||
|
||||
120
test/deploy/validate-configs.sh
Executable file
120
test/deploy/validate-configs.sh
Executable file
@ -0,0 +1,120 @@
|
||||
#!/usr/bin/env bash
|
||||
# Script to validate the packaged module and configs
|
||||
|
||||
# Ensure our workdir is that of the project root
|
||||
cd "${0%/*}/../.." || { echo "Error setting workdir to project directory."; exit 1; }
|
||||
|
||||
# This script takes config paths (from project directory) as optional input
|
||||
# No arguments: all default configs are tested
|
||||
# One ore more arguments: provided configs are tested
|
||||
# Example: validate-configs.sh config/default.json config/file.json
|
||||
TEST_NAME="Deployment testing"
|
||||
declare -a CONFIG_ARRAY
|
||||
if [[ $# -gt 0 ]]; then
|
||||
for CONFIG in "$@"; do
|
||||
if [ ! -f "$CONFIG" ]; then
|
||||
echo "Config file $CONFIG does not exist, check the path (example: config/default.json)"
|
||||
exit 1
|
||||
fi
|
||||
CONFIG_ARRAY+=("$CONFIG")
|
||||
done
|
||||
echo "Deployment testing ${#CONFIG_ARRAY[@]} configs:"
|
||||
else
|
||||
mapfile -t CONFIG_ARRAY < <(ls config/*.json)
|
||||
echo "Deployment testing all configs:"
|
||||
fi
|
||||
printf " - %s\n" "${CONFIG_ARRAY[@]}"
|
||||
|
||||
mkdir -p test/tmp/data
|
||||
echo "$TEST_NAME - Building and installing package"
|
||||
npm pack --loglevel warn
|
||||
npm install -g solid-community-server-*.tgz --loglevel warn
|
||||
rm solid-community-server-*.tgz
|
||||
|
||||
run_server_with_config () {
|
||||
if [[ $# -ne 2 ]]; then
|
||||
echo "Config arguments not set"
|
||||
return 1
|
||||
elif [ ! -f "$1" ]; then
|
||||
echo "Config file does not exist, check the path."
|
||||
return 1
|
||||
fi
|
||||
CONFIG_PATH=$1
|
||||
CONFIG_NAME=$2
|
||||
|
||||
mkdir -p test/tmp/data
|
||||
|
||||
CSS_ARGS=("-p" "8888" "-l" "warn" "-f" "test/tmp/data/" "-s" "http://localhost:4000/sparql")
|
||||
CSS_BASE_URL="http://localhost:8888"
|
||||
|
||||
# HTTPS config specifics: self-signed key/cert + CSS base URL override
|
||||
if [[ $CONFIG_NAME =~ "https" ]]; then
|
||||
openssl req -x509 -nodes -days 1 -newkey rsa:2048 -keyout test/tmp/server.key -out test/tmp/server.cert -subj '/CN=localhost' &>/dev/null
|
||||
CSS_BASE_URL="https://localhost:8888"
|
||||
if [[ $CONFIG_NAME =~ "https-file-cli" ]]; then
|
||||
CSS_ARGS+=("--httpsKey" "test/tmp/server.key" "--httpsCert" "test/tmp/server.cert")
|
||||
elif [[ $CONFIG_NAME =~ "example-https" ]]; then
|
||||
CONFIG_PATH=test/tmp/example-https-file.json
|
||||
cp config/example-https-file.json $CONFIG_PATH
|
||||
sed -i -E "s/(\W+\"options_key\".*\").+(\".*)/\1test\/tmp\/server.key\2/" $CONFIG_PATH
|
||||
sed -i -E "s/(\W+\"options_cert\".*\").+(\".*)/\1test\/tmp\/server.cert\2/" $CONFIG_PATH
|
||||
fi
|
||||
fi
|
||||
|
||||
echo -e "----------------------------------"
|
||||
echo "$TEST_NAME($CONFIG_NAME) - Starting the server"
|
||||
community-solid-server "${CSS_ARGS[@]}" -b $CSS_BASE_URL -c $CONFIG_PATH &>test/tmp/"$CONFIG_NAME" &
|
||||
PID=$!
|
||||
|
||||
FAILURE=1
|
||||
if [ -z $PID ]; then
|
||||
echo "$TEST_NAME($CONFIG_NAME) - FAILURE: Server did not start"
|
||||
cat test/tmp/"$CONFIG_NAME"
|
||||
else
|
||||
echo "$TEST_NAME($CONFIG_NAME) - Attempting HTTP access to the server"
|
||||
if curl -sfkI -X GET --retry 15 --retry-connrefused --retry-delay 1 $CSS_BASE_URL > test/tmp/"$CONFIG_NAME"-curl; then
|
||||
echo "$TEST_NAME($CONFIG_NAME) - SUCCESS: server reached"
|
||||
FAILURE=0
|
||||
else
|
||||
echo "$TEST_NAME($CONFIG_NAME) - FAILURE: Could not reach server"
|
||||
fi
|
||||
kill -9 $PID &> /dev/null
|
||||
timeout 30s tail --pid=$PID -f /dev/null
|
||||
fi
|
||||
|
||||
rm -rf test/tmp/data/*
|
||||
return $FAILURE
|
||||
}
|
||||
|
||||
VALIDATION_FAILURE=0
|
||||
SUCCESSES=''
|
||||
FAILURES=''
|
||||
for CONFIG_PATH in "${CONFIG_ARRAY[@]}"; do
|
||||
CONFIG_NAME=$(echo "$CONFIG_PATH" | sed -E 's/.+\/(.+)\.json/\1/')
|
||||
|
||||
run_server_with_config "$CONFIG_PATH" "$CONFIG_NAME"
|
||||
SERVER_FAILURE=$?
|
||||
if [ $SERVER_FAILURE -eq 0 ]; then
|
||||
SUCCESSES="${SUCCESSES}[SUCCESS]\t$CONFIG_NAME\t($CONFIG_PATH)\n"
|
||||
else
|
||||
echo "$TEST_NAME($CONFIG_NAME) - CSS logs: ";
|
||||
cat test/tmp/"$CONFIG_NAME"
|
||||
echo "$TEST_NAME($CONFIG_NAME) - curl logs: ";
|
||||
cat test/tmp/"$CONFIG_NAME"-curl
|
||||
VALIDATION_FAILURE=1
|
||||
FAILURES="${FAILURES}[FAILURE]\t$CONFIG_NAME\t($CONFIG_PATH)\n"
|
||||
fi
|
||||
echo ""
|
||||
done;
|
||||
|
||||
echo "$TEST_NAME - Cleanup"
|
||||
npm uninstall -g @solid/community-server
|
||||
rm -rf test/tmp/*
|
||||
|
||||
|
||||
echo -e "\n\n----------------------------------------"
|
||||
echo "Config validation overview"
|
||||
echo "----------------------------------------"
|
||||
echo -e "$SUCCESSES"
|
||||
echo -e "$FAILURES"
|
||||
exit $VALIDATION_FAILURE
|
||||
@ -1,37 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
# Script to validate the packaged module
|
||||
|
||||
TEST_NAME="Deployment test: packaged module"
|
||||
|
||||
echo "$TEST_NAME - Building and installing package"
|
||||
npm pack --loglevel warn
|
||||
npm install -g solid-community-server-*.tgz --loglevel warn
|
||||
rm solid-community-server-*.tgz
|
||||
|
||||
echo "$TEST_NAME - Starting the server"
|
||||
community-solid-server -p 8888 -l warn &
|
||||
PID=$!
|
||||
|
||||
FAILURE=1
|
||||
if [ -z $PID ]; then
|
||||
echo "$TEST_NAME - Failure: Server did not start"
|
||||
else
|
||||
echo "$TEST_NAME - Attempting HTTP access to the server"
|
||||
for i in {1..10}; do
|
||||
sleep 1
|
||||
if curl -s -f localhost:8888 > /dev/null; then
|
||||
echo "$TEST_NAME - Success: server reached"
|
||||
FAILURE=0
|
||||
break
|
||||
fi
|
||||
done
|
||||
if [ $FAILURE -eq 1 ]; then
|
||||
echo "$TEST_NAME - Failure: Could not reach server"
|
||||
fi
|
||||
kill -9 $PID
|
||||
fi
|
||||
|
||||
echo "$TEST_NAME - Cleanup"
|
||||
npm uninstall -g @solid/community-server
|
||||
|
||||
exit $FAILURE
|
||||
Loading…
x
Reference in New Issue
Block a user