[#323] Move locals out of main file and create dedicated locals and data files

Author: tung-nimblehq

src/commands/generate/index.test.ts

@@ -65,9 +65,9 @@ describe('Generator command', () => {
           expect(postProcess).toHaveBeenCalledTimes(1);
         });
 
-        it('contains processed project name in main files', () => {
-          const mainFiles = ['shared/main.tf', 'core/main.tf'];
-          mainFiles.forEach((fileName) => {
+        it('contains processed project name in locals files', () => {
+          const localsFiles = ['shared/locals.tf', 'core/locals.tf'];
+          localsFiles.forEach((fileName) => {
             expect(processedDirectoryName).toHaveContentInFile(
               fileName,
               `project_name = "${processedDirectoryName}"`,

src/generators/addons/aws/index.ts

@@ -10,7 +10,6 @@ import {
   applyAwsRegion,
   applyAwsSecurityGroup,
   applyAwsVpc,
-  applyTerraformAwsData,
 } from './modules';
 
 const awsChoices = [
@@ -67,7 +66,6 @@ const generateAwsTemplate = async (
 
     case 'advanced':
       await applyProviderAndRegion(awsOptions);
-      await applyTerraformAwsData(awsOptions);
       await applyAwsVpc(awsOptions);
       await applyAwsSecurityGroup(awsOptions);
       await applyAwsIamUserAndGroup(awsOptions);

src/generators/addons/aws/modules/alb.ts

@@ -6,18 +6,64 @@ import {
   requireAwsModules,
 } from '@/generators/addons/aws/dependencies';
 import {
+  INFRA_CORE_DATA_PATH,
+  INFRA_CORE_LOCALS_PATH,
   INFRA_CORE_MAIN_PATH,
   INFRA_CORE_OUTPUTS_PATH,
   INFRA_CORE_VARIABLES_PATH,
+  MODULES_LOCALS_INDICATOR,
 } from '@/generators/terraform/constants';
-import { appendToFile, copy } from '@/helpers/file';
+import { appendToFile, copy, injectToFile } from '@/helpers/file';
 
 import {
   AWS_SECURITY_GROUP_MAIN_PATH,
   AWS_SECURITY_GROUP_OUTPUTS_PATH,
   AWS_TEMPLATE_PATH,
 } from '../constants';
 
+const albLocalesContent = dedent`
+    ###ALB Locals###
+    alb_s3_bucket_policy = {
+      Version = "2012-10-17"
+      Statement = [
+        {
+          Effect = "Allow"
+          Principal = {
+            AWS = [
+              "\${data.aws_elb_service_account.elb_service_account.arn}"
+            ]
+          }
+          Action   = "s3:PutObject"
+          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}/AWSLogs/*"
+        },
+        {
+          Effect = "Allow",
+          Principal = {
+            Service = "delivery.logs.amazonaws.com"
+          }
+          Action   = "s3:PutObject"
+          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}/AWSLogs/*",
+          Condition = {
+            StringEquals = {
+              "s3:x-amz-acl" = "bucket-owner-full-control"
+            }
+          }
+        },
+        {
+          Effect = "Allow",
+          Principal = {
+            Service = "delivery.logs.amazonaws.com"
+          }
+          Action   = "s3:GetBucketAcl"
+          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}"
+        }
+      ]
+    }`;
+
+const albDataContent = dedent`
+  ###ALB Locals###
+  data "aws_elb_service_account" "elb_service_account" {}`;
+
 const albVariablesContent = dedent`
   variable "health_check_path" {
     description = "Application health check path"
@@ -54,42 +100,7 @@ const albModuleContent = dedent`
     source = "../modules/s3/bucket_policy"
 
     s3_bucket_name = module.s3_alb_access_log.aws_s3_bucket_name
-    s3_bucket_policy = {
-      Version = "2012-10-17"
-      Statement = [
-        {
-          Effect = "Allow"
-          Principal = {
-            AWS = [
-              "\${data.aws_elb_service_account.elb_service_account.arn}"
-            ]
-          }
-          Action   = "s3:PutObject"
-          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}/AWSLogs/*"
-        },
-        {
-          Effect = "Allow",
-          Principal = {
-            Service = "delivery.logs.amazonaws.com"
-          }
-          Action   = "s3:PutObject"
-          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}/AWSLogs/*",
-          Condition = {
-            StringEquals = {
-              "s3:x-amz-acl" = "bucket-owner-full-control"
-            }
-          }
-        },
-        {
-          Effect = "Allow",
-          Principal = {
-            Service = "delivery.logs.amazonaws.com"
-          }
-          Action   = "s3:GetBucketAcl"
-          Resource = "arn:aws:s3:::\${module.s3_alb_access_log.aws_s3_bucket_name}"
-        }
-      ]
-    }
+    s3_bucket_policy = local.alb_s3_bucket_policy
   }`;
 
 const albOutputsContent = dedent`
@@ -155,6 +166,10 @@ const applyAwsAlb = async (options: AwsOptions) => {
   await requireAwsModules('alb', 'securityGroup', options);
 
   copy(`${AWS_TEMPLATE_PATH}/modules/alb`, 'modules/alb', options.projectName);
+  injectToFile(INFRA_CORE_LOCALS_PATH, albLocalesContent, options.projectName, {
+    insertAfter: MODULES_LOCALS_INDICATOR,
+  });
+  appendToFile(INFRA_CORE_DATA_PATH, albDataContent, options.projectName);
   appendToFile(INFRA_CORE_MAIN_PATH, albModuleContent, options.projectName);
   appendToFile(
     INFRA_CORE_VARIABLES_PATH,

src/generators/addons/aws/modules/core/data.test.ts

@@ -1,7 +1,6 @@
 import applyAwsAlb from './alb';
 import applyAwsBastion from './bastion';
 import applyAwsCloudwatch from './cloudwatch';
-import applyTerraformAwsData from './core/data';
 import applyAwsIamUserAndGroup from './core/iamUserAndGroup';
 import applyTerraformAwsProvider from './core/provider';
 import applyAwsRegion from './core/region';
@@ -17,7 +16,6 @@ export {
   applyAwsAlb,
   applyAwsBastion,
   applyTerraformAwsProvider,
-  applyTerraformAwsData,
   applyAwsCloudwatch,
   applyAwsEcr,
   applyAwsEcs,

src/generators/addons/aws/modules/core/data.ts

@@ -2,19 +2,30 @@ const INFRA_CORE_PATH = 'core/';
 const INFRA_CORE_MAIN_PATH = `${INFRA_CORE_PATH}/main.tf`;
 const INFRA_CORE_OUTPUTS_PATH = `${INFRA_CORE_PATH}/outputs.tf`;
 const INFRA_CORE_VARIABLES_PATH = `${INFRA_CORE_PATH}/variables.tf`;
+const INFRA_CORE_LOCALS_PATH = `${INFRA_CORE_PATH}/locals.tf`;
+const INFRA_CORE_DATA_PATH = `${INFRA_CORE_PATH}/data.tf`;
 
 const INFRA_SHARED_PATH = 'shared';
 const INFRA_SHARED_MAIN_PATH = `${INFRA_SHARED_PATH}/main.tf`;
 const INFRA_SHARED_OUTPUTS_PATH = `${INFRA_SHARED_PATH}/outputs.tf`;
 const INFRA_SHARED_VARIABLES_PATH = `${INFRA_SHARED_PATH}/variables.tf`;
+const INFRA_SHARED_LOCALS_PATH = `${INFRA_SHARED_PATH}/locals.tf`;
+const INFRA_SHARED_DATA_PATH = `${INFRA_SHARED_PATH}/data.tf`;
+
+const MODULES_LOCALS_INDICATOR = `### Modules Locals ###`;
 
 export {
   INFRA_CORE_PATH,
   INFRA_CORE_MAIN_PATH,
   INFRA_CORE_OUTPUTS_PATH,
   INFRA_CORE_VARIABLES_PATH,
+  INFRA_CORE_LOCALS_PATH,
+  INFRA_CORE_DATA_PATH,
   INFRA_SHARED_PATH,
   INFRA_SHARED_MAIN_PATH,
   INFRA_SHARED_OUTPUTS_PATH,
   INFRA_SHARED_VARIABLES_PATH,
+  INFRA_SHARED_LOCALS_PATH,
+  INFRA_SHARED_DATA_PATH,
+  MODULES_LOCALS_INDICATOR,
 };

src/generators/addons/aws/modules/index.ts

@@ -2,8 +2,10 @@ import { dedent } from 'ts-dedent';
 
 import { GeneralOptions } from '@/commands/generate';
 import {
-  INFRA_CORE_MAIN_PATH,
-  INFRA_SHARED_MAIN_PATH,
+  INFRA_CORE_LOCALS_PATH,
+  INFRA_SHARED_LOCALS_PATH,
+  INFRA_CORE_DATA_PATH,
+  MODULES_LOCALS_INDICATOR,
 } from '@/generators/terraform/constants';
 import { copy, rename, appendToFile } from '@/helpers/file';
 
@@ -13,13 +15,20 @@ const applyTerraformCore = async (generalOptions: GeneralOptions) => {
   copy('terraform/', '.', projectName);
 
   const coreLocalsContent = dedent`
-      locals {
-        project_name  = "${projectName}"
-        env_namespace = "\${local.project_name}-\${var.environment}"
-      }`;
+  locals {
+    project_name  = "${projectName}"
+    env_namespace = "\${local.project_name}-\${var.environment}"
 
-  appendToFile(INFRA_CORE_MAIN_PATH, coreLocalsContent, projectName);
-  appendToFile(INFRA_SHARED_MAIN_PATH, coreLocalsContent, projectName);
+    ${MODULES_LOCALS_INDICATOR}
+  }`;
+
+  const coreDatContent = dedent`
+  data "aws_caller_identity" "current" {}
+  data "aws_partition" "current" {}`;
+
+  appendToFile(INFRA_CORE_LOCALS_PATH, coreLocalsContent, projectName);
+  appendToFile(INFRA_SHARED_LOCALS_PATH, coreLocalsContent, projectName);
+  appendToFile(INFRA_CORE_DATA_PATH, coreDatContent, projectName);
 
   // Need to rename .gitignore to gitignore because NPN package doesn't include .gitignore
   // https://github.com/npm/npm/issues/3763