@enspirit/emb 0.1.3 → 0.2.0

package/README.md

@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.1.3 darwin-x64 node-v22.12.0
+@enspirit/emb/0.2.0 darwin-x64 node-v22.12.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -27,6 +27,7 @@ USAGE
 * [`emb clean`](#emb-clean)
 * [`emb components`](#emb-components)
 * [`emb components logs COMPONENT`](#emb-components-logs-component)
+* [`emb components shell COMPONENT`](#emb-components-shell-component)
 * [`emb config print`](#emb-config-print)
 * [`emb containers`](#emb-containers)
 * [`emb containers prune`](#emb-containers-prune)
@@ -39,6 +40,7 @@ USAGE
 * [`emb ps`](#emb-ps)
 * [`emb resources`](#emb-resources)
 * [`emb resources build [COMPONENT]`](#emb-resources-build-component)
+* [`emb shell COMPONENT`](#emb-shell-component)
 * [`emb tasks`](#emb-tasks)
 * [`emb tasks run TASK`](#emb-tasks-run-task)
 * [`emb up`](#emb-up)
@@ -142,6 +144,31 @@ EXAMPLES
   $ emb components logs
 ```
 
+## `emb components shell COMPONENT`
+
+Get a shell on a running component.
+
+```
+USAGE
+  $ emb components shell COMPONENT [--flavor <value>] [-s <value>]
+
+ARGUMENTS
+  COMPONENT  The component you want to get a shell on
+
+FLAGS
+  -s, --shell=<value>   [default: bash] The shell to run
+      --flavor=<value>  Specify the flavor to use.
+
+DESCRIPTION
+  Get a shell on a running component.
+
+ALIASES
+  $ emb shell
+
+EXAMPLES
+  $ emb components shell
+```
+
 ## `emb config print`
 
 Print the current config.
@@ -406,6 +433,31 @@ EXAMPLES
   $ emb resources build build --flavor development
 ```
 
+## `emb shell COMPONENT`
+
+Get a shell on a running component.
+
+```
+USAGE
+  $ emb shell COMPONENT [--flavor <value>] [-s <value>]
+
+ARGUMENTS
+  COMPONENT  The component you want to get a shell on
+
+FLAGS
+  -s, --shell=<value>   [default: bash] The shell to run
+      --flavor=<value>  Specify the flavor to use.
+
+DESCRIPTION
+  Get a shell on a running component.
+
+ALIASES
+  $ emb shell
+
+EXAMPLES
+  $ emb shell
+```
+
 ## `emb tasks`
 
 List tasks.

package/dist/src/cli/commands/components/shell.d.ts

@@ -0,0 +1,14 @@
+import { FlavoredCommand } from '../../index.js';
+export default class ComponentsLogs extends FlavoredCommand<typeof ComponentsLogs> {
+    static aliases: string[];
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        shell: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static args: {
+        component: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

package/dist/src/cli/commands/components/shell.js

@@ -0,0 +1,41 @@
+import { Args, Flags } from '@oclif/core';
+import { FlavoredCommand, getContext } from '../../index.js';
+import { ExecShellOperation } from '../../../docker/index.js';
+import { ShellExitError } from '../../../errors.js';
+export default class ComponentsLogs extends FlavoredCommand {
+    static aliases = ['shell'];
+    static description = 'Get a shell on a running component.';
+    static enableJsonFlag = false;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        shell: Flags.string({
+            name: 'shell',
+            char: 's',
+            description: 'The shell to run',
+            default: 'bash',
+        }),
+    };
+    static args = {
+        component: Args.string({
+            name: 'component',
+            description: 'The component you want to get a shell on',
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags, args } = await this.parse(ComponentsLogs);
+        const { monorepo } = await getContext();
+        try {
+            await monorepo.run(new ExecShellOperation(), {
+                component: args.component,
+                shell: flags.shell,
+            });
+        }
+        catch (error) {
+            if (error instanceof ShellExitError) {
+                this.error(error);
+            }
+            throw error;
+        }
+    }
+}

package/dist/src/docker/operations/containers/ExecShellOperation.d.ts

@@ -0,0 +1,11 @@
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+declare const schema: z.ZodObject<{
+    shell: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    component: z.ZodString;
+}, z.core.$strip>;
+export declare class ExecShellOperation extends AbstractOperation<typeof schema, void> {
+    constructor();
+    protected _run(input: z.input<typeof schema>): Promise<void>;
+}
+export {};

package/dist/src/docker/operations/containers/ExecShellOperation.js

@@ -0,0 +1,70 @@
+import { getContext, ListContainersOperation, MultipleContainersFoundError, NoContainerFoundError, ShellExitError, } from '../../../index.js';
+import { spawn } from 'node:child_process';
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+const schema = z.object({
+    shell: z.string().default('bash').optional(),
+    component: z
+        .string()
+        .describe('The name of the component on which to run a shell'),
+});
+export class ExecShellOperation extends AbstractOperation {
+    constructor() {
+        super(schema);
+    }
+    async _run(input) {
+        const { monorepo } = getContext();
+        const containers = await monorepo.run(new ListContainersOperation(), {
+            filters: {
+                label: [
+                    `emb/project=${monorepo.name}`,
+                    `emb/component=${input.component}`,
+                    `emb/flavor=${monorepo.currentFlavor}`,
+                ],
+            },
+        });
+        if (containers.length === 0) {
+            throw new NoContainerFoundError(`No container found for component \`${input.component}\``, input.component);
+        }
+        if (containers.length > 1) {
+            throw new MultipleContainersFoundError(`More than one container found for component \`${input.component}\``, input.component);
+        }
+        const cmd = 'docker';
+        const args = ['exec', '-it', containers[0].Id, input?.shell || 'bash'];
+        const child = spawn(cmd, args, {
+            stdio: 'inherit',
+            env: {
+                ...process.env,
+                DOCKER_CLI_HINTS: 'false',
+            },
+        });
+        const forward = (sig) => {
+            try {
+                child.kill(sig);
+            }
+            catch { }
+        };
+        const signals = [
+            'SIGINT',
+            'SIGTERM',
+            'SIGHUP',
+            'SIGQUIT',
+        ];
+        signals.forEach((sig) => {
+            process.on(sig, () => forward(sig));
+        });
+        return new Promise((resolve, reject) => {
+            child.on('error', (err) => {
+                reject(new Error(`Failed to exeucte docker: ${err.message}`));
+            });
+            child.on('exit', (code, signal) => {
+                if (code !== null && code !== 0) {
+                    reject(new ShellExitError(`The shell exited unexpectedly. ${code}`, input.component, code, signal));
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+}

package/dist/src/docker/operations/containers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './ExecContainerOperation.js';
+export * from './ExecShellOperation.js';
 export * from './ListContainersOperation.js';
 export * from './PruneContainersOperation.js';

package/dist/src/docker/operations/containers/index.js

@@ -1,3 +1,4 @@
 export * from './ExecContainerOperation.js';
+export * from './ExecShellOperation.js';
 export * from './ListContainersOperation.js';
 export * from './PruneContainersOperation.js';

package/dist/src/errors.d.ts

@@ -58,3 +58,17 @@ export declare class CircularDependencyError extends EMBError {
     readonly deps: Array<Array<string>>;
     constructor(msg: string, deps: Array<Array<string>>);
 }
+export declare class ShellExitError extends EMBError {
+    component: string;
+    exitCode: number;
+    signal?: (NodeJS.Signals | null) | undefined;
+    constructor(msg: string, component: string, exitCode: number, signal?: (NodeJS.Signals | null) | undefined);
+}
+export declare class NoContainerFoundError extends EMBError {
+    component: string;
+    constructor(msg: string, component: string);
+}
+export declare class MultipleContainersFoundError extends EMBError {
+    component: string;
+    constructor(msg: string, component: string);
+}

package/dist/src/errors.js

@@ -44,7 +44,7 @@ export class AmbiguousReferenceError extends EMBError {
     ref;
     matches;
     constructor(msg, ref, matches) {
-        super('AMBIGUOUS_TASK', msg);
+        super('AMBIGUOUS_REF', msg);
         this.ref = ref;
         this.matches = matches;
     }
@@ -70,3 +70,28 @@ export class CircularDependencyError extends EMBError {
         this.deps = deps;
     }
 }
+export class ShellExitError extends EMBError {
+    component;
+    exitCode;
+    signal;
+    constructor(msg, component, exitCode, signal) {
+        super('SHELL_EXIT_ERR', msg);
+        this.component = component;
+        this.exitCode = exitCode;
+        this.signal = signal;
+    }
+}
+export class NoContainerFoundError extends EMBError {
+    component;
+    constructor(msg, component) {
+        super('CMP_NO_CONTAINER', msg);
+        this.component = component;
+    }
+}
+export class MultipleContainersFoundError extends EMBError {
+    component;
+    constructor(msg, component) {
+        super('CMP_NO_CONTAINER', msg);
+        this.component = component;
+    }
+}

package/oclif.manifest.json

@@ -217,6 +217,57 @@
         "logs.js"
       ]
     },
+    "components:shell": {
+      "aliases": [
+        "shell"
+      ],
+      "args": {
+        "component": {
+          "description": "The component you want to get a shell on",
+          "name": "component",
+          "required": true
+        }
+      },
+      "description": "Get a shell on a running component.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "shell": {
+          "char": "s",
+          "description": "The shell to run",
+          "name": "shell",
+          "default": "bash",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "components:shell",
+      "pluginAlias": "@enspirit/emb",
+      "pluginName": "@enspirit/emb",
+      "pluginType": "core",
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "src",
+        "cli",
+        "commands",
+        "components",
+        "shell.js"
+      ]
+    },
     "config:print": {
       "aliases": [],
       "args": {},
@@ -469,18 +520,12 @@
         "prune.js"
       ]
     },
-    "resources:build": {
+    "tasks": {
       "aliases": [],
-      "args": {
-        "component": {
-          "description": "List of resources to build (defaults to all)",
-          "name": "component",
-          "required": false
-        }
-      },
-      "description": "Build the resources of the monorepo",
+      "args": {},
+      "description": "List tasks.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> build --flavor development"
+        "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
         "json": {
@@ -489,38 +534,15 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "dry-run": {
-          "description": "Do not build the resources but only produce build meta information",
-          "name": "dry-run",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "force": {
-          "char": "f",
-          "description": "Bypass the cache and force the build",
-          "name": "force",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "resources:build",
+      "id": "tasks",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -528,14 +550,20 @@
         "src",
         "cli",
         "commands",
-        "resources",
-        "build.js"
+        "tasks",
+        "index.js"
       ]
     },
-    "resources": {
+    "tasks:run": {
       "aliases": [],
-      "args": {},
-      "description": "List resources.",
+      "args": {
+        "task": {
+          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
+          "name": "task",
+          "required": true
+        }
+      },
+      "description": "Run tasks.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -547,21 +575,33 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
+        "executor": {
+          "char": "x",
+          "description": "Where to run the task. (experimental!)",
+          "name": "executor",
           "hasDynamicHelp": false,
           "multiple": false,
+          "options": [
+            "container",
+            "local"
+          ],
           "type": "option"
+        },
+        "all-matching": {
+          "char": "a",
+          "description": "Run all tasks matching (when multiple matches)",
+          "name": "all-matching",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "resources",
+      "id": "tasks:run",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
+      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -569,16 +609,22 @@
         "src",
         "cli",
         "commands",
-        "resources",
-        "index.js"
+        "tasks",
+        "run.js"
       ]
     },
-    "tasks": {
+    "resources:build": {
       "aliases": [],
-      "args": {},
-      "description": "List tasks.",
+      "args": {
+        "component": {
+          "description": "List of resources to build (defaults to all)",
+          "name": "component",
+          "required": false
+        }
+      },
+      "description": "Build the resources of the monorepo",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> build --flavor development"
       ],
       "flags": {
         "json": {
@@ -587,15 +633,38 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dry-run": {
+          "description": "Do not build the resources but only produce build meta information",
+          "name": "dry-run",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "Bypass the cache and force the build",
+          "name": "force",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks",
+      "id": "resources:build",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -603,20 +672,14 @@
         "src",
         "cli",
         "commands",
-        "tasks",
-        "index.js"
+        "resources",
+        "build.js"
       ]
     },
-    "tasks:run": {
+    "resources": {
       "aliases": [],
-      "args": {
-        "task": {
-          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
-          "name": "task",
-          "required": true
-        }
-      },
-      "description": "Run tasks.",
+      "args": {},
+      "description": "List resources.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -628,33 +691,21 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "executor": {
-          "char": "x",
-          "description": "Where to run the task. (experimental!)",
-          "name": "executor",
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
-          "options": [
-            "container",
-            "local"
-          ],
           "type": "option"
-        },
-        "all-matching": {
-          "char": "a",
-          "description": "Run all tasks matching (when multiple matches)",
-          "name": "all-matching",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks:run",
+      "id": "resources",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -662,10 +713,10 @@
         "src",
         "cli",
         "commands",
-        "tasks",
-        "run.js"
+        "resources",
+        "index.js"
       ]
     }
   },
-  "version": "0.1.3"
+  "version": "0.2.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@enspirit/emb",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "keywords": ["monorepo", "docker", "taskrunner", "ci", "docker compose", "sentinel", "makefile"],
   "author": "Louis Lambeau <louis.lambeau@enspirit.be>",
   "license": "ISC",