Chore: [AEA-5853] - New supplier NHS Number testing parameters

.github/scripts/release_code.sh

@@ -49,4 +49,7 @@ sam deploy \
       ToggleGetStatusUpdates="$TOGGLE_GET_STATUS_UPDATES" \
       EnableAlerts="$ENABLE_ALERTS" \
       StateMachineLogLevel="$STATE_MACHINE_LOG_LEVEL" \
-      ForwardCsocLogs="$FORWARD_CSOC_LOGS"
+      ForwardCsocLogs="$FORWARD_CSOC_LOGS" \
+      TC007NHSNumberValue="$TC007_NHS_NUMBERS" \
+      TC008NHSNumberValue="$TC008_NHS_NUMBERS" \
+      TC009NHSNumberValue="$TC009_NHS_NUMBERS"

.github/workflows/release.yml

@@ -75,6 +75,9 @@ jobs:
       RUN_REGRESSION_TESTS: true
       REGRESSION_TEST_PRODUCT: PFP-APIGEE
       FORWARD_CSOC_LOGS: false
+      TC007_NHS_NUMBERS: ${{vars.TC007_NHS_NUMBERS}}
+      TC008_NHS_NUMBERS: ${{vars.TC008_NHS_NUMBERS}}
+      TC009_NHS_NUMBERS: ${{vars.TC009_NHS_NUMBERS}}
     secrets:
       REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
@@ -103,6 +106,9 @@ jobs:
       STATE_MACHINE_LOG_LEVEL: ALL
       RUN_REGRESSION_TESTS: false
       FORWARD_CSOC_LOGS: false
+      TC007_NHS_NUMBERS: ${{vars.TC007_NHS_NUMBERS}}
+      TC008_NHS_NUMBERS: ${{vars.TC008_NHS_NUMBERS}}
+      TC009_NHS_NUMBERS: ${{vars.TC009_NHS_NUMBERS}}
     secrets:
       REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
@@ -136,6 +142,9 @@ jobs:
       STATE_MACHINE_LOG_LEVEL: ERROR
       RUN_REGRESSION_TESTS: false
       FORWARD_CSOC_LOGS: false
+      TC007_NHS_NUMBERS: ${{vars.TC007_NHS_NUMBERS}}
+      TC008_NHS_NUMBERS: ${{vars.TC008_NHS_NUMBERS}}
+      TC009_NHS_NUMBERS: ${{vars.TC009_NHS_NUMBERS}}
     secrets:
       REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.REF_CLOUD_FORMATION_DEPLOY_ROLE }}
@@ -170,6 +179,9 @@ jobs:
       RUN_REGRESSION_TESTS: true
       REGRESSION_TEST_PRODUCT: PFP-APIGEE
       FORWARD_CSOC_LOGS: false
+      TC007_NHS_NUMBERS: ${{vars.TC007_NHS_NUMBERS}}
+      TC008_NHS_NUMBERS: ${{vars.TC008_NHS_NUMBERS}}
+      TC009_NHS_NUMBERS: ${{vars.TC009_NHS_NUMBERS}}
     secrets:
       REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.QA_CLOUD_FORMATION_DEPLOY_ROLE }}
@@ -199,6 +211,9 @@ jobs:
       RUN_REGRESSION_TESTS: true
       REGRESSION_TEST_PRODUCT: PFP-APIGEE
       FORWARD_CSOC_LOGS: false
+      TC007_NHS_NUMBERS: ${{vars.TC007_NHS_NUMBERS}}
+      TC008_NHS_NUMBERS: ${{vars.TC008_NHS_NUMBERS}}
+      TC009_NHS_NUMBERS: ${{vars.TC009_NHS_NUMBERS}}
     secrets:
       REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.INT_CLOUD_FORMATION_DEPLOY_ROLE }}

.github/workflows/sam_release_code.yml

@@ -66,6 +66,15 @@ on:
       FORWARD_CSOC_LOGS:
         required: true
         type: boolean
+      TC007_NHS_NUMBERS:
+        required: false
+        type: string
+      TC008_NHS_NUMBERS:
+        required: false
+        type: string
+      TC009_NHS_NUMBERS:
+        required: false
+        type: string
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE:
         required: true
@@ -146,6 +155,9 @@ jobs:
           ENABLE_ALERTS: ${{ inputs.ENABLE_ALERTS }}
           STATE_MACHINE_LOG_LEVEL: ${{ inputs.STATE_MACHINE_LOG_LEVEL }}
           FORWARD_CSOC_LOGS: ${{ inputs.FORWARD_CSOC_LOGS }}
+          TC007_NHS_NUMBERS: ${{ inputs.TC007_NHS_NUMBERS || '9992387920' }}
+          TC008_NHS_NUMBERS: ${{ inputs.TC008_NHS_NUMBERS || '9992387920' }}
+          TC009_NHS_NUMBERS: ${{ inputs.TC009_NHS_NUMBERS || '9992387920' }}
         run: ./release_code.sh
 
       - name: create_int_release_notes

