Merge pull request #704 from NHSDigital/feature/eema1-NRL-973-perfomanceTestHeaders

NRL-973 Add headers to Performance Tests and Fail Workflow if Tests Fail

Author: eesa456

tests/performance/consumer/client.js

@@ -10,6 +10,8 @@ import { check } from "k6";
 function getHeaders(odsCode = ODS_CODE) {
   return {
     "Content-Type": "application/fhir+json",
+    "X-Request-Id": "K6PerformanceTest",
+    "NHSD-Correlation-Id": "K6PerformanceTest",
     "NHSD-Connection-Metadata": JSON.stringify({
       "nrl.ods-code": odsCode,
       "nrl.pointer-types": POINTER_TYPES.map(
@@ -24,6 +26,13 @@ function getHeaders(odsCode = ODS_CODE) {
   };
 }
 
+function checkResponse(res) {
+  const is_success = check(res, { "status is 200": (r) => r.status === 200 });
+  if (!is_success) {
+    console.warn(res.json());
+  }
+}
+
 export function countDocumentReference() {
   const choice = Math.floor(Math.random() * NHS_NUMBERS.length);
   const nhsNumber = NHS_NUMBERS[choice];
@@ -37,8 +46,7 @@ export function countDocumentReference() {
       headers: getHeaders(),
     }
   );
-
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function readDocumentReference() {
@@ -52,7 +60,7 @@ export function readDocumentReference() {
     }
   );
 
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function searchDocumentReference() {
@@ -71,12 +79,7 @@ export function searchDocumentReference() {
       headers: getHeaders(),
     }
   );
-
-  if (res.status !== 200) {
-    console.log(res.json());
-  }
-
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function searchPostDocumentReference() {
@@ -96,6 +99,5 @@ export function searchPostDocumentReference() {
       headers: getHeaders(),
     }
   );
-
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }

tests/performance/process_results.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from csv import DictReader
 from statistics import mean
 
@@ -85,6 +86,7 @@ def _create_response_count_figure(data: dict, title: str):
         timestamps = []
         successful_requests = []
         failed_requests = []
+        failure_plots = []
 
         for timestamp, metrics in scenario_data.items():
             timestamps.append(timestamp)
@@ -139,7 +141,7 @@ def _create_response_count_figure(data: dict, title: str):
         axes.axis("tight")
 
     fig.legend(list(fig_labels), loc="upper left")
-    return fig
+    return fig, failure_plots
 
 
 def _create_response_time_figure(data: dict, title: str):
@@ -306,17 +308,22 @@ def baseline(
     )
     fig.savefig("dist/ramp_up_performance.png")
 
-    fig = _create_response_count_figure(
+    fig, baseline_failures = _create_response_count_figure(
         baseline_data,
         f"NRL v3.0 Consumer API - Baseline Performance ({target_rps} RPS - Warm Start) - Response Count",
     )
     fig.savefig("dist/baseline_count.png")
 
-    fig = _create_response_count_figure(
+    fig, ramp_up_failures = _create_response_count_figure(
         ramp_up_data,
         f"NRL v3.0 Consumer API - Ramp-Up Performance (Up to {target_rps} RPS - Cold Start) - Response Count",
     )
     fig.savefig("dist/ramp_up_count.png")
+    if len(baseline_failures) > 0 or len(ramp_up_failures) > 0:
+        print(
+            f"Number of Failure Responses: {len(baseline_failures) + len(ramp_up_failures)}"
+        )
+        exit(1)
 
 
 def stress(
@@ -341,17 +348,22 @@ def stress(
     )
     fig.savefig("dist/stress_ramp_up_performance.png")
 
-    fig = _create_response_count_figure(
+    fig, baseline_failures = _create_response_count_figure(
         baseline_data,
         f"NRL v3.0 Consumer API - Stress Performance ({target_vus} VUs - Warm Start) - Response Count",
     )
     fig.savefig("dist/stress_baseline_count.png")
 
-    fig = _create_response_count_figure(
+    fig, ramp_up_failures = _create_response_count_figure(
         ramp_up_data,
         f"NRL v3.0 Consumer API - Stress Performance (Up to {target_vus} VUs - Cold Start) - Response Count",
     )
     fig.savefig("dist/stress_ramp_up_count.png")
+    if len(baseline_failures) > 0 or len(ramp_up_failures) > 0:
+        print(
+            f"Number of Failure Responses: {len(baseline_failures) + len(ramp_up_failures)}"
+        )
+        exit(1)
 
 
 if __name__ == "__main__":

tests/performance/producer/client.js

@@ -19,6 +19,8 @@ function getBaseURL() {
 function getHeaders(odsCode = ODS_CODE) {
   return {
     "Content-Type": "application/fhir+json",
+    "X-Request-Id": "K6PerformanceTest",
+    "NHSD-Correlation-Id": "K6PerformanceTest",
     "NHSD-Connection-Metadata": JSON.stringify({
       "nrl.ods-code": odsCode,
       "nrl.pointer-types": POINTER_TYPES.map(
@@ -32,6 +34,12 @@ function getHeaders(odsCode = ODS_CODE) {
     }),
   };
 }
+function checkResponse(res) {
+  const is_success = check(res, { "status is 200": (r) => r.status === 200 });
+  if (!is_success) {
+    console.warn(res.json());
+  }
+}
 
 export function createDocumentReference() {
   const nhsNumber = randomItem(NHS_NUMBERS);
@@ -58,7 +66,7 @@ export function readDocumentReference() {
 
   const res = http.get(`${getBaseURL()}/${id}`, { headers: getHeaders() });
 
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function updateDocumentReference() {
@@ -71,7 +79,7 @@ export function updateDocumentReference() {
     headers: getHeaders(),
   });
 
-  check(res, { "status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function deleteDocumentReference() {
@@ -81,7 +89,7 @@ export function deleteDocumentReference() {
     headers: getHeaders(),
   });
 
-  check(res, { "delete status is 200": (r) => r.status === 200 });
+  checkResponse(res);
 }
 
 export function upsertDocumentReference() {