function to do cf things directly

Author: anthony-nhs

packages/deploymentUtils/src/changesets/checkDestructiveChanges.ts

@@ -1,3 +1,5 @@
+import {CloudFormationClient, DescribeChangeSetCommand} from "@aws-sdk/client-cloudformation"
+
 export type ChangeRequiringAttention = {
   logicalId: string;
   physicalId: string;
@@ -62,3 +64,32 @@ export function checkDestructiveChanges(changeSet: ChangeSet | undefined | null)
     })
     .filter((change): change is ChangeRequiringAttention => Boolean(change))
 }
+
+export async function checkDestructiveChangeSet(
+  changeSetName: string,
+  stackName: string,
+  region: string): Promise<void> {
+  if (!changeSetName || !stackName || !region) {
+    throw new Error("Change set name, stack name, and region are required")
+  }
+
+  const client = new CloudFormationClient({region})
+  const command = new DescribeChangeSetCommand({
+    ChangeSetName: changeSetName,
+    StackName: stackName
+  })
+
+  const response = await client.send(command)
+  const destructiveChanges = checkDestructiveChanges(response)
+
+  if (destructiveChanges.length === 0) {
+    console.log(`Change set ${changeSetName} for stack ${stackName} has no destructive changes.`)
+    return
+  }
+
+  console.error("Resources that require attention:")
+  destructiveChanges.forEach(({logicalId, physicalId, resourceType, reason}) => {
+    console.error(`- LogicalId: ${logicalId}, PhysicalId: ${physicalId}, Type: ${resourceType}, Reason: ${reason}`)
+  })
+  throw new Error(`Change set ${changeSetName} contains destructive changes`)
+}

packages/deploymentUtils/tests/changesets/checkDestructiveChanges.test.ts

@@ -1,8 +1,42 @@
 import {readFileSync} from "node:fs"
 import {dirname, join} from "node:path"
 import {fileURLToPath} from "node:url"
-import {describe, expect, test} from "vitest"
-import {checkDestructiveChanges} from "../../src/changesets/checkDestructiveChanges"
+import {
+  beforeEach,
+  describe,
+  expect,
+  test,
+  vi
+} from "vitest"
+import {checkDestructiveChanges, checkDestructiveChangeSet} from "../../src/changesets/checkDestructiveChanges"
+
+const mockCloudFormationSend = vi.fn()
+
+vi.mock("@aws-sdk/client-cloudformation", () => {
+  class CloudFormationClient {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    config: any
+    constructor(config: {region: string}) {
+      this.config = config
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    send(command: any) {
+      return mockCloudFormationSend(command)
+    }
+  }
+
+  class DescribeChangeSetCommand {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    input: any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(input: any) {
+      this.input = input
+    }
+  }
+
+  return {CloudFormationClient, DescribeChangeSetCommand}
+})
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
@@ -13,6 +47,10 @@ const loadChangeSet = (filePath: string) => JSON.parse(readFileSync(filePath, "u
 const destructiveChangeSet = loadChangeSet(join(fixturesDir, "destructive_changeset.json"))
 const safeChangeSet = loadChangeSet(join(fixturesDir, "safe_changeset.json"))
 
+beforeEach(() => {
+  mockCloudFormationSend.mockReset()
+})
+
 describe("checkDestructiveChanges", () => {
   test("returns resources that require replacement", () => {
     const replacements = checkDestructiveChanges(destructiveChangeSet)
@@ -58,3 +96,44 @@ describe("checkDestructiveChanges", () => {
     ])
   })
 })
+
+describe("checkDestructiveChangeSet", () => {
+  test("logs success when no destructive changes are present", async () => {
+    mockCloudFormationSend.mockResolvedValueOnce(safeChangeSet)
+
+    const logSpy = vi.spyOn(console, "log").mockImplementation(() => undefined)
+    const errorSpy = vi.spyOn(console, "error").mockImplementation(() => undefined)
+
+    try {
+      await expect(checkDestructiveChangeSet("cs", "stack", "eu-west-2")).resolves.toBeUndefined()
+
+      expect(mockCloudFormationSend).toHaveBeenCalledTimes(1)
+      const command = mockCloudFormationSend.mock.calls[0][0] as {input: {ChangeSetName: string; StackName: string}}
+      expect(command.input).toEqual({ChangeSetName: "cs", StackName: "stack"})
+      expect(logSpy).toHaveBeenCalledWith("Change set cs for stack stack has no destructive changes.")
+      expect(errorSpy).not.toHaveBeenCalled()
+    } finally {
+      logSpy.mockRestore()
+      errorSpy.mockRestore()
+    }
+  })
+
+  test("logs details and throws when destructive changes exist", async () => {
+    mockCloudFormationSend.mockResolvedValueOnce(destructiveChangeSet)
+
+    const logSpy = vi.spyOn(console, "log").mockImplementation(() => undefined)
+    const errorSpy = vi.spyOn(console, "error").mockImplementation(() => undefined)
+
+    try {
+      await expect(checkDestructiveChangeSet("cs", "stack", "eu-west-2"))
+        .rejects.toThrow("Change set cs contains destructive changes")
+
+      expect(mockCloudFormationSend).toHaveBeenCalledTimes(1)
+      expect(logSpy).not.toHaveBeenCalled()
+      expect(errorSpy).toHaveBeenCalledWith("Resources that require attention:")
+    } finally {
+      logSpy.mockRestore()
+      errorSpy.mockRestore()
+    }
+  })
+})