From 2e67df55f38c3e456d0dd6ef2f57978c02504832 Mon Sep 17 00:00:00 2001
From: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
Date: Tue, 1 Oct 2024 19:30:24 +0800
Subject: [PATCH] workflows/scheduled: improve coverage of scheduled online
 checks

We do this by testing our formulae more systematically. We do this by
indexing all formulae so that:
- formulae 1 to 50 are tested on the first day of the year
- formulae 51 to 100 are tested on the second day of the year
- formulae 101 to 150 are tested on the third day of the year
- and so on.

This works fine as long as we have fewer than 365 * TEST_COUNT formulae
(currently 18250).

While we're here:
- scope token permissions more tightly
- remove the `os` key from the matrix, since there is only one entry
- remove unused references to `macos-latest`
- always run the formula source test as long as the upstream repository
  has not been archived
- remove the unnecessary `${{  }}` in `if:` properties
---
 .github/workflows/scheduled.yml | 41 +++++++++++++++++++--------------
 1 file changed, 24 insertions(+), 17 deletions(-)

diff --git a/.github/workflows/scheduled.yml b/.github/workflows/scheduled.yml
index cca5902e74159..67185f5884658 100644
--- a/.github/workflows/scheduled.yml
+++ b/.github/workflows/scheduled.yml
@@ -18,8 +18,7 @@ concurrency:
   group: scheduled
   cancel-in-progress: true
 
-permissions:
-  issues: write
+permissions: {}
 
 jobs:
   create_matrix:
@@ -31,7 +30,6 @@ jobs:
       json: ${{ steps.matrix.outputs.json }}
     env:
       TEST_COUNT: 50
-      TAP: homebrew/core
     steps:
       - name: Set up Homebrew
         id: set-up-homebrew
@@ -43,22 +41,34 @@ jobs:
 
       - name: Generate matrix
         id: matrix
+        working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}
         run: |
-          formula="$(find "$(brew --repo "${TAP}")/Formula" -type f | shuf -n "${TEST_COUNT}" | xargs -I{} basename {} .rb)"
-          # shellcheck disable=SC2086
+          # Index all formulae so that we test:
+          #   - formulae 1 to 50 on the first day of the year
+          #   - formulae 51 to 100 on the second day of the year
+          #   - formulae 101 to 150 on the third day of the year
+          #   - ...
+          # This works fine as long as we have fewer than 365 * TEST_COUNT formulae.
+          mapfile -t formulae < <(find Formula -type f -exec basename {} .rb ';' | sort)
+          day="$(date +%j)"
+          formulae_count="${#formulae[@]}"
+          start_index="$(( (day - 1) * TEST_COUNT % formulae_count ))"
+
           json="$(
-            brew info --json=v2 $formula |
-            jq --compact-output '[.formulae[] | select(.deprecated == false and .disabled == false) | .name]'
+            brew info --json=v2 "${formulae[@]:${start_index}:${TEST_COUNT}}" |
+              jq --compact-output '[.formulae[] | select(.deprecated or .disabled | not) | .name]'
           )"
           echo "json=${json}" >> "$GITHUB_OUTPUT"
 
   audit_online:
     if: startsWith( github.repository, 'Homebrew/' )
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     container:
       image: ghcr.io/homebrew/ubuntu22.04:master
+    permissions:
+      issues: write
     needs: create_matrix
-    name: "Online check (${{ matrix.os }}): ${{ matrix.formula }}"
+    name: "Online check: ${{ matrix.formula }}"
     env:
       HOMEBREW_GITHUB_API_TOKEN: "${{ github.token }}"
       GH_TOKEN: "${{ github.token }}"
@@ -69,7 +79,6 @@ jobs:
       fail-fast: false
       matrix:
         formula: ${{ fromJson(needs.create_matrix.outputs.json) }}
-        os: [ubuntu-22.04]
     steps:
       - name: Set up Homebrew
         id: set-up-homebrew
@@ -81,11 +90,10 @@ jobs:
 
       - name: Check formula source is not archived.
         id: archived
-        if: matrix.os != 'macos-latest'
         run: brew audit --online --skip-style --only github_repository_archived,gitlab_repository_archived "$FORMULA"
 
       - name: Report online issues
-        if: ${{ failure() && steps.archived.conclusion == 'failure' }}
+        if: failure() && steps.archived.conclusion == 'failure'
         run: |
           gh issue comment "$REPORTING_ISSUE" \
                            --body "$FORMULA should be archived. Check $RUN_URL" \
@@ -93,11 +101,10 @@ jobs:
 
       - name: Check formula for unavailable homepage.
         id: homepage
-        if: matrix.os != 'macos-latest'
         run: brew audit --online --skip-style --only homepage "$FORMULA"
 
       - name: Report homepage issues
-        if: ${{ failure() && steps.homepage.conclusion == 'failure' }}
+        if: failure() && steps.homepage.conclusion == 'failure'
         run:  |
           gh issue comment "$REPORTING_ISSUE" \
                            --body "$FORMULA has homepage issues. Check $RUN_URL" \
@@ -105,11 +112,11 @@ jobs:
 
       - name: Check formula for missing sources.
         id: fetch
-        if: matrix.os != 'macos-latest'
-        run: brew fetch -s "$FORMULA"
+        if: always() && steps.archived.conclusion != 'failure'
+        run: brew fetch --build-from-source "$FORMULA"
 
       - name: Report fetch issues
-        if: ${{ failure() && steps.fetch.conclusion == 'failure' }}
+        if: failure() && steps.fetch.conclusion == 'failure'
         run:  |
           gh issue comment "$REPORTING_ISSUE" \
                            --body "$FORMULA source has problems. Check $RUN_URL" \