Issue 2864 - Incremental build caching for Rust in GitHub Actions

.github/config/chunks.yaml

@@ -22,7 +22,11 @@ chunks:
   compaction:
     name: Compaction
     workflow: chunk-compaction.yaml
-    modules: [ compaction/compaction-job-execution, compaction/compaction-task-creation, compaction/compaction-job-creation, compaction/compaction-job-creation-lambda, compaction/compaction-status-store, compaction/compaction-core, splitter/splitter-core, splitter/splitter-lambda, compaction/compaction-rust ]
+    modules: [ compaction/compaction-job-execution, compaction/compaction-task-creation, compaction/compaction-job-creation, compaction/compaction-job-creation-lambda, compaction/compaction-status-store, compaction/compaction-core, splitter/splitter-core, splitter/splitter-lambda ]
+  rust:
+    name: Rust
+    workflow: chunk-rust.yaml
+    modules: [ compaction/compaction-rust ]
   data:
     name: Data
     workflow: chunk-data.yaml

.github/workflows/chunk-rust.yaml

@@ -0,0 +1,28 @@
+name: Build Rust Modules
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/chunk-rust.yaml'
+      - '.github/workflows/chunk.yaml'
+      - '.github/config/chunks.yaml'
+      - 'code-style/checkstyle*.xml'
+      - 'code-style/spotbugs*.xml'
+      - 'rust/**'
+      - 'java/pom.xml'
+      - 'java/compaction/pom.xml'
+      - 'java/compaction/compaction-rust/**'
+      - 'java/compaction/compaction-job-creation/**'
+      - 'java/compaction/compaction-core/**'
+      - 'java/common/common-job/**'
+      - 'java/statestore/**'
+      - 'java/parquet/**'
+      - 'java/configuration/**'
+      - 'java/common/dynamodb-tools/**'
+      - 'java/core/**'
+
+jobs:
+  chunk-workflow:
+    uses: ./.github/workflows/chunk.yaml
+    with:
+      chunkId: rust
+      skipRust: false

.github/workflows/chunk.yaml

@@ -9,6 +9,10 @@ on:
         required: false
         type: boolean
 
+env:
+  SCCACHE_GHA_ENABLED: "true"
+  SSCACHE_CACHE_SIZE: "2G"
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -21,6 +25,8 @@ jobs:
           distribution: 'corretto'
       - uses: dtolnay/[email protected]
         if: ${{ ! inputs.skipRust }}
+      - uses: mozilla-actions/[email protected]
+        if: ${{ ! inputs.skipRust }}
       - name: Install cargo cross
         run: cargo install cross
         if: ${{ ! inputs.skipRust }}

.github/workflows/rust-cache.yaml

@@ -0,0 +1,30 @@
+name: Rust Nightly
+on:
+  workflow_dispatch: # Allow manual running to refresh/check cache
+  schedule: # Planned execution once per day
+    - cron: "0 2 * * *"
+  pull_request:
+    paths:
+      - '.github/workflows/rust-cache.yaml'
+
+env:
+  SCCACHE_GHA_ENABLED: "true"
+  RUSTC_WRAPPER: "sccache"
+  SSCACHE_CACHE_SIZE: "2G"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/[email protected]
+      - uses: mozilla-actions/[email protected]
+      - name: Install cargo cross
+        run: cargo install cross
+      - name: Build x86_64
+        working-directory: ./rust
+        run: SCCACHE_LOG=trace cross build --release --target x86_64-unknown-linux-gnu --verbose
+      - name: Build aarch64
+        working-directory: ./rust
+        run: SCCACHE_LOG=trace cross build --release --target aarch64-unknown-linux-gnu --verbose

rust/Cross.toml

@@ -11,11 +11,22 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+[build.env]
+passthrough = [
+    "SCCACHE_ERROR_LOG",
+    "SCCACHE_LOG",
+    "SSCACHE_CACHE_SIZE",
+    "SCCACHE_GHA_ENABLED",
+    "ACTIONS_CACHE_URL",
+    "ACTIONS_RUNTIME_TOKEN",
+]
+
 [target.aarch64-unknown-linux-gnu]
-image = "ghcr.io/cross-rs/aarch64-unknown-linux-gnu:edge"
+dockerfile = "Dockerfile.aarch64-unknown-linux-gnu"
 
 [target.x86_64-unknown-linux-gnu]
