Add cdk-helper modules

Author: gsingh04

.gitignore

@@ -14,6 +14,7 @@
 **/coverage
 **/coverage-reports
 **/.nyc_output
+**/mock-*
 
 # misc
 **/npm-debug.log

deployment/cdk-solution-helper/README.md

@@ -1,14 +1,15 @@
 ## CDK Solution Helper
 
-**For aws-solutions internal purposes only** 
+**For aws-solutions internal purposes only**
 
-This is a module to package templates and lambda binaries on solution internal pipelines. 
-It achieves the following:
+`cdk-solution-helper` runs on solution internal pipeline and makes needed artifact modifications to support 1-click deployment using solution CloudFormation template.
+Additionally, it packages templates and lambda binaries and prepares them to be staged on the solution buckets. 
+
+It does the following:
 + Replace references to local cdk generated assets in the template with solution assets
 
 For eg.
 > cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region} --> solutions-${AWS::Region}
 
 + Package lambda and UI assets generated by cdk and stage them on solution buckets
 
-`cdk-solution-helper` runs on solution internal pipeline and makes needed artifact modifications to support 1-click deployment using solution CloudFormation template.

deployment/cdk-solution-helper/asset-packager/asset-packager.test.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { handler } from "./index";
+import { CDKAssetPackager } from "./asset-packager";
+import { mkdir, writeFile, rm } from "node:fs/promises";
+import path from "path";
+
+const mockAssetDirectoryPath = path.join(__dirname, "mock-dir");
+const mockOutputPath = path.join(__dirname, "mock-dir-output");
+describe("Handler", () => {
+  beforeAll(async function Arrange() {
+    await rm(mockAssetDirectoryPath, { recursive: true, force: true });
+    await rm(mockOutputPath, { recursive: true, force: true });
+    await mkdir(mockAssetDirectoryPath);
+    await mkdir(mockOutputPath);
+  });
+
+  it("should fail in absence of path inputs ", async function () {
+    await expect(handler("", "")).rejects.toThrowError("undefined input path");
+    await expect(handler(undefined, undefined)).rejects.toThrowError("undefined input path");
+  });
+
+  it("should fail for invalid cdk asset path", async function () {
+    await expect(handler("invalidPath", mockOutputPath)).rejects.toThrowError(); // TODO check error thrown
+  });
+
+  it("should succeed if cdk assets not found", async function () {
+    await expect(handler(mockAssetDirectoryPath, "invalidPath")).resolves;
+  });
+
+  it("should fail for invalid output path", async function () {
+    // Arrange
+    const mockAssetPath = path.join(mockAssetDirectoryPath, "asset.cdkAsset.zip");
+    await writeFile(mockAssetPath, "NoOp");
+    // Act, Assert
+    await expect(handler(mockAssetDirectoryPath, "invalidPath")).rejects.toThrowError(); // TODO check error thrown
+  });
+
+  it("should succeed for valid paths", async function () {
+    await expect(handler(mockAssetDirectoryPath, mockOutputPath)).resolves;
+    // check for zip created
+  });
+
+  afterAll(async function Cleanup() {
+    // await rm(mockAssetDirectoryPath, { recursive: true, force: true });
+    // await rm(mockOutputPath, { recursive: true, force: true });
+  });
+});
+
+describe("CDKAssetPackager", () => {
+  beforeAll(function Arrange() {
+    // mock fs calls
+  });
+  describe("getAssetPaths", function () {
+    xit("should return empty array for invalid path", function () {});
+    xit("should return empty array when no assets found", function () {});
+    xit("should return array of paths when assets found", function () {});
+  });
+  describe("createAssetZip", function () {
+    xit("should skip doing anything if path not a folder", function () {});
+    xit("should zip assets in the folder for valid path", function () {});
+    xit("should throw error if error encountered", function () {});
+  });
+  describe("moveZip", function () {
+    xit("should move zips for valid paths", function () {});
+    xit("should throw error if error encountered", function () {});
+  });
+});

deployment/cdk-solution-helper/asset-packager/asset-packager.ts

@@ -7,14 +7,15 @@ import { readdir, lstat, rename } from "node:fs/promises";
 import path from "path";
 import AdmZip from "adm-zip";
 
