feat: new tool installer

.dockerignore

@@ -1,3 +1,4 @@
 *
 !src
 !test
+src/cli

.eslintignore

@@ -0,0 +1 @@
+/dist

.github/workflows/build.yml

@@ -112,6 +112,9 @@ jobs:
       - name: prepare apt proxy
         run: sudo yarn prepare:proxy
 
+      - name: build
+        run: yarn build
+
       - name: test distro
         run: docker buildx bake
 
@@ -149,6 +152,9 @@ jobs:
       - name: prepare apt proxy
         run: sudo yarn prepare:proxy
 
+      - name: build
+        run: yarn build
+
       - name: test distro
         run: docker buildx bake test-distro
 
@@ -208,6 +214,9 @@ jobs:
       - name: prepare apt proxy
         run: sudo yarn prepare:proxy
 
+      - name: build
+        run: yarn build
+
       - name: test
         run: docker buildx bake test
         env:

.gitignore

@@ -1,7 +1,11 @@
 .cache/
 node_modules/
 /bin
+/dist
+
+# generated files
 /src/usr/local/containerbase/version
+/src/usr/local/containerbase/bin/containerbase-cli-*
 
 .eslintcache
 

Dockerfile

@@ -24,7 +24,6 @@ COPY src/ /
 
 RUN install-containerbase
 
-
 # renovate: datasource=github-tags packageName=git/git
 RUN install-tool git v2.41.0
 

README.md

@@ -13,7 +13,12 @@ Commits to `main` branch are automatically build and published.
 
 You need a recent [docker](https://www.docker.com) version with [buildx](https://github.com/docker/buildx) [`>= v0.4.0`](https://github.com/docker/buildx/releases/tag/v0.4.0) plugin installed.
 
-You should use
+You first need to build the cli before building the docker images.
+
+```console
+> yarn install
+> yarn build
+```
 
 ### Base image
 

package.json

@@ -12,7 +12,8 @@
   },
   "scripts": {
     "bats": "node_modules/bats/bin/bats --timing --verbose-run",
-    "build": "release:prepare",
+    "build": "run-s 'build:*'",
+    "build:cli": "node tools/esbuild.js",
     "eslint": "eslint --cache --report-unused-disable-directives .",
     "eslint-fix": "eslint --cache --fix --report-unused-disable-directives .",
     "lint": "run-s prettier eslint",
@@ -22,21 +23,39 @@
     "prettier-fix": "prettier --cache -w -u \"**/*.*\"",
     "release:prepare": "node tools/prepare-release.js",
     "release:publish": "node tools/publish-release.js",
+    "start": "tsx src/cli/index.ts",
     "test:bats": "node_modules/bats/bin/bats --timing --verbose-run test/bash/ test/bash/v2",
     "test:docker": "node tools/test.js"
   },
