ci: use flakybot with matrix workflows (#3112)

* ci: use flakybot with matrix workflows

* fix typo

* update common test file

* test

* add missing npm tests

* add matrix support

* update example text

* address code review feedback

* test workflow

* test schedule

* fix upload logic for testing

* test template

* revert test to functions-slack

* fix license header

* add newline

* fix formatting

Author: kweinmeister

.github/workflows/ci.yaml

@@ -1,3 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 on:
   push:
     branches:
@@ -26,4 +40,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - run: ./.github/workflows/region-tags-tests.sh
+      - run: ./.github/workflows/utils/region-tags-tests.sh

.github/workflows/functions-concepts.yaml

@@ -1,79 +1,57 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: functions-concepts
 on:
   push:
     branches:
     - main
     paths:
     - 'functions/concepts/**'
+    - '.github/workflows/functions-concepts.yaml'
   pull_request:
     paths:
     - 'functions/concepts/**'
+    - '.github/workflows/functions-concepts.yaml'
   pull_request_target:
     types: [labeled]
     paths:
     - 'functions/concepts/**'
+    - '.github/workflows/functions-concepts.yaml'
   schedule:
   - cron:  '0 0 * * 0'
 jobs:
   test:
+    if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run'
     strategy:
       matrix:
-        # Each package in this list will be tested independently.
-        # New packages must be manually added to this list.
-        package:
+        path:
           - 'functions/concepts/afterResponse'
           - 'functions/concepts/afterTimeout'
           - 'functions/concepts/backgroundTermination'
           - 'functions/concepts/filesystem'
           - 'functions/concepts/httpTermination'
           - 'functions/concepts/requests'
-          - 'functions/concepts/stateless'
-    if: ${{ github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 60
-    permissions:
-      contents: 'write'
-      pull-requests: 'write'
-      id-token: 'write'
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: ${{github.event.pull_request.head.ref}}
-        repository: ${{github.event.pull_request.head.repo.full_name}}
-    - uses: google-github-actions/[email protected]
-      with:
-        workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
-        service_account: '[email protected]'
-        create_credentials_file: 'true'
-        access_token_lifetime: 600s
-    - uses: actions/setup-node@v3
-      with:
-        node-version: 14
-    - run: npm install
-      working-directory: ${{ matrix.package }}
-    - run: npm test -- --reporter xunit --reporter-option output=sponge_log.xml --reporter-option suiteName="${{ matrix.package }}"
-      working-directory: ${{ matrix.package }}
-      env:
-        MOCHA_REPORTER: xunit
-    - if: ${{ github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' }}
-      uses: actions/github-script@v6
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          try {
-            await github.rest.issues.removeLabel({
-              name: 'actions:force-run',
-              owner: 'GoogleCloudPlatform',
-              repo: 'nodejs-docs-samples',
-              issue_number: context.payload.pull_request.number
-            });
-          } catch (e) {
-            if (!e.message.includes('Label does not exist')) {
-              throw e;
-            }
-          }
-    - if: ${{ github.event_name == 'schedule' && always() }}
-      run: |
-        curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L
-        chmod +x ./flakybot
-        ./flakybot --repo GoogleCloudPlatform/nodejs-docs-samples --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}
+          - 'functions/concepts/stateless'        
+    uses: ./.github/workflows/test.yaml
+    with:
+      name: 'functions-concepts'
+      path: '${{ matrix.path }}'
+  remove_label:
+    if: github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' && always()
+    uses: ./.github/workflows/remove-label.yaml
+  flakybot:
+    if: github.event_name == 'schedule' && always()
+    uses: ./.github/workflows/flakybot.yaml
+    needs: [test]

.github/workflows/functions-helloworld.yaml

@@ -1,3 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: functions-helloworld
 on:
   push:
@@ -19,63 +33,23 @@ on:
   - cron:  '0 0 * * 0'
 jobs:
   test:
+    if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run'
     strategy:
       matrix:
-        # Each package in this list will be tested independently.
-        # New packages must be manually added to this list.
-        package:
+        path:
           - 'functions/helloworld/helloError'
           - 'functions/helloworld/helloGCS'
           - 'functions/helloworld/helloPubSub'
           - 'functions/helloworld/helloworldGet'
           - 'functions/helloworld/helloworldHttp'
-    if: ${{ github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 60
-    permissions:
-      contents: 'write'
-      pull-requests: 'write'
-      id-token: 'write'
-    steps:
-    - uses: actions/[email protected]
-      with:
-        ref: ${{github.event.pull_request.head.sha}}
-    - uses: 'google-github-actions/[email protected]'
-      with:
-        workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
-        service_account: '[email protected]'
-        create_credentials_file: 'true'
-        access_token_lifetime: 600s
-    - uses: actions/[email protected]
-      with:
-        node-version: 16
-    - run: npm install
-      working-directory: ${{ matrix.package }}
-    - run: npm test -- --reporter xunit --reporter-option output=sponge_log.xml --reporter-option suiteName="${{ matrix.package }}"
-      working-directory: ${{ matrix.package }}
-      env:
-        MOCHA_REPORTER_SUITENAME: functions_helloworld
-        MOCHA_REPORTER_OUTPUT: functions_helloworld_sponge_log.xml
-        MOCHA_REPORTER: xunit
-    - if: ${{ github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' }}
-      uses: actions/github-script@v6
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          try {
-            await github.rest.issues.removeLabel({
-              name: 'actions:force-run',
-              owner: 'GoogleCloudPlatform',
-              repo: 'nodejs-docs-samples',
-              issue_number: context.payload.pull_request.number
-            });
-          } catch (e) {
-            if (!e.message.includes('Label does not exist')) {
-              throw e;
-            }
-          }
-    - if: ${{ github.event_name == 'schedule' && always() }}
-      run: |
-        curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L
-        chmod +x ./flakybot
-        ./flakybot --repo GoogleCloudPlatform/nodejs-docs-samples --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}
+    uses: ./.github/workflows/test.yaml
+    with:
+      name: 'functions-helloworld'
+      path: '${{ matrix.path }}'
+  remove_label:
+    if: github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' && always()
+    uses: ./.github/workflows/remove-label.yaml
+  flakybot:
+    if: github.event_name == 'schedule' && always()
+    uses: ./.github/workflows/flakybot.yaml
+    needs: [test]

.github/workflows/functions-http.yaml

@@ -1,3 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: functions-http
 on:
   push:
@@ -19,62 +33,22 @@ on:
   - cron:  '0 0 * * 0'
 jobs:
   test:
+    if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run'
     strategy:
       matrix:
-        # Each package in this list will be tested independently.
-        # New packages must be manually added to this list.
-        package:
+        path:
           - 'functions/http/corsEnabledFunction'
           - 'functions/http/corsEnabledFunctionAuth'
           - 'functions/http/httpContent'
           - 'functions/http/httpMethods'
-    if: ${{ github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 60
-    permissions:
-      contents: 'write'
-      pull-requests: 'write'
-      id-token: 'write'
-    steps:
-    - uses: actions/[email protected]
-      with:
-        ref: ${{github.event.pull_request.head.sha}}
-    - uses: 'google-github-actions/[email protected]'
-      with:
-        workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
-        service_account: '[email protected]'
-        create_credentials_file: 'true'
-        access_token_lifetime: 600s
-    - uses: actions/[email protected]
-      with:
-        node-version: 16
-    - run: npm install
-      working-directory: ${{ matrix.package }}
-    - run: npm test -- --reporter xunit --reporter-option output=sponge_log.xml --reporter-option suiteName="${{ matrix.package }}"
-      working-directory: ${{ matrix.package }}
-      env:
-        MOCHA_REPORTER_SUITENAME: functions_http
-        MOCHA_REPORTER_OUTPUT: functions_http_sponge_log.xml
-        MOCHA_REPORTER: xunit
-    - if: ${{ github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' }}
-      uses: actions/github-script@v6
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          try {
-            await github.rest.issues.removeLabel({
-              name: 'actions:force-run',
-              owner: 'GoogleCloudPlatform',
-              repo: 'nodejs-docs-samples',
-              issue_number: context.payload.pull_request.number
-            });
-          } catch (e) {
-            if (!e.message.includes('Label does not exist')) {
-              throw e;
-            }
-          }
-    - if: ${{ github.event_name == 'schedule' && always() }}
-      run: |
-        curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L
-        chmod +x ./flakybot
-        ./flakybot --repo GoogleCloudPlatform/nodejs-docs-samples --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}
+    uses: ./.github/workflows/test.yaml
+    with:
+      name: 'functions-http'
+      path: '${{ matrix.path }}'
+  remove_label:
+    if: github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' && always()
+    uses: ./.github/workflows/remove-label.yaml
+  flakybot:
+    if: github.event_name == 'schedule' && always()
+    uses: ./.github/workflows/flakybot.yaml
+    needs: [test]