carlin 1.19.11 → 1.19.13

package/dist/generateEnv/generateEnv.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEnv = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const utils_1 = require("../utils");
+const npmlog_1 = tslib_1.__importDefault(require("npmlog"));
+const logPrefix = 'generate-env';
+const getEnvFilePath = ({ envFileName }) => {
+    return path.resolve(process.cwd(), envFileName);
+};
+const readEnvFile = async ({ envFileName }) => {
+    try {
+        const content = await fs.promises.readFile(getEnvFilePath({ envFileName }), 'utf8');
+        return content;
+    }
+    catch {
+        npmlog_1.default.info(logPrefix, "Env file %s doesn't exist.", envFileName);
+        return undefined;
+    }
+};
+const writeEnvFile = async ({ envFileName, content, }) => {
+    return fs.promises.writeFile(getEnvFilePath({ envFileName }), content);
+};
+/**
+ * Generate environment for packages using `carlin`. If [environment](/docs/CLI#environment)
+ * isn't production, `carlin` will read `.env` file if exists, merge with
+ * additional environment variables and write the result to `.env.local` file. If it's `Production`,
+ * it'll read `.env.production` file instead.
+ *
+ * We chose the name `.env.local` because it works for [Next.js](https://nextjs.org/docs/basic-features/environment-variables)
+ * and [CRA](https://create-react-app.dev/docs/adding-custom-environment-variables/#what-other-env-files-can-be-used) projects.
+ */
+const generateEnv = async () => {
+    const environment = (0, utils_1.getEnvironment)();
+    const isProduction = (environment === null || environment === void 0 ? void 0 : environment.toLocaleLowerCase()) === 'production';
+    const envFileName = isProduction ? '.env.production' : '.env';
+    const envFile = await readEnvFile({ envFileName });
+    if (!envFile) {
+        return;
+    }
+    await writeEnvFile({ content: envFile, envFileName: '.env.local' });
+    npmlog_1.default.info(logPrefix, 'Generate env file %s from %s successfully.', '.env.local', envFileName);
+};
+exports.generateEnv = generateEnv;

package/dist/generateEnv/generateEnvCommand.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEnvCommand = void 0;
+const generateEnv_1 = require("./generateEnv");
+exports.generateEnvCommand = {
+    command: 'generate-env',
+    describe: 'Generate environment files.',
+    handler: generateEnv_1.generateEnv,
+};

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const cli_1 = tslib_1.__importDefault(require("./cli"));
+(0, cli_1.default)().parse();

package/dist/utils/addGroupToOptions.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addGroupToOptions = void 0;
+const addGroupToOptions = (options, group) => {
+    Object.values(options).forEach((option) => {
+        // eslint-disable-next-line no-param-reassign
+        option.group = group;
+    });
+    return options;
+};
+exports.addGroupToOptions = addGroupToOptions;

package/dist/utils/cloudFormationTemplate.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCloudFormationTemplate = exports.dumpToYamlCloudFormationTemplate = exports.getSchema = void 0;
+const tslib_1 = require("tslib");
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const cloudFormationTypes = [
+    {
+        tag: '!Equals',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::Equals': data };
+            },
+        },
+    },
+    {
+        tag: '!FindInMap',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::FindInMap': data };
+            },
+        },
+    },
+    {
+        tag: '!GetAtt',
+        options: {
+            kind: 'scalar',
+            construct: (data) => {
+                return { 'Fn::GetAtt': data.split('.') };
+            },
+        },
+    },
+    {
+        tag: '!GetAtt',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::GetAtt': data };
+            },
+        },
+    },
+    {
+        tag: '!If',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::If': data };
+            },
+        },
+    },
+    {
+        tag: '!ImportValue',
+        options: {
+            kind: 'scalar',
+            construct: (data) => {
+                return { 'Fn::ImportValue': data };
+            },
+        },
+    },
+    {
+        tag: '!Join',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::Join': data };
+            },
+        },
+    },
+    {
+        tag: '!Not',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::Not': data };
+            },
+        },
+    },
+    {
+        tag: '!Ref',
+        options: {
+            kind: 'scalar',
+            construct: (data) => {
+                return { Ref: data };
+            },
+        },
+    },
+    {
+        tag: '!Sub',
+        options: {
+            kind: 'scalar',
+            construct: (data) => {
+                return { 'Fn::Sub': data };
+            },
+        },
+    },
+    {
+        tag: '!Sub',
+        options: {
+            kind: 'sequence',
+            construct: (data) => {
+                return { 'Fn::Sub': data };
+            },
+        },
+    },
+];
+const getYamlTypes = (tagAndTypeArr) => tagAndTypeArr.map(({ tag, options }) => new js_yaml_1.default.Type(tag, options));
+/**
+ * Transform CloudFormation directives in objects. For example, transform
+ * !Ref Something in { Ref: Something }.
+ */
+const getSchema = (tagAndTypeArr = []) => js_yaml_1.default.DEFAULT_SCHEMA.extend(getYamlTypes([...tagAndTypeArr, ...cloudFormationTypes]));
+exports.getSchema = getSchema;
+/**
+ * Transform a JSON in a YAML string.
+ *
+ * @param cloudFormationTemplate JSON CloudFormation template
+ * @returns YAML as string
+ */
+const dumpToYamlCloudFormationTemplate = (cloudFormationTemplate) => js_yaml_1.default.dump(cloudFormationTemplate, { schema: (0, exports.getSchema)() });
+exports.dumpToYamlCloudFormationTemplate = dumpToYamlCloudFormationTemplate;
+/**
+ * Transform YAML string in JSON object.
+ *
+ * @param template template in String format.
+ * @param tagAndTypeArr YAML types.
+ * @returns JSON template.
+ */
+const loadCloudFormationTemplate = (template, tagAndTypeArr = []) => {
+    return js_yaml_1.default.load(template, { schema: (0, exports.getSchema)(tagAndTypeArr) });
+};
+exports.loadCloudFormationTemplate = loadCloudFormationTemplate;

package/dist/utils/codeBuild.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startCodeBuildBuild = exports.waitCodeBuildFinish = void 0;
+const tslib_1 = require("tslib");
+const aws_sdk_1 = require("aws-sdk");
+const npmlog_1 = tslib_1.__importDefault(require("npmlog"));
+const logPrefix = 'codebuild';
+const WAIT_TIME = 10 * 1000;
+/**
+ * @param param.name name used to identify the build.
+ */
+const waitCodeBuildFinish = async ({ buildId, name, }) => {
+    const codeBuild = new aws_sdk_1.CodeBuild();
+    let result;
+    const checkIfBuildIsFinished = async () => {
+        const { builds } = await codeBuild
+            .batchGetBuilds({ ids: [buildId] })
+            .promise();
+        return new Promise((resolve, reject) => {
+            setTimeout(() => {
+                const executedBuild = builds === null || builds === void 0 ? void 0 : builds.find(({ id }) => id === buildId);
+                npmlog_1.default.info(logPrefix, `Build status of ${name || buildId}: ${executedBuild === null || executedBuild === void 0 ? void 0 : executedBuild.buildStatus}`);
+                if (executedBuild && executedBuild.currentPhase === 'COMPLETED') {
+                    if (executedBuild.buildStatus === 'SUCCEEDED') {
+                        resolve(executedBuild);
+                    }
+                    else if (['FAILED', 'FAILURE'].includes(executedBuild.buildStatus || '')) {
+                        reject(new Error(`Cannot execute build ${buildId}.`));
+                    }
+                }
+                resolve(undefined);
+            }, WAIT_TIME);
+        });
+    };
+    while (!result) {
+        // eslint-disable-next-line no-await-in-loop
+        result = await checkIfBuildIsFinished();
+    }
+    return result;
+};
+exports.waitCodeBuildFinish = waitCodeBuildFinish;
+const startCodeBuildBuild = async ({ projectName, }) => {
+    const codeBuild = new aws_sdk_1.CodeBuild();
+    const { build } = await codeBuild.startBuild({ projectName }).promise();
+    if (!build) {
+        throw new Error(`Cannot start ${projectName} build`);
+    }
+    return build;
+};
+exports.startCodeBuildBuild = startCodeBuildBuild;

package/dist/utils/environmentVariables.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setEnvVar = exports.getEnvVar = exports.cache = void 0;
+const cache = new Map();
+exports.cache = cache;
+const getEnvVar = (key) => {
+    return cache.has(key) && cache.get(key) ? cache.get(key) : undefined;
+};
+exports.getEnvVar = getEnvVar;
+const setEnvVar = (key, value) => cache.set(key, value);
+exports.setEnvVar = setEnvVar;

package/dist/utils/exec.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exec = void 0;
+const tslib_1 = require("tslib");
+const child_process_1 = tslib_1.__importDefault(require("child_process"));
+const npmlog_1 = tslib_1.__importDefault(require("npmlog"));
+npmlog_1.default.heading = 'exec';
+const exec = (cmd) => new Promise((resolve, reject) => {
+    child_process_1.default.exec(cmd, (error, stdout, stderr) => {
+        if (error) {
+            return reject(error);
+        }
+        if (stdout) {
+            return resolve(stdout);
+        }
+        if (stderr) {
+            return reject(stderr);
+        }
+        return resolve(undefined);
+    });
+});
+exports.exec = exec;

