@travetto/pack 3.2.6 → 3.2.8

package/__index__.ts

@@ -1 +1,2 @@
-export type { CommonPackConfig, DockerPackFactory, DockerPackConfig } from './support/bin/types';
+export type { CommonPackConfig, DockerPackFactory, DockerPackConfig } from './support/bin/types';
+export { PackConfigUtil } from './support/bin/config-util';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "3.2.6",
+  "version": "3.2.8",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",

package/support/bin/config-util.ts

@@ -0,0 +1,55 @@
+import { DockerPackConfig } from './types';
+
+/**
+ * Common utils for setting up pack config
+ */
+export class PackConfigUtil {
+  /**
+   * Docker setup
+   */
+  static dockerSetup(cfg: DockerPackConfig): string {
+    return [
+      `FROM ${cfg.dockerImage}`,
+      `WORKDIR /${cfg.dockerRuntime.folder}`,
+    ].join('\n');
+  }
+
+  /**
+   * Generate a docker user creation command
+   */
+  static dockerUserCommand(cfg: DockerPackConfig): string {
+    const { user, group, uid, gid } = cfg.dockerRuntime;
+    if (user !== 'root') {
+      return [
+        '',
+        `RUN which addgroup && \
+  ( addgroup -g ${gid} ${group} && adduser -S -u ${uid} ${user} ${group} ) || \
+  ( groupadd -g ${gid} ${group} && useradd -r -u ${uid} -g ${group} ${user} )`,
+        `USER ${user}`
+      ].join('\n');
+    } else {
+      return '';
+    }
+  }
+
+  /**
+   * Expose ports
+   */
+  static dockerExposePorts(cfg: DockerPackConfig): string {
+    return cfg.dockerPort?.map(x => `EXPOSE ${x}`).join('\n') ?? '';
+  }
+
+  /**
+   * Copy workspace contents
+   */
+  static dockerCopyWorkspace(cfg: DockerPackConfig): string {
+    return `COPY --chown="${cfg.dockerRuntime.user}:${cfg.dockerRuntime.group}" . .`;
+  }
+
+  /**
+   * Entrypoint creation for a docker configuration
+   */
+  static dockerEntrypoint(cfg: DockerPackConfig): string {
+    return `ENTRYPOINT ["/${cfg.dockerRuntime.folder}/${cfg.mainName}.sh"]`;
+  }
+}

package/support/bin/types.ts

@@ -25,7 +25,8 @@ export type DockerPackConfig = {
   dockerPort?: number[];
   dockerPush?: boolean;
   dockerRegistry?: string;
-  dockerRuntimeUser: {
+  dockerRuntime: {
+    folder: string;
     user: string;
     uid: number;
     group: string;

package/support/bin/util.ts

@@ -4,7 +4,6 @@ import { path, RootIndex } from '@travetto/manifest';
 import { AppError, ExecUtil, ExecutionOptions } from '@travetto/base';
 
 import { ActiveShellCommand } from './shell';
-import { DockerPackConfig } from './types';
 
 export class PackUtil {
   /**
@@ -78,22 +77,4 @@ export class PackUtil {
       throw new AppError(stderr || message || 'An unexpected error has occurred');
     }
   }
-
-  /**
-   * Generate a docker user creation command
-   */
-  static generateDockerUserCommand(cfg: DockerPackConfig): string {
-    const { user, group, uid, gid } = cfg.dockerRuntimeUser;
-    if (user !== 'root') {
-      return [
-        '',
-        `RUN which addgroup && \
-( addgroup -g ${gid} ${group} && adduser -S -u ${uid} ${user} ${group} ) || \
-( groupadd -g ${gid} ${group} && useradd -r -u ${uid} -g ${group} ${user} )`,
-        `USER ${user}`
-      ].join('\n');
-    } else {
-      return '';
-    }
-  }
 }

package/support/cli.pack_docker.ts

@@ -1,10 +1,11 @@
 import { path, RootIndex } from '@travetto/manifest';
 import { CliCommand, CliFlag, CliUtil, CliValidationError } from '@travetto/cli';
+import { GlobalEnv } from '@travetto/base';
+import { Ignore } from '@travetto/schema';
 
 import { DockerPackOperation } from './bin/docker-operation';
 import { BasePackCommand, PackOperationShape } from './pack.base';
-import { GlobalEnv } from '@travetto/base';
-import { Ignore } from '@travetto/schema';
+import { DockerPackConfig } from './bin/types';
 
 const NODE_MAJOR = GlobalEnv.nodeVersion.replace('v', '').split('.')[0];
 const DEFAULT_USER_ID = 2000;
@@ -33,12 +34,7 @@ export class PackDockerCommand extends BasePackCommand {
   dockerRuntimeUserSrc?: string;
 
   @Ignore()
-  dockerRuntimeUser: {
-    user: string;
-    uid: number;
-    group: string;
-    gid: number;
-  };
+  dockerRuntime: DockerPackConfig['dockerRuntime'];
 
   async validate(...unknownArgs: string[]): Promise<CliValidationError[] | undefined> {
     const errs: CliValidationError[] = [];
@@ -70,7 +66,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.dockerRuntimeUser = { user, uid, group, gid };
+    this.dockerRuntime = { user, uid, group, gid, folder: DEFAULT_USER };
   }
 
   getOperations(): PackOperationShape<this>[] {

package/support/pack.dockerfile.ts

@@ -1,11 +1,10 @@
 import { DockerPackFactory } from './bin/types';
-import { PackUtil } from './bin/util';
+import { PackConfigUtil } from './bin/config-util';
 
-export const factory: DockerPackFactory = cfg => `
-FROM ${cfg.dockerImage}
-${PackUtil.generateDockerUserCommand(cfg)}
-WORKDIR /app
-COPY . .
-${cfg.dockerPort?.map(port => `EXPOSE ${port}`).join('\n') ?? ''}
-ENTRYPOINT ["/app/${cfg.mainName}.sh"]
-`;
+export const factory: DockerPackFactory = cfg => [
+  PackConfigUtil.dockerSetup(cfg),
+  PackConfigUtil.dockerUserCommand(cfg),
+  PackConfigUtil.dockerCopyWorkspace(cfg),
+  PackConfigUtil.dockerExposePorts(cfg),
+  PackConfigUtil.dockerEntrypoint(cfg),
+].join('\n');