ci: display HTML test report URLs in check run summaries (#252)

.github/workflows/connector-tests.yml

@@ -62,7 +62,7 @@ jobs:
     # Forked PRs are handled by the community_ci.yml workflow
     # If the condition is not met the job will be skipped (it will not fail)
     # runs-on: connector-test-large
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04  # Ubuntu 24 doesn't work as of now
     timeout-minutes: 360 # 6 hours
     strategy:
       fail-fast: false
@@ -93,9 +93,11 @@ jobs:
           - connector: source-pokeapi
             cdk_extra: n/a
 
-    name: "Check: '${{matrix.connector}}' (skip=${{needs.cdk_changes.outputs['src'] == 'false' || needs.cdk_changes.outputs[matrix.cdk_extra] == 'false'}})"
+    name: "${{matrix.connector}} Connector Job (skip=${{needs.cdk_changes.outputs['src'] == 'false' || needs.cdk_changes.outputs[matrix.cdk_extra] == 'false'}})"
     permissions:
       checks: write
+      contents: write  # Required for creating commit statuses
+      pull-requests: read
     steps:
       - name: Abort if extra not changed (${{matrix.cdk_extra}})
         id: no_changes
@@ -123,10 +125,12 @@ jobs:
           repository: airbytehq/airbyte
           ref: master
           path: airbyte
+          token: ${{ github.token }}
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
+      # Initial status will be created by the job itself
       - name: Test Connector
         if: steps.no_changes.outputs.status != 'cancelled'
         timeout-minutes: 90
@@ -151,12 +155,36 @@ jobs:
         if: always() && steps.no_changes.outputs.status != 'cancelled'
         run: |
           # save job output json file as ci step output
-          json_output_file=$(find airbyte/airbyte-ci/connectors/pipelines/pipeline_reports -name 'output.json' -print -quit)
+          mkdir -p airbyte/airbyte-ci/connectors/pipelines/pipeline_reports
+          echo "Debug: Searching for output.json in pipeline reports directory"
+          find airbyte/airbyte-ci/connectors/pipelines/pipeline_reports -type f -ls
+
+          json_output_file=$(find airbyte/airbyte-ci/connectors/pipelines/pipeline_reports -name 'output.json' -print -quit || true)
+          echo "Debug: Found output.json at: ${json_output_file}"
+
+          if [ -z "$json_output_file" ] || [ ! -f "$json_output_file" ]; then
+            echo "No output.json found - test may have failed to generate report"
+            echo "## Job Output for ${{matrix.connector}}" >> $GITHUB_STEP_SUMMARY
+            echo "- Test failed to generate report" >> $GITHUB_STEP_SUMMARY
+            echo "::error::Test failed for connector '${{ matrix.connector }}' - no output report generated"
+            exit 1
+          fi
+
+          echo "Debug: Contents of output.json:"
+          cat ${json_output_file}
+
           job_output=$(cat ${json_output_file})
           success=$(echo ${job_output} | jq -r '.success')
           failed_step=$(echo ${job_output} | jq -r '.failed_steps | select(length > 0) | .[0] // "None"')
           run_duration=$(echo ${job_output} | jq -r '.run_duration')
           html_report_url=$(echo ${job_output} | jq -r '.html_report_url')
+
+          echo "Debug: Extracted values from output.json:"
+          echo "- Success: ${success}"
+          echo "- Failed Step: ${failed_step}"
+          echo "- Run Duration: ${run_duration}"
+          echo "- HTML Report URL: ${html_report_url}"
+
           echo "## Job Output for ${{matrix.connector}}" >> $GITHUB_STEP_SUMMARY
           echo "- [HTML Report](${html_report_url})" >> $GITHUB_STEP_SUMMARY
           echo "- Success: ${success}" >> $GITHUB_STEP_SUMMARY
@@ -170,8 +198,46 @@ jobs:
             exit 1
           fi
           echo "See the execution report for details: ${html_report_url}"
+
+          echo "Debug: Setting outputs for other steps"
           echo "success=${success}" >> $GITHUB_OUTPUT
           echo "html_report_url=${html_report_url}" >> $GITHUB_OUTPUT
+
+          echo "Debug: Current GITHUB_OUTPUT contents:"
+          cat $GITHUB_OUTPUT
+
+      # Update the test report check run with results
+      - name: Create Test Report Status
+        if: always() && steps.no_changes.outputs.status != 'cancelled' && steps.evaluate_output.outcome == 'success'
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT_MAINTENANCE_OCTAVIA }}
+        run: |
+          HEAD_SHA="${{ github.event.pull_request.head.sha || github.sha }}"
+          gh api \
+            --method POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            repos/${{ github.repository }}/statuses/$HEAD_SHA \
+            -f state="${{ steps.evaluate_output.outputs.success == 'true' && 'success' || 'failure' }}" \
+            -f target_url="${{ steps.evaluate_output.outputs.html_report_url }}" \
+            -f description="Click Details to view the test report" \
+            -f context="${{ matrix.connector }} Test Report"
+
+      # Create failure status if report generation failed
+      - name: Create Report Generation Failed Status
+        if: always() && steps.no_changes.outputs.status != 'cancelled' && steps.evaluate_output.outcome != 'success'
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT_MAINTENANCE_OCTAVIA }}
+        run: |
+          HEAD_SHA="${{ github.event.pull_request.head.sha || github.sha }}"
+          gh api \
+            --method POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            repos/${{ github.repository }}/statuses/$HEAD_SHA \
+            -f state="failure" \
+            -f description="Test execution failed to generate a report" \
+            -f context="${{ matrix.connector }} Test Report"
 
       # Upload the job output to the artifacts
       - name: Upload Job Output

.github/workflows/dummy_check_result.yml

@@ -0,0 +1,30 @@
+name: Dummy Commit Status
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/dummy_check_result.yml'
+
+jobs:
+  failure_status:
+    name: "Dummy Status (fail)"
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write  # Required for creating commit statuses
+    steps:
+      - name: Create Failure Status
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT_MAINTENANCE_OCTAVIA }}
+        run: |
+          HEAD_SHA="${{ github.event.pull_request.head.sha || github.sha }}"
+          gh api \
+            --method POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            repos/${{ github.repository }}/statuses/$HEAD_SHA \
+            -f state="failure" \
+            -f target_url="https://www.google.com/search?q=failed" \
+            -f description="Click Details to view the test report" \
+            -f context="Dummy Connector Test Report"

airbyte_cdk/logger.py

@@ -18,6 +18,7 @@
 )
 from airbyte_cdk.utils.airbyte_secrets_utils import filter_secrets
 
+
 LOGGING_CONFIG = {
     "version": 1,
     "disable_existing_loggers": False,