@toa.io/cli 0.20.0-dev.3 → 0.20.0-dev.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/cli",
-  "version": "0.20.0-dev.3",
+  "version": "0.20.0-dev.30",
   "description": "Toa CLI",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -22,13 +22,14 @@
     "@toa.io/runtime": "*"
   },
   "dependencies": {
-    "@toa.io/console": "0.20.0-dev.3",
-    "@toa.io/generic": "0.20.0-dev.3",
-    "@toa.io/kubernetes": "0.20.0-dev.3",
-    "@toa.io/norm": "0.20.0-dev.3",
-    "@toa.io/yaml": "0.20.0-dev.3",
+    "@toa.io/console": "0.20.0-dev.31",
+    "@toa.io/generic": "0.20.0-dev.31",
+    "@toa.io/kubernetes": "0.20.0-dev.31",
+    "@toa.io/norm": "0.20.0-dev.31",
+    "@toa.io/yaml": "0.20.0-dev.31",
+    "dotenv": "16.1.1",
     "find-up": "5.0.0",
     "yargs": "17.6.2"
   },
-  "gitHead": "3eabf45761f4cf211e1e4c331933ec60b4a828a7"
+  "gitHead": "f9ad6bf2bab1298b96ca52557b7e36b6041cfc88"
 }

package/readme.md

@@ -1,5 +1,12 @@
 # Toa Command Line Interface
 
+## Common Options
+
+<dl>
+<dt><code>--env</code></dt>
+<dd>Path to the environment variables file (`.env` format)</dd>
+</dl>
+
 ## Development
 
 ### compose
@@ -9,14 +16,15 @@ Run composition.
 <dl>
 <dt><code>toa compose [paths]</code></dt>
 <dd>
-<code>paths</code> glob patterns to look for components<br/>
-<code>--kill</code> shutdown composition after it's started<br/>
-<code>--dock</code> run in Docker using current <code>.env</code><br/>
-<code>--bindnings</code> override bindings (obsolete)<br/>
+<code>paths</code> Glob patterns to look for components.<br/>
+<code>--kill</code> Shutdown composition after it's started<br/>
+<code>--dock</code> Run in Docker using current <code>.env</code>.<br/>
+<code>--context</code> Path to the Context root (default <code>.</code>).<br/>
+<code>--bindnings</code> Override bindings (obsolete).
 </dd>
 </dl>
 
-> Note that your `localhost` it is accessible from the container as `host.docker.internal`.
+> Note that your `localhost` it is accessible from a container as `host.docker.internal`.
 
 ### env
 
@@ -26,13 +34,14 @@ Export environment to a `.env` file.
 <dt><code>toa env [environment]</code></dt>
 <dd>
 <code>environment</code> deployment environment name (default <code>local</code>).<br/>
-<code>--path</code> path to context (default <code>.</code>)<br/>
+<code>--path</code> path to a Context (default <code>.</code>)<br/>
+<code>--as</code> output file path (default <code>.env</code>)
 </dd>
 </dl>
 
-Credentials specified in `.env` file are preserved.
+Credentials specified in the output file are preserved.
 
-> It is recommended to add `.env` to `.gitignore`.
+> It is recommended to add `.env*` to `.gitignore`.
 
 ### replay
 
@@ -42,9 +51,10 @@ format.
 <dl>
 <dt><code>toa replay [paths...]</code></dt>
 <dd>
-<code>paths</code> Path(s) to component(s) or a context (default <code>.</code>).<br/>
-<code>--integration</code> Replay integration tests only.<br/>
+<code>paths</code> Path(s) to Component(s) or a Context (default <code>.</code>).<br/>
 <code>--component &lt;id&gt;</code> Replay samples for a specified component <code>id</code>.<br/>
+<code>--integration</code> Replay integration tests only.<br/>
+<code>--autonomous</code> Replay autonomous tests only.<br/>
 <code>--operation &lt;name&gt;</code> Replay samples for specified operation.<br/>
 <code>--title &lt;regexp&gt;</code> Regexp to match sample titles.<br/>
 <code>--dock</code> Run in Docker. Applicable only for component samples.
