ci-testing-md-files

Summary:

- Support for simple testing of walkthroughs written in markdown, with annotations.

Author: general-kroll-4-life

.github/workflows/scenario.yaml

@@ -6,64 +6,65 @@ on:
       - 'scenario*'
 
 env:
-  GH_ACCESS_TOKEN: ${{ secrets.ACTIONS_PRIVATE_PACKAGE_SECRET }}
+  TAG_NAME: ${{ github.ref_name }}
 
 jobs:
   scenario-testing:
     runs-on: ubuntu-latest
+    timeout-minutes: ${{ vars.DEFAULT_JOB_TIMEOUT_MIN == '' && 120 || vars.DEFAULT_JOB_TIMEOUT_MIN }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Go
-        uses: actions/setup-go@v4
-        with:
-          go-version: ^1.19
-      - name: Install cross-compiler for linux/arm64
-        run: sudo apt-get install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
-      - name: Run Goreleaser
-        uses: goreleaser/goreleaser-action@v5
-        with:
-          version: latest
-          args: release --clean --config .github/goreleaser/.goreleaser-for-linux.yaml --verbose
-        env:
-          GITHUB_TOKEN: ${{env.GH_ACCESS_TOKEN}}
+      - name: Ref Parse
+        run: |
+          {
+            echo "runID=$(echo -n '${{ github.ref_name }}' | cut -d '-' -f 2)"
+          } >> "${GITHUB_ENV}"
 
-  build-macos-binary:
-    runs-on: macos-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Go
-        uses: actions/setup-go@v4
-        with:
-          go-version: ^1.19
-      - name: Run Goreleaser
-        uses: goreleaser/goreleaser-action@v5
-        with:
-          version: latest
-          args: release --clean --config .github/goreleaser/.goreleaser-for-darwin.yaml --verbose
-        env:
-          GITHUB_TOKEN: ${{env.GH_ACCESS_TOKEN}}
+      - name: Check out code into the Go module directory
+        uses: actions/[email protected]
 
-  build-windows-binary:
-    runs-on: windows-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Go
-        uses: actions/setup-go@v4
-        with:
-          go-version: ^1.19
-      - name: Run Goreleaser
-        uses: goreleaser/goreleaser-action@v5
+      - name: Download Artifact
+        uses: actions/[email protected]
         with:
-          version: latest
-          args: release --clean --config .github/goreleaser/.goreleaser-for-windows.yaml --verbose
+          name: stackql_linux_amd64
+          path: build
+          github-token: ${{ secrets.CI_STACKQL_PACKAGE_DOWNLOAD_TOKEN }}
+          run-id: ${{ env.runID }}
+
+      - name: Stackql permissions
+        run:  |
+          sudo chmod a+rwx build/stackql
+          ls -al build/stackql
+          {
+            echo "PATH=$PATH:$(pwd)/build/stackql"
+          } >> "${GITHUB_ENV}"
+
+      - name: Check Stackql Version
+        run: |
+          stackql --version
+      
+      - name: Persist secrets
+        run: |
+          echo "$GCP_RO_SECRET" >> cicd/keys/testing/google-ro-credentials.json
+        shell: bash
         env:
-          GITHUB_TOKEN: ${{env.GH_ACCESS_TOKEN}}
+          GCP_RO_SECRET: ${{ secrets.CI_SCENARIO_GCP_RO_SECRET }}
+      
+      - name: Install Python dependencies
+        run: |
+          pip3 install -r cicd/requirements.txt
+      
+      - name: Run Walkthrough Scenarios
+        run: |
+          python3 test/python/markdown_testing/markdown_testing.py 2>&1 | tee cicd/log/markdown-testing-results.log 
+      
+      - name: Upload Test Results
+        uses: actions/[email protected]
+        with:
+          name: scenario_test_results
+          path: cicd/log/markdown-testing-results.log
+      
+      - name: Cleanup
+        if: always()
+        run: |
+          rm -rf cicd/keys/testing
+

cicd/requirements.txt

@@ -1,4 +1,5 @@
 Flask==3.0.3
+mistune==3.0.2
 psycopg2-binary>=2.9.9
 psycopg[binary]>=3.1.16
 PyYaml>=6.0.1

docs/walkthroughs/get-google-vms.md

@@ -5,7 +5,7 @@ First, create a google service account key using the GCP Console, per [the GCP d
 
 Then, do this in bash:
 
-```bash setup stackql-shell credentials-path=cicd/keys/testing/google-credentials.json app-root-path=./test/tmp/.get-google-vms.stackql
+```bash setup stackql-shell credentials-path=cicd/keys/testing/google-ro-credentials.json app-root-path=./test/tmp/.get-google-vms.stackql
 
 export GOOGLE_CREDENTIALS="$(cat <credentials-path>)";