Experimental: reusable workflow to enable debug mode

actions · Apr 5, 2023 · 6234871 · 6234871
1 parent 4c29743
commit 6234871
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 135 deletions.
diff --git a/.github/workflows/integration-debug.yml b/.github/workflows/integration-debug.yml
@@ -0,0 +1,97 @@
+# This workflow is called from integration.yml as a [reusable] worflow.; this
+# technique makes it possible to set the `ACTIONS_STEP_DEBUG` secret for just
+# this test.
+#
+# [reusable]: https://docs.github.com/en/actions/using-workflows/reusing-workflows
+
+name: Integration (debug parameter test)
+
+on:
+  workflow_call:
+    secrets:
+      ACTIONS_STEP_DEBUG:
+        description: 'Set to "true" to enable debug logging'
+        required: true
+
+jobs:
+  test-debug:
+    name: "Integration test: debug option (runner debug: ${{ (runner.debug == '1' && 'ON') || 'OFF' }})"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
+          restore-keys: ${{runner.os}}-npm-
+      - run: npm ci
+      - id: debug-default
+        name: Default debug not set
+        uses: ./
+        with:
+          script: |
+            const log = github.log
+            return {
+              runnerDebugMode: core.isDebug(),
+              debug: log.debug === console.debug,
+              info: log.info === console.info
+            }
+      - id: debug-true
+        name: Debug set to true
+        uses: ./
+        with:
+          debug: true
+          script: |
+            const log = github.log
+            return {
+              runnerDebugMode: core.isDebug(),
+              debug: log.debug === console.debug,
+              info: log.info === console.info
+            }
+      - id: debug-false
+        name: Debug set to false
+        uses: ./
+        with:
+          debug: false
+          script: |
+            const log = github.log
+            return {
+              runnerDebugMode: core.isDebug(),
+              debug: log.debug === console.debug,
+              info: log.info === console.info
+            }
+      - id: evaluate-tests
+        name: Evaluate test outputs
+        env:
+          RDMODE: ${{ (runner.debug == '1' && 'true') || 'false' }}
+        run: |
+          # tests table, pipe separated: label | output | expected
+          # leading and trailing spaces on any field are trimmed
+          tests=$(cat << 'TESTS'
+            Validating debug default |\
+              ${{ steps.debug-default.outputs.result }} |\
+              {"runnerDebugMode":${{ env.RDMODE }},"debug":${{ env.RDMODE }},"info":${{ env.RDMODE }}}
+            Validating debug set to true |\
+              ${{ steps.debug-true.outputs.result }} |\
+              {"runnerDebugMode":${{ env.RDMODE }},"debug":true,"info":true}
+            Validating debug set to false |\
+              ${{ steps.debug-false.outputs.result }} |\
+              {"runnerDebugMode":${{ env.RDMODE }},"debug":false,"info":false}
+          TESTS
+          )
+
+          strim() { shopt -s extglob; lt="${1##+( )}"; echo "${lt%%+( )}"; }
+          while IFS='|' read label output expected; do
+            label="$(strim "$label")"; output="$(strim "$output")"; expected="$(strim "$expected")"
+            echo -n "- $label:"
+            if [[ "$output" != "$expected" ]]; then
+              echo $'\n::error::\u274C' "Expected '$expected', got '$output'"
+              exit 1
+            fi
+            echo $' \u2705'
+          done <<< "$tests"
+
+          echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY
+
+
+
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -129,138 +129,9 @@ jobs:
           echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY
 
   test-user-agent:
