NRL-1666 Fix broken NHS number generation & document how to run perf tests. SUccessfully ran producer tests

Author: anjalitrace2-nhs

Makefile

@@ -16,7 +16,7 @@ APP_ALIAS ?= default
 HOST ?= $(TF_WORKSPACE_NAME).api.record-locator.$(ENV).national.nhs.uk
 ENV_TYPE ?= $(ENV)
 PERFTEST_TABLE_NAME ?= perftest
-PERFTEST_HOST ?= api.perftest.record-locator.national.nhs.uk
+PERFTEST_HOST ?= perftest-1.perftest.record-locator.national.nhs.uk
 
 export PATH := $(PATH):$(PWD)/.venv/bin
 export USE_SHARED_RESOURCES := $(shell poetry run python scripts/are_resources_shared_for_stack.py $(TF_WORKSPACE_NAME))

tests/performance/README.md

@@ -1,21 +1,51 @@
 # Performance Testing
 
-<!-- TODO: make this proper -->
-
 some high level context short
 
 ## Run perf tests
 
+### Prep the environment
+
+Perf tests are generally conducted in the perftest env. There's a selection of tables in the perftest env representing different pointer volume scenarios e.g. perftest-baseline vs perftest-1million (todo: update with real names!).
+
+To reset this table to the expected state for perftests, restore the table from a backup.
+
+In the steps below, make sure the table name is the table your environment is pointing at. You might need to redeploy NRLF lambdas to point at the desired table.
+
+### Prepare to run tests
+
+#### Pull certs for env
+
 ```sh
 assume management
-make truststore-pull-all ENV=<env>  # e.g. perftest
+make truststore-pull-all ENV=perftest
+```
+
+#### Generate permissions
+
+You will need to generate pointer permissions the first time performance tests are run in an environment e.g. if the perftest environment is destroyed & recreated.
+
+```sh
+make generate permissions   # makes a bunch of json permission files
+make build  # will take all permissions & create nrlf_permissions.zip file
+
+# apply this new permissions zip file to your environment
 cd ./terraform/infrastructure
-tf workspace select # perftest-1 or active stack
-cd ../../ # project root
-assume
-make perftest-prepare PERFTEST_TABLE_NAME=<pointer table name>
+assume test # needed?
+make init TF_WORKSPACE_NAME=perftest-1 ENV=perftest
+tf apply
+```
+
+#### Generate input files
 
-make perftest-consumer ENV_TYPE=<env>  # e.g. perftest
+```sh
+# creates 2 csv files and a json file
+make perftest-prepare PERFTEST_TABLE_NAME=perftest-baseline
 ```
 
-<!-- Mention relevant input files + any environment prep needed e.g. restoring tables from backup -->
+### Run tests
+
+```sh
+make perftest-consumer ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
+make perftest-producer ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
+```

tests/performance/producer/client_perftest.js

@@ -58,51 +58,33 @@ function generateValidNHSNumber(start, end) {
 
   while (!nhsNumber) {
     const seedNumber = randomNHSNumberInRange(start, end);
-    const first9Str = String(seedNumber).padStart(9, "0").substring(0, 8);
+    const first9Str = String(seedNumber).padStart(9, "0").substring(0, 9);
 
-    console.log(
-      `Generating NHS number from seed: ${seedNumber}, first 9 digits: ${first9Str}`
-    );
-
-    if (first9Str.match(/^\d{9}$/)) {
+    if (!first9Str.match(/^\d{9}$/)) {
       throw new Error(
         `bad NHS number generated - expected 9 digits: ${first9Str}, ${seedNumber}`
       );
     }
 
-    //parts_list = [
-    //  int(digit) * (10 - index)
-    //  for index, digit in enumerate(identifier_digits)
-    //]
-    //list_sum = sum(parts_list)
-    //checksum = 11 - (list_sum % 11)
-    //if checksum == 11:
-    //    checksum = 0
-    //return checksum
-
     const parts = [];
     const digits = first9Str.split("");
     for (let i = 0; i < digits.length; i++) {
       parts.push(parseInt(digits[i], 10) * (10 - i));
     }
-
     const list_sum = parts.reduce((a, b) => a + b, 0);
-    let checksum = 11 - (list_sum % 11);
-    if (checksum === 11) {
-      checksum = 0;
-    }
 
-    console.log(
-      `Generated NHS number parts: ${parts}, sum: ${list_sum}, checksum: ${checksum}`
-    );
+    let checksum = 11 - (list_sum % 11);
 
     if (checksum === 10) {
       // Checksum of 10 means NHS number is invalid
       continue;
     }
 
+    if (checksum === 11) {
+      checksum = 0;
+    }
+
     nhsNumber = `${first9Str}${checksum}`;
-    console.log(`Generated NHS number: ${nhsNumber}`);
   }
 
   return nhsNumber;