@agilecustoms/envctl 0.12.0 → 0.13.1

package/dist/commands/delete.js

@@ -1,26 +1,18 @@
 import { Command } from 'commander';
-import { configService, envCtl } from '../container.js';
-import { KnownException } from '../exceptions.js';
+import { envCtl } from '../container.js';
+import { KEYS } from './keys.js';
 import { wrap } from './utils.js';
+import { ensureEnv } from './validation.js';
 export function deleteIt(program) {
     program
         .command('delete')
         .description('Delete a development environment')
-        .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('--project <project>', 'Project code (like tt). Used when multiple projects deployed in same AWS account')
+        .option('--env <env>', KEYS.ENV)
+        .option('--project <project>', KEYS.PROJECT)
         .action(wrap(handler));
 }
 async function handler(options) {
     let { env, project } = options;
-    if (!env) {
-        const owner = configService.getOwner();
-        if (!owner) {
-            throw new KnownException('--env argument is not provided\n'
-                + 'default to owner from local configuration, but it is not configured\n'
-                + 'please call with --env argument or run \'envctl configure\' to configure owner');
-        }
-        console.log(`Env name not provided, default to owner name ${owner}`);
-        env = owner;
-    }
-    await envCtl.delete(env, project);
+    env = ensureEnv(env);
+    await envCtl.delete(project, env);
 }

package/dist/commands/deploy.js

@@ -4,18 +4,20 @@ import { configService, envCtl } from '../container.js';
 import { KnownException } from '../exceptions.js';
 import { EnvType } from '../model/index.js';
 import { EnvSize } from '../model/index.js';
-import { ensureEnumValue, ensureKind, wrap } from './utils.js';
+import { KEYS } from './keys.js';
+import { wrap } from './utils.js';
+import { ensureEnumValue, ensureKind } from './validation.js';
 export function deploy(program) {
     program
         .command('deploy')
         .description('Create new or update existing dev environment')
-        .option('--project <project>', 'Project code (like tt). Used when multiple projects deployed in same AWS account')
-        .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('--kind <kind>', 'Environment kind: complete project (default) or some slice such as tt-core + tt-web')
-        .option('--cwd <cwd>', 'Working directory (default: current directory)')
+        .option('--project <project>', KEYS.PROJECT)
+        .option('--env <env>', KEYS.ENV)
+        .option('--owner <owner>', KEYS.OWNER)
+        .option('--size <size>', KEYS.SIZE)
+        .option('--type <type>', KEYS.TYPE, EnvType.Dev)
+        .option('--kind <kind>', KEYS.KIND)
+        .option('--cwd <cwd>', KEYS.CWD)
         .allowUnknownOption(true)
         .argument('[args...]')
         .action(wrap(handler));

package/dist/commands/index.js

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

package/dist/commands/keys.js

@@ -0,0 +1,9 @@
+export const KEYS = {
+    CWD: 'Working directory (default: current directory)',
+    ENV: 'Environment name (can be git hash). {project}-{env} give env key used to store env state (s3 key in case of AWS)',
+    KIND: 'Environment kind: complete project (default) or some slice such as tt-core + tt-web',
+    OWNER: 'Environment owner (GH username)',
+    PROJECT: 'Project code (like tt). Used when multiple projects deployed in same AWS account',
+    SIZE: 'Environment size: min, small, full',
+    TYPE: 'Environment type: dev, prod',
+};

package/dist/commands/plan.js

@@ -1,17 +1,19 @@
 import { Command } from 'commander';
 import { envCtl } from '../container.js';
+import { EnvType } from '../model/index.js';
 import { parseEnvDto } from './deploy.js';
+import { KEYS } from './keys.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)')
+        .option('--env <env>', KEYS.ENV)
+        .option('--owner <owner>', KEYS.OWNER)
+        .option('--size <size>', KEYS.SIZE)
+        .option('--type <type>', KEYS.TYPE, EnvType.Dev)
+        .option('--cwd <cwd>', KEYS.CWD)
         .allowUnknownOption(true)
         .argument('[args...]')
         .action(wrap(handler));

package/dist/commands/status.js

@@ -0,0 +1,18 @@
+import { Command } from 'commander';
+import { envCtl } from '../container.js';
+import { KEYS } from './keys.js';
+import { wrap } from './utils.js';
+import { ensureEnv } from './validation.js';
+export function status(program) {
+    program
+        .command('status')
+        .description('Get env status')
+        .option('--env <env>', KEYS.ENV)
+        .option('--project <project>', KEYS.PROJECT)
+        .action(wrap(handler));
+}
+async function handler(options) {
+    let { env, project } = options;
+    env = ensureEnv(env);
+    await envCtl.status(project, env);
+}