package/dist/utils/formatCode.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uglify = exports.formatCode = void 0;
+const tslib_1 = require("tslib");
+const UglifyJS = tslib_1.__importStar(require("uglify-js"));
+const prettier = tslib_1.__importStar(require("prettier"));
+const formatCode = (code) => {
+    return prettier.format(code, { parser: 'babel' });
+};
+exports.formatCode = formatCode;
+const uglify = (code) => UglifyJS.minify(code).code;
+exports.uglify = uglify;

package/dist/utils/getAwsAccountId.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAwsAccountId = void 0;
+const aws_sdk_1 = require("aws-sdk");
+const getAwsAccountId = async () => {
+    const sts = new aws_sdk_1.STS();
+    const { Account } = await sts.getCallerIdentity().promise();
+    return Account;
+};
+exports.getAwsAccountId = getAwsAccountId;

package/dist/utils/getCurrentBranch.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentBranch = exports.BRANCH_UNDEFINED = void 0;
+const tslib_1 = require("tslib");
+const environmentVariables_1 = require("./environmentVariables");
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
+exports.BRANCH_UNDEFINED = '';
+/**
+ * Git current branch is used to determine the name of the stack when deploying
+ * resources. If we provide a `CARLIN_BRANCH` through `process.env` or by
+ * options, these values will be used instead of Git current branch. Example:
+ *
+ * ```
+ * CARLIN_BRANCH=branch-name carlin deploy --destroy
+ * carlin deploy --destroy --branch=branch-name
+ * ```
+ *
+ * This parameters is useful when you need to delete a deployment related to
+ * some branch but such branch has already beed deleted.
+ */
+const getCurrentBranch = async () => {
+    try {
+        if ((0, environmentVariables_1.getEnvVar)('BRANCH')) {
+            return (0, environmentVariables_1.getEnvVar)('BRANCH');
+        }
+        const { current } = await (0, simple_git_1.default)().branch();
+        return current || exports.BRANCH_UNDEFINED;
+    }
+    catch (err) {
+        return exports.BRANCH_UNDEFINED;
+    }
+};
+exports.getCurrentBranch = getCurrentBranch;

package/dist/utils/getEnvironment.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvironment = void 0;
+const environmentVariables_1 = require("./environmentVariables");
+const getEnvironment = () => (0, environmentVariables_1.getEnvVar)('ENVIRONMENT');
+exports.getEnvironment = getEnvironment;

package/dist/utils/getIamPath.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIamPath = void 0;
+const config_1 = require("../config");
+const getIamPath = () => `/${config_1.NAME}/`;
+exports.getIamPath = getIamPath;

package/dist/utils/getProjectName.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectName = void 0;
+const environmentVariables_1 = require("./environmentVariables");
+const packageJson_1 = require("./packageJson");
+const change_case_1 = require("change-case");
+/**
+ * This variable is used to determine the name of the whole project. If the
+ * project is a monorepo, the project name is considered as the
+ * [scope](https://docs.npmjs.com/cli/v7/using-npm/scope) of the `package.json`
+ * name property. If isn't a monorepo, is considered the package name.
+ *
+ * This variable is used to set some properties on CloudFormation tags and
+ * defining the name of some stacks, for instance, the CICD stack.
+ */
+const getProjectName = () => {
+    if ((0, environmentVariables_1.getEnvVar)('PROJECT')) {
+        return (0, environmentVariables_1.getEnvVar)('PROJECT');
+    }
+    const name = (0, packageJson_1.getPackageName)();
+    /**
+     * This case happens when user executes `carlin` outside of project.
+     * Even commands like `carlin --help` raise an error.
+     */
+    if (!name) {
+        return '';
+    }
+    try {
+        return (0, change_case_1.pascalCase)(name.split(/[@/]/)[1]);
+    }
+    catch (err) {
+        return (0, change_case_1.pascalCase)(name);
+    }
+};
+exports.getProjectName = getProjectName;

package/dist/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./addGroupToOptions"), exports);
+tslib_1.__exportStar(require("./codeBuild"), exports);
+tslib_1.__exportStar(require("./cloudFormationTemplate"), exports);
+tslib_1.__exportStar(require("./environmentVariables"), exports);
+tslib_1.__exportStar(require("./exec"), exports);
+tslib_1.__exportStar(require("./formatCode"), exports);
+tslib_1.__exportStar(require("./getAwsAccountId"), exports);
+tslib_1.__exportStar(require("./getCurrentBranch"), exports);
+tslib_1.__exportStar(require("./getEnvironment"), exports);
+tslib_1.__exportStar(require("./getIamPath"), exports);
+tslib_1.__exportStar(require("./getProjectName"), exports);
+tslib_1.__exportStar(require("./packageJson"), exports);
+tslib_1.__exportStar(require("./readCloudFormationTemplate"), exports);
+tslib_1.__exportStar(require("./readObjectFile"), exports);

