@invarn/cibuild 2.8.6 → 2.8.7

package/dist/src/yaml/steps/gradle-memory.test.js

@@ -124,6 +124,52 @@ describe("cibuild_gradle_memory_plan", () => {
         ]);
     });
 });
+/** The plan, then the workers plan, as the step runs them. */
+function workersPlan(memMib, maxWorkers) {
+    const script = `${GRADLE_MEMORY_FUNCTIONS}
+cibuild_gradle_memory_plan "$1" gradle.properties "$2/gradle.properties" ""
+cibuild_gradle_workers_plan "$3"
+for a in "\${CIBUILD_GRADLE_MEMORY_ARGS[@]}"; do printf 'ARG %s\\n' "$a"; done
+printf 'LINE %s\\n' "$CIBUILD_GRADLE_WORKERS_LINE"
+printf 'SENTENCE %s\\n' "$CIBUILD_GRADLE_MEMORY_SENTENCE"`;
+    const out = execFileSync("bash", ["-c", script, "plan", memMib, join(dir, "no-user-home"), maxWorkers], {
+        cwd: dir,
+        encoding: "utf-8",
+    });
+    const lines = out.split("\n");
+    return {
+        args: lines.filter((l) => l.startsWith("ARG ")).map((l) => l.slice(4)),
+        line: (lines.find((l) => l.startsWith("LINE ")) ?? "").slice(5),
+        sentence: (lines.find((l) => l.startsWith("SENTENCE ")) ?? "").slice(9),
+    };
+}
+// ReFra was killed again with its heap capped: off-heap memory and parallel
+// native compilers are past what a heap cap bounds. Its CI also sets
+// org.gradle.workers.max=2, which the pipeline carries as max_workers.
+describe("cibuild_gradle_workers_plan", () => {
+    test("ReFra: the worker count goes after the heap cap, and the sentence names it", () => {
+        copyFileSync(join(FIXTURES, "refra.gradle.properties"), join(dir, "gradle.properties"));
+        const p = workersPlan(TEN_GIB, "2");
+        expect(p.args).toEqual(["-Dorg.gradle.jvmargs=-Xmx3840m -Dfile.encoding=UTF-8", "--max-workers=2"]);
+        expect(p.line).toBe("Gradle memory: running with --max-workers=2, as the pipeline asks (set on the command line, over any org.gradle.workers.max).");
+        expect(p.sentence).toMatch(/This build ran them capped: Gradle -Xmx3840m, .* Gradle ran with --max-workers=2\.$/);
+    });
+    test("heaps that fit still get the worker count", () => {
+        const p = workersPlan(TEN_GIB, "4");
+        expect(p.args).toEqual(["--max-workers=4"]);
+    });
+    test("nothing asked, nothing passed or printed", () => {
+        const p = workersPlan(TEN_GIB, "");
+        expect(p.args).toEqual([]);
+        expect(p.line).toBe("");
+        expect(p.sentence).not.toContain("max-workers");
+    });
+    test.each(["0", "02", "-1", "two", "2 --offline"])("%s is not a worker count, and says so", (value) => {
+        const p = workersPlan(TEN_GIB, value);
+        expect(p.args).toEqual([]);
+        expect(p.line).toBe(`Gradle memory: max_workers=${value} is not a positive whole number, so it is not passed and Gradle picks its own worker count.`);
+    });
+});
 /** A directory standing in for PATH, with a fake `dmesg` that prints `oom`. */
 function fakeBin(oom) {
     const bin = join(dir, "bin");
@@ -173,6 +219,38 @@ describe("the Gradle steps", () => {
         const args = execFileSync("cat", [join(dir, "gradlew-args")], { encoding: "utf-8" }).trim().split("\n");
         expect(args).toEqual(["-Dorg.gradle.jvmargs=-Xmx256m -Dfile.encoding=UTF-8", "assembleDebug", "--stacktrace"]);
     });
+    test("the pipeline's max_workers reach Gradle after the heap arguments, before the task", async () => {
+        fakeGradlew("exit 0");
+        const step = await new GradleBuildStepExecutor().execute(
+        // YAML reads `max_workers: 2` as a number.
+        { gradle_task: "assembleDebug", gradle_options: "--stacktrace", jvmargs: "-Xmx256m", max_workers: 2 }, {}, testConfig);
+        const run = runStep(step.script, fakeBin(""));
+        expect(run.status).toBe(0);
+        expect(run.stdout).toContain("Gradle memory: running with --max-workers=2, as the pipeline asks");
+        const args = execFileSync("cat", [join(dir, "gradlew-args")], { encoding: "utf-8" }).trim().split("\n");
+        expect(args).toEqual(["-Dorg.gradle.jvmargs=-Xmx256m", "--max-workers=2", "assembleDebug", "--stacktrace"]);
+    });
+    test("a killed daemon's sentence names the worker count it ran with", async () => {
+        copyFileSync(join(FIXTURES, "refra.gradle.properties"), join(dir, "gradle.properties"));
+        fakeGradlew('echo "Gradle build daemon disappeared unexpectedly"\nexit 1');
+        const step = await new GradleBuildStepExecutor().execute({ gradle_task: "assembleDebug", max_workers: "2" }, {}, testConfig);
+        const run = runStep(step.script, fakeBin(OOM_LINE));
+        expect(run.status).toBe(1);
+        // The test machine's own memory decides whether a cap applied, so only the
+        // sentence's end is asserted.
+        expect(run.stdout).toMatch(/^The build machine has .*asked for 16\.0 GiB .* Gradle ran with --max-workers=2\.$/m);
+    });
+    test("every Gradle step passes max_workers to the plan", async () => {
+        const steps = [
+            await new GradleBuildStepExecutor().execute({ max_workers: 3 }, {}, testConfig),
+            await new AndroidLintStepExecutor().execute({ max_workers: 3 }, {}, testConfig),
+            await new AndroidUnitTestStepExecutor().execute({ max_workers: 3 }, {}, testConfig),
+            await new AndroidBuildForUITestingStepExecutor().execute({ max_workers: 3 }, {}, testConfig),
+        ];
+        for (const step of steps) {
+            expect(step.script).toContain("cibuild_gradle_memory_cap '' '3'");
+        }
+    });
     test("every Gradle step runs through the plan, and every one is valid bash", async () => {
         const steps = [
             await new GradleBuildStepExecutor().execute({}, {}, testConfig),
@@ -182,7 +260,7 @@ describe("the Gradle steps", () => {
         ];
         for (const step of steps) {
             const script = step.script;
-            expect(script).toContain("cibuild_gradle_memory_cap ''");
+            expect(script).toContain("cibuild_gradle_memory_cap '' ''");
             execFileSync("bash", ["-n"], { input: script });
         }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@invarn/cibuild",
-  "version": "2.8.6",
+  "version": "2.8.7",
   "description": "CI Build CLI — local pipeline orchestration and validation",
   "type": "module",
   "main": "dist/cli.cjs",