Merge pull request #512 from intersystems/master-ci-fix

isc-tleavitt · web-flow · commit 82617d3fa2cf · 2024-07-02T07:48:46.000-04:00
Master ci fix
diff --git a/.github/scripts/batcher.py b/.github/scripts/batcher.py
@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+# This script groups elements in a JSON array into given number of batches
+# Usage example: cat data.json | python .github/scripts/batcher.py 10
+# The JSON array is expected to be passed from stdin
+# The output will be an array of comma-separated-values to stdout
+
+import sys
+import json
+
+def batch_array(arr, n):
+    if n <= 0:
+        raise ValueError("n must be a positive integer")
+
+    batch_size = len(arr) // n
+    remainder = len(arr) % n
+    
+    batched_array = []
+    start_index = 0
+    
+    for i in range(n):
+        end_index = start_index + batch_size + (1 if i < remainder else 0)
+        batched_array.append(arr[start_index:end_index])
+        start_index = end_index
+        
+    return batched_array
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print(f"Usage: cat data.json | python3 {sys.argv[0]} <batch_count>", file=sys.stderr)
+        sys.exit(1)
+
+    n_batches = int(sys.argv[1])
+    arr = json.load(sys.stdin)
+    output = batch_array(arr, n_batches)
+    json.dump([','.join(batch) for batch in output], sys.stdout, indent=2)
diff --git a/.github/scripts/summarize_logs.py b/.github/scripts/summarize_logs.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+# Summarize logs in a directory
+# Usage: summarize_logs.py <log_dir>
+
+
+import sys
+import re
+import glob
+
+
+if len(sys.argv) != 2:
+    print(f"Usage: {sys.argv[0]} <log_dir>", file=sys.stderr)
+    sys.exit(1)
+
+p_pat = re.compile(r"Test for package (\S+) passed")
+f_pat = re.compile(r"Test for package (\S+) failed")
+
+passed, failed = set(), set()
+
+for fn in glob.glob(f"{sys.argv[1]}/*.txt"):
+    with open(fn) as f:
+        for line in f.readlines():
+            m = p_pat.search(line)
+            if m:
+                passed.add(m.group(1))
+            m = f_pat.search(line)
+            if m:
+                failed.add(m.group(1))
+
+passed.remove("$package")
+failed.remove("$package")
+
+print(f"A total of {len(passed)} packages passed:", sorted(passed))
+print(f"A total of {len(failed)} packages failed:", sorted(failed))
diff --git a/.github/workflows/packages-summary.yml b/.github/workflows/packages-summary.yml
@@ -0,0 +1,34 @@
+name: Summarize package test results
+on:
+  workflow_call:
+    inputs:
+      runId:
+        type: number
+        required: true
+        description: "Id of the workflow run to summarize"
+  workflow_dispatch:
+    inputs:
+      runId:
+        type: number
+        required: true
+        description: "Id of the workflow run to summarize"
+
+jobs:
+  summarize:
+    runs-on: ubuntu-latest
+    env:
+      BASE_URL: https://api.github.com/repos/intersystems/ipm/actions/runs
+    steps:
+      - name: Donwload log zip
+        run: |
+          curl -L -o logs.zip "${{ env.BASE_URL }}/${{ inputs.runId }}/logs" -H 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}'
+      - name: Unzip logs
+        run: |
+          unzip logs.zip -d logs/
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Summarize logs
+        run: |
+          # Could also use awk script, but python is easier to read and debug
+          python3 .github/scripts/summarize_logs.py logs/
+
diff --git a/.github/workflows/packages.yml b/.github/workflows/packages.yml
@@ -2,11 +2,16 @@ name: Test major packages
 on:
   workflow_dispatch:
     inputs:
+      nJobs:
+        description: "Number of jobs to run in parallel"
+        required: true
+        type: number
+        default: 8
       minVersionCount:
         description: "Minimum number of versions a package must have to be tested"
         required: true
         type: number
-        default: 10
+        default: 1
 
 jobs:
   matrix-setup:
@@ -17,9 +22,11 @@ jobs:
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
       - id: set-matrix
         run: |
-          matrix=$(curl -L "$PM_URL" | jq -cr "$JQ_SCRIPT")
+          matrix=$(curl -L "$PM_URL" | jq -cr "$JQ_SCRIPT" | python3 .github/scripts/batcher.py ${{ inputs.nJobs }} | jq -cr .)
           echo "matrix=$matrix" >> $GITHUB_OUTPUT
 
   prepare-image:
@@ -43,14 +50,14 @@ jobs:
       - name: Test Image
         run: |
           docker load -i /tmp/zpmimage.tar
