Update scripts to take artillery api keys as an option.

Author: wildjames

.github/workflows/run_notify_load.yml

@@ -8,11 +8,15 @@ on:
         required: true
         default: 'ref'
       arrivalRate:
-        description: 'How many requests to send per second'
+        description: 'How many requests to send per second during the main test'
         required: true
         default: '100'
       duration:
-        description: 'The duration of the test'
+        description: 'The duration of the main test'
+        required: true
+        default: '900'
+      rampUpDuration:
+        description: 'The duration of ramp-up phase of the test'
         required: true
         default: '900'
       maxVusers:
@@ -34,6 +38,7 @@ jobs:
           echo "## environment : ${{ github.event.inputs.environment }}" >> "$GITHUB_STEP_SUMMARY"
           echo "## arrivalRate : ${{ github.event.inputs.arrivalRate }}" >> "$GITHUB_STEP_SUMMARY"
           echo "## duration : ${{ github.event.inputs.duration }}" >> "$GITHUB_STEP_SUMMARY"
+          echo "## rampUpDuration : ${{ github.event.inputs.rampUpDuration }}" >> "$GITHUB_STEP_SUMMARY"
           echo "## maxVusers : ${{ github.event.inputs.maxVusers }}" >> "$GITHUB_STEP_SUMMARY"
 
       - name: Checkout repo

artillery/notify_load_test.yml

@@ -4,6 +4,11 @@ config:
     expect: {}
     apdex: {}
   phases:
+    - name: ramp up phase
+      duration: "{{ $env.rampUpDuration }}"
+      arrivalRate: 1
+      rampTo: "{{ $env.arrivalRate }}"
+      maxVusers: "{{ $env.maxVusers }}"
     - name: run phase
       duration: "{{ $env.duration }}"
       arrivalRate: "{{ $env.arrivalRate }}"

scripts/run_notify_load_test.sh

@@ -16,6 +16,11 @@ if [ -z "${duration}" ]; then
     exit 1
 fi
 
+if [ -z "${rampUpDuration}" ]; then
+    echo "rampUpDuration is unset or set to the empty string"
+    exit 1
+fi
+
 if [ -z "${arrivalRate}" ]; then
     echo "arrivalRate is unset or set to the empty string"
     exit 1
@@ -39,6 +44,7 @@ cat <<EOF > runtimeenv.env
 maxVusers=$maxVusers
 duration=$duration
 arrivalRate=$arrivalRate
+rampUpDuration=$rampUpDuration
 EOF
 
 echo ${launch_config}

scripts/test_notify_load_test.sh

@@ -1,11 +1,6 @@
 #!/usr/bin/env bash
 
-
-if [ -z "${artillery_key}" ]; then
-    echo "artillery_key is unset or set to the empty string. Get one from here: https://app.artillery.io/"
-    exit 1
-fi
-
+# Required checks
 if [ -z "${environment}" ]; then
     echo "environment is unset or set to the empty string"
     exit 1
@@ -21,6 +16,11 @@ if [ -z "${duration}" ]; then
     exit 1
 fi
 
+if [ -z "${rampUpDuration}" ]; then
+    echo "rampUpDuration is unset or set to the empty string"
+    exit 1
+fi
+
 if [ -z "${arrivalRate}" ]; then
     echo "arrivalRate is unset or set to the empty string"
     exit 1
@@ -41,12 +41,20 @@ if [ -z "${psu_kid}" ]; then
     exit 1
 fi
 
+# Check artillery_key but don't fail — just omit recording if absent
+if [ -z "${artillery_key}" ]; then
+    echo "Warning: artillery_key is unset; running test without recording to Artillery Cloud."
+    RECORD_ARGS=""
+else
+    RECORD_ARGS="--record --key ${artillery_key}"
+fi
 
 # Create a dotenv file with the variables for Artillery
 cat <<EOF > runtimeenv.env
 maxVusers=${maxVusers}
 duration=${duration}
 arrivalRate=${arrivalRate}
+rampUpDuration=${rampUpDuration}
 psu_api_key="${psu_api_key}"
 psu_private_key="${psu_private_key}"
 psu_kid="${psu_kid}"
@@ -58,15 +66,17 @@ echo ""
 echo "Environment: ${environment}"
 echo "Max Virtual Users: ${maxVusers}"
 echo "Run Phase Duration: ${duration}"
+echo "Ramp-up Duration: ${rampUpDuration}"
 echo "Arrival Rate: ${arrivalRate}"
+[ -n "${artillery_key}" ] && echo "Recording to Artillery Cloud with key: ${artillery_key}"
 echo ""
 
 set -e
 
-# Run the Artillery test locally
+# Run the Artillery test locally, conditionally including recording flags
 npx artillery run \
     -e "${environment}" \
-    --env-file /workspaces/eps-load-test/runtimeenv.env \
-    --output /workspaces/eps-load-test/notify_load_test.json \
-    --record --key ${artillery_key} \
-    /workspaces/eps-load-test/artillery/notify_load_test.yml
+    --env-file "$(pwd)/runtimeenv.env" \
+    --output "$(pwd)/notify_load_test.json" \
+    $RECORD_ARGS \
+    "$(pwd)/artillery/notify_load_test.yml"

scripts/test_psu_load_test.sh

@@ -41,6 +41,13 @@ if [ -z "${psu_kid}" ]; then
     exit 1
 fi
 
+# Check for Artillery Cloud key (optional)
+if [ -z "${artillery_key}" ]; then
+    echo "Warning: artillery_key is unset; running test without recording to Artillery Cloud."
+    RECORD_ARGS=""
+else
+    RECORD_ARGS="--record --key ${artillery_key}"
+fi
 
 # Create a dotenv file with the variables for Artillery
 cat <<EOF > runtimeenv.env
@@ -55,20 +62,23 @@ EOF
 
 echo "Running Artillery test locally..."
 echo ""
+echo "Environment: ${environment}"
 echo "Max Virtual Users: ${maxVusers}"
 echo "Phase Duration: ${duration}"
 echo "Arrival Rate: ${arrivalRate}"
-echo "Ramp Up Duration: ${rampUpDuration}"
+echo "Ramp-up Duration: ${rampUpDuration}"
+[ -n "${artillery_key}" ] && echo "Recording to Artillery Cloud with key: ${artillery_key}"
 echo ""
 
 set -e
 
 # Run the Artillery test locally
 npx artillery run \
     -e "${environment}" \
-    --env-file /workspaces/eps-load-test/runtimeenv.env \
-    --output /workspaces/eps-load-test/psu_load_test.json \
-    /workspaces/eps-load-test/artillery/psu_load_test.yml
+    --env-file "$(pwd)/runtimeenv.env" \
+    --output "$(pwd)/psu_load_test.json" \
+    $RECORD_ARGS \
+    "$(pwd)/artillery/psu_load_test.yml"
 
 # Generate a report from the test results
 npx artillery report psu_load_test.json