Merge pull request #106 from nimblehq/feature/63-add-terraform-addon

[#63] Add Terraform codebase

.github/workflows/test.yml

@@ -34,6 +34,7 @@ jobs:
         run: npm ci
 
       - name: Run tests
+        shell: bash
         run: npm run test '--ignore-scripts' -- --watchAll=false --coverage --ci
 
       - name: Upload test coverage

package.json

@@ -25,13 +25,13 @@
     "@oclif/plugin-plugins": "^2.0.1",
     "@types/dedent": "^0.7.0",
     "dedent": "^0.7.0",
-    "inquirer": "^9.1.0"
+    "inquirer": "^8.2.4"
   },
   "devDependencies": {
     "@nimblehq/eslint-config-nimble": "^2.4.0",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
-    "@types/inquirer": "^9.0.0",
+    "@types/inquirer": "^8.2.1",
     "@types/jest": "^28.1.6",
     "@types/node": "^18.7.6",
     "chai": "^4.3.6",

skeleton/addons/versionControl/github/.github/workflows/lint.yml

@@ -4,7 +4,7 @@ on:
   push:
 
 env:
-  TERRAFORM_VERSION: "1.2.4"
+  TERRAFORM_VERSION: "1.2.8"
 
 jobs:
   linting:

skeleton/core/.tool-versions

@@ -0,0 +1 @@
+terraform 1.2.8

skeleton/aws/main.tf → skeleton/core/main.tf

@@ -8,5 +8,5 @@ terraform {
   }
 
   # Terraform version
-  required_version = "~> 1.2.4"
+  required_version = "~> 1.2.8"
 }

skeleton/aws/variables.tf → skeleton/core/variables.tf

@@ -9,7 +9,7 @@ variable "owner" {
 }
 
 variable "namespace" {
-  description = "The namespace for the application infrastructure on AWS, e.g. acme-web"
+  description = "The namespace for the application infrastructure on the selected provider, e.g. acme-web"
   type        = string
 }
 

src/commands/generate/index.test.ts

