Added simple support to bundle run output into a shared directory

Author: SeriousHorncat

.gitignore

@@ -82,5 +82,5 @@ etc/.rosalution-db-backups
 *.csv
 
 secrets.file
-
-profile.html
+profile.html
+**benchmark-run**/

docker-compose.yml

@@ -59,6 +59,7 @@ services:
       - ./backend:/app
     environment:
       - MONGODB_HOST=rosalution-db
+      - PROFILER_ENABLED=True
     command: ['./etc/entrypoint-init.sh', '--reload']
     networks:
       - rosalution-network

etc/benchmark/bundleBenchmark.sh

@@ -0,0 +1,42 @@
+#! /bin/bash
+# ./bundleBenchmark.sh
+
+usage() {
+  echo " "
+  echo "usage: $0"
+  echo " "
+  echo " -p Absolute File Path to Rosalution Backend Service PyInstrument profiling"
+  echo " -b Absolute File Path to K6 Metrics Summary JSON"
+  echo " -o Output Directory"
+  echo " -h Prints usage"
+  echo " "
+  echo ""
+  echo " "
+  exit
+}
+
+while getopts ":p:b:h" opt; do
+  case $opt in
+    p) pyinstrument_profiling_summary="$OPTARG";;
+    b) k6_metrics_summary_json="$OPTARG";;
+    h) usage;;
+    \?) echo "Invalid option -$OPTARG" && exit 127;;
+  esac
+done
+
+if [ ! -f "$pyinstrument_profiling_summary" ]; then
+  echo "Missing pyinstrument profiling summary"
+  exit 1
+fi
+
+if [ ! -f "$k6_metrics_summary_json" ]; then
+  echo "Missing k6 benchmark metrics summary"
+  exit 1
+fi
+
+date_stamp=$(date +"%Y-%m-%d-%s")
+output_path="./benchmark-run-$date_stamp"
+
+mkdir -p "$output_path"
+mv "$pyinstrument_profiling_summary" "$output_path"
+mv "$k6_metrics_summary_json" "$output_path"

etc/benchmark/config/summary.js

@@ -0,0 +1,4 @@
+
+export function json_metrics_summary(data){
+    return JSON.stringify(data);
+}

etc/benchmark/package.json

@@ -4,6 +4,7 @@
   "description": "Simple Rosalution REST API benchmarking",
   "license": "MIT",
   "scripts": {
-    "benchmark:local:api": "docker run -v .:/scripts -w /scripts -e BASE_URL=http://backend:8000 --network=rosalution-network --rm grafana/k6:1.5.0 run --secret-source=file=/scripts/secrets.file"
+    "benchmark:local:api": "docker run -v .:/scripts -w /scripts -e BASE_URL=http://backend:8000 --network=rosalution-network --rm grafana/k6:1.5.0 run --secret-source=file=/scripts/secrets.file",
+    "bundle:benchmark": "./bundleBenchmark.sh -p '../../backend/profile.html' -b './summary.json'"
   }
 }

etc/benchmark/tests/avg-get-projects.js

@@ -2,13 +2,17 @@ import http from 'k6/http';
 import secrets from 'k6/secrets';
 import { sleep, check } from 'k6';
 
+import { textSummary } from 'https://jslib.k6.io/k6-summary/0.1.0/index.js';
+
+
 import { rosalutionAuth } from '../config/auth.js';
+import { json_metrics_summary } from '../config/summary.js';
 
 const BASE_URL = __ENV.BASE_URL || 'http://backend:8000'
 
 export const options = {
   vus: 10,
-  duration: '30s',
+  duration: '5s',
   thresholds: {
     http_req_failed: ['rate<0.01'], // http errors should be less than 1%
     http_req_duration: ['p(95)<200'] // 95% of requests should be below 200ms
@@ -26,6 +30,13 @@ export async function setup() {
   }
 }
 
+export function handleSummary(data) {
+  return {
+    'summary.json': json_metrics_summary(data.metrics),
+    stdout: textSummary(data)
+  };
+}
+
 export default async function(data) {
   const authHeader = {
     headers: {