chore: code refactor, tests

Author: radekl

__tests__/main.test.ts

@@ -1389,6 +1389,53 @@ describe('Deploy CloudFormation Stack', () => {
     expect(mockCfnClient).toHaveReceivedCommandTimes(ExecuteChangeSetCommand, 0)
   })
 
+  test('deploys the stack with template', async () => {
+    const inputs: Inputs = {
+      name: 'MockStack',
+      template: 'template.yaml',
+      capabilities: 'CAPABILITY_IAM',
+      'parameter-overrides': 'AdminEmail=no-reply@amazon.com',
+      'envs-prefix-for-parameter-overrides': 'CFD_',
+      'no-fail-on-empty-changeset': '0',
+      'disable-rollback': '0',
+      'timeout-in-minutes': '',
+      'notification-arns': '',
+      'role-arn': '',
+      tags: '',
+      'termination-protection': ''
+    }
+
+    jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
+      return inputs[name]
+    })
+
+    process.env = Object.assign(process.env, { CFD_AdminNickname: 'root' })
+
+    await run()
+
+    expect(core.setFailed).toHaveBeenCalledTimes(0)
+    expect(mockDescribeStacks).toHaveBeenCalledTimes(2)
+    expect(mockDescribeStacks).toHaveBeenNthCalledWith(1, {
+      StackName: 'MockStack'
+    })
+    expect(mockDescribeStacks).toHaveBeenNthCalledWith(2, {
+      StackName: mockStackId
+    })
+    expect(mockCreateStack).toHaveBeenNthCalledWith(1, {
+      StackName: 'MockStack',
+      TemplateBody: mockTemplate,
+      Capabilities: ['CAPABILITY_IAM'],
+      Parameters: [
+        { ParameterKey: 'AdminEmail', ParameterValue: 'no-reply@amazon.com' },
+        { ParameterKey: 'AdminNickname', ParameterValue: 'root' }
+      ],
+      DisableRollback: false,
+      EnableTerminationProtection: false
+    })
+    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+  })
+
   test('error is caught by core.setFailed', async () => {
     mockCfnClient.reset().on(DescribeStacksCommand).rejects(new Error())
 

__tests__/utils.test.ts

@@ -1,4 +1,9 @@
-import { parseTags, isUrl, parseParameters } from '../src/utils'
+import {
+  parseTags,
+  isUrl,
+  parseParameters,
+  parseParametersFromEnvs
+} from '../src/utils'
 import * as path from 'path'
 
 jest.mock('@actions/core')
@@ -119,6 +124,30 @@ describe('Parse Parameters', () => {
     ])
   })
 
+  test('returns parameters list from envs if envsPrefixForParameterOverrides is defined', async () => {
+    const mockEnvs = {
+      CFD_MyParam1: 'myValue1',
+      CFD_MyParam2: 'myValue2',
+      USER: 'test',
+      PATH: '/bin:/usr/local/bin',
+      HOME: '/home/test',
+      AWS_PAGER: ''
+    }
+    const envsPrefix = 'CFD_'
+
+    const json = parseParametersFromEnvs(envsPrefix, mockEnvs)
+    expect(json).toEqual([
+      {
+        ParameterKey: 'MyParam1',
+        ParameterValue: 'myValue1'
+      },
+      {
+        ParameterKey: 'MyParam2',
+        ParameterValue: 'myValue2'
+      }
+    ])
+  })
+
   test('throws error if file is not found', async () => {
     const filename = 'file://' + path.join(__dirname, 'params.tezt.json')
     expect(() => parseParameters(filename)).toThrow()

dist/index.js

@@ -227,7 +227,6 @@ let clientConfiguration = {
     customUserAgent: 'aws-cloudformation-github-deploy-for-github-actions'
 };
 function run() {
-    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const { GITHUB_WORKSPACE = __dirname } = process.env;
@@ -243,7 +242,7 @@ function run() {
             const parameterOverrides = core.getInput('parameter-overrides', {
                 required: false
             });
-            const envsPrefixForparameterOverrides = core.getInput('envs-prefix-for-parameter-overrides', {
+            const envsPrefixForParameterOverrides = core.getInput('envs-prefix-for-parameter-overrides', {
                 required: false
             });
             const noEmptyChangeSet = !!+core.getInput('no-fail-on-empty-changeset', {
@@ -320,13 +319,11 @@ function run() {
             if (parameterOverrides) {
                 params.Parameters = (0, utils_1.parseParameters)(parameterOverrides.trim());
             }
-            if (envsPrefixForparameterOverrides.length > 0) {
-                (_a = params.Parameters) === null || _a === void 0 ? void 0 : _a.concat(Object.keys(process.env)
-                    .filter(key => key.startsWith(envsPrefixForparameterOverrides))
-                    .map(key => ({
-                    ParameterKey: key,
-                    ParameterValue: process.env[key]
-                })));
+            if (envsPrefixForParameterOverrides.length > 0) {
+                const envParameters = (0, utils_1.parseParametersFromEnvs)(envsPrefixForParameterOverrides, process.env);
+                params.Parameters = params.Parameters
+                    ? [...params.Parameters, ...envParameters]
+                    : envParameters;
             }
             const stackId = yield (0, deploy_1.deployStack)(cfn, params, noEmptyChangeSet, noExecuteChangeSet, noDeleteFailedChangeSet);
             core.setOutput('stack-id', stackId || 'UNKNOWN');
@@ -383,7 +380,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.configureProxy = exports.parseParameters = exports.parseNumber = exports.parseString = exports.parseARNs = exports.parseTags = exports.isUrl = void 0;
+exports.configureProxy = exports.parseParametersFromEnvs = exports.parseParameters = exports.parseNumber = exports.parseString = exports.parseARNs = exports.parseTags = exports.isUrl = void 0;
+const aws = __importStar(__nccwpck_require__(71786));
 const fs = __importStar(__nccwpck_require__(57147));
 const https_proxy_agent_1 = __nccwpck_require__(77219);
 function isUrl(s) {
@@ -455,6 +453,16 @@ function parseParameters(parameterOverrides) {
     });
 }
 exports.parseParameters = parseParameters;
+function parseParametersFromEnvs(prefix, envs) {
+    const parameters = Object.keys(envs)
+        .filter(key => key.startsWith(prefix))
+        .map(key => ({
+        ParameterKey: key.substring(prefix.length),
+        ParameterValue: envs[key]
+    }));
+    return parameters;
+}
+exports.parseParametersFromEnvs = parseParametersFromEnvs;
 function configureProxy(proxyServer) {
     const proxyFromEnv = process.env.HTTP_PROXY || process.env.http_proxy;
     if (proxyFromEnv || proxyServer) {

src/main.ts

@@ -15,7 +15,8 @@ import {
   parseNumber,
   parseARNs,
   parseParameters,
-  configureProxy
+  configureProxy,
+  parseParametersFromEnvs
 } from './utils'
 import { NodeHttpHandler } from '@smithy/node-http-handler'
 
@@ -52,9 +53,12 @@ export async function run(): Promise<void> {
     const parameterOverrides = core.getInput('parameter-overrides', {
       required: false
     })
-    const envsPrefixForparameterOverrides = core.getInput('envs-prefix-for-parameter-overrides', {
-      required: false
-    })
+    const envsPrefixForParameterOverrides = core.getInput(
+      'envs-prefix-for-parameter-overrides',
+      {
+        required: false
+      }
+    )
     const noEmptyChangeSet = !!+core.getInput('no-fail-on-empty-changeset', {
       required: false
     })
@@ -153,14 +157,14 @@ export async function run(): Promise<void> {
       params.Parameters = parseParameters(parameterOverrides.trim())
     }
 
-    if (envsPrefixForparameterOverrides.length > 0) {
-      params.Parameters?.concat(
-        Object.keys(process.env)
-          .filter(key => key.startsWith(envsPrefixForparameterOverrides))
-          .map(key => ({
-            ParameterKey: key,
-            ParameterValue: process.env[key]
-          })))
+    if (envsPrefixForParameterOverrides.length > 0) {
+      const envParameters = parseParametersFromEnvs(
+        envsPrefixForParameterOverrides,
+        process.env
+      )
+      params.Parameters = params.Parameters
+        ? [...params.Parameters, ...envParameters]
+        : envParameters
     }
 
     const stackId = await deployStack(

src/utils.ts

@@ -78,9 +78,22 @@ export function parseParameters(parameterOverrides: string): Parameter[] {
   })
 }
 
-export function configureProxy(
-  proxyServer: string | undefined
-): HttpsProxyAgent | undefined {
+type Envs = { [k: string]: string | undefined }
+
+export function parseParametersFromEnvs(
+  prefix: string,
+  envs: Envs
+): Parameter[] {
+  const parameters: Parameter[] = Object.keys(envs)
+    .filter(key => key.startsWith(prefix))
+    .map(key => ({
+      ParameterKey: key.substring(prefix.length),
+      ParameterValue: envs[key]
+    }))
+  return parameters
+}
+
+export function configureProxy(proxyServer: string | undefined) {
   const proxyFromEnv = process.env.HTTP_PROXY || process.env.http_proxy
 
   if (proxyFromEnv || proxyServer) {