@@ -51,6 +51,7 @@ describe('Generator command', () => {
         it('creates expected files', () => {
           const expectedFiles = [
             '.gitignore',
+            '.tool-versions',
             'main.tf',
             'variables.tf',
             'providers.tf',

src/commands/generate/index.ts

@@ -8,6 +8,7 @@ import {
   versionControlChoices,
 } from '../../templates/addons/versionControl';
 import { generateAwsTemplate } from '../../templates/aws';
+import { applyCore } from '../../templates/core';
 
 type GeneralOptions = {
   projectName: string;
@@ -59,7 +60,7 @@ export default class Generator extends Command {
     };
 
     try {
-      this.applyCore(generalOptions);
+      this.applyGeneralParts(generalOptions);
 
       switch (generalOptions.provider) {
         case 'aws':
@@ -79,7 +80,8 @@ export default class Generator extends Command {
     }
   }
 
-  private applyCore(generalOptions: GeneralOptions): void {
+  private applyGeneralParts(generalOptions: GeneralOptions): void {
+    applyCore(generalOptions);
     applyVersionControl(generalOptions);
   }
 

src/templates/addons/versionControl/index.test.ts

@@ -31,7 +31,6 @@ describe('Version control add-on', () => {
           '.github/PULL_REQUEST_TEMPLATE/release_template.md',
           '.github/workflows/lint.yml',
           '.github/PULL_REQUEST_TEMPLATE.md',
-          '.gitignore',
         ];
 
         expect(projectDir).toHaveFiles(expectedFiles);

src/templates/aws/addons/alb.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyAlb, {
   albModuleContent,
   albOutputsContent,
@@ -19,6 +20,7 @@ describe('ALB add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyAlb(awsOptions);
     });

src/templates/aws/addons/bastion.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyBastion, {
   bastionModuleContent,
   bastionVariablesContent,
@@ -18,6 +19,7 @@ describe('Bastion add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyBastion(awsOptions);
     });

src/templates/aws/addons/common.test.ts

@@ -22,15 +22,8 @@ describe('Common add-on', () => {
       remove('/', projectDir);
     });
 
-    it('creates expected files', () => {
-      const expectedFiles = [
-        'main.tf',
-        'providers.tf',
-        'outputs.tf',
-        'variables.tf',
-      ];
-
-      expect(projectDir).toHaveFiles(expectedFiles);
+    it('creates the expected file', () => {
+      expect(projectDir).toHaveFile('providers.tf');
     });
   });
 });

src/templates/aws/addons/common.ts

@@ -2,17 +2,7 @@ import { AwsOptions } from '..';
 import { copy } from '../../../helpers/file';
 
 const applyCommon = ({ projectName }: AwsOptions) => {
-  const filesToCopy = [
-    'main.tf',
-    'outputs.tf',
-    'providers.tf',
-    'variables.tf',
-    'README.md',
-  ];
-
-  filesToCopy.forEach((fileName) => {
-    copy(`aws/${fileName}`, fileName, projectName);
-  });
+  copy('aws/providers.tf', 'providers.tf', projectName);
 };
 
 export default applyCommon;

src/templates/aws/addons/ecr.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyEcr, { ecrModuleContent, ecrVariablesContent } from './ecr';
 
@@ -15,6 +16,7 @@ describe('ECR add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyEcr(awsOptions);
     });

src/templates/aws/addons/ecs.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyEcs, { ecsModuleContent, ecsVariablesContent } from './ecs';
 
@@ -15,6 +16,7 @@ describe('ECS add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyEcs(awsOptions);
     });

src/templates/aws/addons/log.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyLog, { logModuleContent } from './log';
 
@@ -15,6 +16,7 @@ describe('Log add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyLog(awsOptions);
     });

src/templates/aws/addons/rds.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyRds, { rdsModuleContent, rdsVariablesContent } from './rds';
 
@@ -15,6 +16,7 @@ describe('RDS add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyRds(awsOptions);
     });

src/templates/aws/addons/region.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyRegion, { regionVariablesContent } from './region';
 
@@ -16,6 +17,7 @@ describe('Region add-on', () => {
         awsRegion,
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyRegion(awsOptions);
     });

src/templates/aws/addons/s3.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyS3, { s3ModuleContent, s3OutputsContent } from './s3';
 
@@ -15,6 +16,7 @@ describe('S3 add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyS3(awsOptions);
     });

src/templates/aws/addons/securityGroup.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applySecurityGroup, {
   securityGroupModuleContent,
@@ -18,6 +19,7 @@ describe('Security group add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applySecurityGroup(awsOptions);
     });

src/templates/aws/addons/ssm.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applySsm, { ssmModuleContent, ssmVariablesContent } from './ssm';
 
@@ -15,6 +16,7 @@ describe('SSM add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applySsm(awsOptions);
     });

src/templates/aws/addons/vpc.test.ts

@@ -1,5 +1,6 @@
 import { AwsOptions } from '..';
 import { remove } from '../../../helpers/file';
+import { applyCore } from '../../core';
 import applyCommon from './common';
 import applyVpc, { vpcModuleContent, vpcOutputsContent } from './vpc';
 
@@ -15,6 +16,7 @@ describe('VPC add-on', () => {
         awsRegion: 'ap-southeast-1',
       };
 
+      applyCore(awsOptions);
       applyCommon(awsOptions);
       applyVpc(awsOptions);
     });

src/templates/core/index.test.ts

@@ -0,0 +1,37 @@
+import { applyCore } from '.';
+import { remove } from '../../helpers/file';
+import { AwsOptions } from '../aws';
+
+describe('Core codebase', () => {
+  describe('given valid AwsOptions', () => {
+    const projectDir = 'core-test';
+
+    beforeAll(() => {
+      const awsOptions: AwsOptions = {
+        projectName: projectDir,
+        provider: 'aws',
+        infrastructureType: 'advanced',
+        awsRegion: 'ap-southeast-1',
+      };
+
+      applyCore(awsOptions);
+    });
+
+    afterAll(() => {
+      jest.clearAllMocks();
+      remove('/', projectDir);
+    });
+
+    it('creates expected files', () => {
+      const expectedFiles = [
+        '.gitignore',
+        '.tool-versions',
+        'main.tf',
+        'outputs.tf',
+        'variables.tf',
+      ];
+
+      expect(projectDir).toHaveFiles(expectedFiles);
+    });
+  });
+});

src/templates/core/index.ts

@@ -0,0 +1,10 @@
+import { GeneralOptions } from '../../commands/generate';
+import { copy } from '../../helpers/file';
+
+const applyCore = (generalOptions: GeneralOptions): void => {
+  const { projectName } = generalOptions;
+
+  copy('core/', '.', projectName);
+};
+
+export { applyCore };