@toa.io/cli 1.0.1-dev.0 → 1.0.2-alpha.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/cli",
-  "version": "1.0.1-dev.0",
+  "version": "1.0.2-alpha.56+a80d81d4",
   "description": "Toa CLI",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -23,12 +23,12 @@
   },
   "dependencies": {
     "@toa.io/console": "0.6.0",
-    "@toa.io/generic": "0.10.0-dev.0",
-    "@toa.io/kubernetes": "0.7.4-dev.0",
-    "@toa.io/norm": "1.0.1-dev.0",
-    "@toa.io/yaml": "0.7.5-dev.0",
+    "@toa.io/generic": "0.10.1-alpha.56+a80d81d4",
+    "@toa.io/kubernetes": "0.7.5-alpha.56+a80d81d4",
+    "@toa.io/norm": "1.0.2-alpha.56+a80d81d4",
+    "@toa.io/yaml": "0.7.6-alpha.56+a80d81d4",
     "find-up": "5.0.0",
     "yargs": "17.6.2"
   },
-  "gitHead": "5e7998b39ea6111a2cf7d38fad8aeae71d742621"
+  "gitHead": "a80d81d4d9da9fec07606154c959dd6512de4c76"
 }

package/readme.md

@@ -2,43 +2,38 @@
 
 ## Development
 
-### configure
+### compose
 
-Outputs shell commands to manipulate local environment variables, thus must be piped
-with `source /dev/stdin` to apply.
+Run composition.
 
 <dl>
-<dt><code>toa configure &lt;key&gt; [value]</code></dt>
+<dt><code>toa compose [paths]</code></dt>
 <dd>
-Set Configuration Object key. Nested keys are addressed with dot notation.
-
-<code>--path</code> path to component (default <code>.</code>)<br/>
-<code>--reset</code> clear <code>key</code><br/>
-
-#### Examples
+<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/>
+</dd>
+</dl>
 
-> It is assumed you are in the component's directory, use `--path` otherwise.
+> Note that your `localhost` it is accessible from the container as `host.docker.internal`.
 
-```shell
-# set new value
-$ toa configure foo 'new value' | source /dev/stdin
-```
-
-```shell
-# clear key
-$ toa configure bar.baz --reset | source /dev/stdin
-```
+### env
 
-</dd>
-<dt><code>toa configure reset</code></dt>
-<dd>Remove Configuration Object.</dd>
-<dt><code>toa configure print</code></dt>
-<dd>Output Configuration Object as YAML.
+Export environment to a `.env` file.
 
-<code>--json</code> as JSON
+<dl>
+<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/>
 </dd>
 </dl>
 
