containerify 2.5.2 → 2.6.1

package/README.md

@@ -18,6 +18,18 @@ This will pull the `node:13-slim` image from Docker hub, build the image by addi
 containerify --fromImage node:13-slim --folder src/ --toImage myapp:latest --toRegistry https://registry.example.com/v2/ --setTimeStamp=$(git show -s --format="%aI" HEAD)
 ```
 
+### customContent - Adding compiled code to non-node container
+
+If you want to build a non-node container (e.g. add compiled frontend code to an nginx container), you can use `--customContent`. When doing this
+the normal `node_modules` etc layers will not be added. By default it does _NOT_ modify then entrypoint, user or workdir, so the base image settings are still used when running. You can still override with `--entrypoint` etc. if needed.
+
+```
+npm run build  # or some other build command
+containerify --fromImage nginx:alpine --folder . --toImage frontend:latest --customContent dist:/usr/share/nginx/html --toRegistry https://registry.example.com/v2/
+```
+
+This will take the `nginx:alpine` image, and copy the files from `./dist/` into `/usr/share/nginx/html`.
+
 ### Command line options
 
 ```
@@ -31,6 +43,7 @@ Options:
   --fromRegistry <registry url>  Optional: URL of registry to pull base image from - Default: https://registry-1.docker.io/v2/
   --fromToken <token>            Optional: Authentication token for from registry
   --toRegistry <registry url>    Optional: URL of registry to push base image to - Default: https://registry-1.docker.io/v2/
+  --optimisticToRegistryCheck    Optional: Treat redirects as layer existing in remote registry. Potentially unsafe, but could save bandwidth.
   --toToken <token>              Optional: Authentication token for target registry
   --toTar <path>                 Optional: Export to tar file
   --registry <path>              Optional: Convenience argument for setting both from and to registry

package/lib/appLayerCreator.js

