@goldstack/utils-terraform 0.3.71 → 0.4.0

package/dist/src/terraformCli.d.ts

@@ -1,17 +1,17 @@
-import { CloudProvider } from './cloudProvider';
-import { TerraformVersion } from './types/utilsTerraformConfig';
-export declare type Variables = [string, string][];
-interface TerraformOptions {
-    dir?: string;
-    provider: CloudProvider;
-    variables?: Variables;
-    backendConfig?: Variables;
-    version: TerraformVersion;
-    options?: string[];
-    silent?: boolean;
-    workspace?: string;
-}
-export declare const assertTerraform: () => void;
-export declare const tf: (cmd: string, options: TerraformOptions) => string;
-export {};
+import { CloudProvider } from './cloudProvider';
+import { TerraformVersion } from './types/utilsTerraformConfig';
+export declare type Variables = [string, string][];
+interface TerraformOptions {
+    dir?: string;
+    provider: CloudProvider;
+    variables?: Variables;
+    backendConfig?: Variables;
+    version: TerraformVersion;
+    options?: string[];
+    silent?: boolean;
+    workspace?: string;
+}
+export declare const assertTerraform: () => void;
+export declare const tf: (cmd: string, options: TerraformOptions) => string;
+export {};
 //# sourceMappingURL=terraformCli.d.ts.map

package/dist/src/terraformCli.js

@@ -1,87 +1,87 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tf = exports.assertTerraform = void 0;
-const utils_sh_1 = require("@goldstack/utils-sh");
-const utils_docker_1 = require("@goldstack/utils-docker");
-const utils_log_1 = require("@goldstack/utils-log");
-const renderVariables = (variables) => {
-    if (variables.length === 0) {
-        return '';
-    }
-    return variables
-        .map(([key, value]) => {
-        const isWin = process.platform === 'win32';
-        let valueFixed = value.replace(/"/g, '\\"');
-        // on anything that is not Windows, ensure '$' is escaped
-        // so it is not replaced with a variable
-        if (!isWin) {
-            valueFixed = valueFixed.replace(/\$/g, '\\$');
-        }
-        return `-var \"${key}=${valueFixed}\" `;
-    })
-        .join('');
-};
-const renderBackendConfig = (variables) => {
-    if (variables.length === 0) {
-        return '';
-    }
-    return variables
-        .map(([key, value]) => `-backend-config=\"${key}=${value}\" `)
-        .join('');
-};
-const execWithDocker = (cmd, options) => {
-    var _a;
-    if (!options.dir) {
-        options.dir = (0, utils_sh_1.pwd)();
-    }
-    (0, utils_docker_1.assertDocker)();
-    let workspaceEnvVariable = '';
-    if (options.workspace) {
-        workspaceEnvVariable = `-e TF_WORKSPACE=${options.workspace}`;
-    }
-    const cmd3 = `docker run --rm -v "${options.dir}":/app ` +
-        ` ${options.provider.generateEnvVariableString()} ${workspaceEnvVariable} ` +
-        '-w /app ' +
-        `${(0, utils_docker_1.imageTerraform)(options.version)} ${cmd} ` +
-        ` ${renderBackendConfig(options.backendConfig || [])} ` +
-        ` ${renderVariables(options.variables || [])} ` +
-        ` ${((_a = options.options) === null || _a === void 0 ? void 0 : _a.join(' ')) || ''} `;
-    return (0, utils_sh_1.exec)(cmd3, { silent: options.silent });
-};
-const assertTerraform = () => {
-    if (!(0, utils_sh_1.commandExists)('terraform')) {
-        (0, utils_log_1.fatal)('Terraform is not installed.\n\n' +
-            'Install terraform CLI or Docker (preferred).');
-        throw new Error();
-    }
-};
-exports.assertTerraform = assertTerraform;
-const execWithCli = (cmd, options) => {
-    var _a;
-    if (!options.dir) {
-        options.dir = (0, utils_sh_1.pwd)();
-    }
-    (0, exports.assertTerraform)();
-    const version = (0, utils_sh_1.exec)('terraform version');
-    if (version.indexOf(options.version) === -1) {
-        throw new Error(`Invalid local Terraform version detected: [${version.split('\n')[0]}], expected version compatible with [${options.version}]. Please install this version locally or install Docker for Goldstack to run the correct Terraform version required for this deployment using Docker.`);
-    }
-    options.provider.setEnvVariables();
-    if (options.workspace) {
-        process.env.TF_WORKSPACE = options.workspace;
-    }
-    const execCmd = `terraform ${cmd} ` +
-        ` ${renderBackendConfig(options.backendConfig || [])} ` +
-        ` ${renderVariables(options.variables || [])} ` +
-        ` ${((_a = options.options) === null || _a === void 0 ? void 0 : _a.join(' ')) || ''} `;
-    return (0, utils_sh_1.exec)(execCmd, { silent: options.silent });
-};
-const tf = (cmd, options) => {
-    // always prefer running with Docker
-    if ((0, utils_docker_1.hasDocker)()) {
-        return execWithDocker(cmd, options);
-    }
-    return execWithCli(cmd, options);
-};
-exports.tf = tf;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tf = exports.assertTerraform = void 0;
+const utils_sh_1 = require("@goldstack/utils-sh");
+const utils_docker_1 = require("@goldstack/utils-docker");
+const utils_log_1 = require("@goldstack/utils-log");
+const renderVariables = (variables) => {
+    if (variables.length === 0) {
+        return '';
+    }
+    return variables
+        .map(([key, value]) => {
+        const isWin = process.platform === 'win32';
+        let valueFixed = value.replace(/"/g, '\\"');
+        // on anything that is not Windows, ensure '$' is escaped
+        // so it is not replaced with a variable
+        if (!isWin) {
+            valueFixed = valueFixed.replace(/\$/g, '\\$');
+        }
+        return `-var \"${key}=${valueFixed}\" `;
+    })
+        .join('');
+};
+const renderBackendConfig = (variables) => {
+    if (variables.length === 0) {
+        return '';
+    }
+    return variables
+        .map(([key, value]) => `-backend-config=\"${key}=${value}\" `)
+        .join('');
+};
+const execWithDocker = (cmd, options) => {
+    var _a;
+    if (!options.dir) {
+        options.dir = (0, utils_sh_1.pwd)();
+    }
+    (0, utils_docker_1.assertDocker)();
+    let workspaceEnvVariable = '';
+    if (options.workspace) {
+        workspaceEnvVariable = `-e TF_WORKSPACE=${options.workspace}`;
+    }
+    const cmd3 = `docker run --rm -v "${options.dir}":/app ` +
+        ` ${options.provider.generateEnvVariableString()} ${workspaceEnvVariable} ` +
+        '-w /app ' +
+        `${(0, utils_docker_1.imageTerraform)(options.version)} ${cmd} ` +
+        ` ${renderBackendConfig(options.backendConfig || [])} ` +
+        ` ${renderVariables(options.variables || [])} ` +
+        ` ${((_a = options.options) === null || _a === void 0 ? void 0 : _a.join(' ')) || ''} `;
+    return (0, utils_sh_1.exec)(cmd3, { silent: options.silent });
+};
+const assertTerraform = () => {
+    if (!(0, utils_sh_1.commandExists)('terraform')) {
+        (0, utils_log_1.fatal)('Terraform is not installed.\n\n' +
+            'Install terraform CLI or Docker (preferred).');
+        throw new Error();
+    }
+};
+exports.assertTerraform = assertTerraform;
+const execWithCli = (cmd, options) => {
+    var _a;
+    if (!options.dir) {
+        options.dir = (0, utils_sh_1.pwd)();
+    }
+    (0, exports.assertTerraform)();
+    const version = (0, utils_sh_1.exec)('terraform version');
+    if (version.indexOf(options.version) === -1) {
+        throw new Error(`Invalid local Terraform version detected: [${version.split('\n')[0]}], expected version compatible with [${options.version}]. Please install this version locally or install Docker for Goldstack to run the correct Terraform version required for this deployment using Docker.`);
+    }
+    options.provider.setEnvVariables();
+    if (options.workspace) {
+        process.env.TF_WORKSPACE = options.workspace;
+    }
+    const execCmd = `terraform ${cmd} ` +
+        ` ${renderBackendConfig(options.backendConfig || [])} ` +
+        ` ${renderVariables(options.variables || [])} ` +
+        ` ${((_a = options.options) === null || _a === void 0 ? void 0 : _a.join(' ')) || ''} `;
+    return (0, utils_sh_1.exec)(execCmd, { silent: options.silent });
+};
+const tf = (cmd, options) => {
+    // always prefer running with Docker
+    if ((0, utils_docker_1.hasDocker)()) {
+        return execWithDocker(cmd, options);
+    }
+    return execWithCli(cmd, options);
+};
+exports.tf = tf;
 //# sourceMappingURL=terraformCli.js.map

package/dist/src/types/utilsTerraformConfig.d.ts

@@ -1,36 +1,36 @@
-import { Deployment } from '@goldstack/infra';
-/**
- * Name of the property that should be converted into a Terraform variable.
- *
- * @title Terraform Variable
- *
- */
-export declare type TerraformVariable = string;
-/**
- * Key used for Terraform state persisted in Terraform state bucket.
- *
- * Will be auto-generated upon first deployment if not provided.
- *
- * @title Terraform State Key
- */
-export declare type TerraformStateKey = string;
-/**
- * Version of Terraform that the remote state for this deployment was created with.
- *
- * Go to the next version using `yarn infra upgrade [deploymentName] [targetVersion]`. Note that Terraform versions should only be increased one at a time, so for instance you can go from v0.12 to v0.13 but not from v0.12 to v0.14.
- *
- * @default '0.12'
- */
-export declare type TerraformVersion = '0.12' | '0.13' | '0.14' | '0.15' | '1.0' | '1.1';
-/**
- * Define which of the deployment variables will be made available for terraform.
- *
- * @title Terraform Variables
- */
-export declare type TerraformVariables = TerraformVariable[];
-export interface TerraformDeployment extends Deployment {
-    terraformVariables?: TerraformVariables;
-    tfStateKey?: TerraformStateKey;
-    tfVersion?: TerraformVersion;
-}
+import { Deployment } from '@goldstack/infra';
+/**
+ * Name of the property that should be converted into a Terraform variable.
+ *
+ * @title Terraform Variable
+ *
+ */
+export declare type TerraformVariable = string;
+/**
+ * Key used for Terraform state persisted in Terraform state bucket.
+ *
+ * Will be auto-generated upon first deployment if not provided.
+ *
+ * @title Terraform State Key
+ */
+export declare type TerraformStateKey = string;
+/**
+ * Version of Terraform that the remote state for this deployment was created with.
+ *
+ * Go to the next version using `yarn infra upgrade [deploymentName] [targetVersion]`. Note that Terraform versions should only be increased one at a time, so for instance you can go from v0.12 to v0.13 but not from v0.12 to v0.14.
+ *
+ * @default '0.12'
+ */
+export declare type TerraformVersion = '0.12' | '0.13' | '0.14' | '0.15' | '1.0' | '1.1';
+/**
+ * Define which of the deployment variables will be made available for terraform.
+ *
+ * @title Terraform Variables
+ */
+export declare type TerraformVariables = TerraformVariable[];
+export interface TerraformDeployment extends Deployment {
+    terraformVariables?: TerraformVariables;
+    tfStateKey?: TerraformStateKey;
+    tfVersion?: TerraformVersion;
+}
 //# sourceMappingURL=utilsTerraformConfig.d.ts.map

package/dist/src/types/utilsTerraformConfig.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=utilsTerraformConfig.js.map

package/dist/src/utilsTerraform.d.ts

@@ -1,12 +1,12 @@
-export type { TerraformDeployment, TerraformVariable, TerraformVariables, } from './types/utilsTerraformConfig';
-import { CloudProvider } from './cloudProvider';
-export type { CloudProvider } from './cloudProvider';
-export { tf } from './terraformCli';
-export { getVariablesFromProperties } from './terraformBuild';
-export declare const infraCommands: () => any;
-export interface TerraformOptions {
-    parallelism?: number;
-    provider?: CloudProvider;
-}
-export declare const terraformCli: (args: string[], options: TerraformOptions) => void;
+export type { TerraformDeployment, TerraformVariable, TerraformVariables, } from './types/utilsTerraformConfig';
+import { CloudProvider } from './cloudProvider';
+export type { CloudProvider } from './cloudProvider';
+export { tf } from './terraformCli';
+export { getVariablesFromProperties } from './terraformBuild';
+export declare const infraCommands: () => any;
+export interface TerraformOptions {
+    parallelism?: number;
+    provider?: CloudProvider;
+}
+export declare const terraformCli: (args: string[], options: TerraformOptions) => void;
 //# sourceMappingURL=utilsTerraform.d.ts.map

package/dist/src/utilsTerraform.js

@@ -1,96 +1,96 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.terraformCli = exports.infraCommands = exports.getVariablesFromProperties = exports.tf = void 0;
-const terraformBuild_1 = require("./terraformBuild");
-var terraformCli_1 = require("./terraformCli");
-Object.defineProperty(exports, "tf", { enumerable: true, get: function () { return terraformCli_1.tf; } });
-var terraformBuild_2 = require("./terraformBuild");
-Object.defineProperty(exports, "getVariablesFromProperties", { enumerable: true, get: function () { return terraformBuild_2.getVariablesFromProperties; } });
-const infraCommands = () => {
-    const deploymentPositional = (yargs) => {
-        return yargs.positional('deployment', {
-            type: 'string',
-            describe: 'Name of the deployment this command should be applied to',
-            demandOption: true,
-        });
-    };
-    return (yargs) => {
-        return yargs
-            .command('up <deployment>', 'Stands up infrastructure for the specified deployment', deploymentPositional)
-            .command('init <deployment>', 'Initialises Terraform working directory for deployment', deploymentPositional)
-            .command('plan <deployment>', 'Creates a Terraform execution plan for deployment', deploymentPositional)
-            .command('apply <deployment>', 'Applies the last Terraform execution plan calculated using `infra plan`', deploymentPositional)
-            .command('destroy <deployment>', 'DANGER: Destroys all deployed infrastructure for the deployment', (yargs) => {
-            return deploymentPositional(yargs).option('yes', {
-                alias: 'y',
-                description: 'DANGER: If provided, confirmation for deleting infrastructure resources will be skipped.',
-                default: false,
-                demandOption: false,
-                type: 'boolean',
-            });
-        })
-            .command('upgrade <deployment> <targetVersion>', 'Upgrades Terraform version to a new target version (experimental)', (yargs) => {
-            return deploymentPositional(yargs).positional('targetVersion', {
-                type: 'string',
-                description: 'Provides the target Terraform version that should be migrated to.',
-                demandOption: true,
-            });
-        })
-            .command('terraform <deployment> [command..]', 'Runs an arbitrary Terraform CLI command', (yargs) => {
-            return deploymentPositional(yargs)
-                .option('inject-variables', {
-                description: 'Injects variables into the Terraform CLI command.',
-                default: false,
-                type: 'boolean',
-                demandOption: false,
-            })
-                .option('inject-backend-config', {
-                description: 'Injects backend config into the Terraform CLI command.',
-                default: false,
-                type: 'boolean',
-                demandOption: false,
-            });
-        });
-    };
-};
-exports.infraCommands = infraCommands;
-const terraformCli = (args, options) => {
-    if (!options.provider) {
-        throw new Error('Cloud provider not defined');
-    }
-    const [operation, ...opArgs] = args;
-    const build = new terraformBuild_1.TerraformBuild(options.provider);
-    if (operation === 'up') {
-        build.init(opArgs);
-        build.plan(opArgs);
-        build.apply(opArgs, options);
-        return;
-    }
-    if (operation === 'init') {
-        build.init(opArgs);
-        return;
-    }
-    if (operation === 'plan') {
-        build.plan(opArgs);
-        return;
-    }
-    if (operation === 'apply') {
-        build.apply(opArgs);
-        return;
-    }
-    if (operation === 'destroy') {
-        build.destroy(opArgs);
-        return;
-    }
-    if (operation === 'upgrade') {
-        build.upgrade(opArgs);
-        return;
-    }
-    if (operation === 'terraform') {
-        build.terraform(opArgs);
-        return;
-    }
-    throw new Error('Unknown infrastructure operation: ' + operation);
-};
-exports.terraformCli = terraformCli;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.terraformCli = exports.infraCommands = exports.getVariablesFromProperties = exports.tf = void 0;
+const terraformBuild_1 = require("./terraformBuild");
+var terraformCli_1 = require("./terraformCli");
+Object.defineProperty(exports, "tf", { enumerable: true, get: function () { return terraformCli_1.tf; } });
+var terraformBuild_2 = require("./terraformBuild");
+Object.defineProperty(exports, "getVariablesFromProperties", { enumerable: true, get: function () { return terraformBuild_2.getVariablesFromProperties; } });
+const infraCommands = () => {
+    const deploymentPositional = (yargs) => {
+        return yargs.positional('deployment', {
+            type: 'string',
+            describe: 'Name of the deployment this command should be applied to',
+            demandOption: true,
+        });
+    };
+    return (yargs) => {
+        return yargs
+            .command('up <deployment>', 'Stands up infrastructure for the specified deployment', deploymentPositional)
+            .command('init <deployment>', 'Initialises Terraform working directory for deployment', deploymentPositional)
+            .command('plan <deployment>', 'Creates a Terraform execution plan for deployment', deploymentPositional)
+            .command('apply <deployment>', 'Applies the last Terraform execution plan calculated using `infra plan`', deploymentPositional)
+            .command('destroy <deployment>', 'DANGER: Destroys all deployed infrastructure for the deployment', (yargs) => {
+            return deploymentPositional(yargs).option('yes', {
+                alias: 'y',
+                description: 'DANGER: If provided, confirmation for deleting infrastructure resources will be skipped.',
+                default: false,
+                demandOption: false,
+                type: 'boolean',
+            });
+        })
+            .command('upgrade <deployment> <targetVersion>', 'Upgrades Terraform version to a new target version (experimental)', (yargs) => {
+            return deploymentPositional(yargs).positional('targetVersion', {
+                type: 'string',
+                description: 'Provides the target Terraform version that should be migrated to.',
+                demandOption: true,
+            });
+        })
+            .command('terraform <deployment> [command..]', 'Runs an arbitrary Terraform CLI command', (yargs) => {
+            return deploymentPositional(yargs)
+                .option('inject-variables', {
+                description: 'Injects variables into the Terraform CLI command.',
+                default: false,
+                type: 'boolean',
+                demandOption: false,
+            })
+                .option('inject-backend-config', {
+                description: 'Injects backend config into the Terraform CLI command.',
+                default: false,
+                type: 'boolean',
+                demandOption: false,
+            });
+        });
+    };
+};
+exports.infraCommands = infraCommands;
+const terraformCli = (args, options) => {
+    if (!options.provider) {
+        throw new Error('Cloud provider not defined');
+    }
+    const [operation, ...opArgs] = args;
+    const build = new terraformBuild_1.TerraformBuild(options.provider);
+    if (operation === 'up') {
+        build.init(opArgs);
+        build.plan(opArgs);
+        build.apply(opArgs, options);
+        return;
+    }
+    if (operation === 'init') {
+        build.init(opArgs);
+        return;
+    }
+    if (operation === 'plan') {
+        build.plan(opArgs);
+        return;
+    }
+    if (operation === 'apply') {
+        build.apply(opArgs);
+        return;
+    }
+    if (operation === 'destroy') {
+        build.destroy(opArgs);
+        return;
+    }
+    if (operation === 'upgrade') {
+        build.upgrade(opArgs);
+        return;
+    }
+    if (operation === 'terraform') {
+        build.terraform(opArgs);
+        return;
+    }
+    throw new Error('Unknown infrastructure operation: ' + operation);
+};
+exports.terraformCli = terraformCli;
 //# sourceMappingURL=utilsTerraform.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goldstack/utils-terraform",
-  "version": "0.3.71",
+  "version": "0.4.0",
   "description": "Run Terraform commands easily as npm package scripts",
   "keywords": [
     "goldstack",
@@ -37,22 +37,22 @@
     "version:apply:force": "yarn version $@ && yarn version apply"
   },
   "dependencies": {
-    "@goldstack/infra": "0.3.38",
-    "@goldstack/infra-aws": "0.3.47",
-    "@goldstack/utils-config": "0.3.35",
-    "@goldstack/utils-docker": "0.3.40",
-    "@goldstack/utils-log": "0.2.16",
-    "@goldstack/utils-package": "0.3.41",
-    "@goldstack/utils-sh": "0.4.33",
+    "@goldstack/infra": "0.4.0",
+    "@goldstack/infra-aws": "0.4.0",
+    "@goldstack/utils-config": "0.4.0",
+    "@goldstack/utils-docker": "0.4.0",
+    "@goldstack/utils-log": "0.3.0",
+    "@goldstack/utils-package": "0.4.0",
+    "@goldstack/utils-sh": "0.5.0",
     "json-stable-stringify": "^1.0.1",
     "prompt-sync": "^4.2.0",
     "yargs": "^17.5.1"
   },
   "devDependencies": {
-    "@goldstack/utils-git": "0.1.36",
-    "@types/jest": "^27.5.1",
+    "@goldstack/utils-git": "0.2.0",
+    "@types/jest": "^28.1.8",
     "@types/json-stable-stringify": "^1",
-    "@types/node": "^17.0.33",
+    "@types/node": "^18.7.13",
     "@types/prompt-sync": "^4.1.0",
     "@types/yargs": "^17.0.10",
     "jest": "^28.1.0",