.pre-commit-config.yaml

@@ -86,6 +86,15 @@ repos:
         types_or: [ts, tsx, javascript, jsx, json]
         pass_filenames: false
 
+      - id: lint-common-utilities
+        name: Lint common utilities
+        entry: npm
+        args: ["run", "--prefix=packages/common/utilities", "lint"]
+        language: system
+        files: ^packages\/common\/src
+        types_or: [ts, tsx, javascript, jsx, json]
+        pass_filenames: false
+
       - id: lint-common-testing
         name: Lint common testing
         entry: npm

Makefile

@@ -125,6 +125,7 @@ lint-node: compile-node
 	npm run lint --workspace packages/nhsd-pfp-sandbox
 	npm run lint --workspace packages/statusLambda
 	npm run lint --workspace packages/serviceSearchClient
+	npm run lint --workspace packages/common/utilities
 	npm run lint --workspace packages/common/testing
 	npm run lint --workspace packages/distanceSelling
 
@@ -147,6 +148,8 @@ test: compile
 	npm run test --workspace packages/statusLambda
 	npm run test --workspace packages/serviceSearchClient
 	npm run test --workspace packages/distanceSelling
+	npm run test --workspace packages/common/utilities
+	npm run test --workspace packages/common/testing
 
 clean:
 	rm -rf packages/capabilityStatement/coverage
@@ -165,6 +168,7 @@ clean:
 	rm -rf packages/distanceSelling/lib
 	rm -rf packages/statusLambda/lib
 	rm -rf packages/getSecretLayer/lib
+	rm -rf packages/common/utilities/lib
 	rm -rf packages/common/testing/lib
 	rm -rf .aws-sam
 

README.md

@@ -21,6 +21,7 @@ It is called by an Apigee proxy that is defined at <https://github.com/NHSDigita
 - `packages/capabilityStatement/` Returns a static capability statement.
 - `packages/serviceSearchClient/` Module for connecting to service search.
 - `packages/distanceSelling/` Module for using Service Search client and enriching the data being returned.
+- `packages/common/utilities` Module containing commonly referenced functions, data types and configuration data.
 - `packages/common/testing` Module that contains some test data used for tests in other modules.
 - `postman/` Contains a postman collection for interacting with the API.
 - `scripts/` Utilities helpful to developers of this specification.

SAMtemplates/functions/main.yaml

@@ -12,6 +12,7 @@ Globals:
     Runtime: nodejs20.x
     Environment:
       Variables:
+        STACK_NAME: !Ref StackName
         NODE_OPTIONS: "--enable-source-maps"
         TargetSpineServer: !Ref TargetSpineServer
         TargetServiceSearchServer: !Ref TargetServiceSearchServer
@@ -64,6 +65,9 @@ Parameters:
   ToggleGetStatusUpdates:
     Type: String
 
+  SSMParameterPolicy:
+    Type: String
+
 Resources:
   GetSecretsLayer:
     Type: AWS::Serverless::LayerVersion
@@ -116,6 +120,7 @@ Resources:
         AdditionalPolicies: !Join
           - ","
           - - !ImportValue account-resources:LambdaAccessSecretsPolicy
+            - !Ref SSMParameterPolicy
         LogRetentionInDays: !Ref LogRetentionInDays
         CloudWatchKMSKeyId: !ImportValue account-resources:CloudwatchLogsKmsKeyArn
         EnableSplunk: !Ref EnableSplunk
@@ -163,6 +168,10 @@ Resources:
         EnableSplunk: !Ref EnableSplunk
         SplunkSubscriptionFilterRole: !ImportValue lambda-resources:SplunkSubscriptionFilterRole
         SplunkDeliveryStreamArn: !ImportValue lambda-resources:SplunkDeliveryStream
+        IncludeAdditionalPolicies: true
+        AdditionalPolicies: !Join
+          - ","
+          - - !Ref SSMParameterPolicy
 
   CapabilityStatement:
     Type: AWS::Serverless::Function

SAMtemplates/main_template.yaml

@@ -95,6 +95,25 @@ Parameters:
 
   StateMachineLogLevel:
     Type: String
+    Default: ERROR
+    AllowedValues:
+      - ALL
+      - ERROR
+      - FATAL
+      - OFF
+    Description: Logging level for Step Functions state machine
+
+  TC007NHSNumberValue:
+    Type: String
+    Default: "123"
+
+  TC008NHSNumberValue:
+    Type: String
+    Default: "123"
+
+  TC009NHSNumberValue:
+    Type: String
+    Default: "123"
 
   ForwardCsocLogs:
     Type: String
