@travetto/pack 4.0.0-rc.6 → 4.0.0-rc.8

package/README.md

@@ -133,15 +133,16 @@ Options:
   -r, --rollup-configuration <string>    Rollup configuration file (default: "@travetto/pack/support/rollup/build")
   --env-file <string>                    Env Flag File Name (default: ".env")
   --manifest-file <string>               Manifest File Name (default: "manifest.json")
-  -df, --docker-factory <string>         Docker Factory source  (default: "@travetto/pack/support/pack.dockerfile")
-  -di, --docker-image <string>           Docker Image to extend  (default: "node:20-alpine")
-  -dn, --docker-name <string>            Docker Image Name  (default: "travetto_pack")
-  -dt, --docker-tag <string>             Docker Image Tag  (default: ["latest"])
-  -dp, --docker-port <number>            Docker Image Port  (default: [])
-  -dx, --docker-push                     Docker Push Tags  (default: false)
+  -df, --docker-factory <string>         Docker Factory source (default: "@travetto/pack/support/pack.dockerfile")
+  -di, --docker-image <string>           Docker Image to extend (default: "node:20-alpine")
+  -dn, --docker-name <string>            Docker Image Name (default: "travetto_pack")
+  -dt, --docker-tag <string>             Docker Image Tag (default: ["latest"])
+  -dp, --docker-port <number>            Docker Image Port (default: [])
+  -dx, --docker-push                     Docker Push Tags (default: false)
   -db, --docker-build-platform <string>  Docker Build Platform
   -dr, --docker-registry <string>        Docker Registry
-  -du, --docker-runtime-user <string>    Docker Runtime user
+  -ru, --runtime-user <string>           Docker Runtime user
+  -rp, --runtime-package <string>        Docker Runtime Packages (default: [])
   -m, --module <module>                  Module to run for
   -h, --help                             display help for command
 ```
@@ -236,12 +237,22 @@ cd $TRV_OUT
 npx rollup -c $TRV_OUT/node_modules/@travetto/pack/support/rollup/build.js
 cd $ROOT
 
+# Pulling Docker Base Image node:20-alpine 
+
+echo "Pulling Docker Base Image node:20-alpine"
+
+docker pull node:20-alpine
+
+# Detected Image OS node:20-alpine as alpine 
+
+echo "Detected Image OS node:20-alpine as alpine"
+
 # Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile 
 
 echo "Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile"
 
 echo "FROM node:20-alpine" > $DIST/Dockerfile
-echo "RUN which useradd && (groupadd --gid 2000 app && useradd -u 2000 -g app app) || (addgroup -g 2000 app && adduser -D -G app -u 2000 app)" >> $DIST/Dockerfile
+echo "RUN addgroup -g 2000 app && adduser -D -G app -u 2000 app" >> $DIST/Dockerfile
 echo "RUN mkdir /app && chown app:app /app" >> $DIST/Dockerfile
 echo "COPY --chown=\"app:app\" . /app" >> $DIST/Dockerfile
 echo "ENV NODE_OPTIONS=\"\"" >> $DIST/Dockerfile
@@ -249,12 +260,6 @@ echo "USER app" >> $DIST/Dockerfile
 echo "WORKDIR /app" >> $DIST/Dockerfile
 echo "ENTRYPOINT [\"/app/todo-app.sh\"]" >> $DIST/Dockerfile
 
-# Pulling Docker Base Image node:20-alpine 
-
-echo "Pulling Docker Base Image node:20-alpine"
-
-docker pull node:20-alpine
-
 # Building Docker Container latest 
 
 echo "Building Docker Container latest"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "4.0.0-rc.6",
+  "version": "4.0.0-rc.8",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -29,12 +29,12 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@travetto/base": "^4.0.0-rc.5",
-    "@travetto/terminal": "^4.0.0-rc.5",
+    "@travetto/base": "^4.0.0-rc.7",
+    "@travetto/terminal": "^4.0.0-rc.7",
     "rollup": "^4.9.6"
   },
   "peerDependencies": {
-    "@travetto/cli": "^4.0.0-rc.5"
+    "@travetto/cli": "^4.0.0-rc.7"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config-util.ts

@@ -1,7 +1,5 @@
 import { DockerPackConfig } from './types';
 
-const ifElse = (check: string, succ: string, fail: string): string => `${check} && (${succ}) || (${fail})`;
-
 /**
  * Common utils for setting up pack config
  */
@@ -13,6 +11,24 @@ export class PackConfigUtil {
     return `FROM ${cfg.dockerImage}`;
   }
 
+  /**
+   * Install docker pages in either apk or apt environments
+   */
+  static dockerPackageInstall(cfg: DockerPackConfig): string {
+    const { os, packages } = cfg.dockerRuntime;
+    if (packages?.length) {
+      switch (os) {
+        case 'alpine': return `RUN apk --update add ${packages.join(' ')} && rm -rf /var/cache/apk/*`;
+        case 'debian': return `RUN apt update && apt install -y ${packages.join(' ')} && rm -rf  /var/lib/{apt,dpkg,cache,log}/`;
+        case 'centos': return `RUN yum -y install ${packages.join(' ')} && yum -y clean all && rm -fr /var/cache`;
+        case 'unknown':
+        default: throw new Error('Unable to install packages in an unknown os');
+      }
+    } else {
+      return '';
+    }
+  }
+
   /**
    * Setup docker ports
    */
