Files
openobserve/.github/workflows/playwright_regression.yml
T
Shrinath RaoandClaude Sonnet 4.6 63b28f68c6 test: fix playwright CI hangs and add browser caching (#12258)
## Problem

Playwright CI jobs were hanging for 2–6 hours and then timing out
without running a single test. Root cause: `npx playwright install
--with-deps chromium` downloads the browser binary successfully (~3s),
but the `--with-deps` flag then runs a second `apt-get` call that waits
indefinitely for the dpkg lock held by Ubuntu's `unattended-upgrades`
background daemon on ubicloud runners.

Evidence: in a 2h8m run, Chromium downloaded at `08:51:49`, but the
`playwright install` process was still listed as a zombie when the job
was killed at `11:00:23`.

## Fix

Two-layer fix applied to all four workflow files (`playwright.yml` +
`playwright_regression.yml` in both OSS and enterprise):

**1. Kill background apt services at job start** (new first step)
```bash
sudo systemctl stop apt-daily.service apt-daily-upgrade.service unattended-upgrades.service
sudo systemctl stop apt-daily.timer apt-daily-upgrade.timer
sudo systemctl disable apt-daily.service apt-daily-upgrade.service unattended-upgrades.service
sudo flock --wait 30 /var/lib/dpkg/lock-frontend true
```
This eliminates the root cause — the dpkg lock contender is gone before
`playwright install` runs.

**2. Cache the browser binary** (`actions/cache@v4` keyed on
`package-lock.json` hash)

On cache hit, only system dependencies are installed (`playwright
install-deps chromium`), avoiding apt entirely. On cache miss, the full
`playwright install --with-deps chromium` runs with apt services already
stopped.

**3. Filter TestDino uploads to failures only**

Before uploading to TestDino, the JSON report is filtered to only
include tests with `status === 'unexpected'`. This prevents passing
tests from polluting the TestDino failure history.

## Files changed
- `.github/workflows/playwright.yml` — kill apt, cache browser,
cache-aware install, TestDino filter
- `.github/workflows/playwright_regression.yml` — kill apt, cache
browser, split into separate npm/playwright/test steps

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-27 02:43:06 +00:00

457 lines
16 KiB
YAML

name: Playwright Regression Tests
on:
schedule:
- cron: '30 3,7,11,15,19,23 * * *' # Every 4 hrs from 9 AM IST (3:30, 7:30, 11:30, 15:30, 19:30, 23:30 UTC)
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
permissions:
contents: read
env:
COLUMNS: 150
ZO_ROOT_USER_EMAIL: root@example.com
ZO_ROOT_USER_PASSWORD: Complexpass#123
ZO_BASE_URL: http://localhost:5080
WS_ZO_BASE_URL: ws://localhost:5080
ZO_BASE_URL_SC: http://localhost:5080
ZO_BASE_URL_SC_UI: http://localhost:5080
INGESTION_URL: http://localhost:5080
ORGNAME: default
ZO_WEB_URL: "http://localhost:5080"
ZO_QUICK_MODE_NUM_FIELDS: 100
ZO_QUICK_MODE_STRATEGY: first
ZO_ALLOW_USER_DEFINED_SCHEMAS: true
ZO_INGEST_ALLOWED_UPTO: 5
ZO_FEATURE_QUERY_EXCLUDE_ALL: false
ZO_USAGE_BATCH_SIZE: 200
ZO_USAGE_PUBLISH_INTERVAL: 2
ZO_USAGE_REPORTING_ENABLED: true
ZO_MIN_AUTO_REFRESH_INTERVAL: 5
ZO_STREAMING_ENABLED: true
ZO_COLS_PER_RECORD_LIMIT: "80000"
ZO_SMTP_ENABLED: true
ZO_FORMAT_STREAM_NAME_TO_LOWERCASE: false
ZO_CREATE_ORG_THROUGH_INGESTION: true
ZO_UTF8_VIEW_ENABLED: false
ZO_ENABLE_CROSS_LINKING: true
ZO_SSRF_ALLOW_LOOPBACK: true
UPLOAD_TO_TESTDINO: ${{ vars.UPLOAD_TO_TESTDINO || 'false' }}
jobs:
build_binary:
timeout-minutes: 45
name: build_binary
runs-on:
labels: ubicloud-standard-16
permissions:
contents: read
steps:
- name: Remove unused tools
run: |
sudo rm -rf /usr/share/dotnet
sudo rm -rf /opt/ghc
sudo rm -rf "/usr/local/share/boost"
sudo rm -rf "$AGENT_TOOLSDIRECTORY"
- name: Clone the current repo
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Setup Rust Toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly-2025-11-11
targets: x86_64-unknown-linux-gnu
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
shared-key: playwright-release-ci
save-if: ${{ github.ref == 'refs/heads/main' }}
- name: Install Protoc
run: |
bash ./.github/protoc.sh
- uses: actions/setup-node@v5
with:
node-version: 22
- name: Lint frontend code
run: cd web && npm ci && npm run lint:ci
- name: Build binary and frontend
env:
NODE_OPTIONS: "--max-old-space-size=8192"
GIT_HASH_OVERRIDE: ${{ github.sha }}
run: |
bash -c "cd web && npm run build && cp -r ./dist /tmp/dist" &
sed -i 's|folder = "web/dist/"|folder = "/tmp/dist/"|' src/handler/http/router/ui.rs
cargo build --profile release-ci --target x86_64-unknown-linux-gnu
wait
- name: Upload binary artifact
uses: actions/upload-artifact@v4
with:
name: release-ci-binary
path: target/x86_64-unknown-linux-gnu/release-ci/openobserve
retention-days: 1
- name: Upload frontend artifact
uses: actions/upload-artifact@v4
with:
name: frontend-dist
path: /tmp/dist
retention-days: 1
if-no-files-found: error
ui_integration_tests:
timeout-minutes: 45
name: e2e / ${{ matrix.testfolder }}
needs: [build_binary]
runs-on:
labels: ubicloud-standard-8
permissions:
contents: read
strategy:
fail-fast: false
matrix:
include:
- testfolder: "Logs-Regression"
run_files:
[
"logs-regression.spec.js",
"logs-regression-bugs.spec.js",
"logs-regression-bugs-2.spec.js",
"logs-9754.spec.js",
"logs-regression-9044-7354.spec.js",
]
- testfolder: "Alerts-Regression"
run_files:
[
"alerts-regression.spec.js",
"alerts-stream-switching-regression.spec.js",
"alerts-regression-bugs.spec.js",
]
- testfolder: "Dashboard-Regression"
run_files:
[
"dashboard-regression.spec.js",
]
- testfolder: "Streams-Regression"
run_files:
[
"streams-regression.spec.js",
]
- testfolder: "Pipelines-Regression"
run_files:
[
"enrichment-regression.spec.js",
"pipeline-regression.spec.js",
]
- testfolder: "Traces-Regression"
run_files:
[
"traces-regression.spec.js",
"traces-regression-bugs.spec.js",
]
- testfolder: "Metrics-Regression"
run_files:
[
"metrics-regression.spec.js",
]
- testfolder: "GeneralTests-Regression"
run_files:
[
"ui-regression.spec.js",
]
steps:
- name: Kill background apt processes
run: |
sudo systemctl stop apt-daily.service apt-daily-upgrade.service unattended-upgrades.service 2>/dev/null || true
sudo systemctl stop apt-daily.timer apt-daily-upgrade.timer 2>/dev/null || true
sudo systemctl disable apt-daily.service apt-daily-upgrade.service unattended-upgrades.service 2>/dev/null || true
sudo flock --wait 30 /var/lib/dpkg/lock-frontend true 2>/dev/null || true
- name: Clone the current repo
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Download binary artifact
uses: actions/download-artifact@v5
with:
name: release-ci-binary
path: release-ci-binary
- name: Download frontend artifact
uses: actions/download-artifact@v5
with:
name: frontend-dist
path: /tmp/dist
- name: Start OpenObserve
run: chmod +x ./release-ci-binary/openobserve && ./release-ci-binary/openobserve > o2.log 2>&1 &
- name: Wait for start
run: |
for i in $(seq 1 120); do
if curl -sf http://localhost:5080/web/login > /dev/null 2>&1; then
echo "Server ready after ${i}s"
exit 0
fi
sleep 1
done
echo "Server failed to start in 120s"
exit 1
- name: Ensure we are getting a reply from the server
run: curl http://localhost:5080/web/login
- uses: actions/setup-node@v5
with:
node-version: 22
- name: Cache Playwright browser
id: playwright-cache
uses: actions/cache@v4
with:
path: ~/.cache/ms-playwright
key: playwright-chromium-${{ runner.os }}-${{ hashFiles('tests/ui-testing/package-lock.json') }}
- name: Install npm dependencies
run: cd tests/ui-testing && npm ci
- name: Install Playwright browser
run: |
cd tests/ui-testing
if [ "${{ steps.playwright-cache.outputs.cache-hit }}" = "true" ]; then
echo "Browser cache hit — installing system deps only"
npx playwright install-deps chromium
else
echo "Browser cache miss — installing browser + system deps"
npx playwright install --with-deps chromium
fi
- name: Write .env and run ui-tests
run: |
touch .env
echo "ZO_ROOT_USER_EMAIL=${ZO_ROOT_USER_EMAIL}" >> .env
echo "ZO_ROOT_USER_PASSWORD=${ZO_ROOT_USER_PASSWORD}" >> .env
echo "ZO_BASE_URL=${ZO_BASE_URL}" >> .env
echo "WS_ZO_BASE_URL=${WS_ZO_BASE_URL}" >> .env
echo "ZO_BASE_URL_SC=${ZO_BASE_URL_SC}" >> .env
echo "ZO_BASE_URL_SC_UI=${ZO_BASE_URL_SC_UI}" >> .env
echo "INGESTION_URL=${INGESTION_URL}" >> .env
echo "ORGNAME=${ORGNAME}" >> .env
echo "ZO_SMTP_ENABLED=${ZO_SMTP_ENABLED}" >> .env
mv .env tests/ui-testing
cd tests/ui-testing
FILE_LIST="${{ join(matrix.run_files, ' ') }}"
if [ -n "$FILE_LIST" ]; then
FILE_PATHS=""
for file in $FILE_LIST; do
FILE_PATHS="$FILE_PATHS ./playwright-tests/RegressionSet/$file"
done
echo "Running: npx playwright test $FILE_PATHS"
npx playwright test $FILE_PATHS
else
echo "No files specified for ${{ matrix.testfolder }}"
fi
- name: Upload blob report to GitHub Actions Artifacts
if: ${{ !cancelled() }}
uses: actions/upload-artifact@v4
with:
name: blob-report-${{ matrix.testfolder }}-${{ github.run_attempt }}
path: tests/ui-testing/blob-report
retention-days: 1
- name: Check OpenObserve logs
if: always()
run: cat o2.log
merge_and_upload_reports:
timeout-minutes: 15
name: Merge Reports and Upload to TestDino
needs: [ui_integration_tests]
if: ${{ !cancelled() && needs.ui_integration_tests.result != 'skipped' }}
runs-on:
labels: ubicloud-standard-8
permissions:
contents: read
steps:
- name: Clone the current repo
uses: actions/checkout@v5
- name: Setup Node.js
uses: actions/setup-node@v5
with:
node-version: '22'
- name: Install project dependencies
run: cd tests/ui-testing && npm ci
- name: Download blob reports from GitHub Actions Artifacts
uses: actions/download-artifact@v4
continue-on-error: true
with:
path: tests/ui-testing/all-blob-reports
pattern: blob-report-*-${{ github.run_attempt }}
merge-multiple: true
- name: Merge Reports
env:
GH_TOKEN: ${{ github.token }}
run: |
cd tests/ui-testing
if [ ! -d "all-blob-reports" ] || [ -z "$(ls -A all-blob-reports 2>/dev/null)" ]; then
echo "::warning::No blob reports found to merge."
echo "::group::Investigating why no blob reports exist"
JOBS_RESPONSE=$(curl -s -H "Authorization: token $GH_TOKEN" \
-H "Accept: application/vnd.github.v3+json" \
"https://api.github.com/repos/${{ github.repository }}/actions/runs/${{ github.run_id }}/attempts/${{ github.run_attempt }}/jobs")
SUCCEEDED=$(echo "$JOBS_RESPONSE" | jq -r '[.jobs[] | select(.name | startswith("e2e /")) | select(.conclusion == "success")] | length')
FAILED=$(echo "$JOBS_RESPONSE" | jq -r '[.jobs[] | select(.name | startswith("e2e /")) | select(.conclusion == "failure")] | length')
TOTAL=$(echo "$JOBS_RESPONSE" | jq -r '[.jobs[] | select(.name | startswith("e2e /"))] | length')
echo "::notice::Test job results: $SUCCEEDED succeeded, $FAILED failed, $TOTAL total"
if [ "$SUCCEEDED" -gt 0 ] && [ "$FAILED" -eq 0 ]; then
echo "::notice::✅ All test jobs succeeded - they likely skipped because tests already passed"
echo "::notice::Creating empty report structure for downstream jobs"
mkdir -p playwright-results/html-report
START_TIME=$(date -u +%Y-%m-%dT%H:%M:%S.000Z)
echo '{"config":{},"suites":[],"errors":[],"stats":{"startTime":"'"$START_TIME"'","duration":0,"expected":0,"unexpected":0,"flaky":0,"skipped":0}}' > playwright-results/report.json
echo "<html><body><h1>No tests executed - all shards skipped</h1><p>All test shards exited early because tests had already passed in a previous attempt.</p></body></html>" > playwright-results/html-report/index.html
echo "::endgroup::"
exit 0
else
echo "::error::❌ Some/all test jobs failed but no blob reports were found"
echo "::error::This indicates a problem with test execution or blob reporter"
echo "::error::Failed jobs: $FAILED, Succeeded jobs: $SUCCEEDED"
echo "::endgroup::"
exit 1
fi
fi
unset CI
npx playwright merge-reports --config playwright.config.js ./all-blob-reports
echo "Contents of playwright-results:"
ls -la playwright-results/
echo "Contents of html-report:"
ls -la playwright-results/html-report/
echo "Checking report.json:"
ls -lh playwright-results/report.json
- name: Cache test failures to TestDino
if: ${{ needs.ui_integration_tests.result == 'failure' }}
env:
TESTDINO_TOKEN: ${{ secrets.TESTDINO_API_TOKEN }}
run: |
cd tests/ui-testing
echo "::group::Caching test failure metadata to TestDino"
if [ -f "playwright-results/report.json" ]; then
echo "::notice::JSON report found at playwright-results/report.json"
ls -lh playwright-results/report.json
mkdir -p ../../playwright-results
cp playwright-results/report.json ../../playwright-results/
cd ../../playwright-results
BRANCH_NAME=$(echo "${{ github.ref_name }}" | sed 's/\//_/g')
CACHE_ID="gh_openobserve_${BRANCH_NAME}_${{ github.run_id }}"
echo "::notice::Using cache ID: $CACHE_ID"
if CACHE_OUTPUT=$(npx tdpw cache --cache-id "$CACHE_ID" 2>&1); then
SUCCESS_MSG=$(echo "$CACHE_OUTPUT" | grep "Cache data submitted successfully" || echo "")
if [ -n "$SUCCESS_MSG" ]; then
echo "::notice::✅ Successfully cached test failure metadata to TestDino cloud"
else
echo "::notice::✅ Cache command completed"
fi
else
echo "::warning::⚠️ Failed to cache test metadata to TestDino"
echo "::warning::Rerun optimization may not work properly"
echo "$CACHE_OUTPUT"
fi
else
echo "::notice::Skipping cache - no report.json found (tests may have been skipped due to rerun optimization)"
fi
echo "::endgroup::"
- name: Upload to TestDino
if: ${{ needs.ui_integration_tests.result == 'failure' && env.UPLOAD_TO_TESTDINO == 'true' }}
run: |
cd tests/ui-testing
if [ ! -f "playwright-results/report.json" ]; then
echo "::notice::Skipping TestDino upload - no report.json found (tests may have been skipped due to rerun optimization)"
exit 0
fi
START_TIME=$(jq -r '.stats.startTime // empty' playwright-results/report.json)
if [ -n "$START_TIME" ] && [[ "$START_TIME" =~ ^[0-9]+$ ]]; then
echo "Converting startTime from Unix timestamp to ISO 8601 string"
jq '.stats.startTime = (.stats.startTime / 1000 | strftime("%Y-%m-%dT%H:%M:%S.000Z"))' playwright-results/report.json > playwright-results/report.json.tmp
mv playwright-results/report.json.tmp playwright-results/report.json
fi
npx --yes tdpw@latest upload playwright-results \
--json-report playwright-results/report.json \
--html-report playwright-results/html-report \
--upload-html \
--verbose \
--token="${{ secrets.TESTDINO_API_TOKEN }}"
playwright_summary:
timeout-minutes: 5
runs-on:
labels: ubicloud-standard-8
permissions: {}
needs: [build_binary, ui_integration_tests, merge_and_upload_reports]
if: always()
steps:
- name: Check test results
run: |
BUILD_OK=false
UI_OK=false
MERGE_OK=false
if [ "${{ needs.build_binary.result }}" == "success" ] || [ "${{ needs.build_binary.result }}" == "skipped" ]; then
BUILD_OK=true
fi
if [ "${{ needs.ui_integration_tests.result }}" == "success" ] || [ "${{ needs.ui_integration_tests.result }}" == "skipped" ]; then
UI_OK=true
fi
if [ "${{ needs.merge_and_upload_reports.result }}" == "success" ] || [ "${{ needs.merge_and_upload_reports.result }}" == "skipped" ] || [ "${{ needs.merge_and_upload_reports.result }}" == "failure" ]; then
MERGE_OK=true
fi
if [ "$BUILD_OK" == "true" ] && [ "$UI_OK" == "true" ] && [ "$MERGE_OK" == "true" ]; then
echo "All regression tests completed successfully"
exit 0
else
echo "Regression tests failed:"
echo " build_binary: ${{ needs.build_binary.result }}"
echo " ui_integration_tests: ${{ needs.ui_integration_tests.result }}"
echo " merge_and_upload_reports: ${{ needs.merge_and_upload_reports.result }}"
exit 1
fi