carlin 0.19.0

package/dist/config.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLOUDFRONT_REGION = exports.AWS_DEFAULT_REGION = exports.NAME = void 0;
+exports.NAME = 'carlin';
+exports.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
+ */
+exports.CLOUDFRONT_REGION = 'us-east-1';

package/dist/deploy/addDefaults.cloudFormation.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDefaults = void 0;
+const config_1 = require("../config");
+const utils_1 = require("../utils");
+const addDefaultsParametersAndTagsToParams = async (params) => {
+    const branchName = await utils_1.getCurrentBranch();
+    const environment = await utils_1.getEnvironment();
+    const packageName = await utils_1.getPackageName();
+    const packageVersion = await utils_1.getPackageVersion();
+    const projectName = await utils_1.getProjectName();
+    return {
+        ...params,
+        Parameters: [
+            ...(params.Parameters || []),
+            ...(environment
+                ? [{ ParameterKey: 'Environment', ParameterValue: environment }]
+                : []),
+            { ParameterKey: 'Project', ParameterValue: projectName },
+        ],
+        Tags: [
+            ...(params.Tags || []),
+            { Key: 'Branch', Value: branchName },
+            ...(environment ? [{ Key: 'Environment', Value: environment }] : []),
+            { Key: 'Package', Value: packageName },
+            { Key: 'Project', Value: projectName },
+            { Key: 'Version', Value: packageVersion },
+        ].filter(({ Value }) => !!Value),
+    };
+};
+const addDefaultParametersToTemplate = async (template) => {
+    const [environment, projectName] = await Promise.all([
+        utils_1.getEnvironment(),
+        utils_1.getProjectName(),
+    ]);
+    const newParameters = {
+        Project: { Default: projectName, Type: 'String' },
+    };
+    if (environment) {
+        newParameters.Environment = { Default: environment, Type: 'String' };
+    }
+    const newTemplate = {
+        ...template,
+        Parameters: { ...newParameters, ...template.Parameters },
+    };
+    return newTemplate;
+};
+const addLogGroupToResources = (template) => {
+    const { Resources } = template;
+    const resourcesEntries = Object.entries(Resources);
+    resourcesEntries.forEach(([key, resource]) => {
+        if (['AWS::Lambda::Function', 'AWS::Serverless::Function'].includes(resource.Type)) {
+            /**
+             * Check if exist a resource on template whose LogGroupName
+             * Properties includes the Lambda logical id.
+             */
+            const logGroup = resourcesEntries.find(([, resource2]) => {
+                var _a, _b;
+                const logGroupNameStr = JSON.stringify(((_b = (_a = resource2.Properties) === null || _a === void 0 ? void 0 : _a.LogGroupName) === null || _b === void 0 ? void 0 : _b['Fn::Join']) || '');
+                return logGroupNameStr.includes(key);
+            });
+            if (!logGroup) {
+                Resources[`${key}LogsLogGroup`] = {
+                    Type: 'AWS::Logs::LogGroup',
+                    DeletionPolicy: 'Delete',
+                    Properties: {
+                        LogGroupName: { 'Fn::Join': ['/', ['/aws/lambda', { Ref: key }]] },
+                    },
+                };
+            }
+        }
+    });
+    return template;
+};
+const addEnvironmentsToLambdaResources = async (template) => {
+    const environment = utils_1.getEnvironment();
+    const { Resources } = template;
+    const resourcesEntries = Object.entries(Resources);
+    resourcesEntries.forEach(([, resource]) => {
+        if (resource.Type === 'AWS::Lambda::Function') {
+            const { Properties } = resource;
+            /**
+             * Lambda@Edege does not support environment variables.
+             * https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-lambda-function-configuration
+             * Then every function that has "Lambda@Edge" in its description will not
+             * have the variables passed to Environment.Variables.
+             */
+            if ((Properties.Description || '').includes('Lambda@Edge')) {
+                return;
+            }
+            if (!environment) {
+                return;
+            }
+            if (!Properties.Environment) {
+                Properties.Environment = {};
+            }
+            if (!Properties.Environment.Variables) {
+                Properties.Environment.Variables = {};
+            }
+            Properties.Environment.Variables.ENVIRONMENT = environment;
+        }
+    });
+    return template;
+};
+const addAppSyncApiOutputs = async (template) => {
+    const newTemplate = { ...template };
+    Object.entries(template.Resources).forEach(([key, resource]) => {
+        if (resource.Type === 'AWS::AppSync::GraphQLApi') {
+            newTemplate.Outputs = {
+                [key]: {
+                    Description: `Automatically added by ${config_1.NAME}`,
+                    Value: { 'Fn::GetAtt': [key, 'GraphQLUrl'] },
+                    Export: {
+                        Name: {
+                            'Fn::Join': [':', [{ Ref: 'AWS::StackName' }, 'GraphQLApiUrl']],
+                        },
+                    },
+                },
+                ...newTemplate.Outputs,
+            };
+        }
+    });
+    return newTemplate;
+};
+const addDefaults = async ({ params, template, }) => {
+    const newTemplate = await [
+        addDefaultParametersToTemplate,
+        addLogGroupToResources,
+        addEnvironmentsToLambdaResources,
+        addAppSyncApiOutputs,
+    ].reduce(async (acc, addFn) => addFn(await acc), Promise.resolve(template));
+    const response = {
+        params: await addDefaultsParametersAndTagsToParams(params),
+        template: newTemplate,
+    };
+    return response;
+};
+exports.addDefaults = addDefaults;