-          docker image ls
           CONTAINER=$(docker run -d --rm -v `pwd`:/home/irisowner/zpm/ zpm)
           docker exec $CONTAINER /usr/irissys/dev/Cloud/ICM/waitISC.sh
           docker exec -i $CONTAINER iris session IRIS << EOF
               zpm "list":1
               zn "%SYS"
               zpm "test zpm -v -only":1:1
           EOF
+          docker container stop $CONTAINER
       - name: Upload Image
         uses: actions/upload-artifact@v2
         with:
@@ -65,7 +72,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        package: ${{ fromJson(needs.matrix-setup.outputs.matrix) }}
+        packages: ${{ fromJson(needs.matrix-setup.outputs.matrix) }}
     steps:
       - uses: actions/checkout@master
       - name: Set up Docker Buildx
@@ -78,33 +85,63 @@ jobs:
       - name: Load Image
         run: |
           docker load -i /tmp/zpmimage.tar
-          docker image ls
-      - name: Container Setup
-        id: setup-zpm
-        timeout-minutes: 15
-        run: |
-          # Don't specify the container name because `act` will run multiple jobs in parallel and cause name conflicts
-          CONTAINER=$(docker run -d --rm -v `pwd`:/home/irisowner/zpm/ zpm)
-          echo "CONTAINER=$CONTAINER" >> $GITHUB_OUTPUT
-          docker exec $CONTAINER /usr/irissys/dev/Cloud/ICM/waitISC.sh
-          docker exec -i $CONTAINER iris session IRIS << EOF
-              zpm "repo -r -name registry -url https://pm.community.intersystems.com/":1
-              halt
-          EOF
-      - name: Test ${{ matrix.package }}
-        timeout-minutes: 15
+      - name: Run tests sequentially
         env:
-          CONTAINER: ${{ steps.setup-zpm.outputs.CONTAINER }}
           test-flags: >-
             -verbose -DUnitTest.ManagerClass=%UnitTest.Manager -DUnitTest.JUnitOutput=/test-reports/junit.xml
             -DUnitTest.FailuresAreFatal=1 -DUnitTest.Manager=%UnitTest.Manager
         run: |
-          docker exec -i ${{ env.CONTAINER }} iris session IRIS << EOF
-              zpm "install ${{ matrix.package }}":1
-              zpm "${{ matrix.package }} test -only ${{ env.test-flags }}":1:1
+          # Don't specify the container name because `act` will run multiple jobs in parallel and cause name conflicts
+          packages=${{ matrix.packages }}
+          IFS=','
+          RED='\033[0;31m'
+          GREEN='\033[0;32m'
+          NC='\033[0m'
+
+          # The EOF of the following heredocs are intentially unindented
+          # because <<-EOF doesn't like spaces while yaml only allows spaces
+          # A potential solution is to use a script file instead of a block
+          for package in $packages; do
+            echo "::group::Set up container for package $package"
+            CONTAINER=$(docker run -d --rm -v `pwd`:/home/irisowner/zpm/ zpm)
+            docker exec $CONTAINER /usr/irissys/dev/Cloud/ICM/waitISC.sh
+            docker exec -i $CONTAINER iris session IRIS <<- EOF
+              zpm "config set analytics 0":1
+              zpm "repo -r -name registry -url https://pm.community.intersystems.com/":1
+              halt
           EOF
-      - name: Stop Container
-        run: |
-          # To ensure a clean state after using `act` locally
-          docker stop -t 5 ${{ steps.setup-zpm.outputs.CONTAINER }}
-          docker ps
+            echo "::endgroup::"
+          
+            echo "::group::Test package $package"
+            set +e
+            docker exec -i $CONTAINER iris session IRIS <<- EOF
+                  zpm "install $package":1
+                zpm "$package test -only ${{ env.test-flags }}":1:1
+          EOF
+
+            if [ $? -ne 0 ]; then
+              # ATTENTION: Don't change the format of the following echo without updating the regex in the summarize.py script
+              echo -e "\n${RED}Test for package $package failed${NC}" >&2
+            else
+              # ATTENTION: Don't change the format of the following echo without updating the regex in the summarize.py script
+              echo -e "\n${GREEN}Test for package $package passed${NC}"
+            fi
+            echo "::endgroup::"
+
+            echo "::group::Clean up container for $package"
+            # To ensure a clean state after using `act` locally
+            docker stop -t 5 $CONTAINER
+            echo "::endgroup::"
+          done
+
+          IFS=' '
+
+  summarize:
+    needs:
+      - run-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Call package-summary workflow
+        uses: ./.github/workflows/packages-summary.yml
+        with:
+          runId: ${{ github.run_id }}
