From 2748f232e4151ae296d83117c55501a65a4c16cd Mon Sep 17 00:00:00 2001
From: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
Date: Mon, 15 Apr 2024 09:53:28 +0200
Subject: [PATCH] ci(github): Run functional tests in up-to-date Docker
 container

Change the `build-and-test` workflow to run the functional tests in a
newly built Docker image. Before that change, functional tests were
executed in the nightly snapshot build of the ORT Docker image. This was
problematic, as changes to the Dockerfile were not immediately reflected
in the test results.

To speed of the build of the Docker image, the workflow uses the
registry cache and builts only the `all-tools` stage which does not
include the ORT build itself. The ORT installation is not required, as
the GitHub workspace is mounted into the Docker container for running
the functional tests.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
---
 .github/workflows/build-and-test.yml | 38 ++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
index 325c9a63739d4..dcd1811a1a676 100644
--- a/.github/workflows/build-and-test.yml
+++ b/.github/workflows/build-and-test.yml
@@ -10,6 +10,8 @@ on:
 
 env:
   GRADLE_OPTS: -Dorg.gradle.daemon=false -Dkotest.assertions.multi-line-diff=unified
+  REGISTRY: ghcr.io
+  TEST_IMAGE_TAG: ort:test
 
 jobs:
   build:
@@ -116,19 +118,45 @@ jobs:
         flags: funTest-non-docker
   funTest-docker:
     runs-on: ubuntu-22.04
-    container:
-      image: ghcr.io/oss-review-toolkit/ort:snapshot
-      options: --user 1001
     steps:
     - name: Checkout Repository
       uses: actions/checkout@v4
       with:
         submodules: recursive
-    - name: Run functional tests that do require external tools
+    - name: Free Disk Space
+      uses: ./.github/actions/free-disk-space
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build ORT Docker Image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        load: true
+        tags: ${{ env.TEST_IMAGE_TAG }}
+        target: all-tools
+        cache-from: type=registry,ref=${{ env.REGISTRY }}/${{ github.repository_owner }}/ort:cache
+    - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v3
       with:
         gradle-home-cache-cleanup: true
-        arguments: --scan -Ptests.include=org.ossreviewtoolkit.plugins.packagemanagers.* funTest jacocoFunTestReport
+    - name: Run functional tests that do require external tools
+      run: |
+        # Change the ownership of the Gradle user home and the workspace to the user in the Docker container.
+        sudo chown -R 1000:1000 /home/runner/.gradle
+        sudo chown -R 1000:1000 ${{ github.workspace }}
+
+        # Run the functional tests in the Docker container.
+        docker run \
+          -v ${{ github.workspace }}:/workspace \
+          -v /home/runner/.gradle:/home/ort/.gradle \
+          -w /workspace \
+          --entrypoint=sh \
+          ${{ env.TEST_IMAGE_TAG }} \
+          -c "GRADLE_USER_HOME=/home/ort/.gradle ./gradlew --scan -Ptests.include=org.ossreviewtoolkit.plugins.packagemanagers.* funTest jacocoFunTestReport"
+
+        # Change the ownership of the Gradle user home and the workspace back to the user in the GitHub Actions runner.
+        sudo chown -R 1001:121 /home/runner/.gradle
+        sudo chown -R 1001:121 ${{ github.workspace }}
     - name: Upload code coverage data
       uses: codecov/codecov-action@v4
       with: