@agilecustoms/envctl 0.10.0 → 0.11.0

package/README.md

@@ -33,7 +33,7 @@ npm view @agilecustoms/envctl version # show latest version available (without i
 `env-api` is a microservice hosted in 'maintenance' account and working as garbage collector: every environment first
 created in `env-api` and then 'managed' by `env-api`: it deletes env when it is not in use anymore OR can extend lifetime.
 Creation API yields unique ID, so you can safely manage env (delete, extend lifetime) via this ID. But creation API
-need to be secured. There are two main use cases:
+needs to be secured. There are two main use cases:
 1. create environment from CI (mainly ephemeral envs)
 2. create env from dev machine
 

package/dist/client/ProcessRunner.js

@@ -9,7 +9,9 @@ export class ProcessRunner {
         return this.run(scriptPath, args, cwd, scanner);
     }
     async run(command, args, cwd, scanner) {
-        const spawnOptions = {};
+        const spawnOptions = {
+            stdio: ['inherit', 'pipe', 'pipe'],
+        };
         if (cwd) {
             spawnOptions.cwd = cwd;
         }
@@ -26,6 +28,10 @@ export class ProcessRunner {
                     scanner(line);
                 console.log(`> ${line}`);
             }
+            if (buffer.includes('Enter a value:')) {
+                console.log(buffer);
+                buffer = '';
+            }
         });
         let errorBuffer = '';
         child.stderr.on('data', (data) => {

package/dist/client/TerraformAdapter.js

@@ -40,15 +40,23 @@ export class TerraformAdapter {
             throw new KnownException('Can not find terraform files. Command needs to be run in a directory with terraform files');
         }
     }
-    async deploy(envAttrs, tfArgs, cwd, attemptNo = 1) {
-        const args = [
+    tfArgs(envAttrs, tfArgs) {
+        return [
             `-var=env=${envAttrs.env}`,
             `-var=owner=${envAttrs.owner}`,
             `-var=env_size=${envAttrs.size}`,
             `-var=env_type=${envAttrs.type}`,
             ...tfArgs
         ];
-        console.log('Running:', 'terraform apply -auto-approve', ...args);
+    }
+    async plan(envAttrs, tfArgs, cwd) {
+        const args = this.tfArgs(envAttrs, tfArgs);
+        console.log('Running: terraform plan -auto-approve', ...args);
+        await this.processRunner.run('terraform', ['plan', ...args], cwd);
+    }
+    async deploy(envAttrs, tfArgs, cwd, attemptNo = 1) {
+        const args = this.tfArgs(envAttrs, tfArgs);
+        console.log('Running: terraform apply -auto-approve', ...args);
         this.printTime();
         try {
             await this.processRunner.run('terraform', ['apply', '-auto-approve', ...args], cwd);

package/dist/commands/deploy.js

@@ -21,6 +21,10 @@ export function deploy(program) {
         .action(wrap(handler));
 }
 async function handler(tfArgs, options) {
+    const envDto = await parseEnvDto(options);
+    await envCtl.deploy(envDto, tfArgs, options.cwd);
+}
+export async function parseEnvDto(options) {
     let { project, env, owner, size, type, kind, cwd } = options;
     if (!owner) {
         owner = configService.getOwner();
@@ -51,6 +55,5 @@ async function handler(tfArgs, options) {
         envSize = answer.size;
     }
     const envType = ensureEnumValue(EnvType, type, 'type');
-    const envAttributes = { project, env, owner, size: envSize, type: envType, kind };
-    await envCtl.deploy(envAttributes, tfArgs, options.cwd);
+    return { project, env, owner, size: envSize, type: envType, kind };
 }

package/dist/commands/index.js

@@ -1,3 +1,4 @@
 export { configure } from './configure.js';
 export { deploy } from './deploy.js';
 export { deleteIt } from './delete.js';
+export { plan } from './plan.js';

package/dist/commands/plan.js

@@ -0,0 +1,22 @@
+import { Command } from 'commander';
+import { envCtl } from '../container.js';
+import { parseEnvDto } from './deploy.js';
+import { wrap } from './utils.js';
+export function plan(program) {
+    program
+        .command('plan')
+        .description('High level wrapper for terraform plan. Compliments deploy command: if you plan to deploy env with envctl deploy,'
+        + ' then it is recommended to do plan with envctl plan to guarantee consistent behavior')
+        .option('--env <env>', 'Environment name (can be git hash). {project}-{env} give env key used to store env state (s3 key in case of AWS)')
+        .option('--owner <owner>', 'Environment owner (GH username)')
+        .option('--size <size>', 'Environment size: min, small, full')
+        .option('--type <type>', 'Environment type: dev, prod', 'dev')
+        .option('--cwd <cwd>', 'Working directory (default: current directory)')
+        .allowUnknownOption(true)
+        .argument('[args...]')
+        .action(wrap(handler));
+}
+async function handler(tfArgs, options) {
+    const envDto = await parseEnvDto(options);
+    await envCtl.plan(envDto, tfArgs, options.cwd);
+}

package/dist/index.js

@@ -2,7 +2,7 @@
 import { createRequire } from 'module';
 import { Command } from 'commander';
 import updateNotifier from 'update-notifier';
-import { configure, deleteIt, deploy } from './commands/index.js';
+import { configure, deleteIt, deploy, plan } from './commands/index.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
 updateNotifier({ pkg, updateCheckInterval: 0 }).notify();
@@ -14,4 +14,5 @@ program
 configure(program);
 deploy(program);
 deleteIt(program);
+plan(program);
 program.parse(process.argv);

package/dist/service/EnvCtl.js

@@ -8,8 +8,15 @@ export class EnvCtl {
         this.envApi = envApi;
         this.terraformAdapter = terraformAdapter;
     }
+    key(project, env) {
+        return project ? `${project}-${env}` : env;
+    }
+    async plan(envDto, tfArgs, cwd) {
+        console.log('Deploying resources');
+        await this.terraformAdapter.plan(envDto, tfArgs, cwd);
+    }
     async deploy(envDto, tfArgs, cwd) {
-        const key = envDto.project ? `${envDto.project}-${envDto.env}` : envDto.env;
+        const key = this.key(envDto.project, envDto.env);
         console.log(`Check if env ${key} already exists`);
         const env = await this.envApi.get(key);
         if (env === null) {
@@ -40,8 +47,8 @@ export class EnvCtl {
         switch (env.status) {
             case EnvStatus.Creating:
             case EnvStatus.Updating: {
-                const answerYes = await promptYesNo(`Env status is ${env.status}, likely to be an error from a previous run\n
-          Do you want to proceed with deployment? (y/n)`);
+                const answerYes = await promptYesNo(`Env status is ${env.status}, likely to be an error from a previous run\n`
+                    + 'Do you want to proceed with deployment?');
                 if (answerYes) {
                     await this.runDeploy(key, envDto, tfArgs, cwd);
                 }
@@ -61,9 +68,9 @@ export class EnvCtl {
                 throw new KnownException(`Unsupported environment status: ${env.status}`);
         }
     }
-    async runDeploy(key, envAttrs, tfArgs, cwd) {
+    async runDeploy(key, envDto, tfArgs, cwd) {
         console.log('Deploying resources');
-        await this.terraformAdapter.deploy(envAttrs, tfArgs, cwd);
+        await this.terraformAdapter.deploy(envDto, tfArgs, cwd);
         console.log('Activating env (to finish creation)');
         await this.envApi.activate(key);
         console.log('Lock env to run db evolution');
@@ -72,14 +79,14 @@ export class EnvCtl {
         await this.envApi.activate(key);
     }
     async delete(envName, project) {
-        const key = project ? `${project}-${envName}` : envName;
+        const key = this.key(project, envName);
         console.log(`Retrieve env`);
         const env = await this.envApi.get(key);
         if (env === null) {
             throw new KnownException(`Environment ${key} does not exist`);
         }
         if (env.status === EnvStatus.Creating) {
-            const answerYes = await promptYesNo('Environment is still being created.\nDo you want to delete it? (y/n) ');
+            const answerYes = await promptYesNo('Environment is still being created.\nDo you want to delete it?');
             if (!answerYes) {
                 throw new KnownException('Aborting env deletion');
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agilecustoms/envctl",
   "description": "node.js CLI client for manage environments",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "author": "Alex Chekulaev",
   "type": "module",
   "bin": {
@@ -27,6 +27,7 @@
     "run": "node dist/index.js",
     "run-version": "tsc --sourceMap true && npm run run -- --version",
     "run-configure": "tsc --sourceMap true && npm run run -- configure",
+    "run-plan": "tsc --sourceMap true && npm run run -- plan --size min --cwd ../tt-core",
     "run-deploy": "tsc --sourceMap true && npm run run -- deploy --size min --cwd ../tt-core",
     "run-delete": "tsc --sourceMap true && npm run run -- delete"
   },