ci: add explain analysis on cloud (#18521)

Author: everpcpc

.github/workflows/cloud.yml

@@ -151,6 +151,14 @@ jobs:
 
             > note: this image tag is only available for internal use.
 
+  explain:
+    needs: [info, build, docker]
+    uses: ./.github/workflows/reuse.explain.yml
+    secrets: inherit
+    with:
+      run_id: ${{ github.run_id }}
+      version: ${{ needs.docker.outputs.tag }}
+
   benchmark:
     if: needs.info.outputs.target
     needs: [info, build, docker]

.github/workflows/reuse.explain.yml

@@ -0,0 +1,86 @@
+name: Explain
+
+on:
+  workflow_call:
+    inputs:
+      run_id:
+        description: The run id for explain
+        required: true
+        type: string
+      version:
+        description: The version of databend to explain
+        required: true
+        type: string
+
+permissions:
+  id-token: write
+  pull-requests: write
+  contents: read
+
+jobs:
+  cloud:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup_bendsql
+
+      - name: Get Latest Release
+        id: latest
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          version_latest=$(gh api /repos/databendlabs/databend/releases/latest | jq -r '.tag_name')
+          echo "version=${version_latest}" >> $GITHUB_OUTPUT
+          echo "Compare explain: ${{ inputs.version }} vs ${version_latest}" >> $GITHUB_STEP_SUMMARY
+
+      - name: Create Warehouse Base
+        id: warehouse-base
+        env:
+          CLOUD_USER: ${{ secrets.BENCHMARK_CLOUD_USER }}
+          CLOUD_PASSWORD: ${{ secrets.BENCHMARK_CLOUD_PASSWORD }}
+          CLOUD_GATEWAY: ${{ secrets.BENCHMARK_CLOUD_GATEWAY }}
+          WAREHOUSE_SIZE: XSmall
+          WAREHOUSE_VERSION: ${{ steps.latest.outputs.version }}
+          WAREHOUSE_NAME: explain-${{ inputs.run_id }}-base
+        run: |
+          ./scripts/ci/cloud/create_warehouse.sh
+          echo "name=${WAREHOUSE_NAME}" >> $GITHUB_OUTPUT
+          echo "dsn=databend://${CLOUD_USER}:${CLOUD_PASSWORD}@${CLOUD_GATEWAY}:443/explain?warehouse=${WAREHOUSE_NAME}" >> $GITHUB_OUTPUT
+
+      - name: Create Warehouse Compare
+        id: warehouse-compare
+        env:
+          CLOUD_USER: ${{ secrets.BENCHMARK_CLOUD_USER }}
+          CLOUD_PASSWORD: ${{ secrets.BENCHMARK_CLOUD_PASSWORD }}
+          CLOUD_GATEWAY: ${{ secrets.BENCHMARK_CLOUD_GATEWAY }}
+          WAREHOUSE_SIZE: XSmall
+          WAREHOUSE_VERSION: ${{ inputs.version }}
+          WAREHOUSE_NAME: explain-${{ inputs.run_id }}-compare
+        run: |
+          ./scripts/ci/cloud/create_warehouse.sh
+          echo "name=${WAREHOUSE_NAME}" >> $GITHUB_OUTPUT
+          echo "dsn=databend://${CLOUD_USER}:${CLOUD_PASSWORD}@${CLOUD_GATEWAY}:443/explain?warehouse=${WAREHOUSE_NAME}" >> $GITHUB_OUTPUT
+
+      - name: Run ExplainB Analysis
+        uses: BohuTANG/[email protected]
+        with:
+          bendsql-dsn1: ${{ steps.warehouse-base.outputs.dsn }}
+          bendsql-dsn2: ${{ steps.warehouse-compare.outputs.dsn }}
+          runbend: 'true'
+          verbose: 'true'
+
+      - name: Upload Report
+        uses: actions/upload-artifact@v4
+        with:
+          name: explainb-report
+          path: report.html
+
+      - name: clean
+        if: always()
+        continue-on-error: true
+        env:
+          BENDSQL_DSN: "databend://${{ secrets.BENCHMARK_CLOUD_USER }}:${{ secrets.BENCHMARK_CLOUD_PASSWORD }}@${{ secrets.BENCHMARK_CLOUD_GATEWAY }}:443/?warehouse=default"
+        run: |
+          echo "DROP WAREHOUSE IF EXISTS '${{ steps.warehouse-base.outputs.name }}';" | bendsql -o table
+          echo "DROP WAREHOUSE IF EXISTS '${{ steps.warehouse-compare.outputs.name }}';" | bendsql -o table

scripts/ci/cloud/create_warehouse.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+set -e
+
+CLOUD_USER=${CLOUD_USER:-}
+CLOUD_PASSWORD=${CLOUD_PASSWORD:-}
+CLOUD_GATEWAY=${CLOUD_GATEWAY:-}
+
+WAREHOUSE_SIZE=${WAREHOUSE_SIZE:-XSmall}
+WAREHOUSE_VERSION=${WAREHOUSE_VERSION:-}
+WAREHOUSE_NAME=${WAREHOUSE_NAME:-}
+
+for var in CLOUD_USER CLOUD_PASSWORD CLOUD_GATEWAY WAREHOUSE_SIZE WAREHOUSE_VERSION WAREHOUSE_NAME; do
+    if [[ -z "${!var}" ]]; then
+        echo "Please set ${var} to create warehouse."
+        exit 1
+    fi
+done
+
+echo "#######################################################"
+echo "Creating warehouse on Databend Cloud..."
+
+export BENDSQL_DSN="databend://${CLOUD_USER}:${CLOUD_PASSWORD}@${CLOUD_GATEWAY}:443?login=disable&warehouse=default"
+
+echo "Creating warehouse: ${WAREHOUSE_NAME}"
+echo "DROP WAREHOUSE IF EXISTS '${WAREHOUSE_NAME}';" | bendsql
+echo "CREATE WAREHOUSE '${WAREHOUSE_NAME}' WITH version='${WAREHOUSE_VERSION}' warehouse_size='${WAREHOUSE_SIZE}';" | bendsql
+echo "SHOW WAREHOUSES;" | bendsql --output table
+
+echo "Waiting for warehouse to be ready..."
+max_retry=20
+counter=0
+until bendsql --query="SHOW WAREHOUSES LIKE '${WAREHOUSE_NAME}'" | grep -q "Running"; do
+    if [[ $counter -gt $max_retry ]]; then
+        echo "Failed to start warehouse ${WAREHOUSE_NAME} in time."
+        exit 1
+    fi
+    echo "Waiting for warehouse to be ready... (attempt $((counter + 1))/$((max_retry + 1)))"
+    counter=$((counter + 1))
+    sleep 10
+done
+
+echo "Warehouse ${WAREHOUSE_NAME} is now running!"