test: increase coverage

Author: tstephen-nhs

packages/cdk/tests/stacks.test.ts

@@ -0,0 +1,89 @@
+import {App} from "aws-cdk-lib"
+import {Template} from "aws-cdk-lib/assertions"
+import {describe, it} from "vitest"
+import {PfPApiSandboxStack, PfPApiSandboxStackProps} from "../stacks/PfPApiSandboxStack"
+import {PfPApiStack, PfPApiStackProps} from "../stacks/PfPApiStack"
+
+function createStandardStackProps() {
+  return {
+    commitId: "test-commit",
+    env: {
+      region: "eu-west-2"
+    },
+    environment: "test",
+    isPullRequest: true,
+    version: "0.0.0-test"
+  }
+}
+
+function createMainStackProps(): PfPApiStackProps {
+  return {
+    ...createStandardStackProps(),
+    allowNhsNumberOverride: "false",
+    csocApiGatewayDestination: "arn:aws:logs:eu-west-2:693466633220:destination:api_gateway_log_destination",
+    enableAlerts: true,
+    forwardCsocLogs: false,
+    logLevel: "INFO",
+    logRetentionInDays: 7,
+    mutualTlsTrustStoreKey: undefined,
+    serviceSearchApiKeySecretName: "pfp-PfP-ServiceSearch-API-Key",
+    stackName: "pfp-test-stack",
+    targetServiceSearchServer: "https://live/service-search-api/",
+    targetSpineServer: "https://example-spine.test",
+    tc007NhsNumberValue: "9000000009",
+    tc008NhsNumberValue: "9000000017",
+    tc009NhsNumberValue: "9000000025",
+    toggleGetStatusUpdates: "true"
+  }
+}
+
+function createSandboxStackProps(): PfPApiSandboxStackProps {
+  return {
+    ...createStandardStackProps(),
+    logLevel: "INFO",
+    logRetentionInDays: 30,
+    mutualTlsTrustStoreKey: undefined,
+    stackName: "pfp-sandbox",
+    targetServiceSearchServer: "https://sandbox/service-search-api/",
+    targetSpineServer: "https://example-spine.test"
+  }
+}
+
+describe("CDK stack synthesis", () => {
+  it("synthesizes the main stack with the core API resources", () => {
+    const app = new App()
+    const stack = new PfPApiStack(app, "TestPfPApiStack", createMainStackProps())
+    const template = Template.fromStack(stack)
+
+    template.resourceCountIs("AWS::ApiGateway::RestApi", 1)
+    template.resourceCountIs("AWS::CloudWatch::Alarm", 4)
+    template.resourceCountIs("AWS::StepFunctions::StateMachine", 1)
+
+    template.hasResourceProperties("AWS::CloudWatch::Alarm", {
+      AlarmDescription: "Count of Service Search errors",
+      AlarmName: "pfp-test-stack-ServiceSearch_Errors",
+      ActionsEnabled: true
+    })
+
+    template.hasResourceProperties("AWS::Lambda::Function", {
+      FunctionName: "pfp-test-stack-GetMyPrescriptions"
+    })
+  })
+
+  it("synthesizes the sandbox stack with its public endpoints", () => {
+    const app = new App()
+    const stack = new PfPApiSandboxStack(app, "TestPfPApiSandboxStack", createSandboxStackProps())
+    const template = Template.fromStack(stack)
+
+    template.resourceCountIs("AWS::ApiGateway::RestApi", 1)
+    template.resourceCountIs("AWS::Lambda::Function", 3)
+
+    template.hasResourceProperties("AWS::Lambda::Function", {
+      FunctionName: "pfp-sandbox-Sandbox"
+    })
+
+    template.hasResourceProperties("AWS::Lambda::Function", {
+      FunctionName: "pfp-sandbox-CapabilityStatement"
+    })
+  })
+})

packages/cdk/tests/synth.test.ts

@@ -16,6 +16,8 @@ function createBaseEnv() {
   }
 }
 
+// These are smoke tests for the CLI entrypoints. Resource assertions should be done in-process
+// against synthesized stacks so coverage is attributed to the CDK code under test.
 describe("CDK synth smoke tests", () => {
   it("type-checks the cdk package", () => {
     expect(() => {

packages/cdk/vitest.config.ts

@@ -1,5 +1,6 @@
 import {createVitestConfig} from "../../vitest.default.config"
 
 export default createVitestConfig({
-  workspaceRoot: "../../"
+  workspaceRoot: "../../",
+  inlineDeps: ["@nhsdigital/eps-cdk-constructs"]
 })

vitest.default.config.ts

@@ -5,10 +5,11 @@ type VitestDefaultConfigOptions = {
   workspaceRoot: string;
   setupFiles?: Array<string>;
   aliasOverrides?: Record<string, string>;
+  inlineDeps?: Array<string>;
 }
 
 export function createVitestConfig(options: VitestDefaultConfigOptions) {
-  const {workspaceRoot, setupFiles = [], aliasOverrides = {}} = options
+  const {workspaceRoot, setupFiles = [], aliasOverrides = {}, inlineDeps = []} = options
 
   return defineConfig({
     resolve: {
@@ -31,7 +32,6 @@ export function createVitestConfig(options: VitestDefaultConfigOptions) {
     test: {
       clearMocks: true,
       coverage: {
-        all: false,
         exclude: [
           "**/node_modules/**",
           "**/lib/**",
@@ -50,7 +50,7 @@ export function createVitestConfig(options: VitestDefaultConfigOptions) {
       include: ["tests/*.test.ts"],
       server: {
         deps: {
-          inline: ["@nhsdigital/eps-spine-client", /@middy/]
+          inline: ["@nhsdigital/eps-spine-client", /@middy/, ...inlineDeps]
         }
       },
       setupFiles