fix: reduce test run time

Signed-off-by: Alexei Dodon <[email protected]>
project-zot · Sep 21, 2023 · 9942f40 · 9942f40
1 parent 8c55944
commit 9942f40
Show file tree

Hide file tree

Showing 10 changed files with 274 additions and 104 deletions.
diff --git a/.github/actions/check-diskspace/action.yaml b/.github/actions/check-diskspace/action.yaml
@@ -0,0 +1,21 @@
+name: 'Check disk space'
+description: 'Show available disk space'
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      if: always()
+      run: |
+        cd $GITHUB_WORKSPACE
+        set -x
+        df -h
+        sudo ls -lRh /tmp/* || true
+        sudo du -sh /tmp || true
+        sudo du -sh /tmp/* || true
+        sudo find /tmp/ -size +5M | sudo xargs ls -lh
+        du -sh ./* || true
+        find ./ -size +5M   | xargs ls -lh
+        sudo du -sh /var/
+        sudo du -sh /var/lib/docker/
+        du -sh /home/runner/work/
+        set +x
diff --git a/.github/actions/setup-localstack/action.yaml b/.github/actions/setup-localstack/action.yaml
@@ -0,0 +1,20 @@
+name: 'Setup localstack service'
+description: 'Download & run localstack container'
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      run: |
+            pip install localstack                    # Install LocalStack cli
+            docker pull localstack/localstack:1.3     # Make sure to pull the latest version of the image
+            localstack start -d                       # Start LocalStack in the background
+
+            echo "Waiting for LocalStack startup..."  # Wait 30 seconds for the LocalStack container
+            localstack wait -t 30                     # to become ready before timing out
+            echo "Startup complete"
+
+            aws --endpoint-url=http://localhost:4566 s3api create-bucket --bucket zot-storage --region us-east-2 --create-bucket-configuration="{\"LocationConstraint\": \"us-east-2\"}"
+            aws dynamodb --endpoint-url http://localhost:4566 --region "us-east-2" create-table --table-name BlobTable --attribute-definitions AttributeName=Digest,AttributeType=S --key-schema AttributeName=Digest,KeyType=HASH --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5
+      env:
+        AWS_ACCESS_KEY_ID: fake
+        AWS_SECRET_ACCESS_KEY: fake
diff --git a/.github/actions/teardown-localstack/action.yaml b/.github/actions/teardown-localstack/action.yaml
@@ -0,0 +1,8 @@
+name: 'Stop localstack'
+description: 'Stop localstack container'
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      if: always()
+      run: localstack stop
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -8,13 +8,13 @@ on:
   release:
     types:
       - published
-name: build-test
+name: build
 
 permissions: read-all
 
 jobs:
-  build-test-arch:
-    name: Build and test ZOT
+  build-arch:
+    name: Build ZOT multiarch
     permissions:
       contents: write
       packages: write
@@ -72,86 +72,17 @@ jobs:
           curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v1.0.0-rc.4/notation_1.0.0-rc.4_linux_amd64.tar.gz
           sudo tar xvzf notation.tar.gz -C /usr/bin notation
           rm -f notation.tar.gz
-          go install github.com/wadey/gocovmerge@latest
-
-      - if: matrix.os == 'linux' && matrix.arch == 'amd64'
-        name: Setup localstack service
-        run: |
-            pip install localstack                    # Install LocalStack cli
-            docker pull localstack/localstack:1.3     # Make sure to pull the latest version of the image
-            localstack start -d                       # Start LocalStack in the background
-
-            echo "Waiting for LocalStack startup..."  # Wait 30 seconds for the LocalStack container
-            localstack wait -t 30                     # to become ready before timing out
-            echo "Startup complete"
-
-            aws --endpoint-url=http://localhost:4566 s3api create-bucket --bucket zot-storage --region us-east-2 --create-bucket-configuration="{\"LocationConstraint\": \"us-east-2\"}"
-            aws dynamodb --endpoint-url http://localhost:4566 --region "us-east-2" create-table --table-name BlobTable --attribute-definitions AttributeName=Digest,AttributeType=S --key-schema AttributeName=Digest,KeyType=HASH --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5
-        env:
-          AWS_ACCESS_KEY_ID: fake
-          AWS_SECRET_ACCESS_KEY: fake
-
-      - name: Check disk space before build
-        run: |
-          cd $GITHUB_WORKSPACE
-          set -x
-          df -h
-          sudo ls -lRh /tmp/* || true
-          sudo du -sh /tmp || true
-          sudo du -sh /tmp/* || true
-          sudo find /tmp/ -size +5M | sudo xargs ls -lh
-          du -sh ./* || true
-          find ./ -size +5M   | xargs ls -lh
-          sudo du -sh /var/
-          sudo du -sh /var/lib/docker/
-          du -sh /home/runner/work/
-          set +x
-
-      - name: Run build and test
+      - uses: ./.github/actions/check-diskspace
+      - name: Run build
         timeout-minutes: 80
         run: |
           echo "Building for $OS:$ARCH"
           cd $GITHUB_WORKSPACE
-          if [[ $OS == "linux" && $ARCH == "amd64" ]]; then
-            make
-            sudo env "PATH=$PATH" make privileged-test
-          else
-            make binary binary-minimal binary-debug cli bench exporter-minimal
-          fi
+          make binary binary-minimal binary-debug cli bench exporter-minimal
         env:
-          S3MOCK_ENDPOINT: localhost:4566
-          DYNAMODBMOCK_ENDPOINT: http://localhost:4566
-          AWS_ACCESS_KEY_ID: fake
-          AWS_SECRET_ACCESS_KEY: fake
           OS: ${{ matrix.os }}
           ARCH: ${{ matrix.arch }}
-
-      - if: matrix.os == 'linux' && matrix.arch == 'amd64'
-        name: Stop localstack
-        run: |
-            localstack stop
-
-      - name: Check disk space after build
-        if: always()
-        run: |
-          cd $GITHUB_WORKSPACE
-          set -x
-          df -h
-          sudo ls -lRh /tmp/* || true
-          sudo du -sh /tmp || true
-          sudo du -sh /tmp/* || true
-          sudo find /tmp/ -size +5M | sudo xargs ls -lh
-          du -sh ./* || true
-          find ./ -size +5M   | xargs ls -lh
-          sudo du -sh /var/
-          sudo du -sh /var/lib/docker/
-          du -sh /home/runner/work/
-          set +x
-
-      - name: Upload code coverage
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+      - uses: ./.github/actions/check-diskspace
 
       - name: Generate GraphQL Introspection JSON on Release
         if: github.event_name == 'release' && github.event.action == 'published' && matrix.os == 'linux' && matrix.arch == 'amd64'

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -56,9 +56,6 @@ jobs:
         cd $GITHUB_WORKSPACE
         go install github.com/swaggo/swag/cmd/[email protected]
         go mod download
-        go install github.com/wadey/gocovmerge@latest
-        go get -u github.com/swaggo/swag/cmd/swag
-        go mod download
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

diff --git a/.github/workflows/compare-binary-size.yml b/.github/workflows/compare-binary-size.yml
@@ -36,11 +36,11 @@ jobs:
           [[ $BINSIZE -eq $BINSIZE_MAIN ]] && echo "zot-minimal binary size is not affected by PR" && exit 0
 
           if [[ $BINSIZE -gt $BINSIZE_MAIN ]]; then \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zot minimal binary increased by $PERCENTAGE% comparing with main"; \
             if ((`bc <<< "$PERCENTAGE>=1.0"`)); then exit 1; fi; \
           else \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zot minimal binary decreased by $PERCENTAGE% comparing with main"; \
           fi
       - if: always()
@@ -61,11 +61,11 @@ jobs:
           [[ $BINSIZE -eq $BINSIZE_MAIN ]] && echo "zb binary size is not affected by PR" && exit 0
 
           if [[ $BINSIZE -gt $BINSIZE_MAIN ]]; then \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zb binary increased by $PERCENTAGE% comparing with main"; \
             if ((`bc <<< "$PERCENTAGE>=1.0"`)); then exit 1; fi; \
           else \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zb binary decreased by $PERCENTAGE% comparing with main"; \
           fi
       - if: always()
@@ -86,10 +86,10 @@ jobs:
           [[ $BINSIZE -eq $BINSIZE_MAIN ]] && echo "zli binary size is not affected by PR" && exit 0
 
           if [[ $BINSIZE -gt $BINSIZE_MAIN ]]; then \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE-$BINSIZE_MAIN)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zli binary increased by $PERCENTAGE% comparing with main"; \
             if ((`bc <<< "$PERCENTAGE>=1.0"`)); then exit 1; fi; \
           else \
-            PERCENTAGE=$(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc); \
+            PERCENTAGE=$(printf '%.*f\n' 2 $(echo "scale=2; (($BINSIZE_MAIN-$BINSIZE)*100)/$BINSIZE_MAIN" | bc)); \
             echo "zli binary decreased by $PERCENTAGE% comparing with main"; \
           fi
diff --git a/.github/workflows/golangci-lint.yaml b/.github/workflows/golangci-lint.yaml
@@ -41,3 +41,6 @@ jobs:
 
           # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
           # skip-build-cache: true
+      - name: Run linter
+        run: |
+          make check
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,165 @@
+name: "Running tests"
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches: [main]
+  release:
+    types:
+      - published
+
+permissions: read-all
+
+jobs:
+  test-run-minimal:
+    name: Running zot without extensions tests
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/clean-runner
+      - name: Install go
+        uses: actions/setup-go@v4
+        with:
+          cache: false
+          go-version: 1.20.x
+      - name: Cache go dependencies
+        id: cache-go-dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-mod-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-mod-
+      - name: Install go dependencies
+        if: steps.cache-go-dependencies.outputs.cache-hit != 'true'
+        run: |
+          cd $GITHUB_WORKSPACE
+          go mod download
+      - uses: ./.github/actions/setup-localstack
+      - uses: ./.github/actions/check-diskspace
+      - name: run zot minimal tests
+        run: |
+          cd $GITHUB_WORKSPACE
+          make test-minimal
+        env:
+          S3MOCK_ENDPOINT: localhost:4566
+          DYNAMODBMOCK_ENDPOINT: http://localhost:4566
+          AWS_ACCESS_KEY_ID: fake
+          AWS_SECRET_ACCESS_KEY: fake
+      - name: upload coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-minimal
+          path: coverage-minimal.txt
+      - uses: ./.github/actions/check-diskspace
+      - uses: ./.github/actions/teardown-localstack
+  test-run-extensions:
+    name: run zot with extensions tests
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/clean-runner
+      - uses: actions/setup-go@v4
+        with:
+          cache: false
+          go-version: 1.20.x
+      - name: Cache go dependencies
+        id: cache-go-dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-mod-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-mod-
+      - name: Install go dependencies
+        if: steps.cache-go-dependencies.outputs.cache-hit != 'true'
+        run: |
+          cd $GITHUB_WORKSPACE
+          go mod download
+      - uses: ./.github/actions/setup-localstack
+      - uses: ./.github/actions/check-diskspace
+      - name: run zot extended tests
+        run: |
+          cd $GITHUB_WORKSPACE
+          make test-extended
+        env:
+          S3MOCK_ENDPOINT: localhost:4566
+          DYNAMODBMOCK_ENDPOINT: http://localhost:4566
+          AWS_ACCESS_KEY_ID: fake
+          AWS_SECRET_ACCESS_KEY: fake
+          BUILD_LABELS: imagetrust,lint,metrics,mgmt,profile,scrub,search,sync,ui,userprefs
+      - name: upload coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-extended
+          path: coverage-extended.txt
+      - uses: ./.github/actions/check-diskspace
+      - uses: ./.github/actions/teardown-localstack
+  test-run-devmode:
+    name: Running privileged tests on Linux
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/clean-runner
+      - uses: actions/setup-go@v4
+        with:
+          cache: false
+          go-version: 1.20.x
+      - name: Cache go dependencies
+        id: cache-go-dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-mod-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-mod-
+      - name: Install go dependencies
+        if: steps.cache-go-dependencies.outputs.cache-hit != 'true'
+        run: |
+            cd $GITHUB_WORKSPACE
+            go mod download
+      - uses: ./.github/actions/check-diskspace
+      - name: run zot development-mode unit tests (possibly using failure injection)
+        run: make test-devmode
+      - name: upload coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-devmode
+          path: coverage-dev-minimal.txt coverage-dev-extended.txt
+      - name: upload coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-devmode
+          path: coverage-dev-extended.txt
+      - name: run zot privileged tests
+        run: sudo env "PATH=$PATH" make privileged-test
+      - uses: ./.github/actions/check-diskspace
+  test-coverage:
+    name: generate test coverage
+    runs-on: ubuntu-22.04
+    if: always()
+    needs: [test-run-minimal,test-run-extensions,test-run-devmode]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          cache: false
+          go-version: 1.20.x
+      - name: download all workflow coverage files
+        uses: actions/download-artifact@v3
+      - name: merge code coverage
+        run: |
+          cd $GITHUB_WORKSPACE
+          cp coverage-minimal/* .
+          cp coverage-extended/* .
+          cp coverage-devmode/* .
+          make covhtml
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+