Merge pull request #3111 from iosh/githubTest

feat: add GitHub Actions workflow for running tests

Author: iosh

.github/workflows/docs.Dockerfile renamed to .github/dockers/base.Dockerfile

@@ -20,17 +20,18 @@ RUN apt-get update && \
     rm -rf /var/lib/apt/lists/* && \
     rm llvm.sh
 
+WORKDIR /app
+
+COPY rust-toolchain.toml .
+
 RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-host x86_64-unknown-linux-gnu -y && \
     . ~/.cargo/env && \
-    rustup default nightly-2024-01-29 && \
-    git config --global --add safe.directory '*'
+    git config --global --add safe.directory /app && \
+    cargo install cargo-nextest --version "0.9.85" --locked
 
 ENV PATH="/root/.cargo/bin:/home/builder/.cargo/bin:${PATH}"
 ENV CC=clang-18
 ENV CXX=clang++-18
 ENV CXXFLAGS="-std=c++11 -stdlib=libc++"
 ENV LDFLAGS="-stdlib=libc++"
 
-WORKDIR /app
-
-COPY . .

.github/workflows/docs.yml

@@ -13,26 +13,39 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-base-${{ hashFiles('.github/dockers/base.Dockerfile') }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-base-
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
       - name: Build docker image
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: .github/workflows/docs.Dockerfile
+          file: .github/dockers/base.Dockerfile
           load: true
-          tags: doc-builder:latest
+          tags: base-builder:latest
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
 
       - name: Generate documentation
         run: |
-          mkdir -p target
-          chmod -R 777 target
-          docker run --rm -v $(pwd)/target:/app/target -w /app doc-builder:latest \
-            bash -c "RUSTDOCFLAGS='--enable-index-page -Z unstable-options' cargo +nightly-2024-01-29 doc --no-deps"
+          docker run --rm -v $(pwd):/app -w /app base-builder:latest \
+            bash -c "rustup default nightly-2024-01-29 && RUSTDOCFLAGS='--enable-index-page -Z unstable-options' cargo +nightly-2024-01-29 doc --no-deps"
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./target/doc
+
+      - name: Move cache to the correct location
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

.github/workflows/test.yml

@@ -0,0 +1,79 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Free up space
+        run: |
+          sudo rm -rf /usr/share/dotnet /usr/local/lib/android
+
+      - name: Cache Cargo and build artifacts
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target/release
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-base-${{ hashFiles('.github/dockers/base.Dockerfile') }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-base-
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: .github/dockers/base.Dockerfile
+          load: true
+          tags: base-builder:latest
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
+
+      - name: Run workspace tests
+        run: |
+          docker run --rm \
+            -v $(pwd):/app \
+            -v ~/.cargo/registry:/root/.cargo/registry \
+            -v ~/.cargo/git:/root/.cargo/git \
+            -e RUST_BACKTRACE=1 \
+            -w /app base-builder:latest \
+            cargo nextest run --no-fail-fast --release --workspace
+
+      - name: Run cfx-addr
+        run: |
+          docker run --rm \
+            -v $(pwd):/app \
+            -v ~/.cargo/registry:/root/.cargo/registry \
+            -v ~/.cargo/git:/root/.cargo/git \
+            -e RUST_BACKTRACE=1 \
+            -w /app base-builder:latest \
+            cargo nextest run --no-fail-fast -p cfx-addr --no-default-features
+
+      - name: Ensure cache files are accessible
+        run: |
+          sudo chown -R $(id -u):$(id -g) target/release
+          sudo chown -R $(id -u):$(id -g) ~/.cargo
+
+      - name: Move cache to the correct location
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache