feat: cicd (#27)

* feat: vpc on base stack

* feat: api execute task working

* docs: cicd ecr docs

* feat: deploy cicd lambdas

* fix: lambda name

* feat: improve tests and documentation

* chore: update faker number

* test: add more tests

* feat: pipelines first implementation

* feat: lambdas implementation

* fix: improve pr pipeline

* fix: update cicd commands

* feat: add close pr commands

.gitignore

@@ -110,4 +110,6 @@ node_modules/
 .cache/
 tmp_*
 storybook-static/
-package-lock.json
+package-lock.json
+
+github-app/

cicd/.gitignore

@@ -0,0 +1 @@
+ssh-key*

cicd/carlin.yml

@@ -0,0 +1,5 @@
+pipelines:
+  - pr
+  # - main
+sshKey: './ssh-key'
+sshUrl: [email protected]:ttoss/carlin.git

package.json

@@ -12,7 +12,6 @@
     "publish": "lerna publish && lerna run deploy --scope carlin-website",
     "version": "lerna version",
     "test": "lerna run test",
-    "build": "lerna run build",
     "deploy": "lerna run deploy"
   },
   "repository": {

packages/cli/jest.config.js

@@ -2,10 +2,10 @@ module.exports = {
   collectCoverage: true,
   coverageThreshold: {
     global: {
-      branches: 28,
-      functions: 37,
-      lines: 50,
-      statements: 53,
+      branches: 31,
+      functions: 51,
+      lines: 57,
+      statements: 60,
     },
   },
   preset: 'ts-jest',

packages/cli/package.json

@@ -24,42 +24,45 @@
   },
   "homepage": "https://github.com/ttoss/carlin#readme",
   "dependencies": {
-    "adm-zip": "^0.5.1",
+    "@octokit/webhooks": "^9.4.0",
+    "adm-zip": "^0.5.5",
     "app-root-path": "^3.0.0",
-    "aws-sdk": "^2.805.0",
-    "builtin-modules": "^3.1.0",
+    "aws-sdk": "^2.897.0",
+    "builtin-modules": "^3.2.0",
     "change-case": "^4.1.2",
     "deepmerge": "^4.2.2",
     "find-up": "^5.0.0",
     "glob": "^7.1.6",
-    "js-yaml": "^3.14.1",
-    "mime-types": "^2.1.29",
+    "js-yaml": "^4.1.0",
+    "mime-types": "^2.1.30",
     "npmlog": "^4.1.2",
     "prettier": "^2.2.1",
-    "semver": "^7.3.4",
-    "simple-git": "^2.25.0",
-    "ts-loader": "^8.0.14",
+    "semver": "^7.3.5",
+    "simple-git": "^2.38.0",
+    "ts-loader": "^9.1.1",
     "ts-node": "^9.1.1",
-    "typescript": "^4.1.2",
-    "uglify-js": "^3.13.0",
-    "webpack": "^5.15.0",
+    "typescript": "^4.2.4",
+    "uglify-js": "^3.13.5",
+    "webpack": "^5.36.2",
     "yargs": "^16.2.0"
   },
   "devDependencies": {
-    "@types/adm-zip": "^0.4.33",
+    "@types/adm-zip": "^0.4.34",
     "@types/app-root-path": "^1.2.4",
-    "@types/eslint": "^7.2.6",
-    "@types/faker": "^5.1.5",
-    "@types/jest": "^26.0.17",
-    "@types/js-yaml": "^3.12.5",
+    "@types/aws-lambda": "^8.10.76",
+    "@types/eslint": "^7.2.10",
+    "@types/faker": "^5.5.3",
+    "@types/jest": "^26.0.23",
+    "@types/js-yaml": "^4.0.1",
     "@types/mime-types": "^2.1.0",
-    "@types/node": "^14.14.10",
+    "@types/node": "^15.0.1",
     "@types/npmlog": "^4.1.2",
-    "@types/semver": "^7.3.4",
-    "@types/yargs": "^16.0.0",
-    "faker": "^5.1.0",
+    "@types/semver": "^7.3.5",
+    "@types/uglify-js": "^3.13.0",
+    "@types/yargs": "^16.0.1",
+    "faker": "^5.5.3",
     "jest": "^26.6.3",
-    "ts-jest": "^26.4.4"
+    "ts-jest": "^26.5.5"
   },
   "bin": {
     "carlin": "./bin/carlin"

packages/cli/src/cli.spec.ts

@@ -25,21 +25,50 @@ jest.mock('find-up', () => ({
     .mockReturnValueOnce(undefined),
 }));
 
-jest.mock('./deploy/staticApp/staticApp', () => ({
-  ...(jest.requireActual('./deploy/staticApp/staticApp') as any),
-  deployStaticApp: jest.fn(),
+jest.mock('./deploy/baseStack/deployBaseStack', () => ({
+  ...(jest.requireActual('./deploy/baseStack/deployBaseStack') as any),
+  deployBaseStack: jest.fn(),
 }));
 
 import { getCurrentBranch, getEnvironment, getProjectName } from './utils';
 
 import cli from './cli';
 
-import { deployStaticApp } from './deploy/staticApp/staticApp';
+import { deployBaseStack } from './deploy/baseStack/deployBaseStack';
 
 const parse = async (arg: any, context: any) => {
   return cli().strict(false).parse(arg, context);
 };
 
+describe('environment type', () => {
+  test('throw error if it is an object', () => {
+    expect(() =>
+      parse(`print-args`, {
+        environment: { obj: faker.random.word() },
+      }),
+    ).rejects.toThrow();
+  });
+
+  test('throw error if it is an array', () => {
+    expect(() =>
+      parse(`print-args`, {
+        environment: [faker.random.word()],
+      }),
+    ).rejects.toThrow();
+  });
+
+  test("don't throw error if it is a string", async () => {
+    const environment = faker.random.word();
+    const argv = await parse(`print-args`, { environment });
+    expect(argv.environment).toEqual(environment);
+  });
+
+  test("don't throw error if it is a string", async () => {
+    const argv = await parse(`print-args`, {});
+    expect(argv.environment).toBeUndefined();
+  });
+});
+
 describe('validating environment variables', () => {
   afterEach(() => {
     delete process.env.CARLIN_BRANCH;
@@ -96,11 +125,11 @@ describe('validating environment variables', () => {
 
 describe('handle merge config correctly', () => {
   describe('Config merging errors when default values is present #16 https://github.com/ttoss/carlin/issues/16', () => {
-    test('deploy static-app --region should not be the default', async () => {
-      await parse('deploy static-app', {
+    test('deploy base-stack --region should not be the default', async () => {
+      await parse('deploy base-stack', {
         environment: 'Production',
       });
-      expect(deployStaticApp).toHaveBeenCalledWith(
+      expect(deployBaseStack).toHaveBeenCalledWith(
         expect.objectContaining({ region }),
       );
     });

packages/cli/src/cli.ts

@@ -207,6 +207,18 @@ const cli = () => {
           });
         }
       }) as any)
+      /**
+       * Sometimes "environments" can be written as "environment" on config file.
+       */
+      .middleware(({ environment }) => {
+        if (!['string', 'undefined'].includes(typeof environment)) {
+          throw new Error(
+            `environment type is invalid. The value: ${JSON.stringify(
+              environment,
+            )}`,
+          );
+        }
+      })
       .pkgConf(getPkgConfig())
       .config(getConfig())
       .config('config', (configPath: string) =>

packages/cli/src/config.ts

@@ -1,3 +1,9 @@
 export const NAME = 'carlin';
 
 export const AWS_DEFAULT_REGION = 'us-east-1';
+
+/**
+ * CloudFront triggers can be only in US East (N. Virginia) Region.
+ * https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-cloudfront-triggers
+ */
+export const CLOUDFRONT_REGION = 'us-east-1';

packages/cli/src/deploy/baseStack/config.ts

@@ -2,32 +2,39 @@ import { pascalCase } from 'change-case';
 
 import { NAME } from '../../config';
 
-export const BASE_STACK_NAME = `${pascalCase(NAME)}BaseStack`;
+const pascalCaseName = pascalCase(NAME);
+
+export const BASE_STACK_NAME = `${pascalCaseName}BaseStack`;
 export const BASE_STACK_BUCKET_TEMPLATES_FOLDER = 'cloudformation-templates';
 
 /**
  * S3 Bucket.
  */
-export const BASE_STACK_BUCKET_LOGICAL_NAME = `${pascalCase(NAME)}Bucket`;
+export const BASE_STACK_BUCKET_LOGICAL_NAME = `${pascalCaseName}Bucket`;
 
-export const BASE_STACK_BUCKET_NAME_EXPORTED_NAME = `${pascalCase(
-  NAME,
-)}BucketNameExportedName`;
+export const BASE_STACK_BUCKET_NAME_EXPORTED_NAME = `${pascalCaseName}BucketNameExportedName`;
 
 /**
  * Lambda image builder.
  */
-export const BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = `${pascalCase(
-  NAME,
-)}LambdaImageBuilder`;
+export const BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaImageBuilder`;
 
-export const BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = `${pascalCase(
-  NAME,
-)}LambdaImageBuilderExportedName`;
+export const BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = `${pascalCaseName}LambdaImageBuilderExportedName`;
 
 /**
  * Lambda layer builder.
  */
-export const BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = `${pascalCase(
-  NAME,
-)}LambdaLayerBuilder`;
+export const BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaLayerBuilder`;
+
+/**
+ * VPC
+ */
+export const BASE_STACK_VPC_ID_EXPORTED_NAME = `${pascalCaseName}VPCIDExportedName`;
+
+export const BASE_STACK_VPC_DEFAULT_SECURITY_GROUP_EXPORTED_NAME = `${pascalCaseName}DefaultSecurityGroupExportedName`;
+
+export const BASE_STACK_VPC_PUBLIC_SUBNET_0_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet0ExportedName`;
+
+export const BASE_STACK_VPC_PUBLIC_SUBNET_1_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet1ExportedName`;
+
+export const BASE_STACK_VPC_PUBLIC_SUBNET_2_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet2ExportedName`;

packages/cli/src/deploy/baseStack/deployBaseStack.spec.ts

@@ -20,6 +20,7 @@ test('should create base resources', async () => {
 
   expect(deployMock).toHaveBeenCalledWith({
     template: expect.objectContaining({
+      AWSTemplateFormatVersion: '2010-09-09',
       Resources: expect.objectContaining({
         [BASE_STACK_BUCKET_LOGICAL_NAME]: expect.anything(),
         [BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME]: expect.anything(),