From 2cb9f475cd7a7847261bbb0b8d562cb26eaeb16c Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand@redhat.com>
Date: Thu, 21 Nov 2024 12:01:33 +0100
Subject: [PATCH] github: Skip clang-analyze when reference generation fails.

By assuming that OVS maintainers never push changes that breaks
compilation in GHA (which seems to be the case so far), it seems natural
to assume that generating the reference for clang analyzer should always
work.

If generating this reference fails, it means that this failure is likely
due to a change external to OVS code, but the patch being tested is not
at fault for this even though at the moment a failure will be reported
in patchwork.

Split the clang analyzer check in two jobs:
- a clang-cache job, responsible for computing a cache key of the
  reference code and compiling a reference build,
- a clang-analyzer job, which depends on the former job, responsible for
  compiling the current patch and comparing the result against the
  reference,

The cache generation won't be reported as a failure at the OVS build step
(using continue-on-error:). If such a failure happens, the cache-analyzer
will be skipped.

Fixes: d662eee09724 ("ci: Add clang-analyze to GitHub actions.")
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 .github/workflows/build-and-test.yml | 66 +++++++++++++++++++++++++---
 1 file changed, 60 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
index 6501f23d263..bfd11f39b18 100644
--- a/.github/workflows/build-and-test.yml
+++ b/.github/workflows/build-and-test.yml
@@ -336,7 +336,7 @@ jobs:
         name: logs-linux-${{ join(matrix.*, '-') }}
         path: logs.tgz
 
-  build-clang-analyze:
+  build-clang-cache:
     needs: build-dpdk
     env:
       dependencies: |
@@ -345,7 +345,10 @@ jobs:
       CC:   clang
       DPDK: dpdk
       CLANG_ANALYZE: true
-    name: clang-analyze
+    name: clang-cache
+    outputs:
+      key: ${{ steps.cache_key.outputs.key }}
+      outcome: ${{ steps.build_base.outcome }}
     runs-on: ubuntu-24.04
     timeout-minutes: 30
 
@@ -416,35 +419,86 @@ jobs:
         key:  ${{ steps.cache_key.outputs.key }}
 
     - name: set up python
+      if: steps.clang_cache.outputs.cache-hit != 'true'
       uses: actions/setup-python@v5
       with:
         python-version: ${{ env.python_default }}
 
     - name: get cached dpdk-dir
+      if: steps.clang_cache.outputs.cache-hit != 'true'
       uses: actions/cache/restore@v4
       with:
         path: dpdk-dir
         key:  ${{ needs.build-dpdk.outputs.dpdk_key }}
 
     - name: update APT cache
+      if: steps.clang_cache.outputs.cache-hit != 'true'
       run:  sudo apt update || true
 
     - name: install common dependencies
+      if: steps.clang_cache.outputs.cache-hit != 'true'
       run:  sudo apt install -y ${{ env.dependencies }}
 
     - name: prepare
+      if: steps.clang_cache.outputs.cache-hit != 'true'
       run:  ./.ci/linux-prepare.sh
 
     - name: build base reference
+      id: build_base
       if: steps.clang_cache.outputs.cache-hit != 'true'
+      continue-on-error: true
       run:  ./.ci/linux-build.sh
 
-    - name: save cache
-      uses: actions/cache/save@v4
-      if: steps.clang_cache.outputs.cache-hit != 'true'
+  build-clang-analyze:
+    needs: [build-dpdk, build-clang-cache]
+    if: >
+        needs.build-clang-cache.outputs.outcome == 'success' ||
+        needs.build-clang-cache.outputs.outcome == 'skipped'
+    env:
+      dependencies: |
+        automake bc clang-tools libnuma-dev libunbound-dev libunwind-dev \
+        libssl-dev libtool libxdp-dev llvm-dev
+      CC:   clang
+      DPDK: dpdk
+      CLANG_ANALYZE: true
+    name: clang-analyze
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+
+    - name: update PATH
+      run: |
+        echo "$HOME/bin"        >> $GITHUB_PATH
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - name: check for analyzer result cache
+      uses: actions/cache/restore@v4
       with:
         path: base-clang-analyzer-results
-        key:  ${{ steps.cache_key.outputs.key }}
+        key:  ${{ needs.build-clang-cache.outputs.key }}
+
+    - name: set up python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.python_default }}
+
+    - name: get cached dpdk-dir
+      uses: actions/cache/restore@v4
+      with:
+        path: dpdk-dir
+        key:  ${{ needs.build-dpdk.outputs.dpdk_key }}
+
+    - name: update APT cache
+      run:  sudo apt update || true
+
+    - name: install common dependencies
+      run:  sudo apt install -y ${{ env.dependencies }}
+
+    - name: prepare
+      run:  ./.ci/linux-prepare.sh
 
     - name: build
       run:  ./.ci/linux-build.sh