-export class AssetPackager {
-  constructor(readonly cdkAssetPath: string) {}
-  async getCDKAssetFiles() {
+export class CDKAssetPackager {
+  constructor(private readonly assetFolderPath: string) {}
+
+  async getAssetPaths() {
     try {
-      const allFiles = await readdir(this.cdkAssetPath);
+      const allFiles = await readdir(this.assetFolderPath);
       const assetFilePaths = allFiles
         .filter((file) => file.includes("asset"))
-        .map((file) => path.join(this.cdkAssetPath, file));
+        .map((file) => path.join(this.assetFolderPath, file));
       return assetFilePaths;
     } catch (err) {
       console.error(err);
@@ -26,22 +27,23 @@ export class AssetPackager {
    * @description goes down 1 level deep to create zip
    * @param folderPath
    */
-  async createZip(folderPath: string) {
+  async createAssetZip(folderPath: string) {
     const isDir = (await lstat(folderPath)).isDirectory();
     if (isDir) {
       const zip = new AdmZip();
       const allFiles = await readdir(folderPath);
       for (const file of allFiles) zip.addLocalFile(path.join(folderPath, file));
-      const newName = `${folderPath.split("/").pop()?.split(".").pop()}.zip`;
-      zip.writeZip(path.join(this.cdkAssetPath, newName));
+      const zipName = `${folderPath.split("/").pop()}.zip`;
+      zip.writeZip(path.join(this.assetFolderPath, zipName));
     }
   }
 
   async moveZips(outputPath: string) {
-    const allFiles = await readdir(this.cdkAssetPath);
-    const allZips = allFiles.filter((file) => path.extname(file) === ".zip");
-    for (const zip of allZips) {
-      await rename(path.join(this.cdkAssetPath, zip), path.join(outputPath, zip));
+    const allFiles = await readdir(this.assetFolderPath);
+    const allZipPaths = allFiles.filter((file) => path.extname(file) === ".zip");
+    for (const zipPath of allZipPaths) {
+      await rename(path.join(this.assetFolderPath, zipPath), path.join(outputPath, zipPath.split("asset.").pop()!));
+      // remove cdk prepended string "asset.*"
     }
   }
 }

deployment/cdk-solution-helper/asset-packager/index.ts

@@ -1,19 +1,30 @@
-import { AssetPackager } from "./asset-packager";
-import * as path from "path";
-async function handler() {
-  const cdkAssetPath = process.argv[2];
-  const outputPath = process.argv[3];
-  const assetPackager = new AssetPackager(cdkAssetPath);
-  const assetFilePaths = await assetPackager.getCDKAssetFiles();
-  for (const path of assetFilePaths) {
-    await assetPackager.createZip(path);
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { CDKAssetPackager } from "./asset-packager";
+import path from "path";
+
+export async function handler(cdkAssetFolderPath: string | undefined, outputPath: string | undefined) {
+  if (!cdkAssetFolderPath || !outputPath) throw new Error("undefined input path");
+  const assetPackager = new CDKAssetPackager(cdkAssetFolderPath);
+  const assetPaths = await assetPackager.getAssetPaths();
+  for (const path of assetPaths) {
+    await assetPackager.createAssetZip(path);
   }
   await assetPackager.moveZips(outputPath);
 }
 
-handler()
-  .then(() => console.log("all assets packaged"))
-  .catch((err) => {
-    console.error(err);
-    throw err;
-  });
+if (require.main === module) {
+  // this module was run directly from the command line, getting command line arguments
+  // e.g. npx ts-node index.ts cdkAssetPath outputPath
+  const cdkAssetPath = process.argv[3];
+  const outputPath = process.argv[4];
+  handler(cdkAssetPath, outputPath)
+    .then(() => console.log("all assets packaged"))
+    .catch((err) => {
+      console.error(err);
+      throw err;
+    });
+}

deployment/cdk-solution-helper/jest.config.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { Config } from "jest";
+
+const config: Config = {
+  clearMocks: false,
+
+  collectCoverage: false,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  coveragePathIgnorePatterns: ["/node_modules/"],
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  moduleDirectories: ["node_modules"],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: ["ts", "json", "jsx", "js", "tsx", "node"],
+
+  // Automatically reset mock state between every test
+  resetMocks: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ["**/?(*.)+(spec|test).[t]s?(x)"],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: ["/node_modules/"],
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.(t)sx?$": "ts-jest",
+  },
+
+  // Indicates whether each individual test should be reported during the run
+  verbose: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  collectCoverageFrom: ["**/*.ts", "!**/*.spec.ts", "!./jest.config.ts", "!./jest.setup.ts"],
+
+  // A list of paths to modules that run some code to configure or set up the testing environment
+  // setupFiles: ["./jest.setup.ts"],
+
+  // coverageReporters: [["lcov", { projectRoot: "../" }], "text"],
+
+  rootDir: "./",
+};
+
+export default config;

deployment/cdk-solution-helper/package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "cdk-solution-helper",
   "version": "1.0.0",
-  "description": "helper to update references in cdk generated cfn template",
+  "description": "helper to update references in cdk generated cfn template and package lambda assets",
   "main": "index.js",
   "scripts": {
     "test": "jest"
@@ -10,6 +10,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/adm-zip": "^0.5.0",
+    "@types/jest": "^29.4.0",
     "@types/node": "^18.11.18",
     "jest": "^29.4.1",
     "ts-jest": "^29.0.5",

deployment/cdk-solution-helper/package.json

@@ -6,8 +6,14 @@
 import { writeFile } from "node:fs/promises";
 import { TemplateBuilder } from "./template-builder";
 
-async function handler() {
-  const CDKHelper = new TemplateBuilder(process.argv[2], process.argv[3], process.argv[4], process.argv[5]);
+export async function handler(
+  templatePath: string | undefined,
+  solutionName: string | undefined,
+  lambdaBucket: string | undefined,
+  version: string | undefined
+) {
+  if (!templatePath || !solutionName || !lambdaBucket || !version) throw new Error("undefined arguments");
+  const CDKHelper = new TemplateBuilder(templatePath, solutionName, lambdaBucket, version);
   const templatePaths = await CDKHelper.getTemplateFilePaths();
   for (const path of templatePaths) {
     const templateContents = await CDKHelper.parseJsonTemplate(path);
@@ -19,9 +25,17 @@ async function handler() {
   }
 }
 
-handler()
-  .then(() => console.log("written all cfn templates"))
-  .catch((err) => {
-    console.error(err);
-    throw err;
-  });
+if (require.main === module) {
+  // this module was run directly from the command line, getting command line arguments
+  // e.g. npx ts-node index.ts templatePath mySolution lambdaAssetBucketName myVersion
+  const templatePath = process.argv[3];
+  const solutionName = process.argv[4];
+  const lambdaBucketName = process.argv[5];
+  const version = process.argv[6];
+  handler(templatePath, solutionName, lambdaBucketName, version)
+    .then(() => console.log("written all cfn templates"))
+    .catch((err) => {
+      console.error(err);
+      throw err;
+    });
+}

deployment/cdk-solution-helper/template-builder/index.ts

@@ -3,4 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-// TODO add unit tests
+import { handler } from "./index";
+
+describe("Handler Tests", () => {
+  it("should ", async function () {
+    // Arrange, Act
+    // Assert
+  });
+});