Merge pull request #36 from evaline-ju/fix-ci

👷🐛 Use docker for test run

Author: gkumbhat

.github/workflows/build.yml

@@ -0,0 +1,93 @@
+name: Test and Lint Orchestrator
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+env:
+  CARGO_TERM_COLOR: always
+  TEST_IMAGE_NAME: "orchestr8-tests:0"
+  LINT_IMAGE_NAME: "orchestr8-lint:0"
+  FMT_IMAGE_NAME: "orchestr8-fmt:0"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    env:
+      CACHE_TEST_IMAGE: "ghcr.io/foundation-model-stack/fms-guardrails-orchestrator:test-cache"
+      CACHE_LINT_IMAGE: "ghcr.io/foundation-model-stack/fms-guardrails-orchestrator:lint-cache"
+      CACHE_FMT_IMAGE: "ghcr.io/foundation-model-stack/fms-guardrails-orchestrator:fmt-cache"
+      CACHE_REGISTRY: "ghcr.io"
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: "Setup Docker Buildx"
+        uses: docker/setup-buildx-action@v3
+      - name: "Log in to cache image container registry"
+        uses: docker/login-action@v3
+        if: github.event_name != 'pull_request'
+        with:
+          registry: ${{ env.CACHE_REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: "Set build cache target"
+        run: |
+          # For push to `main` (PR merged), push a new cache image with all layers (cache-mode=max).
+          # For PR builds, use GitHub action cache which isolates cached layers by PR/branch.
+          # to optimize builds for subsequent pushes to the same PR/branch.
+          # Do not set a cache-to image for PR builds to not overwrite the `main` cache image and
+          # to not ping-pong cache images for two or more different PRs.
+          # Do not push cache images for each PR or multiple branches to not exceed GitHub package
+          # usage and traffic limitations.
+          # UPDATE: GHA cache appears to have issues, cannot use `cache-to: gha,mode=min`
+          # if `cache-from: reg...,mode=max` but `cache-to: gha,mode=max` takes longer than uncached
+          # build and exhausts GHA cache size limits, so use cache `type=inline` (no external cache).
+          if [ "${{ github.event_name }}" == "pull_request" ]
+          then
+              #CACHE_TO="type=gha,mode=min"
+              CACHE_TEST_TO="type=inline"
+              CACHE_LINT_TO="type=inline"
+              CACHE_FMT_TO="type=inline"
+          else
+              CACHE_TEST_TO="type=registry,ref=${{ env.CACHE_TEST_IMAGE }},mode=max"
+              CACHE_LINT_TO="type=registry,ref=${{ env.CACHE_LINT_IMAGE }},mode=max"
+              CACHE_FMT_TO="type=registry,ref=${{ env.CACHE_FMT_IMAGE }},mode=max"
+          fi
+          echo "CACHE_TEST_TO=$CACHE_TEST_TO" >> $GITHUB_ENV
+          echo "CACHE_LINT_TO=$CACHE_LINT_TO" >> $GITHUB_ENV
+          echo "CACHE_FMT_TO=$CACHE_FMT_TO" >> $GITHUB_ENV
+      - name: Test
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          target: tests
+          tags: ${{ env.TEST_IMAGE_NAME }}
+          cache-from: type=registry,ref=${{ env.CACHE_TEST_IMAGE }}
+          cache-to: ${{ env.CACHE_TEST_TO }}
+          push: false
+          platforms: linux/amd64
+      - name: Lint with clippy
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          target: lint
+          tags: ${{ env.LINT_IMAGE_NAME }}
+          cache-from: type=registry,ref=${{ env.CACHE_LINT_IMAGE }}
+          cache-to: ${{ env.CACHE_LINT_TO }}
+          push: false
+          platforms: linux/amd64
+      - name: Format
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          target: format
+          tags: ${{ env.FMT_IMAGE_NAME }}
+          cache-from: type=registry,ref=${{ env.CACHE_FMT_IMAGE }}
+          cache-to: ${{ env.CACHE_FMT_TO }}
+          push: false
+          platforms: linux/amd64

.github/workflows/test.yml

@@ -33,10 +33,21 @@ WORKDIR /app
 # TODO: Make releases via cargo-release
 RUN cargo install --root /app/ --path .
 
+## Tests stage ##################################################################
+FROM fms-guardrails-orchestr8-builder as tests
+RUN cargo test
+
+## Lint stage ###################################################################
+FROM fms-guardrails-orchestr8-builder as lint
+RUN cargo clippy --all-targets --all-features -- -D warnings
+
+## Formatting check stage #######################################################
+FROM fms-guardrails-orchestr8-builder as format
+RUN cargo fmt --check
 
 ## Release Image ################################################################
 
-FROM ${UBI_MINIMAL_BASE_IMAGE}:${UBI_BASE_IMAGE_TAG}
+FROM ${UBI_MINIMAL_BASE_IMAGE}:${UBI_BASE_IMAGE_TAG} as fms-guardrails-orchestr8-release
 
 COPY --from=fms-guardrails-orchestr8-builder /app/bin/ /app/bin/
 COPY config /app/config
@@ -53,4 +64,4 @@ USER orchestr8
 
 ENV ORCHESTRATOR_CONFIG /app/config/config.yaml
 
-CMD /app/bin/fms-guardrails-orchestr8
+CMD /app/bin/fms-guardrails-orchestr8