hammerkit 2.0.0-next.6 → 2.0.0-next.7

package/dist/kubernetes/ensure-persistent-data.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensurePersistentData = exports.packSource = exports.clearStateFiles = exports.restoreLiveFiles = exports.syncLiveFiles = exports.SYNC_FILES = exports.getStateDirsInUse = exports.REMOVE_OTHER_STATES = exports.execInPod = exports.clearClaim = exports.getPodForPersistence = exports.applyWithinQuota = exports.QUOTA_TIMEOUT = exports.TRANSFER_POD_RESOURCES = void 0;
+exports.ensurePersistentData = exports.packSource = exports.clearStateFiles = exports.ENSURE_OUTPUT_FILES = exports.restoreLiveFiles = exports.syncLiveFiles = exports.SYNC_FILES = exports.getStateDirsInUse = exports.REMOVE_OTHER_STATES = exports.execInPod = exports.clearClaim = exports.getPodForPersistence = exports.applyWithinQuota = exports.QUOTA_TIMEOUT = exports.TRANSFER_POD_RESOURCES = void 0;
 const volumes_1 = require("./volumes");
 const apply_1 = require("./apply");
 const path_1 = require("path");
@@ -88,7 +88,11 @@ signal, fn) {
     // and takes no upload
     const own = persistence.mounts.filter((m) => !m.workspace);
     const mounts = type === 'read'
-        ? own.map((m) => m.mount)
+        ? // what a task stores are its outputs, which it mounts writable: its src and the
+            // outputs of its deps are not mounted, so an output inside a folder of its src
+            // (pkg/coverage/lcov.info) has a place in the pod even when the claim holds no src,
+            // after a restore into a new claim
+            own.filter((m) => service.data.type !== 'container-task' || !m.mount.readOnly).map((m) => m.mount)
         : own.reduce((array, v) => {
             if (!array.some((i) => i.name === v.mount.name)) {
                 array.push({
@@ -99,11 +103,13 @@ signal, fn) {
             }
             return array;
         }, []);
+    // only the claims it mounts: one of a dep it doesn't read would only bind where it goes
+    const volumes = persistence.volumes.filter((volume) => mounts.some((mount) => mount.name === volume.name));
     // Guarantee the claims exist right before scheduling the pod that mounts
     // them. ensurePersistentData also creates them, but store/restore reach this
     // function directly, and a claim shared with another work item can be removed
     // concurrently — without this the pod would hang Pending on "pvc not found".
-    for (const volume of persistence.volumes) {
+    for (const volume of volumes) {
         await (0, ensure_kubernetes_persistent_volume_claim_exists_1.ensureKubernetesPersistentVolumeClaimExists)(instance, env, volume, service, persistence.sizes[volume.name], persistence.kept.includes(volume.name));
     }
     const name = (0, resources_1.getResourceName)(service, env, type === 'write' ? '-upload' : '-download');
@@ -111,7 +117,7 @@ signal, fn) {
     // commit): the pod is not one its Service sends to
     const serving = !!env.server?.serviceRun && service.data.type === 'container-service';
     // and on a service run, it goes where the pods that mount the same claims run
-    const claims = env.server?.serviceRun ? (0, volumes_1.getClaimPodSpec)(persistence.volumes) : { labels: {} };
+    const claims = env.server?.serviceRun ? (0, volumes_1.getClaimPodSpec)(volumes) : { labels: {} };
     const podSpec = {
         kind: 'Pod',
         apiVersion: 'v1',
@@ -144,7 +150,7 @@ signal, fn) {
                     ...(0, job_placement_1.getContainerSecurity)(env),
                 },
             ],
-            volumes: persistence.volumes,
+            volumes,
         },
     };
     service.status.write('debug', `create pod ${name}`);
@@ -329,6 +335,33 @@ async function prepareStateFiles(instance, env, work, pod, dir, inUse) {
     await clearStateDir(instance, env, pod, `${targetPath}/${dir}`);
     return true;
 }
+// Makes each of `files` (paths in the claim of `work`, see KubernetesPersistence.files) an
+// empty file unless it is one: Kubernetes would make a directory of a subPath that isn't
+// there, and the task could not write the file. A directory there is what an earlier
+// version left in a kept claim, and goes. A path ending in `/` is made a folder.
+exports.ENSURE_OUTPUT_FILES = `cd "$1" || exit 1
+shift
+for f; do
+  case "$f" in */) mkdir -p "$f" || exit 1; continue ;; esac
+  if [ -d "$f" ] && [ ! -L "$f" ]; then rm -rf "$f" || exit 1; fi
+  if [ ! -e "$f" ] && [ ! -L "$f" ]; then mkdir -p "$(dirname "$f")" && : > "$f" || exit 1; fi
+done`;
+async function ensureOutputFiles(instance, env, work, pod, files) {
+    if (files.length === 0) {
+        return;
+    }
+    const made = await execInPod(instance, env, pod, [
+        'sh',
+        '-c',
+        exports.ENSURE_OUTPUT_FILES,
+        'sh',
+        `/dev/hammerkit/${work.id()}`,
+        ...files,
+    ]);
+    if (made) {
+        throw new Error(`unable to make the output files ${files.join(', ')} of ${work.name}: ${made}`);
+    }
+}
 // what a failed upload, restore or task left: tar does not remove files the commit does not have
 async function clearStateDir(instance, env, pod, path) {
     const cleared = await execInPod(instance, env, pod, ['rm', '-rf', path]);
@@ -397,7 +430,7 @@ options = {}) {
     const files = persistence.volumes.some((volume) => volume.persistentVolumeClaim?.claimName === claim)
         ? options.files
         : undefined;
-    if (persistence.sources.length === 0 && !options.reset && !files) {
+    if (persistence.sources.length === 0 && persistence.files.length === 0 && !options.reset && !files) {
         return;
     }
     // the folders of the states the pods of the run mount, before the upload pod mounts the claim
@@ -447,6 +480,7 @@ options = {}) {
                 }
             });
         }
