Added stack name calculation for stateless stacks

Author: MatthewPopat-NHS

packages/cdkConstructs/src/apps/createApp.ts

@@ -5,7 +5,7 @@ import {
   StackProps
 } from "aws-cdk-lib"
 import {AwsSolutionsChecks} from "cdk-nag"
-import {getConfigFromEnvVar, getBooleanConfigFromEnvVar} from "../config"
+import {getConfigFromEnvVar, getBooleanConfigFromEnvVar, calculateVersionedStackName} from "../config"
 
 export interface StandardStackProps extends StackProps {
   readonly stackName: string
@@ -18,9 +18,10 @@ export function createApp(
   appName: string,
   repoName: string,
   driftDetectionGroup: string,
+  isStateless: boolean = true,
   region: string = "eu-west-2"
 ): {app: App, props: StandardStackProps} {
-  const stackName = getConfigFromEnvVar("stackName")
+  let stackName = getConfigFromEnvVar("stackName")
   const versionNumber = getConfigFromEnvVar("versionNumber")
   const commitId = getConfigFromEnvVar("commitId")
   const isPullRequest = getBooleanConfigFromEnvVar("isPullRequest")
@@ -40,6 +41,10 @@ export function createApp(
   Tags.of(app).add("repo", repoName)
   Tags.of(app).add("cfnDriftDetectionGroup", cfnDriftDetectionGroup)
 
+  if (isStateless && !isPullRequest) {
+    stackName = calculateVersionedStackName(stackName, versionNumber)
+  }
+
   return {
     app,
     props: {

packages/cdkConstructs/src/config/index.ts

@@ -64,3 +64,7 @@ export function getBooleanCFConfigValue(exports: Record<string, string>, exportN
   const value = getCFConfigValue(exports, exportName)
   return value.toLowerCase() === "true"
 }
+
+export function calculateVersionedStackName(baseStackName: string, version: string): string {
+  return `${baseStackName}-${version.replace(/\./g, "-")}`
+}

packages/cdkConstructs/src/specifications/deployApi.ts

@@ -1,6 +1,6 @@
 
 import {LambdaClient, InvokeCommand} from "@aws-sdk/client-lambda"
-import {getCFConfigValue, getCloudFormationExports} from "../config"
+import {getCFConfigValue, getCloudFormationExports, calculateVersionedStackName} from "../config"
 
 export type ApiConfig = {
   specification: string
@@ -61,6 +61,7 @@ export async function deployApi(
     spec["x-nhsd-apim"].monitoring = false
     delete spec["x-nhsd-apim"].target.security.secret
   } else {
+    stackName = calculateVersionedStackName(stackName, version)
     spec["x-nhsd-apim"].target.security.secret = mtlsSecretName
   }
   spec.info.version = version

packages/cdkConstructs/tests/apps/createApp.test.ts

@@ -51,15 +51,21 @@ describe("createApp", () => {
       const {app, props} = createApp("testApp", "testRepo", "test-drift-group")
 
       expect(app).toBeInstanceOf(App)
-      expect(props.stackName).toBe("test-stack")
+      expect(props.stackName).toBe("test-stack-1-2-3")
       expect(props.version).toBe("1.2.3")
       expect(props.commitId).toBe("abc123def456")
       expect(props.isPullRequest).toBe(false)
       expect(props.env?.region).toBe("eu-west-2")
     })
 
+    test("creates stateful App with correct stackName", () => {
+      const {props} = createApp("testApp", "testRepo", "test-drift-group", false)
+
+      expect(props.stackName).toBe("test-stack")
+    })
+
     test("uses custom region when provided", () => {
-      const {props} = createApp("testApp", "testRepo", "test-drift-group", "us-east-1")
+      const {props} = createApp("testApp", "testRepo", "test-drift-group", true, "us-east-1")
 
       expect(props.env?.region).toBe("us-east-1")
     })
@@ -107,12 +113,21 @@ describe("createApp", () => {
       process.env.CDK_CONFIG_isPullRequest = "true"
     })
 
-    test("sets isPullRequest to true in props", () => {
+    test("correctly modifies props", () => {
       const {props} = createApp("testApp", "testRepo", "test-drift-group")
 
+      expect(props.stackName).toBe("pr-stack")
+      expect(props.version).toBe("0.0.1-pr")
+      expect(props.commitId).toBe("pr123")
       expect(props.isPullRequest).toBe(true)
     })
 
+    test("creates stateful App with unmodified stackName", () => {
+      const {props} = createApp("testApp", "testRepo", "test-drift-group", false)
+
+      expect(props.stackName).toBe("pr-stack")
+    })
+
     test("modifies drift detection group with -pull-request suffix", () => {
       // Spy on Tags.of(app).add to verify tag calls
       const addTagSpy = vi.fn()

packages/cdkConstructs/tests/specifications/deployApi.test.ts

@@ -30,12 +30,15 @@ vi.mock("@aws-sdk/client-lambda", () => {
   return {LambdaClient, InvokeCommand}
 })
 
-const getCloudFormationExportsMock = vi.fn()
+const getCloudFormationExportsMock = vi.hoisted(() => vi.fn())
 
-vi.mock("../../src/config", () => ({
-  getCloudFormationExports: () => getCloudFormationExportsMock(),
-  getCFConfigValue: (exports: Record<string, string>, name: string) => exports[name]
-}))
+vi.mock("../../src/config", async (importOriginal) => {
+  const originalModule = await importOriginal<typeof import("../../src/config")>()
+  return {
+    ...originalModule,
+    getCloudFormationExports: getCloudFormationExportsMock
+  }
+})
 
 function createSpec() {
   return {
@@ -94,17 +97,15 @@ function functionNameFromCall(callIndex: number) {
 describe("deployApi", () => {
   beforeEach(() => {
     lambdaSendMock.mockReset().mockResolvedValue({Payload: Buffer.from('"ok"')})
-    getCloudFormationExportsMock.mockReset()
+    getCloudFormationExportsMock.mockReset().mockResolvedValue(defaultExportsMap)
   })
 
   test("stores secrets, deploys instance and publishes spec for internal-dev", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
-
     await deployApi(
       buildConfig({
         version: "2.0.0",
         apigeeEnvironment: "internal-dev",
-        stackName: "eps-stack-001"
+        stackName: "eps-stack"
       }),
       false
     )
@@ -130,7 +131,7 @@ describe("deployApi", () => {
     expect(instancePayload.specDefinition.info.version).toBe("2.0.0")
     expect(instancePayload.specDefinition["x-nhsd-apim"].target.security.secret).toBe("mtls/secret")
     expect(instancePayload.specDefinition["x-nhsd-apim"].target.url)
-      .toBe("https://eps-stack-001.nonprod.eps.national.nhs.uk")
+      .toBe("https://eps-stack-2-0-0.nonprod.eps.national.nhs.uk")
     expect(instancePayload.specDefinition.components.securitySchemes["nhs-cis2-aal3"].$ref)
       .toBe("https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/nhs-cis2-aal3")
     expect(instancePayload.specDefinition.servers[0].url)
@@ -144,8 +145,6 @@ describe("deployApi", () => {
   })
 
   test("handles pull requests in sandbox without storing secrets", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
-
     await deployApi(
       buildConfig({
         version: "3.1.4",
@@ -171,8 +170,6 @@ describe("deployApi", () => {
   })
 
   test("uses prod lambdas and prod security scheme refs", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
-
     await deployApi(
       buildConfig({
         version: "4.0.0",
@@ -196,8 +193,6 @@ describe("deployApi", () => {
   })
 
   test("publishes spec to prod catalogue for int environment", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
-
     await deployApi(
       buildConfig({
         version: "5.0.0",
@@ -217,7 +212,6 @@ describe("deployApi", () => {
   })
 
   test("dry run only logs intended invocations", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
     const logSpy = vi.spyOn(console, "log").mockImplementation(() => undefined)
 
     await deployApi(
@@ -237,7 +231,6 @@ describe("deployApi", () => {
   })
 
   test("throws when lambda invocation returns a FunctionError", async () => {
-    getCloudFormationExportsMock.mockResolvedValue(defaultExportsMap)
     lambdaSendMock
       .mockResolvedValueOnce({FunctionError: "Handled", Payload: Buffer.from('"bad"')})