+Credentials specified in `.env` file are preserved.
+
+> It is recommended to add `.env` to `.gitignore`.
+
 ### replay
 
 [Replay](/extensions/sampling/docs/replay.md) samples. Reports in [TAP](https://testanything.org)
@@ -47,11 +42,12 @@ 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>--component &lt;id&gt;</code> replay samples for specified component id<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>paths</code> Path(s) to component(s) or a context (default <code>.</code>).<br/>
+<code>--integration</code> Replay integration tests only.<br/>
+<code>--component &lt;id&gt;</code> Replay samples for a specified component <code>id</code>.<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.
 </dd>
 </dl>
 
@@ -60,17 +56,15 @@ format.
 ```shell
 $ toa replay
 $ toa replay ./path/to/component
-$ toa replay ./components/a ./components/b
+$ toa replay ./components/a ./components/b --dock
 $ toa replay ./components/*
 $ toa replay ./path/to/context
 $ toa replay --title "should add numbers"
 ```
 
-If path is a context directory (containing `context.toa.yaml` file), samples for components within
+If a path is a context directory (containing `context.toa.yaml` file), samples for components within
 the context will be found and replayed sequentially.
 
-## Exporting
-
 ### export manifest
 
 <dl>
@@ -82,24 +76,9 @@ the context will be found and replayed sequentially.
 </dd>
 </dl>
 
-### env
+## Operations
 
-<dl>
-<dt><code>toa env [environment]</code></dt>
-<dd>Select environment. Set local environment variables to <code>.env</code> file.
-
-<code>environment</code> deployment environment name (default <code>local</code>).<br/>
-<code>--path</code> path to context (default <code>.</code>)<br/>
-</dd>
-</dl>
-
-> It is recommended to add `.env` to `.gitignore`.
-
-> Credentials specified in a `.env` file are preserved during environment selection.
-
-## Deployment
-
-> Deployment commands use current `kubectl` context.
+> Commands use current Kubernetes context.
 
 ### deploy
 
@@ -114,16 +93,8 @@ the context will be found and replayed sequentially.
 ### conceal
 
 <dl>
-<dt>
-<code>toa conceal</code>
-<img src="https://img.shields.io/badge/Not_Implemented-red" alt="Not Implemented"/>
-</dt>
-<dd>Deploy new declared secrets.
-
-<code>--reset</code> don't skip already deployed</dd>
-
 <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 <code>secret</code>.</dd>
+<dd>Deploy a <code>key</code> with a <code>value</code> to a secret named <code>toa-{secret}</code>.</dd>
 </dl>
 
 ### reveal
@@ -134,3 +105,21 @@ the context will be found and replayed sequentially.
 </dt>
 <dd>Print keys and values of a secret.</dd>
 </dl>
+
+### shell
+
+<dl>
+<dt>
+<code>toa shell [image]</code>
+</dt>
+<dd>Run interactive shell inside a disposable pod.
+
+<code>image</code> Docker image<br/>
+</dd>
+</dl>
+
+Extra arguments can be passed:
+
+```shell
+$ toa shell -- ping 1.1
+```

package/src/commands/build.js

@@ -4,10 +4,6 @@ const { build } = require('../handlers/build')
 
 const builder = (yargs) => {
   yargs
-    .positional('environment', {
-      type: 'string',
-      desc: 'Deployment environment'
-    })
     .option('path', {
       alias: 'p',
       group: 'Command options:',
@@ -17,7 +13,7 @@ const builder = (yargs) => {
     })
 }
 
-exports.command = 'build [environment]'
-exports.desc = 'Build and push docker images'
+exports.command = 'build'
+exports.desc = 'Build Docker images'
 exports.builder = builder
 exports.handler = build

package/src/commands/compose.js

@@ -12,10 +12,20 @@ const builder = (yargs) => {
       default: '.'
     })
     .array('paths')
+    .option('kill', {
+      group: 'Command options:',
+      type: 'boolean',
+      desc: 'Immediate shutdown'
+    })
+    .option('dock', {
+      group: 'Command options:',
+      type: 'boolean',
+      desc: 'Run in Docker'
+    })
     .option('bindings', {
       group: 'Command options:',
       type: 'string',
-      desc: 'Bindings'
+      desc: 'OBSOLETE'
     })
     .array('bindings')
     .example([

package/src/commands/export/deployment.js

@@ -6,7 +6,7 @@ const builder = (yargs) => {
   yargs
     .positional('target', {
       type: 'string',
-      desc: 'Export target path'
+      desc: 'Path to export to'
     })
     .positional('environment', {
       type: 'string',
@@ -21,7 +21,7 @@ const builder = (yargs) => {
     })
 }
 
-exports.command = ['deployment <target> [environment]', 'dep']
+exports.command = ['deployment <environment> <target>', 'dep']
 exports.desc = 'Export context deployment'
 exports.builder = builder
 exports.handler = dump

package/src/commands/export/images.js

@@ -6,7 +6,7 @@ const builder = (yargs) => {
   yargs
     .positional('target', {
       type: 'string',
-      desc: 'Export target path'
+      desc: 'Path to export to'
     })
     .option('path', {
       alias: 'p',
@@ -17,7 +17,7 @@ const builder = (yargs) => {
     })
 }
 
-exports.command = ['images [target]', 'imgs']
+exports.command = ['images <target>', 'img']
 exports.desc = 'Export docker image sources'
 exports.builder = builder
 exports.handler = prepare

package/src/commands/push.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const { push } = require('../handlers/push')
+
+const builder = (yargs) => {
+  yargs
+    .option('path', {
+      alias: 'p',
+      group: 'Command options:',
+      type: 'string',
+      desc: 'Path to context',
+      default: '.'
+    })
+}
+
+exports.command = 'push'
+exports.desc = 'Build and push Docker images'
+exports.builder = builder
+exports.handler = push

package/src/commands/replay.js

@@ -4,6 +4,10 @@
 
 const { replay } = require('../handlers/replay')
 
+/*
+!!! OPTIONS MUST BE SYNCHRONIZED WITH ../handlers/.replay/args !!!
+ */
+
 const builder = (yargs) => {
   yargs
     .positional('paths', {
@@ -35,6 +39,13 @@ const builder = (yargs) => {
       group: 'Command options:',
       describe: 'Replay samples with titles matching given regexp'
     })
+    .option('dock', {
+      alias: 'd',
+      type: 'boolean',
+      default: false,
+      group: 'Command options:',
+      describe: 'Replay inside Docker container'
+    })
 }
 
 exports.command = 'replay [paths...]'

package/src/commands/shell.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { shell } = require('../handlers/shell')
+
+const builder = (yargs) => {
+  yargs
+    .positional('image', {
+      group: 'Command options:',
+      type: 'string',
+      desc: 'Docker image',
+      default: 'alpine'
+    })
+    .example([
+      ['$0 shell'],
+      ['$0 shell -- ping localhost']
+    ])
+}
+
+exports.command = 'shell [image]'
+exports.desc = 'Run interactive shell from the current Kubernetes context'
+exports.builder = builder
+exports.handler = shell

package/src/handlers/build.js

@@ -6,9 +6,9 @@ const { context: find } = require('../util/find')
 
 const build = async (argv) => {
   const path = find(argv.path)
-  const operator = await boot.deployment(path, argv.environment)
+  const registry = await boot.registry(path)
 
-  await operator.build()
+  await registry.build()
 }
 
 exports.build = build

package/src/handlers/compose.js

@@ -1,14 +1,38 @@
 'use strict'
 
+const { file: { dot } } = require('@toa.io/filesystem')
+const { pick } = require('@toa.io/generic')
 const boot = require('@toa.io/boot')
 
+const docker = require('./docker')
 const { components: find } = require('../util/find')
 
+/**
+ * @param {Record<string, string | boolean>} argv
+ * @return {Promise<void>}
+ */
 async function compose (argv) {
+  if (argv.dock === true) return dock(argv)
+
   const paths = find(argv.paths)
   const composition = await boot.composition(paths, argv)
 
   await composition.connect()
+
+  if (argv.kill === true) await composition.disconnect()
+}
+
+/**
+ * @param {Record<string, string | string[] | boolean>} argv
+ * @return {Promise<void>}
+ */
+async function dock (argv) {
+  const envFile = await dot('env')
+  const repository = await docker.build(argv.paths)
+  const args = pick(argv, ['kill', 'bindings'])
+  const command = docker.command('toa compose *', args)
+
+  await docker.run(repository, command, ['--env-file', envFile])
 }
 
 exports.compose = compose

package/src/handlers/conceal.js

@@ -4,8 +4,12 @@ const { secrets } = require('@toa.io/kubernetes')
 
 const conceal = async (argv) => {
   const { secret, key, value } = argv
+  const prefixed = PREFIX + secret
 
-  await secrets.store(secret, { [key]: value })
+  await secrets.store(prefixed, { [key]: value })
 }
 
+const PREFIX = 'toa-'
+
 exports.conceal = conceal
+exports.PREFIX = PREFIX

package/src/handlers/docker/build.js

@@ -0,0 +1,67 @@
+'use strict'
+
+const { newid } = require('@toa.io/generic')
+const { component: load } = 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
+ * @return {Promise<string>}
+ */
+async function build (paths) {
+  const context = await createContext(/** @type {string[]} */ paths)
+  const factory = new Factory(context)
+  const registry = factory.registry()
+
+  await registry.build()
+
+  const composition = context.compositions[0].name
+
+  return `${context.name}/composition-${composition}`
+}
+
+/**
+ * @param {string[]} patterns
+ * @return {Promise<toa.norm.Context>}
+ */
+async function createContext (patterns) {
+  const paths = patterns.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
+    }]
+  }
+}
+
+/**
+ * @param {string[]} paths
+ * @return {Promise<toa.norm.Component[]>}
+ */
+async function loadComponents (paths) {
+  const components = []
+
+  for (const path of paths) {
+    const component = await load(path)
+
+    components.push(component)
+  }
+
+  return components
+}
+
+exports.build = build

package/src/handlers/docker/command.js

@@ -0,0 +1,23 @@
+'use strict'
+
+/**
+ * @param {string} command
+ * @param {Record<string, any>} args
+ */
+const command = (command, args) => {
+  const options = []
+
+  for (const [name, value] of Object.entries(args)) {
+    if (value === undefined) continue
+
+    options.push('--' + name)
+
+    if (typeof value !== 'boolean') options.push(`"${value}"`)
+  }
+
+  const argumentLine = options.join(' ')
+
+  return command + ' ' + argumentLine
+}
+
+exports.command = command

package/src/handlers/docker/index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const { build } = require('./build')
+const { command } = require('./command')
+const { run } = require('./run')
+
+exports.build = build
+exports.command = command
+exports.run = run

package/src/handlers/docker/run.js

@@ -0,0 +1,34 @@
+'use strict'
+
+const { spawn, exec } = require('node:child_process')
+const { promisify } = require('node:util')
+
+const { promex } = require('@toa.io/generic')
+
+const execute = promisify(exec)
+
+/**
+ * @param {string} repository
+ * @param {string} command
+ * @param {string[]} runArguments
+ * @return {Promise<void>}
+ */
+async function run (repository, command, runArguments) {
+  const imagesResult =
+    /** @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 done = promex()
+
+  const running = await spawn('docker', args, { stdio: 'inherit' })
+
+  running.on('exit', done.resolve)
+
+  await done
+
+  await execute(`docker rmi ${id}`)
+}
+
+exports.run = run

package/src/handlers/export/images.js

@@ -13,4 +13,12 @@ const prepare = async (argv) => {
   console.log(path)
 }
 
+// const prepare = async (argv) => {
+//   const context = find(argv.path)
+//   const registry = await boot.registry(context)
+//   const path = await registry.prepare(argv.target)
+//
+//   console.log(path)
+// }
+
 exports.prepare = prepare

package/src/handlers/push.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const boot = require('@toa.io/boot')
+
+const { context: find } = require('../util/find')
+
+const push = async (argv) => {
+  const path = find(argv.path)
+  const registry = await boot.registry(path)
+
+  await registry.push()
+}
+
+exports.push = push

package/src/handlers/replay.js

@@ -1,10 +1,17 @@
 'use strict'
 
+const { pick } = require('@toa.io/generic')
+const { context, components } = require('@toa.io/userland/samples')
+
 const find = require('../util/find')
+const docker = require('./docker')
 
+/**
+ * @param {Record<string, string | boolean>} argv
+ * @return {Promise<void>}
+ */
 async function replay (argv) {
-  // prevent loading userland which is intended for local use only
-  const { context, components } = require('@toa.io/userland/samples')
+  if (argv.dock) return dock(argv)
 
   /** @type {boolean} */
   let ok
@@ -16,7 +23,8 @@ async function replay (argv) {
     component: argv.component,
     integration: argv.integration,
     operation: argv.operation,
-    title: argv.title
+    title: argv.title,
+    runner: { bail: true }
   }
 
   if (paths !== null) {
@@ -36,6 +44,18 @@ async function replay (argv) {
   process.on('beforeExit', () => console.log(message))
 }
 
+/**
+ * @param {Record<string, string | string[] | boolean>} argv
+ * @return {Promise<void>}
+ */
+async function dock (argv) {
+  const repository = await docker.build(argv.paths)
+  const args = pick(argv, ['component', 'operation', 'integration', 'title'])
+  const command = docker.command('toa replay *', args)
+
+  await docker.run(repository, command)
+}
+
 const GREEN = '\x1b[32m'
 const RED = '\x1b[31m'
 const RESET = '\x1b[0m'

package/src/handlers/reveal.js

@@ -3,8 +3,11 @@
 const { secrets } = require('@toa.io/kubernetes')
 const { remap, decode } = require('@toa.io/generic')
 
+const { PREFIX } = require('./conceal')
+
 const reveal = async (argv) => {
-  const secret = await secrets.get(argv.secret)
+  const prefixed = PREFIX + argv.secret
+  const secret = await secrets.get(prefixed)
   const values = remap(secret.data, decode)
 
   for (const [key, value] of Object.entries(values)) {

package/src/handlers/shell.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const { spawn } = require('node:child_process')
+const { newid } = require('@toa.io/generic')
+
+const shell = async (argv) => {
+  const rnd = newid().substring(0, 6)
+
+  const args = [
+    'run',
+    'shell-' + rnd,
+    '--rm',
+    '-i',
+    '--tty',
+    '--image',
+    argv.image,
+    '--restart=Never',
+    '--'
+  ]
+
+  const extra = argv._.splice(1)
+
+  if (extra.length > 0) args.push(...extra)
+  else args.push('sh')
+
+  await spawn('kubectl', args, { stdio: 'inherit' })
+}
+
+exports.shell = shell

package/src/program.js

@@ -19,7 +19,7 @@ yargs(process.argv.slice(2))
   .fail((msg, err) => {
     const actual = err || new Error(msg)
 
-    console.error(process.env.TOA_DEBUG === '1' ? actual : actual.message)
+    console.error(actual)
 
     process.exit(actual.exitCode > 0 ? actual.exitCode : 1)
   })

package/src/util/find.js

@@ -17,7 +17,7 @@ const find = (from, filename, test) => {
 
     if (found.size === 0) {
       if (test === true) return null
-      else throw new Error(`File '${filename}' is found in ${from.join(', ')}`)
+      else throw new Error(`File '${filename}' is not found in ${from.join(', ')}`)
     }
 
     return [...found]

package/src/commands/configure.js

@@ -1,43 +0,0 @@
-'use strict'
-
-const { configure } = require('../handlers/configure')
-
-const builder = (yargs) => {
-  yargs
-    .positional('key', {
-      type: 'string',
-      desc: 'Configuration Object key'
-    })
-    .positional('value', {
-      type: 'string',
-      desc: 'Key value'
-    })
-    .option('path', {
-      alias: 'p',
-      group: 'Command options:',
-      describe: 'Path to component',
-      type: 'string',
-      default: '.'
-    })
-    .option('reset', {
-      group: 'Command options:',
-      type: 'boolean',
-      desc: 'Remove Configuration Object key'
-    })
-    .option('json', {
-      group: 'Command options:',
-      type: 'boolean',
-      desc: 'Print as JSON'
-    })
-    .example([
-      ['$0 configure myKey \'new value\' | source /dev/stdin'],
-      ['$0 configure myObject.myKey --reset | source /dev/stdin'],
-      ['$0 configure reset | source /dev/stdin'],
-      ['$0 configure print --json']
-    ])
-}
-
-exports.command = 'configure [key] [value]'
-exports.desc = 'Output shell command to update local environment Configuration Object'
-exports.builder = builder
-exports.handler = configure

package/src/handlers/.configure/subcommands.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const { dump } = require('@toa.io/yaml')
-
-const reset = (provider) => console.log('unset ' + provider.key)
-
-const print = async (provider, argv) => {
-  await provider.connect()
-
-  const formatter = argv.json ? JSON.stringify : dump
-
-  console.log(formatter(provider.object))
-}
-
-exports.subcommands = { print, reset }

package/src/handlers/configure.js

@@ -1,46 +0,0 @@
-'use strict'
-
-const boot = require('@toa.io/boot')
-
-const { Factory } = require('@toa.io/extensions.configuration')
-
-const { subcommands } = require('./.configure/subcommands')
-const { components: find } = require('../util/find')
-
-async function configure (argv) {
-  const path = find(argv.path)
-  const manifest = await boot.manifest(path)
-  const factory = new Factory()
-  const provider = factory.provider(manifest)
-
-  if (argv.value === undefined && subcommands[argv.key] !== undefined) {
-    await subcommands[argv.key](provider, argv)
-
-    return
-  }
-
-  await provider.connect()
-
-  let key = argv.key
-  let value = argv.value
-
-  // :(
-  if (key !== undefined) {
-    if (value === undefined && key.includes('=')) [key, value] = key.split('=')
-
-    if (value === undefined) {
-      if (argv.reset !== true) throw new Error('Key value expected')
-      else provider.unset(key)
-    } else provider.set(key, value)
-  }
-
-  let command
-  const exported = provider.export()
-
-  if (exported === undefined) command = `unset ${provider.key}`
-  else command = `export ${provider.key}=` + exported
-
-  console.log(command)
-}
-
-exports.configure = configure