-image = "ghcr.io/cross-rs/x86_64-unknown-linux-gnu:edge"
+dockerfile = "Dockerfile.x86_64-unknown-linux-gnu"
 
 [build]
 pre-build = ["apt-get update && apt-get --assume-yes install libssl-dev"]

rust/Dockerfile.aarch64-unknown-linux-gnu

@@ -0,0 +1,11 @@
+FROM ghcr.io/cross-rs/aarch64-unknown-linux-gnu:edge
+ARG DEBIAN_FRONTEND=noninteractive
+
+# COPY sccache-source.sh /sccache.sh
+# RUN /sccache.sh aarch64-unknown-linux-gnu
+
+COPY sccache-prebuilt.sh /sccache.sh
+RUN /sccache.sh x86_64-unknown-linux-musl
+
+ENV RUSTC_WRAPPER="/usr/bin/sccache"
+ENV SCCACHE_DIR="/tmp/sccache"

rust/Dockerfile.x86_64-unknown-linux-gnu

@@ -0,0 +1,11 @@
+FROM ghcr.io/cross-rs/x86_64-unknown-linux-gnu:edge
+ARG DEBIAN_FRONTEND=noninteractive
+
+# COPY sccache-source.sh /sccache.sh
+# RUN /sccache.sh x86_64-unknown-linux-gnu
+
+COPY sccache-prebuilt.sh /sccache.sh
+RUN /sccache.sh x86_64-unknown-linux-musl
+
+ENV RUSTC_WRAPPER="/usr/bin/sccache"
+ENV SCCACHE_DIR="/tmp/sccache"

rust/sccache-prebuilt.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+set -x
+set -euo pipefail
+
+# shellcheck disable=SC1091
+. lib.sh
+
+main() {
+    local triple
+    local tag
+    local td
+    local url="https://github.com/mozilla/sccache"
+    triple="${1}"
+
+    install_packages unzip tar
+
+    # Download our package, then install our binary.
+    td="$(mktemp -d)"
+    pushd "${td}"
+    tag=$(git ls-remote --tags --refs --exit-code \
+        "${url}" \
+        | cut -d/ -f3 \
+        | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' \
+        | sort --version-sort \
+        | tail -n1)
+    curl -LSfs "${url}/releases/download/${tag}/sccache-${tag}-${triple}.tar.gz" \
+        -o sccache.tar.gz
+    tar -xvf sccache.tar.gz
+    rm sccache.tar.gz
+    cp "sccache-${tag}-${triple}/sccache" "/usr/bin/sccache"
+    chmod +x "/usr/bin/sccache"
+
+    # clean up our install
+    purge_packages
+    popd
+    rm -rf "${td}"
+    rm "${0}"
+}
+
+main "${@}"

rust/sccache-source.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+set -x
+set -euo pipefail
+
+# shellcheck disable=SC1091
+. lib.sh
+
+main() {
+    local triple
+    local tag
+    local td
+    local url="https://github.com/mozilla/sccache"
+    triple="${1}"
+
+    install_packages ca-certificates curl unzip
+
+    # install rust and cargo to build sccache
+    export RUSTUP_HOME=/tmp/rustup
+    export CARGO_HOME=/tmp/cargo
+    curl --retry 3 -sSfL https://sh.rustup.rs -o rustup-init.sh
+    sh rustup-init.sh -y --no-modify-path
+    rm rustup-init.sh
+    export PATH="${CARGO_HOME}/bin:${PATH}"
+    rustup target add "${triple}"
+
+    # download the source code from the latest sccache release
+    td="$(mktemp -d)"
+    pushd "${td}"
+    tag=$(git ls-remote --tags --refs --exit-code \
+        "${url}" \
+        | cut -d/ -f3 \
+        | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' \
+        | sort --version-sort \
+        | tail -n1)
+    curl -LSfs "${url}/archive/refs/tags/${tag}.zip" \
+        -o sccache.zip
+    unzip sccache.zip
+    mv "sccache-${tag//v/}" sccache
+    rm sccache.zip
+
+    # build from source for the desired architecture
+    # you can also use additional features here
+    cd sccache
+    cargo build --release --target "${triple}" \
+        --features=all,"openssl/vendored"
+    cp "target/${triple}/release/sccache" "/usr/bin/sccache"
+
+    # clean up our install
+    rm -r "${RUSTUP_HOME}" "${CARGO_HOME}"
+    purge_packages
+    popd
+    rm -rf "${td}"
+    rm "${0}"
+}
+
+main "${@}"