@enspirit/emb 0.1.1 → 0.1.3

package/README.md

@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.1.1 darwin-x64 node-v22.12.0
+@enspirit/emb/0.1.3 darwin-x64 node-v22.12.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -26,6 +26,7 @@ USAGE
 * [`emb autocomplete [SHELL]`](#emb-autocomplete-shell)
 * [`emb clean`](#emb-clean)
 * [`emb components`](#emb-components)
+* [`emb components logs COMPONENT`](#emb-components-logs-component)
 * [`emb config print`](#emb-config-print)
 * [`emb containers`](#emb-containers)
 * [`emb containers prune`](#emb-containers-prune)
@@ -34,6 +35,7 @@ USAGE
 * [`emb images`](#emb-images)
 * [`emb images delete`](#emb-images-delete)
 * [`emb images prune`](#emb-images-prune)
+* [`emb logs COMPONENT`](#emb-logs-component)
 * [`emb ps`](#emb-ps)
 * [`emb resources`](#emb-resources)
 * [`emb resources build [COMPONENT]`](#emb-resources-build-component)
@@ -115,6 +117,31 @@ EXAMPLES
   $ emb components
 ```
 
+## `emb components logs COMPONENT`
+
+Get components logs.
+
+```
+USAGE
+  $ emb components logs COMPONENT [--flavor <value>] [-f]
+
+ARGUMENTS
+  COMPONENT  The component you want to see the logs of
+
+FLAGS
+  -f, --follow          Follow log output
+      --flavor=<value>  Specify the flavor to use.
+
+DESCRIPTION
+  Get components logs.
+
+ALIASES
+  $ emb logs
+
+EXAMPLES
+  $ emb components logs
+```
+
 ## `emb config print`
 
 Print the current config.
@@ -225,10 +252,11 @@ List docker images.
 
 ```
 USAGE
-  $ emb images [--json] [-a]
+  $ emb images [--json] [--flavor <value>] [-a]
 
 FLAGS
-  -a, --all  Show all images. Only images from a final layer (no children) are shown by default.
+  -a, --all             Show all images. Only images from a final layer (no children) are shown by default.
+      --flavor=<value>  Specify the flavor to use.
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -282,6 +310,31 @@ EXAMPLES
   $ emb images prune
 ```
 
+## `emb logs COMPONENT`
+
+Get components logs.
+
+```
+USAGE
+  $ emb logs COMPONENT [--flavor <value>] [-f]
+
+ARGUMENTS
+  COMPONENT  The component you want to see the logs of
+
+FLAGS
+  -f, --follow          Follow log output
+      --flavor=<value>  Specify the flavor to use.
+
+DESCRIPTION
+  Get components logs.
+
+ALIASES
+  $ emb logs
+
+EXAMPLES
+  $ emb logs
+```
+
 ## `emb ps`
 
 List docker containers.

package/dist/src/cli/abstract/FlavouredCommand.d.ts

@@ -9,5 +9,8 @@ export declare abstract class FlavoredCommand<T extends typeof Command> extends
     static enableJsonFlag: boolean;
     protected args: Args<T>;
     protected flags: Flags<T>;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<void>;
     init(): Promise<void>;
 }

package/dist/src/cli/abstract/FlavouredCommand.js

@@ -1,5 +1,6 @@
 import { getContext, setContext } from '../../index.js';
 import { Flags } from '@oclif/core';
+import { JsonPatchError } from 'fast-json-patch';
 import { BaseCommand } from './BaseCommand.js';
 export class FlavoredCommand extends BaseCommand {
     // define flags that can be inherited by any command that extends FlavoredCommand
@@ -14,6 +15,19 @@ export class FlavoredCommand extends BaseCommand {
     static enableJsonFlag = true;
     args;
     flags;
+    async catch(err) {
+        if (err instanceof JsonPatchError) {
+            this.log('INVALID', err.operation);
+            this.error('Invalid patch detected while applying flavor', {
+                code: err.name,
+                message: `Path \`${err.operation?.path}\``,
+            });
+            return;
+        }
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
     async init() {
         await super.init();
         const { args, flags } = await this.parse({

package/dist/src/cli/commands/components/logs.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: {
+        follow: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        component: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,60 @@
+import { Args, Flags } from '@oclif/core';
+import { FlavoredCommand, getContext } from '../../index.js';
+import { ListContainersOperation } from '../../../docker/index.js';
+export default class ComponentsLogs extends FlavoredCommand {
+    static aliases = ['logs'];
+    static description = 'Get components logs.';
+    static enableJsonFlag = false;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        follow: Flags.boolean({
+            name: 'follow',
+            char: 'f',
+            description: 'Follow log output',
+            default: false,
+        }),
+    };
+    static args = {
+        component: Args.string({
+            name: 'component',
+            description: 'The component you want to see the logs of',
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags, args } = await this.parse(ComponentsLogs);
+        const { monorepo, docker } = await getContext();
+        const component = monorepo.component(args.component);
+        const containers = await monorepo.run(new ListContainersOperation(), {
+            filters: {
+                label: [
+                    `emb/project=${monorepo.name}`,
+                    `emb/component=${component.name}`,
+                    `emb/flavor=${monorepo.currentFlavor}`,
+                ],
+            },
+        });
+        if (containers.length === 0) {
+            return this.error(`No container found for component \`${component.name}\``);
+        }
+        if (containers.length > 1) {
+            return this.error(`More than one container found for component \`${component.name}\``);
+        }
+        const container = await docker.getContainer(containers[0].Id);
+        if (flags.follow) {
+            const stream = await container.logs({
+                follow: true,
+                stderr: true,
+                stdout: true,
+            });
+            stream.pipe(process.stdout);
+        }
+        else {
+            const res = await container.logs({
+                stderr: true,
+                stdout: true,
+            });
+            this.log(res.toString());
+        }
+    }
+}

package/dist/src/cli/commands/images/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseCommand } from '../../index.js';
+import { FlavoredCommand } from '../../index.js';
 export type ImageInfo = {
     created: Date;
     imageId: string;
@@ -6,7 +6,7 @@ export type ImageInfo = {
     size: number;
     tag: string;
 };
-export default class ImagesIndex extends BaseCommand {
+export default class ImagesIndex extends FlavoredCommand<typeof ImagesIndex> {
     static description: string;
     static enableJsonFlag: boolean;
     static examples: string[];

package/dist/src/cli/commands/images/index.js

@@ -1,10 +1,10 @@
 import { getContext } from '../../../index.js';
 import { Flags } from '@oclif/core';
 import { printTable } from '@oclif/table';
-import { BaseCommand, TABLE_DEFAULTS } from '../../index.js';
+import { FlavoredCommand, TABLE_DEFAULTS } from '../../index.js';
 import { listImages, shortId } from '../../../docker/index.js';
 import { timeAgo } from '../../../utils/index.js';
-export default class ImagesIndex extends BaseCommand {
+export default class ImagesIndex extends FlavoredCommand {
     static description = 'List docker images.';
     static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>'];

package/dist/src/cli/commands/up.js

@@ -20,6 +20,9 @@ export default class UpCommand extends FlavoredCommand {
         if (flags.force) {
             buildFlags.push('--force');
         }
+        if (flags.flavor) {
+            buildFlags.push('--flavor', flags.flavor);
+        }
         await this.config.runCommand('resources:build', buildFlags);
         await monorepo.run(new ComposeUpOperation(), {
             forceRecreate: flags.force,

package/dist/src/config/schema.d.ts

@@ -129,6 +129,5 @@ export interface JsonPatchCopyOperation {
     from: string;
 }
 export interface ProjectFlavorConfig {
-    defaults?: DefaultsConfig;
     patches?: JsonPatchOperation[];
 }

package/dist/src/config/schema.json

@@ -200,9 +200,6 @@
             "additionalProperties": false,
             "required": [],
             "properties": {
-                "defaults": {
-                    "$ref": "#/$defs/DefaultsConfig"
-                },
                 "patches": {
                     "type": "array",
                     "items": {

package/dist/src/docker/resources/DockerImageResource.js

@@ -15,18 +15,23 @@ const DockerImageOpFactory = async ({ config, component, monorepo }) => {
     await statfs(context);
     const plugin = new GitPrerequisitePlugin();
     const sources = await plugin.collect(context);
+    const imageName = [monorepo.name, fromConfig.tag || component.name].join('/');
+    const tagName = fromConfig.tag || monorepo.defaults.docker?.tag || 'latest';
     const buildParams = {
         context,
         dockerfile: fromConfig.dockerfile || 'Dockerfile',
         src: sources.map((s) => s.path),
-        buildArgs: fromConfig.buildArgs || {},
-        tag: [monorepo.name, fromConfig.tag || component.name].join('/'),
-        labels: {
+        buildArgs: await monorepo.expand({
+            ...monorepo.defaults.docker?.buildArgs,
+            ...fromConfig.buildArgs,
+        }),
+        tag: await monorepo.expand(`${imageName}:${tagName}`),
+        labels: await monorepo.expand({
             ...fromConfig.labels,
             'emb/project': monorepo.name,
             'emb/component': component.name,
             'emb/flavor': monorepo.currentFlavor,
-        },
+        }),
         target: fromConfig.target,
     };
     const lastUpdatedInfo = async (sources) => {
@@ -54,7 +59,7 @@ const DockerImageOpFactory = async ({ config, component, monorepo }) => {
                 ? lastUpdated
                 : undefined;
         },
-        input: await monorepo.expand(buildParams),
+        input: buildParams,
         operation: new BuildImageOperation(),
     };
 };

package/dist/src/monorepo/component.js

@@ -41,7 +41,7 @@ export class Component {
         const patches = this.flavor(name).patches || [];
         const errors = jsonpatch.validate(patches, original);
         if (errors) {
-            throw new Error('Invalid patch(es) detected');
+            throw errors;
         }
         const patched = patches.reduce((doc, patch, index) => {
             return jsonpatch.applyReducer(doc, patch, index);

package/dist/src/monorepo/monorepo.js

@@ -167,13 +167,13 @@ export class Monorepo {
         const original = this._config.toJSON();
         const errors = jsonpatch.validate(patches || [], original);
         if (errors) {
-            throw new Error('Invalid patch(es) detected');
+            throw errors;
         }
         const withComponentPatches = this.components.reduce((config, cmp) => {
             const componentPatches = cmp.flavor(flavorName, false)?.patches || [];
             const errors = jsonpatch.validate(componentPatches || [], config.components[cmp.name]);
             if (errors) {
-                throw new Error('Invalid patch(es) detected');
+                throw errors;
             }
             config.components[cmp.name] = componentPatches.reduce((doc, patch, index) => {
                 return jsonpatch.applyReducer(doc, patch, index);

package/oclif.manifest.json

@@ -168,12 +168,59 @@
         "index.js"
       ]
     },
-    "containers": {
+    "components:logs": {
       "aliases": [
-        "ps"
+        "logs"
+      ],
+      "args": {
+        "component": {
+          "description": "The component you want to see the logs of",
+          "name": "component",
+          "required": true
+        }
+      },
+      "description": "Get components logs.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
       ],
+      "flags": {
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "follow": {
+          "char": "f",
+          "description": "Follow log output",
+          "name": "follow",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "components:logs",
+      "pluginAlias": "@enspirit/emb",
+      "pluginName": "@enspirit/emb",
+      "pluginType": "core",
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "src",
+        "cli",
+        "commands",
+        "components",
+        "logs.js"
+      ]
+    },
+    "config:print": {
+      "aliases": [],
       "args": {},
-      "description": "List docker containers.",
+      "description": "Print the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -185,22 +232,21 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "all": {
-          "char": "a",
-          "description": "Retun all containers. By default, only running containers are shown",
-          "name": "all",
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
           "required": false,
-          "allowNo": false,
-          "type": "boolean"
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers",
+      "id": "config:print",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -208,14 +254,16 @@
         "src",
         "cli",
         "commands",
-        "containers",
-        "index.js"
+        "config",
+        "print.js"
       ]
     },
-    "containers:prune": {
-      "aliases": [],
+    "containers": {
+      "aliases": [
+        "ps"
+      ],
       "args": {},
-      "description": "Prune containers.",
+      "description": "List docker containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -226,11 +274,19 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "all": {
+          "char": "a",
+          "description": "Retun all containers. By default, only running containers are shown",
+          "name": "all",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers:prune",
+      "id": "containers",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -243,13 +299,13 @@
         "cli",
         "commands",
         "containers",
-        "prune.js"
+        "index.js"
       ]
     },
-    "config:print": {
+    "containers:prune": {
       "aliases": [],
       "args": {},
-      "description": "Print the current config.",
+      "description": "Prune containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -260,22 +316,15 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:print",
+      "id": "containers:prune",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
+      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -283,8 +332,8 @@
         "src",
         "cli",
         "commands",
-        "config",
-        "print.js"
+        "containers",
+        "prune.js"
       ]
     },
     "images:delete": {
@@ -344,6 +393,14 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "all": {
           "char": "a",
           "description": "Show all images. Only images from a final layer (no children) are shown by default.",
@@ -359,7 +416,6 @@
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -611,5 +667,5 @@
       ]
     }
   },
-  "version": "0.1.1"
+  "version": "0.1.3"
 }

package/package.json

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