Adds comprehensive performance testing suite

.github/workflows/build-and-push-performance-test-image.yml → .github/workflows/build-and-push-data-generator-image.yml

@@ -1,4 +1,4 @@
-name: Build and Push Perftest Image
+name: Build and Push Images
 
 on:
   push:
@@ -8,12 +8,20 @@ on:
 jobs:
   build-and-push:
     runs-on: ubuntu-24.04
-
+    name: ${{ matrix.image_name }}
     permissions:
       contents: read
       packages: write
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - image_name: opencrvs-data-generator
+            dockerfile: Dockerfile.data-generator
+          - image_name: opencrvs-perf-test
+            dockerfile: Dockerfile.perf-test
     env:
-      image_path: ghcr.io/opencrvs/opencrvs-perftest-data-generator
+      image_path: ghcr.io/opencrvs/${{ matrix.image_name }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
@@ -35,7 +43,7 @@ jobs:
           fi
       - name: Build Docker image
         run: |
-          docker build -t ${{ env.image_path }}:${{ env.image_tag }} -f Dockerfile .
+          docker build -t ${{ env.image_path }}:${{ env.image_tag }} -f ${{ matrix.dockerfile }} .
 
       - name: Push Docker image
         run: |

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 local-README.md
+dist/
+.env

Dockerfile.perf-test

@@ -0,0 +1,31 @@
+FROM node:22-slim AS base
+
+RUN apt-get update && apt-get upgrade -y
+
+RUN apt-get clean && \
+    rm -rf /var/cache/apt/archives /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY --chown=node:node *.json .
+COPY --chown=node:node yarn.lock .
+COPY --chown=node:node build.mjs .
+COPY --chown=node:node src ./src
+COPY --chown=node:node tests ./tests
+RUN yarn install && yarn build
+
+# Build the k6 binary with the elasticsearch output extension
+# See reference:
+# https://grafana.com/docs/k6/latest/results-output/real-time/elasticsearch/
+# https://hub.docker.com/r/grafana/xk6/
+FROM grafana/xk6:latest AS k6-builder
+WORKDIR /app
+RUN xk6 build --with github.com/elastic/xk6-output-elasticsearch
+RUN ls -la /app
+
+# Final image with k6 and test script
+FROM alpine:latest
+WORKDIR /app
+COPY --from=k6-builder /app/k6 /usr/bin/k6
+COPY --from=base /app/dist /app
+ENTRYPOINT ["/usr/bin/k6"]

build.mjs

@@ -0,0 +1,26 @@
+import esbuild from 'esbuild';
+import { readdir } from 'fs/promises';
+
+// Usage: node build.mjs [testName...]
+//   node build.mjs          → builds all tests/*.ts
+//   node build.mjs smoke    → builds tests/smoke.ts only
+const names = process.argv.slice(2);
+
+const entryPoints =
+  names.length > 0
+    ? names.map((n) => `tests/${n}.ts`)
+    : (await readdir('tests'))
+        .filter((f) => f.endsWith('.ts'))
+        .map((f) => `tests/${f}`);
+
+await esbuild.build({
+  entryPoints,
+  bundle: true,
+  platform: 'browser',
+  format: 'cjs',
+  target: 'es2015',
+  outdir: 'dist',
+  // k6 built-in modules must stay external — not bundled
+  external: ['k6', 'k6/*', 'https://jslib.k6.io/*'],
+  logLevel: 'info',
+});

charts/performance-test/Chart.yaml → charts/generate-data/Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: performance-test
+name: data-generator
 description: Run a one-off job to generate performance test data
 type: application
 version: 0.1.0

charts/performance-test/templates/generate-data-job.yaml → charts/generate-data/templates/generate-data-job.yaml

@@ -2,6 +2,9 @@ apiVersion: batch/v1
 kind: Job
 metadata:
   name: {{ include "perf-test-generator.fullname" . }}-{{ .Release.Revision }}
+  labels:
+    app.kubernetes.io/name: {{ include "perf-test-generator.name" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
 spec:
   backoffLimit: {{ .Values.job.backoffLimit }}
   ttlSecondsAfterFinished: {{ .Values.job.ttlSecondsAfterFinished }}

charts/perf-test/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: perf-test
+description: Run a one-off performance test job
+type: application
+version: 0.1.0
+appVersion: "1.0.0"

charts/perf-test/README.md

@@ -0,0 +1,47 @@
+# General informaiton
+
+Goal of this helm chart is to provide developer and tester a way to run performance data generator on remote server.
+
+Helm chart creates one time kubernetes job to generate data.
+
+# Values
+
+Create you own `values.yaml` using values.yaml as reference.
+
+
+# Install/Upgrade from your laptop
+
+Example of custom perf-test.yaml file**
+
+```yaml
+env:
+  GATEWAY_URL: https://gateway.tmp-prod.opencrvs.dev
+  EVENTS_URL: https://events.tmp-prod.opencrvs.dev
+
+```
+
+
+**Install/upgrade command**
+
+```
+helm upgrade \
+  --install \
+  -f perf-test.yaml \
+  perf-test-job chart/perf-test/
+```
+
+
+# Install/Upgrade from GitHub Actions workflow
+
+Please create all required secrets/variables before adding this code snipped to GitHub actions
+
+```
+helm upgrade \
+  --install \
+  --set env.GATEWAY_URL=https://gateway.${{ vars.domain }} \
+  --set env.EVENTS_URL=https://events.${{ vars.domain }} \
+  --set postgres.user=${{ secrets.POSTGRES_USER }} \
+  --set postgres.password=${{ secrets.POSTGRES_PASSWORD }} \
+  --set postgres.host=${{ vars.POSTGRES_HOSTNAME }} \
+  perf-test-job oci://ghcr.io/opencrvs/perf-test:0.1.0
+```

charts/perf-test/templates/_helpers.tpl

@@ -0,0 +1,11 @@
+{{- define "perf-test-generator.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{- define "perf-test-generator.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name (include "perf-test-generator.name" .) | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}

charts/perf-test/templates/perf-test-job.yaml

@@ -0,0 +1,75 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ include "perf-test-generator.fullname" . }}-{{ .Release.Revision }}
+  labels:
+    app.kubernetes.io/name: {{ include "perf-test-generator.name" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+spec:
+  backoffLimit: {{ .Values.job.backoffLimit }}
+  ttlSecondsAfterFinished: {{ .Values.job.ttlSecondsAfterFinished }}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "perf-test-generator.name" . }}
+        app.kubernetes.io/instance: {{ .Release.Name }}
+    spec:
+      restartPolicy: Never
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      containers:
+        - name: generator
+          command:
+          {{- if .Values.command }}
+            {{- toYaml .Values.command | nindent 10 }}
+          {{- else }}
+            ["k6"]
+          {{- end }}
+          args:
+          {{- if .Values.command }}
+            {{- toYaml .Values.command | nindent 10 }}
+          {{- else }}
+            - run
+            - /app/{{ .Values.k6_script }}.js
+          {{- if .Values.k6_output }}
+            - --out
+            - {{ .Values.k6_output }}
+          {{- end }}
+          {{- range $k, $v := .Values.k6_env_args }}
+            - -e
+            - {{ $k }}={{ $v }}
+          {{- end }}
+          {{- end }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          env:
+          {{- range $k, $v := .Values.env }}
+            - name: {{ $k }}
+              value: {{ $v | quote }}
+          {{- end }}
+          {{- range $secretName, $mappings := .Values.perf_test.secrets }}
+          {{- range $mappings }}
+          {{- $parts := splitList ":" . }}
+            - name: {{ index $parts 1 }}
+              valueFrom:
+                secretKeyRef:
+                  name: {{ $secretName }}
+                  key: {{ index $parts 0 }}
+          {{- end }}
+          {{- end }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

charts/perf-test/values.yaml

@@ -0,0 +1,27 @@
+image:
+  repository: ghcr.io/opencrvs/opencrvs-perf-test
+  tag: latest
+  pullPolicy: Always
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+job:
+  backoffLimit: 0
+  ttlSecondsAfterFinished: 3600
+
+resources: {}
+
+nodeSelector: {}
+tolerations: []
+affinity: {}
+
+# Optional: override command/args if your image does not already have the right entrypoint
+command: []
+args: []
+
+k6_script: "smoke"
+
+k6_env_args:
+  GATEWAY_URL: "http://opencrvs-gateway:3000"