+  "dependencies": {
+    "clipanion": "3.2.0",
+    "execa": "7.1.1",
+    "got": "12.6.0",
+    "hasha": "5.2.2",
+    "inversify": "6.0.1",
+    "pino": "8.14.1",
+    "pino-pretty": "10.0.0",
+    "reflect-metadata": "0.1.13",
+    "semver": "7.5.1",
+    "tar": "6.1.15",
+    "typanion": "3.12.1"
+  },
   "devDependencies": {
     "@semantic-release/exec": "6.0.3",
     "@tsconfig/node18": "2.0.1",
     "@types/node": "18.16.16",
+    "@types/semver": "7.5.0",
     "@types/shelljs": "0.8.12",
+    "@types/tar": "6.1.5",
     "@typescript-eslint/eslint-plugin": "5.59.9",
     "@typescript-eslint/parser": "5.59.9",
     "bats": "1.9.0",
     "bats-assert": "2.0.0",
     "bats-support": "0.3.0",
     "clipanion": "3.2.1",
     "conventional-changelog-conventionalcommits": "6.0.0",
+    "esbuild": "0.17.19",
+    "esbuild-plugin-pino": "2.0.0",
     "eslint": "8.42.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-formatter-gha": "1.4.2",
@@ -49,10 +68,12 @@
     "husky": "8.0.3",
     "lint-staged": "13.2.2",
     "npm-run-all": "4.1.5",
+    "pkg": "5.8.1",
     "prettier": "2.8.8",
     "prettier-plugin-package": "1.3.0",
     "semantic-release": "21.0.3",
     "shelljs": "0.8.5",
+    "tsx": "3.12.7",
     "typescript": "5.1.3"
   },
   "contributors": [

src/cli/command/index.ts

@@ -0,0 +1,44 @@
+import { argv0 } from 'node:process';
+import type { Cli } from 'clipanion';
+import type { CliMode } from '../utils';
+import { logger } from '../utils/logger';
+import { InstallToolCommand, InstallToolShortCommand } from './install-tool';
+import { PrepareToolCommand, PrepareToolShortCommand } from './prepare-tool';
+import { prepareToolVersion } from './utils';
+
+export function prepareCommands(
+  cli: Cli,
+  mode: CliMode | null,
+  args: string[]
+): string[] {
+  logger.debug('prepare commands');
+  /*
+   * Workaround for linking the cli tool as different executables.
+   * So it can be called as
+   * - `install-tool node 1.2.3`
+   * - `prepare-tool node`
+   */
+  if (mode === 'install-tool') {
+    cli.register(InstallToolShortCommand);
+    return prepareToolVersion(mode, args);
+  } else if (mode === 'prepare-tool') {
+    cli.register(PrepareToolShortCommand);
+    return args;
+  }
+
+  cli.register(InstallToolCommand);
+  cli.register(PrepareToolCommand);
+  return prepareToolVersion(mode, args);
+}
+
+export function parseBinaryName(
+  mode: CliMode | null,
+  node: string,
+  app: string
+): string | undefined {
+  if (mode) {
+    return mode;
+  }
+
+  return argv0.endsWith('/node') || argv0 === 'node' ? `${node} ${app}` : argv0;
+}

src/cli/command/install-tool.ts

@@ -0,0 +1,57 @@
+import { Command, Option } from 'clipanion';
+import * as t from 'typanion';
+import { installTool } from '../install-tool';
+import { logger, validateVersion } from '../utils';
+
+export class InstallToolCommand extends Command {
+  static override paths = [['install', 'tool'], ['it']];
+
+  static override usage = Command.Usage({
+    description: 'Installs a tool into the container.',
+    examples: [
+      ['Installs node 14.17.0', '$0 install tool node 14.17.0'],
+      [
+        'Installs node with version via environment variable',
+        'NODE_VERSION=14.17.0 $0 install tool node',
+      ],
+    ],
+  });
+
+  name = Option.String({ required: true });
+
+  version = Option.String({
+    required: true,
+    validator: t.cascade(t.isString(), validateVersion()),
+  });
+
+  dryRun = Option.Boolean('-d,--dry-run', false);
+
+  async execute(): Promise<number | void> {
+    const start = Date.now();
+
+    logger.info(`Installing tool ${this.name} v${this.version}...`);
+    try {
+      return await installTool(this.name, this.version, this.dryRun);
+    } catch (err) {
+      logger.fatal(err);
+      return 1;
+    } finally {
+      logger.info(`Installed tool ${this.name} in ${Date.now() - start}ms.`);
+    }
+  }
+}
+
+export class InstallToolShortCommand extends InstallToolCommand {
+  static override paths = [];
+
+  static override usage = Command.Usage({
+    description: 'Installs a tool into the container.',
+    examples: [
+      ['Installs node v14.17.0', '$0 node 14.17.0'],
+      [
+        'Installs node with version via environment variable',
+        'NODE_VERSION=14.17.0 $0 node',
+      ],
+    ],
+  });
+}

src/cli/command/prepare-tool.ts

@@ -0,0 +1,46 @@
+import { Command, Option } from 'clipanion';
+import { prepareTools } from '../prepare-tool';
+import { logger } from '../utils';
+
+export class PrepareToolCommand extends Command {
+  static override paths = [['prepare', 'tool'], ['pt']];
+
+  static override usage = Command.Usage({
+    description: 'Prepares a tool into the container.',
+    examples: [
+      ['Prepares node', '$0 prepare tool node'],
+      ['Prepares all tools', '$0 prepare tool all'],
+    ],
+  });
+
+  tools = Option.Rest({ required: 1 });
+
+  dryRun = Option.Boolean('-d,--dry-run', false);
+
+  async execute(): Promise<number | void> {
+    const start = Date.now();
+    logger.info(`Preparing tools ${this.tools.join(', ')}...`);
+    try {
+      return await prepareTools(this.tools, this.dryRun);
+    } catch (err) {
+      logger.fatal(err);
+      return 1;
+    } finally {
+      logger.info(
+        `Prepared tools ${this.tools.join(', ')} in ${Date.now() - start}ms.`
+      );
+    }
+  }
+}
+
+export class PrepareToolShortCommand extends PrepareToolCommand {
+  static override paths = [];
+
+  static override usage = Command.Usage({
+    description: 'Prepares a tool into the container.',
+    examples: [
+      ['Prepares node', '$0 node'],
+      ['Prepares all tools', '$0'],
+    ],
+  });
+}

src/cli/command/utils.ts

@@ -0,0 +1,37 @@
+import type { CliMode } from '../utils';
+
+export function prepareToolVersion(
+  mode: CliMode | null,
+  args: string[]
+): string[] {
+  switch (mode) {
+    case 'install-tool': {
+      if (args.length === 1) {
+        // install-tool node
+        appendVersion(args, 0);
+      }
+      break;
+    }
+    case 'containerbase-cli':
+    default: {
+      if (args.length === 2) {
+        // containerbase-cli it node
+        appendVersion(args, 1);
+      } else if (args.length === 3) {
+        // containerbase-cli install tool node
+        appendVersion(args, 2);
+      }
+      break;
+    }
+  }
+  return args;
+}
+
+function appendVersion(args: string[], index: number): void {
+  const tool = args.at(index)!;
+  const version =
+    process.env[tool.replace('-', '_').toUpperCase() + '_VERSION'];
+  if (version) {
+    args.push(version);
+  }
+}

src/cli/index.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import 'reflect-metadata';
+import { main } from './main';
+
+void main();

src/cli/install-tool/index.ts

@@ -0,0 +1,31 @@
+import { Container } from 'inversify';
+import { rootContainer } from '../services';
+import { InstallDockerService } from '../tools/docker';
+import { logger } from '../utils';
+import { InstallLegacyToolService } from './install-legacy-tool.service';
+import { INSTALL_TOOL_TOKEN, InstallToolService } from './install-tool.service';
+
+function prepareContainer(): Container {
+  logger.trace('preparing container');
+  const container = new Container();
+  container.parent = rootContainer;
+
+  // core services
+  container.bind(InstallToolService).toSelf();
+  container.bind(InstallLegacyToolService).toSelf();
+
+  // tool services
+  container.bind(INSTALL_TOOL_TOKEN).to(InstallDockerService);
+
+  logger.trace('preparing container done');
+  return container;
+}
+
+export function installTool(
+  tool: string,
+  version: string,
+  dryRun = false
+): Promise<number | void> {
+  const container = prepareContainer();
+  return container.get(InstallToolService).execute(tool, version, dryRun);
+}

src/cli/install-tool/install-legacy-tool.service.ts

@@ -0,0 +1,13 @@
+import { execa } from 'execa';
+import { injectable } from 'inversify';
+import { logger } from '../utils';
+
+@injectable()
+export class InstallLegacyToolService {
+  async execute(tool: string, version: string): Promise<void> {
+    logger.info(`Preparing legacy tool ${tool} ...`);
+    await execa('/usr/local/containerbase/bin/install-tool', [tool, version], {
+      stdio: 'inherit',
+    });
+  }
+}