@@ -62,8 +72,8 @@ $ toa replay ./path/to/context
 $ toa replay --title "should add numbers"
 ```
 
-If a path is a context directory (containing `context.toa.yaml` file), samples for components within
-the context will be found and replayed sequentially.
+If the path is a Context root (containing `context.toa.yaml` file), samples for components within the Context will be
+found and replayed sequentially.
 
 ### export manifest
 
@@ -72,54 +82,93 @@ the context will be found and replayed sequentially.
 <dd>Print normalized manifest.
 
 <code>--path</code> path to component (default <code>.</code>)<br/>
-<code>--error</code> print errors only<br/>
+<code>--error</code> print errors only
 </dd>
 </dl>
 
 ## Operations
 
-> Commands use current Kubernetes context.
+> Some commands use current `kubectl` and `docker` context.
+
+### build
+
+Build Docker images.
+
+<dl>
+<dt><code>toa build</code></dt>
+<dd>
+<code>--path</code> path to a Context (default <code>.</code>)
+</dd>
+</dl>
 
 ### deploy
 
+Deploy a Context.
+
+- Build Docker images.
+- Push Docker images to the registry.
+- Build a Helm chart.
+- Apply the Helm chart to the current Kubernetes context.
+
 <dl>
 <dt><code>toa deploy [environment]</code></dt>
-<dd>Deploy context.
-
+<dd>
 <code>environment</code> deployment environment name (default <code>default</code>).<br/>
+<code>--path</code> path to a Context (default <code>.</code>)<br/>
+<code>--namespace</code> Kubernetes namespace to apply the Helm chat to<br/>
+<code>--wait</code> wait until all
+Pods [are ready](https://helm.sh/docs/intro/using_helm/#helpful-options-for-installupgraderollback)<br/>
+<code>--dry</code> do not apply the Helm chart
 </dd>
 </dl>
 
 ### conceal
 
+Deploy a generic Kubernetes secret with the prefix `toa-`.
+
 <dl>
-<dt><code>toa conceal &lt;secret&gt; &lt;key&gt; &lt;value&gt;</code></dt>
-<dd>Deploy a <code>key</code> with a <code>value</code> to a secret named <code>toa-{secret}</code>.</dd>
+<dt><code>toa conceal &lt;secret&gt; &lt;key-values...&gt;</code></dt>
+<dd>
+<code>secret</code> Secret name.<br/>
+<code>key-values</code> List of keys and values of the secret as <code>key=value</code>.<br/>
+<code>--namespace</code> Kubernetes namespace where the secret should be deployed.
+</dd>
 </dl>
 
+> Existing secret will be replaced.
+
+#### Example
+
+```shell
+$ toa conceal bindings-amqp-default username=developer password=secret
+```
+
 ### reveal
 
+Outputs keys and values of a secret.
+
 <dl>
 <dt>
 <code>toa reveal &lt;secret&gt;</code>
 </dt>
-<dd>Print keys and values of a secret.</dd>
 </dl>
 
 ### shell
 
+Run interactive shell inside a disposable pod inside a Kubernetes cluster.
+
 <dl>
 <dt>
 <code>toa shell [image]</code>
 </dt>
-<dd>Run interactive shell inside a disposable pod.
-
-<code>image</code> Docker image<br/>
+<dd>
+<code>image</code> Docker image to Run (default <code>alpine</code>).<br/>
 </dd>
 </dl>
 
-Extra arguments can be passed:
+#### Examples
 
 ```shell