@@ -166,7 +166,10 @@ function parseCommandLineToParts(entrypoint) {
 }
 function addAppLayers(options, config, todir, manifest, tmpdir) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (options.customContent.length > 0) {
+        if (Object.entries(options.customContent).length > 0) {
+            // We only add these layers if they have been explicitely set for customContent. This allows customContent
+            // to be used to add compiled frontend code to an nginx container without also modifying the entrypoint, user,
+            // and workdir.
             if (options.nonDefaults.workdir)
                 yield addWorkdirLayer(options, config, options.nonDefaults.workdir);
             if (options.nonDefaults.entrypoint)
@@ -175,7 +178,7 @@ function addAppLayers(options, config, todir, manifest, tmpdir) {
                 yield addUserLayer(options, config, options.nonDefaults.user);
             yield addEnvsLayer(options, config);
             yield addLabelsLayer(options, config);
-            yield addDataLayer(tmpdir, todir, options, config, manifest, options.customContent, "custom");
+            yield addDataLayer(tmpdir, todir, options, config, manifest, Object.entries(options.customContent), "custom");
         }
         else {
             yield addWorkdirLayer(options, config, options.workdir);

package/lib/cli.js

@@ -32,6 +32,7 @@ const possibleArgs = {
     "--fromRegistry <registry url>": "Optional: URL of registry to pull base image from - Default: https://registry-1.docker.io/v2/",
     "--fromToken <token>": "Optional: Authentication token for from registry",
     "--toRegistry <registry url>": "Optional: URL of registry to push base image to - Default: https://registry-1.docker.io/v2/",
+    "--optimisticToRegistryCheck": "Treat redirects as layer existing in remote registry. Potentially unsafe, but can save bandwidth.",
     "--toToken <token>": "Optional: Authentication token for target registry",
     "--toTar <path>": "Optional: Export to tar file",
     "--toDocker": "Optional: Export to local docker registry",
@@ -48,16 +49,17 @@ const possibleArgs = {
     "--setTimeStamp <timestamp>": "Optional: Set a specific ISO 8601 timestamp on all entries (e.g. git commit hash). Default: 1970 in tar files, and current time on manifest/config",
     "--verbose": "Verbose logging",
     "--allowInsecureRegistries": "Allow insecure registries (with self-signed/untrusted cert)",
-    "--customContent <dirs/files>": "Optional: Skip normal node_modules and applayer and include specified root folder files/directories instead",
+    "--customContent <dirs/files>": "Optional: Skip normal node_modules and applayer and include specified root folder files/directories instead. You can specify as local-path:absolute-container-path if you want to place it in a specific location",
     "--extraContent <dirs/files>": "Optional: Add specific content. Specify as local-path:absolute-container-path,local-path2:absolute-container-path2 etc",
     "--layerOwner <gid:uid>": "Optional: Set specific gid and uid on files in the added layers",
     "--buildFolder <path>": "Optional: Use a specific build folder when creating the image",
     "--layerCacheFolder <path>": "Optional: Folder to cache base layers between builds",
     "--version": "Get containerify version",
 };
-function setKeyValue(target, keyValue, separator = "=") {
+function setKeyValue(target, keyValue, separator = "=", defaultValue) {
+    var _a;
     const [k, v] = keyValue.split(separator, 2);
-    target[k.trim()] = v.trim();
+    target[k.trim()] = (_a = v === null || v === void 0 ? void 0 : v.trim()) !== null && _a !== void 0 ? _a : defaultValue;
 }
 const cliLabels = {};
 commander_1.program.on("option:label", (ops) => {
@@ -114,9 +116,9 @@ Object.keys(envOpt)
     exitWithErrorIf(true, `Env ${l} specified both with --envs and --env`);
 });
 const envs = Object.assign(Object.assign(Object.assign({}, configFromFile.envs), envOpt), cliEnv); //Let cli arguments override file
-const customContent = [];
-(_e = configFromFile.customContent) === null || _e === void 0 ? void 0 : _e.forEach((c) => customContent.push(c));
-(_f = cliOptions.customContent) === null || _f === void 0 ? void 0 : _f.split(",").forEach((c) => customContent.push(c));
+const customContent = {};
+(_e = configFromFile.customContent) === null || _e === void 0 ? void 0 : _e.forEach((c) => setKeyValue(customContent, c, ":", c));
+(_f = cliOptions.customContent) === null || _f === void 0 ? void 0 : _f.split(",").forEach((c) => setKeyValue(customContent, c, ":", c));
 const cliExtraContent = {};
 (_g = cliOptions.extraContent) === null || _g === void 0 ? void 0 : _g.split(",").forEach((x) => setKeyValue(cliExtraContent, x, ":"));
 const extraContent = Object.assign(Object.assign({}, configFromFile.extraContent), cliExtraContent);
@@ -184,7 +186,7 @@ if (options.fromRegistry && !options.fromRegistry.endsWith("/"))
 if (!options.fromRegistry && !((_k = (_j = (_h = options.fromImage) === null || _h === void 0 ? void 0 : _h.split(":")) === null || _j === void 0 ? void 0 : _j[0]) === null || _k === void 0 ? void 0 : _k.includes("/"))) {
     options.fromImage = "library/" + options.fromImage;
 }
-options.customContent.forEach((p) => {
+Object.keys(options.customContent).forEach((p) => {
     exitWithErrorIf(!fs.existsSync(p), "Could not find " + p + " in the base folder " + options.folder);
 });
 if (options.layerCacheFolder) {
@@ -230,7 +232,7 @@ function run(options) {
             yield tarExporter_1.default.saveToTar(todir, tmpdir, options.toTar, [options.toImage], options);
         }
         if (options.toRegistry) {
-            const toRegistry = (0, registry_1.createRegistry)(options.toRegistry, (_b = options.toToken) !== null && _b !== void 0 ? _b : "");
+            const toRegistry = (0, registry_1.createRegistry)(options.toRegistry, (_b = options.toToken) !== null && _b !== void 0 ? _b : "", options.optimisticToRegistryCheck);
             yield toRegistry.upload(options.toImage, todir);
         }
         logger_1.default.debug("Deleting " + tmpdir + " ...");

package/lib/registry.d.ts

@@ -1,5 +1,5 @@
 import { Platform } from "./types";
-export declare function createRegistry(registryBaseUrl: string, token: string): {
+export declare function createRegistry(registryBaseUrl: string, token: string, optimisticToRegistryCheck?: boolean): {
     download: (imageStr: string, folder: string, preferredPlatform: Platform, cacheFolder?: string) => Promise<void>;
     upload: (imageStr: string, folder: string) => Promise<void>;
 };

package/lib/registry.js

@@ -13,15 +13,15 @@ exports.createDockerRegistry = exports.createRegistry = void 0;
 const https = require("https");
 const http = require("http");
 const URL = require("url");
+const fss = require("fs");
 const fs_1 = require("fs");
 const path = require("path");
 const fse = require("fs-extra");
-const fss = require("fs");
 const fileutil = require("./fileutil");
 const logger_1 = require("./logger");
 const MIMETypes_1 = require("./MIMETypes");
 const utils_1 = require("./utils");
-const redirectCodes = [307, 303, 302];
+const redirectCodes = [308, 307, 303, 302, 301];
 function request(options, callback) {
     return (options.protocol == "https:" ? https : http).request(options, (res) => {
         callback(res);
@@ -128,18 +128,36 @@ function buildHeaders(accept, auth) {
         headers.authorization = auth;
     return headers;
 }
-function headOk(url, headers) {
+function headOk(url, headers, optimisticCheck = false, depth = 0) {
+    if (depth >= 5) {
+        logger_1.default.info("Followed five redirects, assuming layer does not exist");
+        return new Promise((resolve) => resolve(false));
+    }
     return new Promise((resolve, reject) => {
         logger_1.default.debug(`HEAD ${url}`);
         const options = URL.parse(url);
         options.headers = headers;
         options.method = "HEAD";
         request(options, (res) => {
+            var _a;
             logger_1.default.debug(`HEAD ${url}`, res.statusCode);
+            // Not found
             if (res.statusCode == 404)
                 return resolve(false);
+            // OK
             if (res.statusCode == 200)
                 return resolve(true);
+            // Redirected
+            if (redirectCodes.includes((_a = res.statusCode) !== null && _a !== void 0 ? _a : 0) && res.headers.location) {
+                if (optimisticCheck)
+                    return resolve(true);
+                return resolve(headOk(res.headers.location, headers, optimisticCheck, ++depth));
+            }
+            // Unauthorized
+            // Possibly related to https://gitlab.com/gitlab-org/gitlab/-/issues/23132
+            if (res.statusCode == 401) {
+                return resolve(false);
+            }
             reject(toError(res));
         }).end();
     });
@@ -175,12 +193,12 @@ function uploadContent(uploadUrl, file, fileConfig, auth) {
         fss.createReadStream(file).pipe(req);
     });
 }
-function createRegistry(registryBaseUrl, token) {
+function createRegistry(registryBaseUrl, token, optimisticToRegistryCheck = false) {
     const auth = token.startsWith("Basic ") ? token : "Bearer " + token;
     function exists(image, layer) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = `${registryBaseUrl}${image.path}/blobs/${layer.digest}`;
-            return yield headOk(url, buildHeaders(layer.mediaType, auth));
+            return yield headOk(url, buildHeaders(layer.mediaType, auth), optimisticToRegistryCheck, 0);
         });
     }
     function uploadLayerContent(uploadUrl, layer, dir) {

package/lib/types.d.ts

@@ -61,6 +61,7 @@ export type Options = {
     fromRegistry?: string;
     fromToken?: string;
     toRegistry?: string;
+    optimisticToRegistryCheck?: boolean;
     toToken?: string;
     toTar?: string;
     toDocker?: boolean;
@@ -75,7 +76,7 @@ export type Options = {
     setTimeStamp?: string;
     verbose?: boolean;
     allowInsecureRegistries?: boolean;
-    customContent: string[];
+    customContent: Record<string, string>;
     extraContent: Record<string, string>;
     layerOwner?: string;
     buildFolder?: string;

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.5.2";
+export declare const VERSION = "2.6.1";

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "2.5.2";
+exports.VERSION = "2.6.1";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "containerify",
-	"version": "2.5.2",
+	"version": "2.6.1",
 	"description": "Build node.js docker images without docker",
 	"main": "./lib/cli.js",
 	"scripts": {