-    name: 'Integration test: user-agent option'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
-          restore-keys: ${{runner.os}}-npm-
-      - run: npm ci
-      - id: user-agent-default
-        name: Default user-agent not set
-        uses: ./
-        with:
-          script: |
-            const endpoint = github.request.endpoint
-            return endpoint({}).headers['user-agent']
-          result-encoding: string
-      - id: user-agent-set
-        name: User-agent set
-        uses: ./
-        with:
-          user-agent: foobar
-          script: |
-            const endpoint = github.request.endpoint
-            return endpoint({}).headers['user-agent']
-          result-encoding: string
-      - id: user-agent-empty
-        name: User-agent set to an empty string
-        uses: ./
-        with:
-          user-agent: ''
-          script: |
-            const endpoint = github.request.endpoint
-            return endpoint({}).headers['user-agent']
-          result-encoding: string
-      - run: |
-          echo "- Validating user-agent default"
-          expected="actions/github-script octokit-core.js/"
-          if [[ "${{steps.user-agent-default.outputs.result}}" != "$expected"* ]]; then
-            echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-default.outputs.result}}"
-            exit 1
-          fi
-          echo "- Validating user-agent set to a value"
-          expected="foobar octokit-core.js/"
-          if [[ "${{steps.user-agent-set.outputs.result}}" != "$expected"* ]]; then
-            echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-set.outputs.result}}"
-            exit 1
-          fi
-          echo "- Validating user-agent set to an empty string"
-          expected="octokit-core.js/"
-          if [[ "${{steps.user-agent-empty.outputs.result}}" != "$expected"* ]]; then
-            echo $'::error::\u274C' "Expected user-agent to start with '$expected', got ${{steps.user-agent-empty.outputs.result}}"
-            exit 1
-          fi
-          echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY
-
-  test-debug:
-    name: "Integration test: debug option"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
-          restore-keys: ${{runner.os}}-npm-
-      - run: npm ci
-      - id: debug-default
-        name: Default debug not set
-        uses: ./
-        with:
-          script: |
-            const log = github.log
-            return {
-              runnerDebugMode: core.isDebug(),
-              debug: log.debug === console.debug,
-              info: log.info === console.info
-            }
-      - id: debug-true
-        name: Debug set to true
-        uses: ./
-        with:
-          debug: true
-          script: |
-            const log = github.log
-            return {
-              runnerDebugMode: core.isDebug(),
-              debug: log.debug === console.debug,
-              info: log.info === console.info
-            }
-      - id: debug-false
-        name: Debug set to false
-        uses: ./
-        with:
-          debug: false
-          script: |
-            const log = github.log
-            return {
-              runnerDebugMode: core.isDebug(),
-              debug: log.debug === console.debug,
-              info: log.info === console.info
-            }
-      - id: evaluate-tests
-        name: Evaluate test outputs
-        env:
-          RDMODE: ${{ (runner.debug == '1' && 'true') || 'false' }}
-        run: |
-          # tests table, pipe separated: label | output | expected
-          # leading and trailing spaces on any field are trimmed
-          tests=$(cat << 'TESTS'
-            Validating debug default |\
-              ${{ steps.debug-default.outputs.result }} |\
-              {"runnerDebugMode":${{ env.RDMODE }},"debug":${{ env.RDMODE }},"info":${{ env.RDMODE }}}
-            Validating debug set to true |\
-              ${{ steps.debug-true.outputs.result }} |\
-              {"runnerDebugMode":${{ env.RDMODE }},"debug":true,"info":true}
-            Validating debug set to false |\
-              ${{ steps.debug-false.outputs.result }} |\
-              {"runnerDebugMode":${{ env.RDMODE }},"debug":false,"info":false}
-          TESTS
-          )
-
-          strim() { shopt -s extglob; lt="${1##+( )}"; echo "${lt%%+( )}"; }
-          while IFS='|' read label output expected; do
-            label="$(strim "$label")"; output="$(strim "$output")"; expected="$(strim "$expected")"
-            echo -n "- $label:"
-            if [[ "$output" != "$expected" ]]; then
-              echo $'\n::error::\u274C' "Expected '$expected', got '$output'"
-              exit 1
-            fi
-            echo $' \u2705'
-          done <<< "$tests"
-
-          echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY
+    strategy:
+      matrix:
+        runner_debug: ['', 'true']
+    uses: ./.github/workflow/integration-debug.yml
+    secrets:
+      ACTIONS_STEP_DEBUG: ${{ matrix.runner_debug }}