@@ -24,14 +40,18 @@ export class PackConfigUtil {
    * Setup docker user
    */
   static dockerUser(cfg: DockerPackConfig): string {
-    const { user, group, uid, gid } = cfg.dockerRuntime;
-    return [
-      user !== 'root' ? ifElse(
-        'RUN which useradd',
-        `groupadd --gid ${gid} ${group} && useradd -u ${uid} -g ${group} ${user}`,
-        `addgroup -g ${gid} ${group} && adduser -D -G ${group} -u ${uid} ${user}`
-      ) : '',
-    ].join('\n');
+    const { os, user, group, uid, gid } = cfg.dockerRuntime;
+    if (user === 'root') {
+      return '';
+    } else {
+      switch (os) {
+        case 'alpine': return `RUN addgroup -g ${gid} ${group} && adduser -D -G ${group} -u ${uid} ${user}`;
+        case 'debian':
+        case 'centos': return `RUN groupadd --gid ${gid} ${group} && useradd -u ${uid} -g ${group} ${user}`;
+        case 'unknown':
+        default: throw new Error('Unable to add user/group for an unknown os');
+      }
+    }
   }
 
   /**
@@ -79,6 +99,7 @@ export class PackConfigUtil {
     return [
       this.dockerPorts(cfg),
       this.dockerUser(cfg),
+      this.dockerPackageInstall(cfg),
       this.dockerAppFolder(cfg),
       this.dockerAppFiles(cfg),
       this.dockerEnvVars(cfg),

package/src/types.ts

@@ -33,6 +33,8 @@ export type DockerPackConfig = {
   dockerPush?: boolean;
   dockerRegistry?: string;
   dockerRuntime: {
+    os?: 'alpine' | 'debian' | 'centos' | 'unknown';
+    packages?: string[];
     folder: string;
     user: string;
     uid: number;

package/support/bin/docker-operation.ts

@@ -14,6 +14,18 @@ export class DockerPackOperation {
     return (cfg.dockerTag ?? []).map(x => cfg.dockerRegistry ? `${cfg.dockerRegistry}/${cfg.dockerName}:${x}` : `${cfg.dockerName}:${x}`);
   }
 
+  /**
+   * Detect image os
+   */
+  static async* detectDockerImageOs(cfg: DockerPackConfig): AsyncIterable<string[]> {
+    // Read os before writing
+    cfg.dockerRuntime.os = await PackUtil.runCommand(
+      ['docker', 'run', '--entrypoint', '/bin/sh', cfg.dockerImage, '-c', 'cat /etc/*release*']
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    ).then(out => out.match(/\b(?:debian|alpine|centos)\b/i)?.[0].toLowerCase() as 'alpine' ?? 'unknown');
+    yield* PackOperation.title(cfg, cliTpl`${{ title: 'Detected Image OS' }} ${{ param: cfg.dockerImage }} as ${{ param: cfg.dockerRuntime.os }}`);
+  }
+
   /**
    * Write Docker File
    */

package/support/cli.pack_docker.ts

@@ -15,25 +15,27 @@ const DEFAULT_USER = 'app';
  */
 @CliCommand({ addModule: true })
 export class PackDockerCommand extends BasePackCommand {
-  @CliFlag({ desc: 'Docker Factory source ', short: 'df', envVars: ['PACK_DOCKER_FACTORY'] })
+  @CliFlag({ desc: 'Docker Factory source', short: 'df', envVars: ['PACK_DOCKER_FACTORY'] })
   dockerFactory = '@travetto/pack/support/pack.dockerfile';
-  @CliFlag({ desc: 'Docker Image to extend ', short: 'di', envVars: ['PACK_DOCKER_IMAGE'] })
+  @CliFlag({ desc: 'Docker Image to extend', short: 'di', envVars: ['PACK_DOCKER_IMAGE'] })
   dockerImage = `node:${NODE_MAJOR}-alpine`;
-  @CliFlag({ desc: 'Docker Image Name ', short: 'dn', envVars: ['PACK_DOCKER_IMAGE'] })
+  @CliFlag({ desc: 'Docker Image Name', short: 'dn', envVars: ['PACK_DOCKER_IMAGE'] })
   @Required(false)
   dockerName: string;
-  @CliFlag({ desc: 'Docker Image Tag ', short: 'dt', envVars: ['PACK_DOCKER_TAGS'] })
+  @CliFlag({ desc: 'Docker Image Tag', short: 'dt', envVars: ['PACK_DOCKER_TAGS'] })
   dockerTag: string[] = ['latest'];
-  @CliFlag({ desc: 'Docker Image Port ', short: 'dp', envVars: ['PACK_DOCKER_PORT'] })
+  @CliFlag({ desc: 'Docker Image Port', short: 'dp', envVars: ['PACK_DOCKER_PORT'] })
   dockerPort: number[] = [];
-  @CliFlag({ desc: 'Docker Push Tags ', short: 'dx', envVars: ['PACK_DOCKER_PUSH'] })
+  @CliFlag({ desc: 'Docker Push Tags', short: 'dx', envVars: ['PACK_DOCKER_PUSH'] })
   dockerPush = false;
-  @CliFlag({ desc: 'Docker Build Platform ', short: 'db', envVars: ['PACK_DOCKER_BUILD_PLATFORM'] })
+  @CliFlag({ desc: 'Docker Build Platform', short: 'db', envVars: ['PACK_DOCKER_BUILD_PLATFORM'] })
   dockerBuildPlatform?: string;
-  @CliFlag({ desc: 'Docker Registry ', short: 'dr', envVars: ['PACK_DOCKER_REGISTRY'] })
+  @CliFlag({ desc: 'Docker Registry', short: 'dr', envVars: ['PACK_DOCKER_REGISTRY'] })
   dockerRegistry?: string;
-  @CliFlag({ desc: 'Docker Runtime user ', short: 'du', name: 'docker-runtime-user', envVars: ['PACK_DOCKER_RUNTIME_USER'] })
+  @CliFlag({ desc: 'Docker Runtime user', short: 'ru', name: 'runtime-user', envVars: ['PACK_DOCKER_RUNTIME_USER'] })
   dockerRuntimeUserSrc?: string;
+  @CliFlag({ desc: 'Docker Runtime Packages', short: 'rp', name: 'runtime-package', envVars: ['PACK_DOCKER_RUNTIME_PACKAGES'] })
+  dockerRuntimePackages: string[] = [];
 
   @Ignore()
   dockerRuntime: DockerPackConfig['dockerRuntime'];
@@ -67,7 +69,7 @@ export class PackDockerCommand extends BasePackCommand {
     const gid = groupIsNum ? +groupOrGid : DEFAULT_USER_ID;
     const group = (!groupIsNum ? groupOrGid : undefined) || DEFAULT_USER;
     const user = (!userIsNum ? userOrUid : undefined) || DEFAULT_USER;
-    this.dockerRuntime = { user, uid, group, gid, folder: `/${DEFAULT_USER}` };
+    this.dockerRuntime = { user, uid, group, gid, folder: `/${DEFAULT_USER}`, packages: this.dockerRuntimePackages };
   }
 
   preHelp(): void {
@@ -77,8 +79,9 @@ export class PackDockerCommand extends BasePackCommand {
   getOperations(): PackOperationShape<this>[] {
     return [
       ...super.getOperations(),
-      DockerPackOperation.writeDockerFile,
       DockerPackOperation.pullDockerBaseImage,
+      DockerPackOperation.detectDockerImageOs,
+      DockerPackOperation.writeDockerFile,
       DockerPackOperation.buildDockerContainer,
       DockerPackOperation.pushDockerContainer
     ];