Merge pull request #8 from sodadata/CLOUD-4354-soda-github-actions-fails-when

[CLOUD-4354] Implement exit codes correctly

Author: dirkgroenen

.github/workflows/tests.yaml

@@ -23,14 +23,23 @@ jobs:
             data_source: reporting_api__marts
             checks: ./testing/checks_p*.yaml
             expected_exit_code: 0
-          - name: failing scan on check
+          - name: scan with check warnings
             data_source: reporting_api__marts
-            checks: ./testing/checks_fail_on_check.yaml
-            expected_exit_code: 2
-          - name: failing scan on error
-            data_source: MISSING_DS
-            checks: ./testing/checks_pass.yaml
+            checks: ./testing/checks_warn.yaml
             expected_exit_code: 1
+          - name: scan with check failures
+            data_source: reporting_api__marts
+            checks: ./testing/checks_fail.yaml
+            expected_exit_code: 2
+          - name: scan with errors (wrong checks)
+            data_source: reporting_api__marts
+            checks: ./testing/checks_error.yaml
+            expected_exit_code: 3
+          # Disabled until https://github.com/sodadata/soda-library/pull/63 is merged and released
+          # - name: scan with errors (wrong data source)
+          #   data_source: MISSING_DS
+          #   checks: ./testing/checks_pass.yaml
+          #   expected_exit_code: 3
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -39,8 +48,7 @@ jobs:
         continue-on-error: true
         uses: ./
         with:
-          # should be latest, but it is not published yet
-          soda_library_version: v1.0.4
+          soda_library_version: v1.0.6
           configuration: ./testing/configuration.yaml
           data_source: ${{ matrix.data_source }}
           checks: ${{ matrix.checks }}

.gitignore

@@ -3,3 +3,4 @@ soda_scan_results_raw.json
 *.DS_store
 .env_file
 testing/configuration_local.yaml
+.venv

action.yaml

@@ -122,7 +122,7 @@ runs:
       shell: bash
 
     - name: Scan results link
-      if: env.SCAN_EXIT_CODE == 0 || env.SCAN_EXIT_CODE == 2
+      if: env.SCAN_EXIT_CODE <= 2
       run: |
         echo -e "\033[36;1m-----------------------------\033[0m"
         echo -e "\033[36;1m View the full scan results -> \033[0m ${{ env.SCAN_CLOUD_LINK }}"
@@ -151,7 +151,19 @@ runs:
 
           [View the full scan results](${{ env.SCAN_CLOUD_LINK }})
 
-    - name: Comment PR on failure with results
+    - name: Comment PR on warning
+      uses: thollander/actions-comment-pull-request@8c77f42bbcc27c832a3a5962c8f9a60e34b594f3
+      continue-on-error: true
+      if: env.SCAN_EXIT_CODE == 1
+      with:
+        message: |
+          🟠 Soda scan completed with the following results:
+
+          ${{ steps.table.outputs.table }}
+
+          [View the full scan results](${{ env.SCAN_CLOUD_LINK }})
+
+    - name: Comment PR on failure
       uses: thollander/actions-comment-pull-request@8c77f42bbcc27c832a3a5962c8f9a60e34b594f3
       continue-on-error: true
       if: env.SCAN_EXIT_CODE == 2
@@ -163,23 +175,23 @@ runs:
 
           [View the full scan results](${{ env.SCAN_CLOUD_LINK }})
 
-    - name: Comment PR on fatal failure
+    - name: Comment PR on scan errors
       uses: thollander/actions-comment-pull-request@8c77f42bbcc27c832a3a5962c8f9a60e34b594f3
       continue-on-error: true
-      if: env.SCAN_EXIT_CODE == 1 || env.SCAN_EXIT_CODE == 3
+      if: env.SCAN_EXIT_CODE == 3
       with:
         message: |
-          🔴 Soda scan failed. Check logs for more details.
+          🔴 Soda scan failed. Check the logs for more details.
 
 
     # 6. Post additional message to make it clear scan failed or not
-    - name: Fail Job if Soda Scan Failed
+    - name: Fail job if Soda scan failed
       shell: bash
       if: env.SCAN_EXIT_CODE != 0
       run: |
         echo -e "\033[31;1;4mSoda Scan failed\033[0m" && exit ${{ env.SCAN_EXIT_CODE }}
 
-    - name: Fail Job if Soda Scan Succeeded
+    - name: Exit job if Soda scan succeeded
       shell: bash
       if: env.SCAN_EXIT_CODE == 0
       run: |

entrypoint.sh

@@ -11,14 +11,8 @@ soda scan \
   --scan-type cicd \
   -cif soda_scan_ci_info.json
 
-exit_status=$?
+echo "SCAN_EXIT_CODE=$?" >> $GITHUB_ENV
+echo "SCAN_CLOUD_LINK=$(python3 /tmp/action_path/scripts/reformat_json.py soda_scan_results_raw.json)" >> $GITHUB_ENV
+echo "SCAN_RESULTS=$(cat soda_scan_results.json 2> /dev/null)" >> $GITHUB_ENV
 
-scan_cloud_link=$(python3 /tmp/action_path/scripts/reformat_json.py soda_scan_results_raw.json)
-
-{
-  echo "SCAN_RESULTS=$(cat soda_scan_results.json)"
-  echo "SCAN_EXIT_CODE=$exit_status"
-  echo "SCAN_CLOUD_LINK=$scan_cloud_link"
-} >> "$GITHUB_ENV"
-
-exit $exit_status
+exit 0

testing/checks_incorrect.yaml testing/checks_error.yamltesting/checks_incorrect.yaml renamed to testing/checks_error.yaml

@@ -0,0 +1,3 @@
+checks for incidents:
+  - row_count:
+      warn: when > 0

testing/checks_fail_on_check.yaml testing/checks_fail.yamltesting/checks_fail_on_check.yaml renamed to testing/checks_fail.yaml

@@ -15,4 +15,4 @@ data_source reporting_api__marts:
 soda_cloud:
   host: dev.sodadata.io
   api_key_id: ${CLOUD_API_KEY_ID}
-  api_key_secret: ${CLOUD_API_KEY_SECRET}
+  api_key_secret: ${CLOUD_API_KEY_SECRET}