ssmParametersConstruct.test.ts

import {App, Stack} from "aws-cdk-lib"
import {Template} from "aws-cdk-lib/assertions"
import {
  beforeAll,
  describe,
  expect,
  test
} from "vitest"

import {SsmParametersConstruct} from "../../src/constructs/SsmParametersConstruct"
import {assert} from "node:console"

describe("SsmParametersConstruct", () => {
  let template: Template

  beforeAll(() => {
    const app = new App()
    const stack = new Stack(app, "parameterStack")

    const params = new SsmParametersConstruct(stack, "TestingParameters", {
      namePrefix: "mock-stack",
      parameters: [
        {
          id: "MockParam1",
          nameSuffix: "MockParam1",
          description: "Description for mock parameter 1",
          value: "mock-value-1",
          outputExportSuffix: "MockParam1Parameter",
          outputDescription: "Name of the SSM parameter holding MockParam1"
        },
        {
          id: "MockParam2",
          nameSuffix: "MockParam2",
          description: "Description for mock parameter 2",
          value: "mock-value-2",
          outputExportSuffix: "MockParam2Parameter",
          outputDescription: "Name of the SSM parameter holding MockParam2"
        },
        {
          id: "MockParam3",
          nameSuffix: "MockParam3",
          description: "Description for mock parameter 3",
          value: "mock-value-3",
          outputExportSuffix: "MockParam3Parameter",
          outputDescription: "Name of the SSM parameter holding MockParam3"
        }
      ],
      readPolicyDescription: "Mock policy description",
      readPolicyOutputDescription: "Mock read policy output description",
      readPolicyExportSuffix: "MockGetParametersPolicy"
    })
    // Sonarcloud complains that the construct is not used, so we add an assertion to sidestep that.
    assert(params, "SsmParametersConstruct should be created successfully")

    template = Template.fromStack(stack)
  })

  test("creates all SSM parameters", () => {
    template.hasResourceProperties("AWS::SSM::Parameter", {
      Name: "mock-stack-MockParam1",
      Type: "String",
      Value: "mock-value-1"
    })

    template.hasResourceProperties("AWS::SSM::Parameter", {
      Name: "mock-stack-MockParam2",
      Type: "String",
      Value: "mock-value-2"
    })

    template.hasResourceProperties("AWS::SSM::Parameter", {
      Name: "mock-stack-MockParam3",
      Type: "String",
      Value: "mock-value-3"
    })
  })

  test("creates read policy with GetParameter actions for all parameters", () => {
    const policies = template.findResources("AWS::IAM::ManagedPolicy", {
      Properties: {
        Description: "Mock policy description"
      }
    })

    expect(Object.keys(policies)).toHaveLength(1)

    const policy = Object.values(policies)[0] as {
      Properties: {
        PolicyDocument: {
          Statement: Array<{
            Action: Array<string>
            Resource: Array<unknown>
          }>
        }
      }
    }

    const statement = policy.Properties.PolicyDocument.Statement[0]
    expect(statement.Action).toEqual(["ssm:GetParameter", "ssm:GetParameters"])
    expect(statement.Resource).toHaveLength(3)
  })
})

describe("SsmParametersConstruct uses defaults when optional fields are omitted", () => {
  test("creates parameter and policy with default readPolicyDescription when optional fields are omitted", () => {
    const app = new App()
    const stack = new Stack(app, "defaultsStack")
    const params = new SsmParametersConstruct(stack, "DefaultsParameters", {
      namePrefix: "mock-stack",
      parameters: [
        {
          id: "MockParam1",
          nameSuffix: "MockParam1Suffix",
          description: "Mock SSM parameter description",
          value: "mock-value-1"
        }
      ],
      readPolicyExportSuffix: "MockGetParametersPolicy"
    })
    // Get sonar to shup up about the construct not being used
    assert(params, "SsmParametersConstruct should be created successfully")
    const template = Template.fromStack(stack)

    template.hasResourceProperties("AWS::SSM::Parameter", {
      Name: "mock-stack-MockParam1Suffix",
      Type: "String",
      Value: "mock-value-1",
      Description: "Mock SSM parameter description"
    })

    template.hasResourceProperties("AWS::IAM::ManagedPolicy", {
      Description: "Allows reading SSM parameters"
    })
  })
})

describe("SsmParametersConstruct validation", () => {
  test("throws when parameters array is empty", () => {
    const app = new App()
    const stack = new Stack(app, "emptyParamStack")
    expect(() => new SsmParametersConstruct(stack, "EmptyParameters", {
      namePrefix: "mock-stack",
      parameters: []
    })).toThrow("SsmParametersConstruct requires at least one parameter definition")
  })

  test("throws when duplicate parameter ids are detected", () => {
    const app = new App()
    const stack = new Stack(app, "duplicateIdStack")
    expect(() => new SsmParametersConstruct(stack, "DuplicateIdParameters", {
      namePrefix: "mock-stack",
      parameters: [
        {
          id: "MockParam1",
          nameSuffix: "MockParam1",
          description: "Description for mock parameter 1",
          value: "mock-value-1"
        },
        {
          id: "MockParam1",
          nameSuffix: "MockParam1Different",
          description: "Description for duplicate id parameter",
          value: "mock-value-2"
        }
      ]
    })).toThrow("Duplicate parameter id detected: MockParam1.")
  })

  test("throws when duplicate parameter names are detected", () => {
    const app = new App()
    const stack = new Stack(app, "duplicateNameStack")
    expect(() => new SsmParametersConstruct(stack, "DuplicateNameParameters", {
      namePrefix: "mock-stack",
      parameters: [
        {
          id: "MockParam1",
          nameSuffix: "SharedSuffix",
          description: "Description for mock parameter 1",
          value: "mock-value-1"
        },
        {
          id: "MockParam2",
          nameSuffix: "SharedSuffix",
          description: "Description for duplicate name parameter",
          value: "mock-value-2"
        }
      ]
    })).toThrow("Duplicate parameter name detected: mock-stack-SharedSuffix.")
  })
})