@@ -123,6 +142,16 @@ Resources:
         EnableSplunk: !Ref EnableSplunk
         ForwardCsocLogs: !Ref ForwardCsocLogs
 
+  Parameters:
+    Type: AWS::Serverless::Application
+    Properties:
+      Location: parameters/main.yaml
+      Parameters:
+        StackName: !Ref AWS::StackName
+        TC007NHSNumberValue: !Ref TC007NHSNumberValue
+        TC008NHSNumberValue: !Ref TC008NHSNumberValue
+        TC009NHSNumberValue: !Ref TC009NHSNumberValue
+
   Functions:
     Type: AWS::Serverless::Application
     Properties:
@@ -138,6 +167,7 @@ Resources:
         VersionNumber: !Ref VersionNumber
         CommitId: !Ref CommitId
         ToggleGetStatusUpdates: !Ref ToggleGetStatusUpdates
+        SSMParameterPolicy: !GetAtt Parameters.Outputs.GetPfPParameterPolicy
 
   StateMachines:
     Type: AWS::Serverless::Application

SAMtemplates/parameters/main.yaml

@@ -0,0 +1,82 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Description: >-
+  SSM Parameter Store entries. Values may differ between prod and non-prod environments
+
+Parameters:
+  StackName:
+    Type: String
+
+  TC007NHSNumberValue:
+    Type: String
+
+  TC008NHSNumberValue:
+    Type: String
+
+  TC009NHSNumberValue:
+    Type: String
+
+Resources:
+  TC007NHSNumberParameter:
+    Type: AWS::SSM::Parameter
+    Properties:
+      Name: !Sub ${StackName}-TC007NHSNumber
+      Description: "List of NHS numbers that will trigger 'temporarily unavailable' response for testing purposes."
+      Type: String
+      Value: !Ref TC007NHSNumberValue
+
+  TC008NHSNumberParameter:
+    Type: AWS::SSM::Parameter
+    Properties:
+      Name: !Sub ${StackName}-TC008NHSNumber
+      Description: "List of NHS numbers that will trigger '500 system error' response for testing purposes."
+      Type: String
+      Value: !Ref TC008NHSNumberValue
+
+  TC009NHSNumberParameter:
+    Type: AWS::SSM::Parameter
+    Properties:
+      Name: !Sub ${StackName}-TC009NHSNumber
+      Description: "List of NHS numbers that will trigger 'one or more prescriptions missing' response for testing purposes."
+      Type: String
+      Value: !Ref TC009NHSNumberValue
+
+  GetPfPParameterPolicy:
+    Type: AWS::IAM::ManagedPolicy
+    Properties:
+      Description: "Allows reading SSM parameters"
+      PolicyDocument:
+        Version: 2012-10-17
+        Statement:
+          - Effect: Allow
+            Action:
+              - ssm:GetParameter
+              - ssm:GetParameters
+            Resource:
+              - !Sub arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/${TC007NHSNumberParameter}
+              - !Sub arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/${TC008NHSNumberParameter}
+              - !Sub arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/${TC009NHSNumberParameter}
+
+Outputs:
+  TC007NHSNumberParameterName:
+    Description: "Name of the SSM parameter holding TC007_NHS_Number"
+    Value: !Ref TC007NHSNumberParameter
+    Export:
+      Name: !Sub ${StackName}-TC007NHSNumberParameter
+
+  TC008NHSNumberParameterName:
+    Description: "Name of the SSM parameter holding TC008_NHS_Number"
+    Value: !Ref TC008NHSNumberParameter
+    Export:
+      Name: !Sub ${StackName}-TC008NHSNumberParameter
+
+  TC009NHSNumberParameterName:
+    Description: "Name of the SSM parameter holding TC009_NHS_Number"
+    Value: !Ref TC009NHSNumberParameter
+    Export:
+      Name: !Sub ${StackName}-TC009NHSNumberParameter
+
+  GetPfPParameterPolicy:
+    Description: Access to the parameters used by the notifications integration
+    Value: !Ref GetPfPParameterPolicy
+    Export:
+      Name: !Sub ${StackName}-GetPfPParameterPolicy

jest.default.config.ts

@@ -10,7 +10,11 @@ const jestConfig: JestConfigWithTsJest = {
   preset: "ts-jest/presets/default-esm",
   moduleFileExtensions: ["js", "json", "ts", "d.ts"],
   moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1"
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+    "^@pfp-common/testing$": "<rootDir>/../../packages/common/testing/lib/index.js",
+    "^@pfp-common/testing/(.*)$": "<rootDir>/../../packages/common/testing/lib/$1.js",
+    "^@pfp-common/utilities$": "<rootDir>/../../packages/common/utilities/lib/index.js",
+    "^@pfp-common/utilities/(.*)$": "<rootDir>/../../packages/common/utilities/lib/$1.js"
   },
   transform: {
     "^.+\\.ts?$": [