CI/CD Integration Documentation

This document explains the continuous integration and delivery (CI/CD) pipeline used for running Playwright-based vendor automation tests for HungryHub’s reservation API integrations. The workflow is triggered manually or on schedule, shards test execution, generates Allure reports, and notifies Slack with test summaries.

📂 Workflow File: Playwright-Tests.yml

Located in .github/workflows/Playwright-Tests.yml

🧩 Trigger Types

🔧 Manual Inputs (workflow_dispatch)

📦 Job 1: setup-playwright

🛠 Responsibilities

• Install dependencies & Playwright browsers
• Generate dynamic restaurantData.json from API
• Upload src/data/restaurantData.json for use in test steps

💡 Notable steps

• Cache Playwright browsers for faster setup
• Use npm run generate-master-data to prepare data per environment
• Upload artifact restaurant-data for use in next job

🧪 Job 2: running-playwright

🛠 Responsibilities

• Download generated data
• Run Playwright tests across 4 shards for parallelism
• Upload Allure results per shard

📌 Test Command Logic

# If `all` is selected or blank, run all tests with sharding
npx playwright test src/tests --shard X/4 --reporter=allure-playwright

# Else run a specific test file
npx playwright test ${{ github.event.inputs.scenarios }} --shard X/4 --reporter=allure-playwright

🌐 Secrets & Vars

Supports various vendors with secrets like:

• HMAC_API_KEY_VENDOR_*
• BASIC_AUTH_*
• API_KEY, API_SECRET_KEY
• BASE_URL, ENV_MODE, etc. All secrets are injected securely via GitHub's secrets & vars.

📈 Job 3: merge-reports-and-upload

🛠 Responsibilities

• Merge all allure-results
• Generate Allure HTML report
• Upload report to:
  • Cloudflare R2 (path includes environment + run number)
  • GitHub as artifact (zipped)
• Notify on Slack with summary and link to report

🔍 Allure Stats Parsed

📤 Slack Notification

Sent via 8398a7/action-slack@v3, includes:

• Trigger source (Schedule or Manual)
• Environment (ballbot)
• Passed/Failed/Broken/Skipped counts
• Link to Cloudflare-hosted report

📊 Sample Slack Output **End to End Testing Result for Environment ballbot - Trigger From Schedule** - ✅ Passed: 85 - ❌ Failed: 3 - ⭕ Skipped: 5 - ❗ Broken: 0 📊 View Report: https://allure.hh-ballbot.my.id/api/hh-server/ballbot/245

✅ Key CI/CD Features