From 6cc7cadb3e18051e13b18501550196cda044e44d Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 12 Nov 2026 08:46:59 +0000 Subject: [PATCH] Add a DSpace lane with the BoringCache Maven tool cache DSpace spends most of each build in one mvn package step that every source change invalidates, so no layer cache shortens it. The plus lane loads Maven build cache extension 1.3.0 and serves its remote cache through the BoringCache Docker Maven tool cache. Preparation writes overlay/dspace-maven.Dockerfile from each step's upstream Dockerfile: it adds .mvn/extensions.xml after the source copy and runs the assembly plugin's single goal even when the dspace module is restored, because the Dockerfile moves the dspace-installer directory that goal creates. It fails if either upstream line changes. There is no gha-plus lane. The build runs as the non-root dspace user, cache-dance restores cache mounts owned by root, and a uid or mode option gives the mount an identity cache-dance does not restore. rolling_series = 2 restarts every DSpace lane from start_sha with empty caches so the new lane has the same cold step 0. https://boringcache.com/docs/adapters/docker https://maven.apache.org/extensions/maven-build-cache-extension/parameters.html --- tools/README.md | 20 ++++++++++-- tools/docker/dspace/case.toml | 3 ++ tools/docker/dspace/plus/.boringcache.toml | 15 +++++++++ tools/docker/dspace/prepare.sh | 36 ++++++++++++++++++++++ 4 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 tools/docker/dspace/plus/.boringcache.toml create mode 100644 tools/docker/dspace/prepare.sh diff --git a/tools/README.md b/tools/README.md index 022f881a7b..454c87bef1 100644 --- a/tools/README.md +++ b/tools/README.md @@ -262,7 +262,7 @@ days before the cases were added. | `docker/fred` | `43a0d105e95419faf1a66bf5d9e65f594fb95631` | 27 | 2 | 20 commits before head | | `docker/dspace` | `ef95eb4edd924854b98ce5c6f9712114f2dda421` | 3 | every commit | 10 commits before head | -Every lane builds upstream's CI image with the source unchanged. +Every base lane builds upstream's CI image with the source unchanged. - `gram` builds `agents/code-runner/Dockerfile`, the image of the `validate` job's "Build smoke-test image" step. Upstream runs that step only when the @@ -283,11 +283,27 @@ Every lane builds upstream's CI image with the source unchanged. different days can start from different dependency images. Upstream exports its GitHub Actions cache with `mode=min`; the shared `gha` and `ghcr` lanes export `mode=max`. +- The `dspace` plus lane adds the BoringCache Maven tool cache to the layer + cache. Preparation writes `overlay/dspace-maven.Dockerfile` from each step's + upstream Dockerfile. After the source copy it adds `.mvn/extensions.xml` + with Maven build cache extension 1.3.0. The `mvn package` command gains + `-Dmaven.build.cache.alwaysRunPlugins=maven-assembly-plugin:single`, because + the Dockerfile moves `dspace/target/dspace-installer`, which that goal + creates, even when the build cache restores the `dspace` module. + Preparation fails if either upstream line changes. There is no `gha-plus` + lane. The build runs as the non-root `dspace` user. cache-dance creates the + restored cache mount as root before the build, so that user cannot write a + persisted local build cache. A `uid` or `mode` option gives the mount a + different identity that cache-dance does not restore. Adding the plus lane + set `rolling_series = 2`, so every DSpace lane restarted from `start_sha` + with an empty cache. Sources: [Gram code runner workflow](https://github.com/speakeasy-api/gram/blob/2f2e8c27cfa973101fe639618aa2a3d623f2c4b7/.github/workflows/code-runner.yaml), [honeybeepf-llm image workflow](https://github.com/honeybee-studio/honeybeepf-llm/blob/b3cb83737e0efa8d40342e57ef5b60c4f9b7c7c0/.github/workflows/docker-publish.yml), [Fred image list](https://github.com/ThalesGroup/fred/blob/3d18384205a469f691bbf3ca3cb697911bc6b257/.github/docker-images.json), -[DSpace reusable image build](https://github.com/DSpace/DSpace/blob/622fc02e14914a990eba0bc175c2f5dfecf702de/.github/workflows/reusable-docker-build.yml). +[DSpace reusable image build](https://github.com/DSpace/DSpace/blob/622fc02e14914a990eba0bc175c2f5dfecf702de/.github/workflows/reusable-docker-build.yml), +[BoringCache Docker tool caches](https://boringcache.com/docs/adapters/docker), +[Maven build cache extension parameters](https://maven.apache.org/extensions/maven-build-cache-extension/parameters.html). ## Weekly runner samples diff --git a/tools/docker/dspace/case.toml b/tools/docker/dspace/case.toml index 0589d8ec64..3ce19e4332 100644 --- a/tools/docker/dspace/case.toml +++ b/tools/docker/dspace/case.toml @@ -1,9 +1,12 @@ repo = "DSpace/DSpace" branch = "main" start_sha = "622fc02e14914a990eba0bc175c2f5dfecf702de" +rolling_series = 2 +prepare = ["bash \"$BENCH_ROOT/tools/docker/dspace/prepare.sh\""] check = "docker image inspect dspace-benchmark:local" [runs] boringcache-docker = ["github", "github-arm", "local"] +boringcache-docker-plus = ["github", "github-arm", "local"] gha = ["github", "github-arm"] ghcr = ["github", "github-arm"] diff --git a/tools/docker/dspace/plus/.boringcache.toml b/tools/docker/dspace/plus/.boringcache.toml new file mode 100644 index 0000000000..864b0332f5 --- /dev/null +++ b/tools/docker/dspace/plus/.boringcache.toml @@ -0,0 +1,15 @@ +workspace = "boringcache/benchmarks" + +[adapters.docker] +fail-on-cache-error = true +tag = "dspace-docker" +no-git = true +metadata-hints = ["benchmark=dspace", "upstream-job=dspace"] +tool-cache = ["maven:dspace-maven"] +command = [ + "docker", "buildx", "build", + "--file", "overlay/dspace-maven.Dockerfile", + "--tag", "dspace-benchmark:local", + "--load", + "upstream", +] diff --git a/tools/docker/dspace/prepare.sh b/tools/docker/dspace/prepare.sh new file mode 100644 index 0000000000..a4f1b15b3d --- /dev/null +++ b/tools/docker/dspace/prepare.sh @@ -0,0 +1,36 @@ +set -euo pipefail + +source=upstream/Dockerfile +target=overlay/dspace-maven.Dockerfile +copy='COPY --chown=dspace . /app/' +build='RUN mvn --no-transfer-progress package ${MAVEN_FLAGS} && \' + +for line in "$copy" "$build"; do + if [ "$(grep -cxF -- "$line" "$source")" != 1 ]; then + echo "upstream/Dockerfile must contain this line exactly once: $line" >&2 + exit 1 + fi +done + +mkdir -p overlay +awk -v copy="$copy" -v build="$build" ' + $0 == copy { + print + print "COPY --chown=dspace <" + print "" + print " " + print " org.apache.maven.extensions" + print " maven-build-cache-extension" + print " 1.3.0" + print " " + print "" + print "EOF" + next + } + $0 == build { + print "RUN mvn --no-transfer-progress package ${MAVEN_FLAGS} -Dmaven.build.cache.alwaysRunPlugins=maven-assembly-plugin:single && \\" + next + } + { print } +' "$source" > "$target"