feat: remove entries when parameter is deleted

Author: coderbyheart

cdk/RegistryStack.ts

@@ -122,7 +122,7 @@ export class RegistryStack extends Stack {
 				source: ['aws.ssm'],
 				detailType: ['Parameter Store Change'],
 				detail: {
-					operation: ['Create', 'Update'],
+					operation: ['Create', 'Update', 'Delete'],
 				},
 			},
 			targets: [new EventsTargets.LambdaFunction(publishToS3)],

feature-runner/run-features.ts

@@ -2,7 +2,6 @@ import { CloudFormationClient } from '@aws-sdk/client-cloudformation'
 import { SSMClient } from '@aws-sdk/client-ssm'
 import { runFolder } from '@nordicsemiconductor/bdd-markdown'
 import { stackOutput } from '@nordicsemiconductor/cloudformation-helpers'
-import { randomUUID } from 'node:crypto'
 import path from 'node:path'
 import type { StackOutputs } from '../cdk/RegistryStack.js'
 import { STACK_NAME } from '../cdk/stackConfig.js'
@@ -15,13 +14,17 @@ const config = await stackOutput(new CloudFormationClient({}))<StackOutputs>(
 export type World = {
 	registryEndpoint: string
 	stackName: string
-	randomString: string
-	randomNumber: number
-}
+} & Record<string, any>
 
 const runner = await runFolder<World>({
 	folder: path.join(process.cwd(), 'features'),
 	name: 'Public Parameter Registry',
+	logObserver: {
+		onDebug: console.debug,
+		onError: console.error,
+		onInfo: console.log,
+		onProgress: console.debug,
+	},
 })
 
 const stepDefs = steps({ ssm: new SSMClient({}) })
@@ -30,8 +33,6 @@ runner.addStepRunners(...stepDefs.steps)
 const res = await runner.run({
 	registryEndpoint: config.registryEndpoint,
 	stackName: STACK_NAME,
-	randomNumber: Math.floor(Math.random() * 1000000),
-	randomString: randomUUID(),
 })
 
 await stepDefs.cleanup()

feature-runner/steps.ts

@@ -1,4 +1,5 @@
 import {
+	DeleteParameterCommand,
 	DeleteParametersCommand,
 	ParameterType,
 	PutParameterCommand,
@@ -11,15 +12,15 @@ import {
 	type StepRunner,
 	type StepRunnerArgs,
 } from '@nordicsemiconductor/bdd-markdown'
-import { check, objectMatching } from 'tsmatchers'
+import { randomUUID } from 'node:crypto'
+import { check, not, objectMatching, objectWithKeys } from 'tsmatchers'
 import { type World } from './run-features.js'
-
 export const steps = ({
 	ssm,
 }: {
 	ssm: SSMClient
 }): { steps: StepRunner<World>[]; cleanup: () => Promise<void> } => {
-	const Names: string[] = []
+	let Names: string[] = []
 	return {
 		steps: [
 			async ({
@@ -29,21 +30,45 @@ export const steps = ({
 					step: { debug },
 				},
 			}: StepRunnerArgs<World>): Promise<StepRunResult> => {
-				const match = /^`(?<value>[^`]+)` is stored in `(?<name>[^`]+)`$/.exec(
-					step.title,
-				)
+				const match =
+					/^a random (?<type>string|number) in `(?<storageName>[^`]+)` is stored in `(?<name>[^`]+)`$/.exec(
+						step.title,
+					)
 				if (match === null) return noMatch
 				const Name = `/${context.stackName}/public/${match.groups?.name}`
+				const value =
+					match.groups?.type === 'string'
+						? randomUUID()
+						: Math.floor(Math.random() * 1000000)
 				debug(Name)
 				await ssm.send(
 					new PutParameterCommand({
 						Name,
-						Value: match.groups?.value ?? '',
+						Value: `${value}`,
 						Type: ParameterType.STRING,
 						Overwrite: true,
 					}),
 				)
 				Names.push(Name)
+				context[match.groups?.storageName ?? ''] = value
+			},
+			async ({
+				step,
+				context,
+				log: {
+					step: { debug },
+				},
+			}: StepRunnerArgs<World>): Promise<StepRunResult> => {
+				const match = /^`(?<name>[^`]+)` is deleted$/.exec(step.title)
+				if (match === null) return noMatch
+				const Name = `/${context.stackName}/public/${match.groups?.name}`
+				debug(Name)
+				await ssm.send(
+					new DeleteParameterCommand({
+						Name,
+					}),
+				)
+				Names = Names.filter((n) => n !== Name)
 			},
 			async ({
 				step,
@@ -71,6 +96,29 @@ export const steps = ({
 				)
 				return registry
 			},
+			async ({
+				step,
+				log: {
+					step: { debug },
+				},
+			}: StepRunnerArgs<World>): Promise<StepRunResult> => {
+				const match =
+					/^the result of GET `(?<url>[^`]+)` should not have property `(?<property>[^`]+)`$/.exec(
+						step.title,
+					)
+				if (match === null) return noMatch
+				const res = await fetch(match?.groups?.url ?? '')
+				const body = await res.text()
+				debug(body)
+				let registry: Record<string, any> = {}
+				try {
+					registry = JSON.parse(body)
+				} catch {
+					throw new Error(`Failed to parse body as JSON: ${body}`)
+				}
+				check(registry).is(not(objectWithKeys(match.groups?.property ?? '')))
+				return registry
+			},
 		],
 		cleanup: async () => {
 			if (Names.length === 0) return

features/DeleteParameter.feature.md

@@ -0,0 +1,18 @@
+---
+retry:
+  initialDelay: 5000
+needs:
+  - Get Parameters
+---
+
+# Remove a deleted parameters
+
+> After removing a parameter, it should be removed from the registry
+
+## Background
+
+Given `example/aNumberParameter` is deleted
+
+## Get the parameters
+
+Soon the result of GET `${registryEndpoint}` should not have property `example`

features/GetParameters.feature.md

@@ -9,9 +9,9 @@ retry:
 
 ## Background
 
-Given `${randomString}` is stored in `aStringParameter`
+Given a random string in `randomString` is stored in `aStringParameter`
 
-And `${randomNumber}` is stored in `example/aNumberParameter`
+And a random number in `randomNumber` is stored in `example/aNumberParameter`
 
 ## Get the parameters
 

lambda/publishToS3.ts

@@ -28,7 +28,7 @@ export const handler = async (event: {
 	detail: {
 		name: string // '/public-parameter-registry/public/some-parameter'
 		type: string // 'String'
-		operation: string // 'Create', 'Update
+		operation: string // 'Create', 'Update', 'Delete'
 	}
 }): Promise<void> => {
 	console.log(JSON.stringify({ event }))

package-lock.json

@@ -30,7 +30,7 @@
     "@aws-sdk/client-s3": "3.315.0",
     "@aws-sdk/client-ssm": "3.315.0",
     "@nordicsemiconductor/asset-tracker-cloud-code-style": "12.0.23",
-    "@nordicsemiconductor/bdd-markdown": "3.5.47",
+    "@nordicsemiconductor/bdd-markdown": "3.6.0",
     "@nordicsemiconductor/cloudformation-helpers": "8.0.0",
     "@nordicsemiconductor/eslint-config-asset-tracker-cloud-typescript": "15.0.0",
     "@swc/cli": "0.1.62",