-$ toa shell -- ping 1.1
+$ toa shell mongo
+$ toa shell -- ping 1.1 # extra arguments can be passed
 ```

package/src/commands/compose.js

@@ -22,6 +22,12 @@ const builder = (yargs) => {
       type: 'boolean',
       desc: 'Run in Docker'
     })
+    .option('context', {
+      group: 'Command options:',
+      type: 'string',
+      desc: 'Path to the Context (used with --dock)',
+      default: '.'
+    })
     .option('bindings', {
       group: 'Command options:',
       type: 'string',

package/src/commands/conceal.js

@@ -7,15 +7,25 @@ const builder = (yargs) => {
     .positional('secret', {
       type: 'string'
     })
-    .positional('key', {
-      type: 'string'
+    .positional('key-values', {
+      type: 'string',
+      array: true,
+      desc: 'Secret key-value pairs'
     })
-    .positional('value', {
-      type: 'string'
+    .option('namespace', {
+      alias: 'n',
+      group: 'Command options:',
+      type: 'string',
+      desc: 'Target Kubernetes namespace'
     })
+    .example([
+      ['$0 conceal amqp-credentials username=developer'],
+      ['$0 conceal amqp-credentials username=developer password=secret'],
+      ['$0 conceal amqp-credentials username=developer --namespace app']
+    ])
 }
 
-exports.command = 'conceal <secret> <key> <value>'
-exports.desc = 'Deploy a key with a value to a secret'
+exports.command = 'conceal <secret> <key-values...>'
+exports.desc = 'Deploy a secret'
 exports.builder = builder
 exports.handler = conceal

package/src/commands/env.js

@@ -12,10 +12,16 @@ const builder = (yargs) => {
     .option('path', {
       alias: 'p',
       group: 'Command options:',
-      describe: 'Path to component',
+      describe: 'Path to a Context',
       type: 'string',
       default: '.'
     })
+    .option('as', {
+      group: 'Command options:',
+      describe: 'Output file path',
+      type: 'string',
+      default: '.env'
+    })
 }
 
 exports.command = 'env [environment]'

package/src/commands/replay.js

@@ -21,6 +21,12 @@ const builder = (yargs) => {
       group: 'Command options:',
       describe: 'Replay samples for specified component'
     })
+    .option('autonomous', {
+      alias: 'a',
+      type: 'boolean',
+      group: 'Command options:',
+      describe: 'Replay autonomous tests only'
+    })
     .option('integration', {
       alias: 'i',
       type: 'boolean',
@@ -46,6 +52,12 @@ const builder = (yargs) => {
       group: 'Command options:',
       describe: 'Replay inside Docker container'
     })
+    .option('context', {
+      group: 'Command options:',
+      type: 'string',
+      desc: 'Path to the Context (used with --dock)',
+      default: '.'
+    })
 }
 
 exports.command = 'replay [paths...]'

package/src/handlers/compose.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const { file: { dot } } = require('@toa.io/filesystem')
 const { pick } = require('@toa.io/generic')
 const boot = require('@toa.io/boot')
 
@@ -27,12 +26,11 @@ async function compose (argv) {
  * @return {Promise<void>}
  */
 async function dock (argv) {
-  const envFile = await dot('env')
-  const repository = await docker.build(argv.paths)
+  const repository = await docker.build(argv.context, argv.paths)
   const args = pick(argv, ['kill', 'bindings'])
   const command = docker.command('toa compose *', args)
 
-  await docker.run(repository, command, ['--env-file', envFile])
+  await docker.run(repository, command, argv.env)
 }
 
 exports.compose = compose

package/src/handlers/conceal.js

@@ -3,10 +3,17 @@
 const { secrets } = require('@toa.io/kubernetes')
 
 const conceal = async (argv) => {
-  const { secret, key, value } = argv
-  const prefixed = PREFIX + secret
+  const values = argv['key-values'].reduce((values, pair) => {
+    const [key, value] = pair.split('=')
 
-  await secrets.store(prefixed, { [key]: value })
+    values[key] = value
+
+    return values
+  }, {})
+
+  const secret = PREFIX + argv.secret
+
+  await secrets.store(secret, values, argv.namespace)
 }
 
 const PREFIX = 'toa-'

package/src/handlers/docker/build.js

@@ -1,18 +1,18 @@
 'use strict'
 
 const { newid } = require('@toa.io/generic')
-const { component: load } = require('@toa.io/norm')
+const norm = require('@toa.io/norm')
 const { deployment: { Factory } } = require('@toa.io/operations')
-const runtime = require('@toa.io/runtime')
 
 const find = require('../../util/find')
 
 /**
- * @param {string[]} paths
+ * @param {string} contextPath
+ * @param {string[]} componentPatterns
  * @return {Promise<string>}
  */
-async function build (paths) {
-  const context = await createContext(/** @type {string[]} */ paths)
+async function build (contextPath, componentPatterns) {
+  const context = await createContext(contextPath, componentPatterns)
   const factory = new Factory(context)
   const registry = factory.registry()
 
@@ -20,32 +20,26 @@ async function build (paths) {
 
   const composition = context.compositions[0].name
 
-  return `${context.name}/composition-${composition}`
+  return `${context.registry.base === undefined ? '' : context.registry.base + '/'}${context.name}/composition-${composition}`
 }
 
 /**
- * @param {string[]} patterns
+ * @param {string} contextPath
+ * @param {string[]} componentPatterns
  * @return {Promise<toa.norm.Context>}
  */
-async function createContext (patterns) {
-  const paths = patterns.map((pattern) => find.components(pattern))
+async function createContext (contextPath, componentPatterns) {
+  const contextRoot = find.context(contextPath)
+  const context = await norm.context(contextRoot)
+  const paths = componentPatterns.map((pattern) => find.components(pattern))
   const components = await loadComponents(paths)
   const rnd = newid().substring(0, 6)
   const name = 'replay-' + rnd
 
-  return {
-    name: 'toa-temp',
-    runtime: {
-      version: runtime.version
-    },
-    registry: {
-      platforms: null
-    },
-    compositions: [{
-      name,
-      components
-    }]
-  }
+  context.name += '-' + rnd
+  context.compositions = [{ name, components }]
+
+  return context
 }
 
 /**
@@ -56,7 +50,7 @@ async function loadComponents (paths) {
   const components = []
 
   for (const path of paths) {
-    const component = await load(path)
+    const component = await norm.component(path)
 
     components.push(component)
   }

package/src/handlers/docker/run.js

@@ -4,22 +4,27 @@ const { spawn, exec } = require('node:child_process')
 const { promisify } = require('node:util')
 
 const { promex } = require('@toa.io/generic')
+const { file: { dot } } = require('@toa.io/filesystem')
 
 const execute = promisify(exec)
 
 /**
  * @param {string} repository
  * @param {string} command
- * @param {string[]} runArguments
+ * @param {string} [envFile]
  * @return {Promise<void>}
  */
-async function run (repository, command, runArguments) {
-  const imagesResult =
+async function run (repository, command, envFile) {
+  if (envFile === undefined) envFile = await dot('env')
+
+  const envArgs = envFile === undefined ? [] : ['--env-file', envFile]
+
+  const found =
     /** @type {{ stdout: string }} */
     await execute(`docker images -q ${repository} | head -n 1`)
 
-  const id = imagesResult.stdout.trim()
-  const args = ['run', '--rm', ...(runArguments ?? []), id, 'sh', '-c', command]
+  const id = found.stdout.trim()
+  const args = ['run', '--rm', ...envArgs, id, 'sh', '-c', command]
   const done = promex()
 
   const running = await spawn('docker', args, { stdio: 'inherit' })
@@ -28,7 +33,7 @@ async function run (repository, command, runArguments) {
 
   await done
 
-  await execute(`docker rmi ${id}`)
+  await execute(`docker rmi --force ${id}`)
 }
 
 exports.run = run

package/src/handlers/env.js

@@ -8,7 +8,7 @@ const { context: find } = require('../util/find')
 
 async function env (argv) {
   const path = find(argv.path)
-  const filepath = join(path, '.env')
+  const filepath = join(path, argv.as)
   const operator = await boot.deployment(path, argv.environment)
   const variables = operator.variables()
   const currentValues = await read(filepath)

package/src/handlers/replay.js

@@ -7,7 +7,7 @@ const find = require('../util/find')
 const docker = require('./docker')
 
 /**
- * @param {Record<string, string | boolean>} argv
+ * @param {Record<string, string | string[] | boolean>} argv
  * @return {Promise<void>}
  */
 async function replay (argv) {
@@ -21,6 +21,7 @@ async function replay (argv) {
   /** @type {toa.samples.suite.Options} */
   const options = {
     component: argv.component,
+    autonomous: argv.autonomous,
     integration: argv.integration,
     operation: argv.operation,
     title: argv.title,
@@ -49,11 +50,11 @@ async function replay (argv) {
  * @return {Promise<void>}
  */
 async function dock (argv) {
-  const repository = await docker.build(argv.paths)
+  const repository = await docker.build(argv.context, argv.paths)
   const args = pick(argv, ['component', 'operation', 'integration', 'title'])
   const command = docker.command('toa replay *', args)
 
-  await docker.run(repository, command)
+  await docker.run(repository, command, argv.env)
 }
 
 const GREEN = '\x1b[32m'

package/src/program.js

@@ -16,6 +16,11 @@ yargs(process.argv.slice(2))
 
     console.level(argv.log)
   })
+  .middleware(async (argv) => {
+    if (argv.env === undefined) return
+
+    require('dotenv').config({ path: /** @type {string} */ argv.env })
+  })
   .fail((msg, err) => {
     const actual = err || new Error(msg)
 
@@ -26,6 +31,10 @@ yargs(process.argv.slice(2))
   .option('log', {
     describe: 'Log level'
   })
+  .option('env', {
+    type: 'string',
+    describe: 'Path to environment variables file (.env format)'
+  })
   .commandDir('./commands')
   .demandCommand(1, 'A command is required. Pass --help to see all available commands and options.')
   .strict()