+        await ensureOutputFiles(instance, env, service, name, persistence.files);
         if (files) {
             const dir = `/dev/hammerkit/${service.id()}/${files.dir}`;
             const marked = await execInPod(instance, env, name, [

package/dist/kubernetes/restore-kubernetes-data.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.restoreKubernetesData = exports.getRestoreTarget = void 0;
+exports.restoreKubernetesData = exports.getRestoreTarget = exports.RESTORE_FILE = void 0;
 const event_cache_1 = require("../executer/event-cache");
 const log_1 = require("../log");
 const volumes_1 = require("./volumes");
 const ensure_persistent_data_1 = require("./ensure-persistent-data");
 const claim_layout_1 = require("./claim-layout");
+// Unpacks the archive of an output that is a file to `$1`: by its content, since the name in
+// the archive is the file's and the one in the claim may carry a hash (see getClaimSubPath)
+exports.RESTORE_FILE = 'mkdir -p "$(dirname "$1")" && rm -rf "$1" && tar xzf - -O > "$1"';
 // Where the upload pod (which mounts the work's claim at /dev/hammerkit/<id>) unpacks the
 // archive of an output: the output's place in the claim, which its mount reads
 function getRestoreTarget(work, path, 
@@ -22,6 +25,13 @@ async function restoreKubernetesData(work, kubernetes, instance, environment, pa
 options = {}) {
     const persistence = await (0, volumes_1.getKubernetesPersistence)(work, kubernetes, options.stateKey);
     const stateDir = kubernetes.server?.serviceRun ? (0, volumes_1.getItemFilesDir)(work, options.stateKey) : undefined;
+    // an output that is a file: its archive holds it alone (see storeKubernetesData), and it
+    // takes the place of whatever is at its path in the claim
+    const files = new Set(work.data.type === 'container-task'
+        ? work.data.generates
+            .filter((generate) => generate.isFile && !generate.inherited)
+            .map((generate) => generate.path)
+        : []);
     // a run stopped while the pod waits for room under the quota
     const { signal } = environment.abortCtrl;
     await (0, ensure_persistent_data_1.getPodForPersistence)(instance, kubernetes, work, persistence, 'write', signal, async (name) => {
@@ -39,7 +49,13 @@ options = {}) {
             // a claim made for this run (a server removes the claims of a run when it
             // ends) does not have the directory of the output yet
             let failure = null;
-            const res = await instance.exec.exec(kubernetes.namespace, name, 'volume', ['sh', '-c', 'mkdir -p "$1" && tar xzf - -C "$1"', 'sh', targetPath], process.stdout, process.stderr, environment.file.readStream(generatedArchive.filename), false, (status) => {
+            const res = await instance.exec.exec(kubernetes.namespace, name, 'volume', [
+                'sh',
+                '-c',
+                files.has(generatedArchive.path) ? exports.RESTORE_FILE : 'mkdir -p "$1" && tar xzf - -C "$1"',
+                'sh',
+                targetPath,
+            ], process.stdout, process.stderr, environment.file.readStream(generatedArchive.filename), false, (status) => {
                 work.status.write('debug', `upload ${generatedArchive.filename} to ${name}: ${status.status}`);
                 if (status.status !== 'Success') {
                     failure = status.message ?? status.reason ?? 'unknown';

package/dist/kubernetes/store-kubernetes-data.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.storeKubernetesData = void 0;
+const path_1 = require("path");
 const log_1 = require("../log");
 const event_cache_1 = require("../executer/event-cache");
 const volumes_1 = require("./volumes");
@@ -12,10 +13,18 @@ stateKey) {
     const persistence = await (0, volumes_1.getKubernetesPersistence)(work, kubernetes, stateKey);
     // a run stopped while the pod waits for room under the quota
     const { signal } = environment.abortCtrl;
+    // an output that is a file is mounted as one: its archive holds it by its name, as on Docker
+    const files = new Set(work.data.type === 'container-task'
+        ? work.data.generates
+            .filter((generate) => generate.isFile && !generate.inherited)
+            .map((generate) => generate.path)
+        : []);
     await (0, ensure_persistent_data_1.getPodForPersistence)(instance, kubernetes, work, persistence, 'read', signal, async (name) => {
         for (const generatedArchive of (0, event_cache_1.getArchivePaths)(work.data, path)) {
             const writerStream = environment.file.createWriteStream(generatedArchive.filename);
-            const res = await instance.exec.exec(kubernetes.namespace, name, 'volume', ['tar', 'zcf', '-', '-C', generatedArchive.path, '.'], writerStream, process.stderr, null, false, (status) => {
+            const res = await instance.exec.exec(kubernetes.namespace, name, 'volume', files.has(generatedArchive.path)
+                ? ['tar', 'zcf', '-', '-C', path_1.posix.dirname(generatedArchive.path), path_1.posix.basename(generatedArchive.path)]
+                : ['tar', 'zcf', '-', '-C', generatedArchive.path, '.'], writerStream, process.stderr, null, false, (status) => {
                 work.status.write('debug', `archive ${generatedArchive.path} of ${name}: ${status}`);
                 writerStream.close();
             });

package/dist/kubernetes/volumes.js

@@ -59,6 +59,7 @@ stateKey) {
         sources: [],
         mounts: [],
         initCommands: [],
+        files: [],
     };
     const workspace = kubernetes.server?.workspace;
     for (const mount of work.data.mounts) {
@@ -79,8 +80,12 @@ stateKey) {
     }
     if (work.data.type === 'container-task') {
         for (const generate of work.data.generates) {
-            appendVolume(generate.inherited ?? work, persistence, generate.path, null, false, !!generate.inherited, kubernetes, dirOf(generate.inherited ?? work));
+            const subPath = appendVolume(generate.inherited ?? work, persistence, generate.path, null, generate.isFile, !!generate.inherited, kubernetes, dirOf(generate.inherited ?? work));
+            if (generate.isFile && !generate.inherited) {
+                persistence.files.push(subPath);
+            }
         }
+        persistence.files.push(...getNestedMountPlaces(persistence, getVolumeName(work, kubernetes)));
     }
     else {
         for (const volume of work.data.volumes) {
@@ -92,6 +97,27 @@ stateKey) {
     return persistence;
 }
 exports.getKubernetesPersistence = getKubernetesPersistence;
+// The places in the claim `claim` of the paths mounted inside a folder that is mounted read
+// only from it: an output of a task inside a folder of its src (pkg/coverage/lcov.info with a
+// src pkg). The container runtime makes the place of a mount where it isn't there, which it
+// can't in a folder mounted read only, and the pod fails to start (exit 128). Each is in the
+// claim's folder of the read-only path, a folder ending in `/`, or a file.
+function getNestedMountPlaces(persistence, claim) {
+    const own = persistence.mounts.filter((m) => !m.workspace);
+    const folders = own.filter((m) => m.mount.name === claim && m.mount.readOnly && m.cwd === m.mount.mountPath && m.mount.subPath);
+    const places = [];
+    for (const mount of own) {
+        const parent = folders
+            .filter((folder) => folder !== mount && mount.mount.mountPath.startsWith(`${folder.mount.mountPath}/`))
+            .sort((a, b) => b.mount.mountPath.length - a.mount.mountPath.length)[0];
+        if (!parent) {
+            continue;
+        }
+        const place = `${parent.mount.subPath}/${mount.mount.mountPath.slice(parent.mount.mountPath.length + 1)}`;
+        places.push(mount.cwd === mount.mount.mountPath ? `${place}/` : place);
+    }
+    return places;
+}
 function appendVolume(sourceWork, persistence, containerPath, localPath, isFile, readOnly, kubernetes, 
 // the folder of the state of `sourceWork` the path is in, see getStateFilesDir
 stateDir, 
@@ -134,6 +160,7 @@ claimPath = (0, claim_layout_1.getClaimSubPath)(sourceWork, containerPath)) {
             stateKey: '', // TODO
         });
     }
+    return subPath;
 }
 exports.appendVolume = appendVolume;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hammerkit",
   "description": "Containerized build tool with incremental caching that runs the same build file locally, in Docker and on Kubernetes.",
-  "version": "2.0.0-next.6",
+  "version": "2.0.0-next.7",
   "keywords": [
     "build",
     "build-tool",