package/dist/utils/packageJson.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackageVersion = exports.getPackageName = void 0;
+const tslib_1 = require("tslib");
+const find_up_1 = tslib_1.__importDefault(require("find-up"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const readPackageJson = () => {
+    const packageJsonDir = find_up_1.default.sync('package.json');
+    if (!packageJsonDir) {
+        return {};
+    }
+    return JSON.parse(fs_1.default.readFileSync(packageJsonDir).toString());
+};
+const getPackageJsonProperty = ({ property }) => {
+    try {
+        return readPackageJson()[property];
+    }
+    catch {
+        return '';
+    }
+};
+const getPackageName = () => getPackageJsonProperty({ property: 'name' });
+exports.getPackageName = getPackageName;
+const getPackageVersion = () => getPackageJsonProperty({ property: 'version' });
+exports.getPackageVersion = getPackageVersion;

package/dist/utils/readCloudFormationTemplate.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readCloudFormationYamlTemplate = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const cloudFormationTemplate_1 = require("./cloudFormationTemplate");
+const getTypes = () => [
+    {
+        tag: `!SubString`,
+        options: {
+            kind: 'scalar',
+            construct: (filePath) => {
+                return fs
+                    .readFileSync(path.resolve(process.cwd(), filePath))
+                    .toString();
+            },
+        },
+    },
+];
+/**
+ * CloudFormation
+ * @param param0
+ */
+const readCloudFormationYamlTemplate = ({ templatePath, }) => {
+    const template = fs.readFileSync(templatePath).toString();
+    const parsed = (0, cloudFormationTemplate_1.loadCloudFormationTemplate)(template, getTypes());
+    if (!parsed || typeof parsed === 'string') {
+        throw new Error('Cannot parse CloudFormation template.');
+    }
+    return parsed;
+};
+exports.readCloudFormationYamlTemplate = readCloudFormationYamlTemplate;

package/dist/utils/readObjectFile.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readObjectFile = exports.readYaml = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable @typescript-eslint/no-var-requires */
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const readYaml = ({ path }) => {
+    const template = fs_1.default.readFileSync(path, 'utf8') || JSON.stringify({});
+    return js_yaml_1.default.load(template);
+};
+exports.readYaml = readYaml;
+/**
+ * If your file is `.ts`, you must you must export the final object
+ * `export default { ... }`. If your file is `.js`, you must you must export
+ * the final object `module.exports =  { ... }`. `.json` and `.yml/yaml` must
+ * define the resources in [JSON](https://www.json.org/json-en.html) and
+ * [YAML](https://yaml.org/) format respectively.
+ */
+const readObjectFile = ({ path }) => {
+    if (!fs_1.default.existsSync(path)) {
+        return {};
+    }
+    const extension = path.split('.').pop();
+    if (extension === 'ts') {
+        require('ts-node').register({
+            compilerOptions: { module: 'commonjs' },
+            transpileOnly: true,
+        });
+        const tsObj = require(path);
+        const obj = tsObj.default || tsObj;
+        return typeof obj === 'function' ? obj() : obj;
+    }
+    if (extension === 'js') {
+        const obj = require(path);
+        return typeof obj === 'function' ? obj() : obj;
+    }
+    if (extension === 'json') {
+        return require(path);
+    }
+    if (extension === 'yml' || extension === 'yaml') {
+        return (0, exports.readYaml)({ path });
+    }
+    return {};
+};
+exports.readObjectFile = readObjectFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carlin",
-  "version": "1.19.11",
+  "version": "1.19.13",
   "description": "",
   "license": "GPL-3.0",
   "author": "Pedro Arantes <arantespp@gmail.com> (https://twitter.com/arantespp)",
@@ -50,7 +50,7 @@
     "yargs": "^17.4.1"
   },
   "devDependencies": {
-    "@ttoss/test-utils": "^1.16.10",
+    "@ttoss/test-utils": "^1.17.0",
     "@types/adm-zip": "^0.5.0",
     "@types/aws-lambda": "^8.10.95",
     "@types/deep-equal": "^1.0.1",
@@ -71,5 +71,5 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "b9f9de9b8389be76965f125b593166f10c2171e6"
+  "gitHead": "eaf4015635a5476a3b59beb3c35284404c1f07d5"
 }