package/dist/commands/utils.js

@@ -1,4 +1,3 @@
-import path from 'path';
 import { ExitPromptError } from '@inquirer/core';
 import inquirer from 'inquirer';
 import { BusinessException, ExitException, KnownException } from '../exceptions.js';
@@ -33,31 +32,3 @@ export async function promptYesNo(message, defaultValue = false) {
         }]);
     return answer;
 }
-export function ensureKind(kind, cwd) {
-    if (kind) {
-        return kind;
-    }
-    kind = getDirName(cwd);
-    console.log(`Inferred kind from directory name: ${kind}`);
-    return kind;
-}
-function getDirName(cwd) {
-    cwd = resolveCwd(cwd);
-    return path.basename(cwd);
-}
-function resolveCwd(cwd) {
-    if (!cwd) {
-        return process.cwd();
-    }
-    if (path.isAbsolute(cwd)) {
-        return cwd;
-    }
-    return path.resolve(process.cwd(), cwd);
-}
-export function ensureEnumValue(enumObj, value, name) {
-    const values = Object.values(enumObj);
-    if (!values.includes(value)) {
-        throw new KnownException(`Invalid ${name}: "${value}". Must be one of: ${values.join(', ')}`);
-    }
-    return value;
-}

package/dist/commands/validation.js

@@ -0,0 +1,44 @@
+import path from 'path';
+import { configService } from '../container.js';
+import { KnownException } from '../exceptions.js';
+export function ensureKind(kind, cwd) {
+    if (kind) {
+        return kind;
+    }
+    kind = getDirName(cwd);
+    console.log(`Inferred kind from directory name: ${kind}`);
+    return kind;
+}
+function getDirName(cwd) {
+    cwd = resolveCwd(cwd);
+    return path.basename(cwd);
+}
+function resolveCwd(cwd) {
+    if (!cwd) {
+        return process.cwd();
+    }
+    if (path.isAbsolute(cwd)) {
+        return cwd;
+    }
+    return path.resolve(process.cwd(), cwd);
+}
+export function ensureEnumValue(enumObj, value, name) {
+    const values = Object.values(enumObj);
+    if (!values.includes(value)) {
+        throw new KnownException(`Invalid ${name}: "${value}". Must be one of: ${values.join(', ')}`);
+    }
+    return value;
+}
+export function ensureEnv(env) {
+    if (env) {
+        return env;
+    }
+    const owner = configService.getOwner();
+    if (!owner) {
+        throw new KnownException('--env argument is not provided\n'
+            + 'default to owner from local configuration, but it is not configured\n'
+            + 'please call with --env argument or run \'envctl configure\' to configure owner');
+    }
+    console.log(`Env name not provided, default to owner name ${owner}`);
+    return owner;
+}

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, plan } from './commands/index.js';
+import { configure, deleteIt, deploy, plan, status } from './commands/index.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
 updateNotifier({ pkg, updateCheckInterval: 0 }).notify();
@@ -15,4 +15,5 @@ configure(program);
 deploy(program);
 deleteIt(program);
 plan(program);
+status(program);
 program.parse(process.argv);

package/dist/service/EnvCtl.js

@@ -11,6 +11,16 @@ export class EnvCtl {
     key(project, env) {
         return project ? `${project}-${env}` : env;
     }
+    async status(project, envName) {
+        const key = this.key(project, envName);
+        console.log(`Retrieve env ${key}`);
+        const env = await this.envApi.get(key);
+        if (env === null) {
+            console.log(`Env ${key} does not exist`);
+            return;
+        }
+        console.log(`Env ${key} status: ${env.status}`);
+    }
     async plan(envDto, tfArgs, cwd) {
         const key = this.key(envDto.project, envDto.env);
         console.log(`Check if env ${key} already exists`);
@@ -83,7 +93,7 @@ export class EnvCtl {
         console.log('Unlock env after db evolution');
         await this.envApi.activate(key);
     }
-    async delete(envName, project) {
+    async delete(project, envName) {
         const key = this.key(project, envName);
         console.log(`Retrieve env`);
         const env = await this.envApi.get(key);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agilecustoms/envctl",
   "description": "node.js CLI client for manage environments",
-  "version": "0.12.0",
+  "version": "0.13.1",
   "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-status": "tsc --sourceMap true && npm run run -- status",
     "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"