package/dist/deploy/baseStack/command.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployBaseStackCommand = void 0;
+const deployBaseStack_1 = require("./deployBaseStack");
+exports.deployBaseStackCommand = {
+    command: 'base-stack',
+    describe: 'Create base resources.',
+    handler: deployBaseStack_1.deployBaseStack,
+};

package/dist/deploy/baseStack/config.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_STACK_VPC_PUBLIC_SUBNET_2_EXPORTED_NAME = exports.BASE_STACK_VPC_PUBLIC_SUBNET_1_EXPORTED_NAME = exports.BASE_STACK_VPC_PUBLIC_SUBNET_0_EXPORTED_NAME = exports.BASE_STACK_VPC_DEFAULT_SECURITY_GROUP_EXPORTED_NAME = exports.BASE_STACK_VPC_ID_EXPORTED_NAME = exports.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = exports.BASE_STACK_BUCKET_NAME_EXPORTED_NAME = exports.BASE_STACK_BUCKET_LOGICAL_NAME = exports.BASE_STACK_BUCKET_TEMPLATES_FOLDER = exports.BASE_STACK_NAME = void 0;
+const change_case_1 = require("change-case");
+const config_1 = require("../../config");
+const pascalCaseName = change_case_1.pascalCase(config_1.NAME);
+exports.BASE_STACK_NAME = `${pascalCaseName}BaseStack`;
+exports.BASE_STACK_BUCKET_TEMPLATES_FOLDER = 'cloudformation-templates';
+/**
+ * S3 Bucket.
+ */
+exports.BASE_STACK_BUCKET_LOGICAL_NAME = `${pascalCaseName}Bucket`;
+exports.BASE_STACK_BUCKET_NAME_EXPORTED_NAME = `${pascalCaseName}BucketNameExportedName`;
+/**
+ * Lambda image builder.
+ */
+exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaImageBuilder`;
+exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = `${pascalCaseName}LambdaImageBuilderExportedName`;
+/**
+ * Lambda layer builder.
+ */
+exports.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaLayerBuilder`;
+/**
+ * VPC
+ */
+exports.BASE_STACK_VPC_ID_EXPORTED_NAME = `${pascalCaseName}VPCIDExportedName`;
+exports.BASE_STACK_VPC_DEFAULT_SECURITY_GROUP_EXPORTED_NAME = `${pascalCaseName}DefaultSecurityGroupExportedName`;
+exports.BASE_STACK_VPC_PUBLIC_SUBNET_0_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet0ExportedName`;
+exports.BASE_STACK_VPC_PUBLIC_SUBNET_1_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet1ExportedName`;
+exports.BASE_STACK_VPC_PUBLIC_SUBNET_2_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet2ExportedName`;

package/dist/deploy/baseStack/deployBaseStack.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployBaseStack = exports.baseStackTemplate = void 0;
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const cloudFormation_core_1 = require("../cloudFormation.core");
+const utils_1 = require("../utils");
+const config_1 = require("./config");
+const getBucket_template_1 = require("./getBucket.template");
+const getLambdaImageBuilder_template_1 = require("./getLambdaImageBuilder.template");
+const getLambdaLayerBuilder_template_1 = require("./getLambdaLayerBuilder.template");
+const getVpc_template_1 = require("./getVpc.template");
+const logPrefix = 'base-stack';
+exports.baseStackTemplate = deepmerge_1.default.all([
+    getBucket_template_1.getBucketTemplate(),
+    getLambdaImageBuilder_template_1.getLambdaImageBuilderTemplate(),
+    getLambdaLayerBuilder_template_1.getLambdaLayerBuilderTemplate(),
+    getVpc_template_1.getVpcTemplate(),
+]);
+/**
+ * Base Stack is a set of auxiliary resources that will be used to help at the
+ * deployment time. The resources that will be created are listed below.
+ *
+ * - **S3 bucket**. Deployment may need an auxiliary bucket to succeed. For
+ * instance, to deploy resources that contain a
+ * [Lambda](https://carlin.ttoss.dev/docs/commands/deploy#lambda), we need a S3
+ * bucket to upload the zipped code. Or if the CloudFormation template has a
+ * size greater than [the limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html),
+ * we need to upload the template to a S3 bucket in order to create/update the
+ * stack.
+ *
+ * - **Lambda Layer builder**. This resource is a CodeBuild project that is
+ * used to create Lambda Layers when [--lambda-externals](/docs/api-reference/deploy#lambda-externals)
+ * has values.
+ *
+ * - **Lambda Image builder**. This resource is a CodeBuild project that builds
+ * Docker Images if Lambda is going to use them.
+ *
+ * - **VPC**. This resource is used when some network infrastructure is
+ * required. For example, CICD needs a VPC to execute the [Fargate](https://aws.amazon.com/fargate/)
+ * operations.
+ */
+const deployBaseStack = async () => {
+    try {
+        const { stackName } = await utils_1.handleDeployInitialization({
+            logPrefix,
+            stackName: config_1.BASE_STACK_NAME,
+        });
+        await cloudFormation_core_1.deploy({
+            template: exports.baseStackTemplate,
+            params: { StackName: stackName },
+            terminationProtection: true,
+        });
+    }
+    catch (error) {
+        utils_1.handleDeployError({ error, logPrefix });
+    }
+};
+exports.deployBaseStack = deployBaseStack;

package/dist/deploy/baseStack/getBaseStackResource.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBaseStackResource = exports.getBaseStackOutput = void 0;
+const cloudFormation_core_1 = require("../cloudFormation.core");
+const config_1 = require("./config");
+const getBaseStackOutput = async (outputKey) => {
+    const output = await cloudFormation_core_1.getStackOutput({
+        stackName: config_1.BASE_STACK_NAME,
+        outputKey,
+    });
+    return output.OutputValue;
+};
+exports.getBaseStackOutput = getBaseStackOutput;
+const resourcesKeys = {
+    BASE_STACK_BUCKET_LOGICAL_NAME: config_1.BASE_STACK_BUCKET_LOGICAL_NAME,
+    BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME: config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME,
+    BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME: config_1.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME,
+};
+const resources = {};
+const getBaseStackResource = async (resource) => {
+    if (!resources[resource]) {
+        resources[resource] = await exports.getBaseStackOutput(resourcesKeys[resource]);
+    }
+    return resources[resource];
+};
+exports.getBaseStackResource = getBaseStackResource;

package/dist/deploy/baseStack/getBucket.template.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBucketTemplate = void 0;
+const config_1 = require("./config");
+const getBucketTemplate = () => ({
+    AWSTemplateFormatVersion: '2010-09-09',
+    Resources: {
+        [config_1.BASE_STACK_BUCKET_LOGICAL_NAME]: {
+            Type: 'AWS::S3::Bucket',
+            DeletionPolicy: 'Retain',
+            Properties: {
+                LifecycleConfiguration: {
+                    Rules: [
+                        {
+                            ExpirationInDays: 1,
+                            Prefix: config_1.BASE_STACK_BUCKET_TEMPLATES_FOLDER,
+                            Status: 'Enabled',
+                        },
+                        {
+                            NoncurrentVersionExpirationInDays: 3,
+                            Status: 'Enabled',
+                        },
+                    ],
+                },
+                /**
+                 * This is necessary because if we update Lambda code without change
+                 * CloudFormation template, the Lambda will not be updated.
+                 */
+                VersioningConfiguration: {
+                    Status: 'Enabled',
+                },
+            },
+        },
+    },
+    Outputs: {
+        [config_1.BASE_STACK_BUCKET_LOGICAL_NAME]: {
+            Value: { Ref: config_1.BASE_STACK_BUCKET_LOGICAL_NAME },
+            Export: {
+                Name: config_1.BASE_STACK_BUCKET_NAME_EXPORTED_NAME,
+            },
+        },
+    },
+});
+exports.getBucketTemplate = getBucketTemplate;

package/dist/deploy/baseStack/getLambdaImageBuilder.template.js

@@ -0,0 +1,188 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLambdaImageBuilderTemplate = void 0;
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const utils_1 = require("../../utils");
+const config_1 = require("./config");
+const getLambdaImageBuilderTemplate = () => {
+    const CODE_BUILD_PROJECT_LOGS_LOGICAL_ID = 'CodeBuildProjectLogsLogGroup';
+    const CODE_BUILD_PROJECT_SERVICE_ROLE_LOGICAL_ID = 'ImageCodeBuildProjectIAMRole';
+    return {
+        AWSTemplateFormatVersion: '2010-09-09',
+        Resources: {
+            [CODE_BUILD_PROJECT_LOGS_LOGICAL_ID]: {
+                Type: 'AWS::Logs::LogGroup',
+                DeletionPolicy: 'Delete',
+                Properties: {},
+            },
+            [CODE_BUILD_PROJECT_SERVICE_ROLE_LOGICAL_ID]: {
+                Type: 'AWS::IAM::Role',
+                Properties: {
+                    AssumeRolePolicyDocument: {
+                        Version: '2012-10-17',
+                        Statement: [
+                            {
+                                Effect: 'Allow',
+                                Principal: {
+                                    Service: 'codebuild.amazonaws.com',
+                                },
+                                Action: 'sts:AssumeRole',
+                            },
+                        ],
+                    },
+                    Path: utils_1.getIamPath(),
+                    Policies: [
+                        {
+                            PolicyName: `${CODE_BUILD_PROJECT_SERVICE_ROLE_LOGICAL_ID}Policy`,
+                            PolicyDocument: {
+                                Version: '2012-10-17',
+                                Statement: [
+                                    {
+                                        Effect: 'Allow',
+                                        Action: ['logs:CreateLogStream', 'logs:PutLogEvents'],
+                                        Resource: '*',
+                                    },
+                                    {
+                                        Effect: 'Allow',
+                                        Action: ['ecr:GetAuthorizationToken'],
+                                        Resource: '*',
+                                    },
+                                    {
+                                        Effect: 'Allow',
+                                        Action: [
+                                            'ecr:BatchCheckLayerAvailability',
+                                            'ecr:CompleteLayerUpload',
+                                            'ecr:InitiateLayerUpload',
+                                            'ecr:PutImage',
+                                            'ecr:UploadLayerPart',
+                                        ],
+                                        Resource: '*',
+                                    },
+                                    {
+                                        Effect: 'Allow',
+                                        Action: 's3:GetObject',
+                                        Resource: [
+                                            {
+                                                'Fn::Sub': [
+                                                    // eslint-disable-next-line no-template-curly-in-string
+                                                    'arn:aws:s3:::${BucketName}/*',
+                                                    {
+                                                        BucketName: {
+                                                            Ref: config_1.BASE_STACK_BUCKET_LOGICAL_NAME,
+                                                        },
+                                                    },
+                                                ],
+                                            },
+                                        ],
+                                    },
+                                ],
+                            },
+                        },
+                    ],
+                },
+            },
+            [config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME]: {
+                Type: 'AWS::CodeBuild::Project',
+                Properties: {
+                    Artifacts: {
+                        Type: 'NO_ARTIFACTS',
+                    },
+                    Cache: {
+                        Location: 'LOCAL',
+                        Modes: ['LOCAL_DOCKER_LAYER_CACHE'],
+                        Type: 'LOCAL',
+                    },
+                    Description: 'Create Lambda image.',
+                    Environment: {
+                        ComputeType: 'BUILD_GENERAL1_SMALL',
+                        EnvironmentVariables: [
+                            {
+                                Name: 'AWS_ACCOUNT_ID',
+                                Value: { Ref: 'AWS::AccountId' },
+                            },
+                            {
+                                Name: 'AWS_REGION',
+                                Value: { Ref: 'AWS::Region' },
+                            },
+                            {
+                                Name: 'IMAGE_TAG',
+                                Value: 'latest',
+                            },
+                            {
+                                Name: 'LAMBDA_EXTERNALS',
+                                Value: '',
+                            },
+                        ],
+                        Image: 'aws/codebuild/standard:3.0',
+                        ImagePullCredentialsType: 'CODEBUILD',
+                        PrivilegedMode: true,
+                        Type: 'LINUX_CONTAINER',
+                    },
+                    LogsConfig: {
+                        CloudWatchLogs: {
+                            Status: 'ENABLED',
+                            GroupName: { Ref: CODE_BUILD_PROJECT_LOGS_LOGICAL_ID },
+                        },
+                    },
+                    ServiceRole: {
+                        'Fn::GetAtt': [CODE_BUILD_PROJECT_SERVICE_ROLE_LOGICAL_ID, 'Arn'],
+                    },
+                    Source: {
+                        BuildSpec: js_yaml_1.default.dump({
+                            version: '0.2',
+                            phases: {
+                                install: {
+                                    commands: [
+                                        'echo install started on `date`',
+                                        'npm init -y',
+                                        /**
+                                         * https://stackoverflow.com/a/51433146/8786986
+                                         */
+                                        'npm install --save --package-lock-only --no-package-lock $LAMBDA_EXTERNALS',
+                                        'ls',
+                                    ],
+                                },
+                                pre_build: {
+                                    commands: [
+                                        'echo pre_build started on `date`',
+                                        '$(aws ecr get-login --no-include-email --region $AWS_REGION)',
+                                    ],
+                                },
+                                build: {
+                                    commands: [
+                                        'echo build started on `date`',
+                                        'echo Building the repository image...',
+                                        'echo "$DOCKERFILE" > Dockerfile',
+                                        'docker build -t $REPOSITORY_ECR_REPOSITORY:$IMAGE_TAG -f Dockerfile .',
+                                        'docker tag $REPOSITORY_ECR_REPOSITORY:$IMAGE_TAG $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$REPOSITORY_ECR_REPOSITORY:$IMAGE_TAG',
+                                    ],
+                                },
+                                post_build: {
+                                    commands: [
+                                        'echo post_build completed on `date`',
+                                        'echo Pushing the repository image...',
+                                        'docker push $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$REPOSITORY_ECR_REPOSITORY:$IMAGE_TAG',
+                                    ],
+                                },
+                            },
+                        }),
+                        Type: 'NO_SOURCE',
+                    },
+                    TimeoutInMinutes: 60,
+                },
+            },
+        },
+        Outputs: {
+            [config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME]: {
+                Value: { Ref: config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME },
+                Export: {
+                    Name: config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME,
+                },
+            },
+        },
+    };
+};
+exports.getLambdaImageBuilderTemplate = getLambdaImageBuilderTemplate;