@catladder/cli 0.0.0-next-b3e567e8 → 0.0.0-next-dccc0a36

package/dist/bundles/catenv/index.js

@@ -2321,7 +2321,7 @@ class GithubBackend {
         await (0, promises_1.rm)(scriptFiles_1.GITHUB_SCRIPTS_FOLDER, { recursive: true, force: true });
     }
     async createFiles(config) {
-        const images = this.createImagesPlan();
+        const images = this.createImagesPlan(config);
         const scripts = new scriptFiles_1.GithubScriptFiles();
         const workflows = await this.createWorkflows(config, images, scripts);
         return [
@@ -2336,13 +2336,13 @@ class GithubBackend {
             ...(0, shippedCatci_1.getCatciGeneratedFiles)(),
         ];
     }
-    createImagesPlan() {
-        return new jobImagesPlan_1.JobImagesPlan(this.type);
+    createImagesPlan(config) {
+        return new jobImagesPlan_1.JobImagesPlan(this.type, config.images);
     }
     /**
      * all workflows keyed by file name, mainly for testing purposes
      */
-    async createWorkflows(config, images = this.createImagesPlan(), scripts = new scriptFiles_1.GithubScriptFiles()) {
+    async createWorkflows(config, images = this.createImagesPlan(config), scripts = new scriptFiles_1.GithubScriptFiles()) {
         var _a, _b, _c, _d;
         const workflows = {};
         // per-pipeline-type variables (pipelines.github.runnerVariables);
@@ -3311,7 +3311,7 @@ class GitlabBackend {
         await (0, promises_1.rm)(this.generatedFolder, { force: true, recursive: true });
     }
     async createFiles(config) {
-        const images = this.createImagesPlan();
+        const images = this.createImagesPlan(config);
         const includes = await this.createIncludes(config, images);
         const mainFile = {
             path: ".gitlab-ci.yml",
@@ -3328,15 +3328,15 @@ class GitlabBackend {
             ...(0, shippedCatci_1.getCatciGeneratedFiles)(),
         ];
     }
-    createImagesPlan() {
-        return new jobImagesPlan_1.JobImagesPlan(this.type);
+    createImagesPlan(config) {
+        return new jobImagesPlan_1.JobImagesPlan(this.type, config.images);
     }
     /**
      * the complete pipeline as one object (all includes merged into one),
      * mainly for testing purposes
      */
     async createCompletePipeline(config) {
-        const includes = await this.createIncludes(config, this.createImagesPlan());
+        const includes = await this.createIncludes(config, this.createImagesPlan(config));
         return includes.reduce((acc, { content }) => {
             return {
                 ...acc,
@@ -6981,7 +6981,7 @@ exports.makeSecretEnvVarMapping = makeSecretEnvVarMapping;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.computeCustomImageHash = void 0;
+exports.computeInlineImageHash = exports.computeCustomImageHash = void 0;
 const crypto_1 = __nccwpck_require__(76982);
 const fs_1 = __nccwpck_require__(79896);
 const path_1 = __nccwpck_require__(16928);
@@ -7002,6 +7002,29 @@ function listFilesRecursive(dir) {
     })
         .sort();
 }
+/**
+ * the parts every image definition hashes on top of its content:
+ * files outside the definition, and the build args
+ */
+function hashExtras(hash, config) {
+    const watchedPaths = [];
+    // Hash extra paths (for files outside the dir)
+    if (config.hashExtraPaths) {
+        // Extra paths are literal file paths (not globs) for simplicity
+        const extraFiles = [...config.hashExtraPaths].sort();
+        for (const file of extraFiles) {
+            hash.update(file);
+            hash.update((0, fs_1.readFileSync)(file));
+        }
+        watchedPaths.push(...config.hashExtraPaths);
+    }
+    // Hash build args (sorted keys for determinism)
+    if (config.buildArgs) {
+        const sorted = Object.entries(config.buildArgs).sort(([a], [b]) => a.localeCompare(b));
+        hash.update(JSON.stringify(sorted));
+    }
+    return watchedPaths;
+}
 function computeCustomImageHash(config) {
     var _a;
     const hash = (0, crypto_1.createHash)("sha256");
@@ -7022,27 +7045,29 @@ function computeCustomImageHash(config) {
         }
         watchedPaths.push(`${extraDir}/**/*`);
     }
-    // Hash extra paths (for files outside the dir)
-    if (config.hashExtraPaths) {
-        // Extra paths are literal file paths (not globs) for simplicity
-        const extraFiles = [...config.hashExtraPaths].sort();
-        for (const file of extraFiles) {
-            hash.update(file);
-            hash.update((0, fs_1.readFileSync)(file));
-        }
-        watchedPaths.push(...config.hashExtraPaths);
-    }
-    // Hash build args (sorted keys for determinism)
-    if (config.buildArgs) {
-        const sorted = Object.entries(config.buildArgs).sort(([a], [b]) => a.localeCompare(b));
-        hash.update(JSON.stringify(sorted));
-    }
+    watchedPaths.push(...hashExtras(hash, config));
     return {
         hash: hash.digest("hex").slice(0, 12),
         watchedPaths,
     };
 }
 exports.computeCustomImageHash = computeCustomImageHash;
+/**
+ * the hash of an image defined by an inline Dockerfile: its content
+ * stands in for the definition dir. The build context is deliberately
+ * NOT hashed (it may be the whole repository) — `hashExtraPaths` is how
+ * context files opt into the hash.
+ */
+function computeInlineImageHash(config) {
+    const hash = (0, crypto_1.createHash)("sha256");
+    hash.update(config.dockerfileContent);
+    const watchedPaths = hashExtras(hash, config);
+    return {
+        hash: hash.digest("hex").slice(0, 12),
+        watchedPaths,
+    };
+}
+exports.computeInlineImageHash = computeInlineImageHash;
 //# sourceMappingURL=hash.js.map
 
 /***/ }),
@@ -7053,7 +7078,7 @@ exports.computeCustomImageHash = computeCustomImageHash;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.JobImagesPlan = exports.GENERATED_IMAGES_FOLDER = void 0;
+exports.JobImagesPlan = exports.PROJECT_IMAGES_FOLDER = exports.GENERATED_IMAGES_FOLDER = void 0;
 const fs_1 = __nccwpck_require__(79896);
 const path_1 = __nccwpck_require__(16928);
 const ciVariables_1 = __nccwpck_require__(72700);
@@ -7061,6 +7086,7 @@ const docker_1 = __nccwpck_require__(83777);
 const runner_1 = __nccwpck_require__(71065);
 const gitlab_1 = __nccwpck_require__(37393);
 const hash_1 = __nccwpck_require__(34092);
+const projectImages_1 = __nccwpck_require__(55537);
 const shippedImages_1 = __nccwpck_require__(28687);
 exports.GENERATED_IMAGES_FOLDER = ".catladder-generated/images";
 /**
@@ -7068,7 +7094,44 @@ exports.GENERATED_IMAGES_FOLDER = ".catladder-generated/images";
  * catladder image, so building images never depends on one (bootstrap)
  */
 const BUILDER_IMAGE = "docker.io/docker:29.5.1";
-const ensureJobName = (name) => `🐳 job image ${name}`;
+/**
+ * every planned image is consumed the same way: its url, plus an
+ * optional dependency on its build job
+ */
+const toResolvedJobImage = ({ imageRef, jobName, }) => ({
+    image: imageRef,
+    fromRepoRegistry: true,
+    need: {
+        job: jobName,
+        artifacts: false,
+        optional: true,
+        global: true,
+    },
+});
+/**
+ * materializes an image definition directory into the generated files
+ * (used for the definitions catladder ships)
+ */
+const materializeDir = (sourceDir, targetDir) => listFilesRecursive(sourceDir).map((file) => ({
+    path: (0, path_1.join)(targetDir, file),
+    content: (0, fs_1.readFileSync)((0, path_1.join)(sourceDir, file), "utf-8"),
+}));
+// built-in (catladder-shipped) images carry the catladder marker in
+// their job name; project-declared images get the short plain name
+const ensureJobName = (name) => `🐳 catladder image ${name}`;
+const projectEnsureJobName = (name) => `🐳 image ${name}`;
+/**
+ * the config file whose content feeds the project image hashes
+ * (`buildArgs`, `hashExtraPaths`): the gitlab change detection has to
+ * watch it, because a config-only change alters the image tag without
+ * touching the image dir
+ */
+const CONFIG_FILE = "catladder.ts";
+/**
+ * where inline project Dockerfiles are materialized — a subfolder, so a
+ * project image can carry the same name as a shipped one
+ */
+exports.PROJECT_IMAGES_FOLDER = `${exports.GENERATED_IMAGES_FOLDER}/project`;
 /**
  * plans the catladder job images of one backend run: resolves image
  * references, collects the image build jobs, and the image definitions
@@ -7079,33 +7142,30 @@ const ensureJobName = (name) => `🐳 job image ${name}`;
  * Reference-driven: only images actually used by a job are built.
  */
 class JobImagesPlan {
-    constructor(pipelineType) {
+    constructor(pipelineType, projectImages = {}) {
         this.pipelineType = pipelineType;
+        this.projectImages = projectImages;
         this.used = new Map();
+        this.usedProject = new Map();
     }
     /**
      * resolves a job image (marker or concrete) to a concrete image url
      * plus the build job dependency
      */
     resolve(image) {
-        if (!(0, runner_1.isCatladderImageRef)(image)) {
-            return { image };
+        if ((0, runner_1.isCatladderImageRef)(image)) {
+            return this.resolveRef(image);
+        }
+        if ((0, projectImages_1.isProjectImageRef)(image)) {
+            return this.resolveProjectRef(image);
         }
-        return this.resolveRef(image);
+        return { image };
     }
     resolveRef(ref) {
-        const name = ref.catladderImage;
-        const { hash } = this.use(name);
-        return {
-            image: `${this.registryImageRef()}/catladder/${name}:${hash}`,
-            fromRepoRegistry: true,
-            need: {
-                job: ensureJobName(name),
-                artifacts: false,
-                optional: true,
-                global: true,
-            },
-        };
+        return toResolvedJobImage(this.use(ref.catladderImage));
+    }
+    resolveProjectRef(ref) {
+        return toResolvedJobImage(this.useProject(ref.image));
     }
     /**
      * the registry image prefix. On github, container images can't use
@@ -7116,6 +7176,85 @@ class JobImagesPlan {
             ? "ghcr.io/${{ github.repository }}"
             : `${(0, ciVariables_1.getCiVariable)({ pipelineType: this.pipelineType }, "registryImage")}`;
     }
+    useProject(name) {
+        const existing = this.usedProject.get(name);
+        if (existing) {
+            return existing;
+        }
+        const imageConfig = this.projectImages[name];
+        if (!imageConfig) {
+            const declared = Object.keys(this.projectImages);
+            throw new Error(`unknown job image "${name}" — ${declared.length > 0
+                ? `images declared in config.images: ${declared.join(", ")}`
+                : "no images are declared in config.images"}`);
+        }
+        const source = this.planProjectSource(name, imageConfig);
+        const planned = {
+            ...source,
+            jobName: projectEnsureJobName(name),
+            buildArgs: imageConfig.buildArgs,
+            // `job-images/` keeps the project's job images apart from its
+            // deployable component images (registry root) and build caches
+            imageRef: `${this.registryImageRef()}/job-images/${name}:${source.hash}`,
+        };
+        this.usedProject.set(name, planned);
+        return planned;
+    }
+    /**
+     * the source-dependent half of a project image: an inline Dockerfile
+     * is materialized into the generated files and hashed by its content,
+     * a directory is hashed and watched in place
+     */
+    planProjectSource(name, imageConfig) {
+        var _a, _b;
+        if (imageConfig.dockerfile !== undefined) {
+            const content = toDockerfileContent(imageConfig.dockerfile);
+            const dockerfilePath = `${exports.PROJECT_IMAGES_FOLDER}/${name}/Dockerfile`;
+            const { hash, watchedPaths } = (0, hash_1.computeInlineImageHash)({
+                dockerfileContent: content,
+                hashExtraPaths: imageConfig.hashExtraPaths,
+                buildArgs: imageConfig.buildArgs,
+            });
+            return {
+                hash,
+                dockerfilePath,
+                // an inline definition carries no directory of its own — the
+                // repository root is the sensible default context
+                contextDir: (_a = imageConfig.context) !== null && _a !== void 0 ? _a : ".",
+                watchedPaths: [
+                    `${exports.PROJECT_IMAGES_FOLDER}/${name}/**/*`,
+                    ...watchedPaths,
+                    CONFIG_FILE,
+                ],
+                files: [{ path: dockerfilePath, content }],
+            };
+        }
+        const dir = imageConfig.dir;
+        // fail at generation time with the offending image named: an
+        // unreadable dir would otherwise surface as a bare fs ENOENT, and a
+        // missing Dockerfile only as a docker build failure in CI
+        if (!(0, fs_1.existsSync)(dir)) {
+            throw new Error(`job image "${name}": the directory "${dir}" does not exist (config.images.${name}.dir, relative to the repository root)`);
+        }
+        if (!(0, fs_1.existsSync)((0, path_1.join)(dir, "Dockerfile"))) {
+            throw new Error(`job image "${name}": no Dockerfile in "${dir}" (config.images.${name}.dir)`);
+        }
+        const { hash, watchedPaths } = (0, hash_1.computeCustomImageHash)({
+            dir,
+            hashExtraPaths: imageConfig.hashExtraPaths,
+            buildArgs: imageConfig.buildArgs,
+        });
+        return {
+            hash,
+            dockerfilePath: `${dir}/Dockerfile`,
+            contextDir: (_b = imageConfig.context) !== null && _b !== void 0 ? _b : dir,
+            // the dir is committed in the project — watched in place, nothing
+            // is materialized. The config file is watched too: buildArgs /
+            // hashExtraPaths changes alter the tag without touching the dir
+            watchedPaths: [...watchedPaths, CONFIG_FILE],
+            files: [],
+        };
+    }
     use(name) {
         var _a;
         const existing = this.used.get(name);
@@ -7130,27 +7269,43 @@ class JobImagesPlan {
             dir: (0, shippedImages_1.getShippedImageDir)(name),
             extraDirs: dependencies.map((dependency) => (0, shippedImages_1.getShippedImageDir)(dependency)),
         });
-        const entry = { hash };
-        this.used.set(name, entry);
-        return entry;
+        const targetDir = `${exports.GENERATED_IMAGES_FOLDER}/${name}`;
+        const planned = {
+            hash,
+            jobName: ensureJobName(name),
+            imageRef: `${this.registryImageRef()}/catladder/${name}:${hash}`,
+            dockerfilePath: `${targetDir}/Dockerfile`,
+            // the jobs family INCLUDEs sibling images, so it builds from the
+            // images root; the others from their own dir
+            contextDir: shippedImages_1.RUNNER_IMAGE_BUILD_CONTEXT[name] === "root"
+                ? exports.GENERATED_IMAGES_FOLDER
+                : targetDir,
+            watchedPaths: [name, ...dependencies].map((dir) => `${exports.GENERATED_IMAGES_FOLDER}/${dir}/**/*`),
+            // pipelines build from committed, reviewable files (and gitlab's
+            // rules:changes can watch them)
+            files: materializeDir((0, shippedImages_1.getShippedImageDir)(name), targetDir),
+        };
+        this.used.set(name, planned);
+        return planned;
     }
     /**
      * the image build jobs for all used images
      */
     getEnsureJobs() {
-        return [...this.used.entries()].map(([name, { hash }]) => this.createEnsureJob(name, hash));
+        return [...this.used.values(), ...this.usedProject.values()].map((planned) => this.createImageBuildJob(planned));
     }
-    createEnsureJob(name, hash) {
-        var _a;
+    createImageBuildJob({ jobName, imageRef, watchedPaths, dockerfilePath, contextDir, buildArgs, }) {
+        const buildArgFlags = Object.entries(buildArgs !== null && buildArgs !== void 0 ? buildArgs : {})
+            .map(([key, value]) => ` --build-arg '${key}=${value}'`)
+            .join("");
+        const buildCommand = `DOCKER_BUILDKIT=1 docker build -t ${imageRef}${buildArgFlags} -f ${dockerfilePath} ${contextDir}`;
         const ctx = { pipelineType: this.pipelineType };
         const registryUser = (0, ciVariables_1.getCiVariable)(ctx, "registryUser");
         const jobToken = (0, ciVariables_1.getCiVariable)(ctx, "jobToken");
         const registry = (0, ciVariables_1.getCiVariable)(ctx, "registry");
-        const imageRef = `${this.registryImageRef()}/catladder/${name}:${hash}`;
-        const watchedDirs = [name, ...((_a = shippedImages_1.RUNNER_IMAGE_DEPENDENCIES[name]) !== null && _a !== void 0 ? _a : [])];
         const { services, runnerVariables } = (0, docker_1.getDockerJobBaseProps)();
         return {
-            name: ensureJobName(name),
+            name: jobName,
             stage: "setup",
             image: BUILDER_IMAGE,
             services,
@@ -7160,7 +7315,9 @@ class JobImagesPlan {
             // no equivalent and always runs (the existence check is fast)
             rules: [
                 {
-                    changes: watchedDirs.map((dir) => `${exports.GENERATED_IMAGES_FOLDER}/${dir}/**/*`),
+                    // a fresh array per job: the yaml serializer anchors repeated
+                    // objects, and a shared reference would reshuffle anchors
+                    changes: [...watchedPaths],
                 },
             ],
             variables: {},
@@ -7174,31 +7331,33 @@ class JobImagesPlan {
                     `  exit 0`,
                     `fi`,
                 ]),
-                ...(0, gitlab_1.collapseableSection)("docker-build", "Building image")([
-                    `DOCKER_BUILDKIT=1 docker build -t ${imageRef} -f ${exports.GENERATED_IMAGES_FOLDER}/${name}/Dockerfile ${shippedImages_1.RUNNER_IMAGE_BUILD_CONTEXT[name] === "root"
-                        ? exports.GENERATED_IMAGES_FOLDER
-                        : `${exports.GENERATED_IMAGES_FOLDER}/${name}`}`,
-                ]),
+                ...(0, gitlab_1.collapseableSection)("docker-build", "Building image")([buildCommand]),
                 ...(0, gitlab_1.collapseableSection)("docker-push", "Pushing image")([`docker push ${imageRef}`]),
             ],
         };
     }
     /**
-     * the image definitions of all used images, materialized into the
-     * generated files (so pipelines build from committed, reviewable
-     * files and gitlab's rules:changes can watch them)
+     * the image definitions to materialize into the generated files (so
+     * pipelines build from committed, reviewable files and gitlab's
+     * rules:changes can watch them): the definitions catladder ships and
+     * the project's inline Dockerfiles. A project image directory is
+     * already committed and contributes nothing.
      */
     getGeneratedFiles() {
-        return [...this.used.keys()].flatMap((name) => {
-            const dir = (0, shippedImages_1.getShippedImageDir)(name);
-            return listFilesRecursive(dir).map((file) => ({
-                path: (0, path_1.join)(exports.GENERATED_IMAGES_FOLDER, name, file),
-                content: (0, fs_1.readFileSync)((0, path_1.join)(dir, file), "utf-8"),
-            }));
-        });
+        return [...this.used.values(), ...this.usedProject.values()].flatMap(({ files }) => files);
     }
 }
 exports.JobImagesPlan = JobImagesPlan;
+/**
+ * an inline Dockerfile is written as given — as one string, or as lines
+ * joined with newlines (always newline-terminated)
+ */
+const toDockerfileContent = (dockerfile) => {
+    const content = Array.isArray(dockerfile)
+        ? dockerfile.join("\n")
+        : dockerfile;
+    return content.endsWith("\n") ? content : `${content}\n`;
+};
 const IGNORED_FILES = new Set([".DS_Store", "Thumbs.db"]);
 const listFilesRecursive = (dir) => (0, fs_1.readdirSync)(dir, { recursive: true, encoding: "utf-8" })
     .filter((entry) => {
@@ -7212,6 +7371,22 @@ const listFilesRecursive = (dir) => (0, fs_1.readdirSync)(dir, { recursive: true
 
 /***/ }),
 
+/***/ 55537:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.isProjectImageRef = void 0;
+const isProjectImageRef = (value) => typeof value === "object" &&
+    value !== null &&
+    "image" in value &&
+    typeof value.image === "string";
+exports.isProjectImageRef = isProjectImageRef;
+//# sourceMappingURL=projectImages.js.map
+
+/***/ }),
+
 /***/ 28687:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
@@ -9925,6 +10100,8 @@ __exportStar(__nccwpck_require__(68906), exports);
 __exportStar(__nccwpck_require__(23040), exports);
 __exportStar(__nccwpck_require__(35086), exports);
 __exportStar(__nccwpck_require__(71065), exports);
+__exportStar(__nccwpck_require__(55537), exports);
+__exportStar(__nccwpck_require__(47864), exports);
 __exportStar(__nccwpck_require__(80769), exports);
 __exportStar(__nccwpck_require__(7732), exports);
 __exportStar(__nccwpck_require__(66526), exports);