-
Task
-
Resolution: Unresolved
-
Blocker
-
None
-
None
-
2
-
False
-
-
False
-
-
Description
Migrate GitHub Discovery E2E tests to workspaces/backstage/e2e-tests/.
NOTE
This task is based on the existing RHDH core test case and may have missed some details. Please review the original test files in RHDH core before implementation.
DOCUMENTATION
Follow the RHDH E2E Test Utils - Overlay Documentation for implementation guidance.
Setup Prerequisites
GitHub App Integration: GitHub App with organization access
- GITHUB_APP_APP_ID, GITHUB_APP_CLIENT_ID, GITHUB_APP_CLIENT_SECRET
- GITHUB_APP_PRIVATE_KEY, GITHUB_APP_WEBHOOK_URL, GITHUB_APP_WEBHOOK_SECRET
Based on RHDH core config (.ibm/pipelines/resources/config_map/app-config-rhdh.yaml):
catalog:
providers:
github:
providerId:
organization: "${GITHUB_ORG}"
schedule:
frequency: { hours: 24 }
timeout: { minutes: 30 }
GitHub Organization: Test organization with catalog entities (e.g., JANUS_QE_ORG)
Source Files (RHDH Core)
| File | Path |
|---|---|
| Test spec | e2e-tests/playwright/e2e/github-discovery.spec.ts |
| Page Object | e2e-tests/playwright/support/pages/catalog.ts |
| API Helper | e2e-tests/playwright/support/api/github.ts |
Plugin Packages
| Package | Type |
|---|---|
| backstage-plugin-catalog-backend-module-github-dynamic | Backend |
Acceptance Criteria
1. Create Workspace Structure
- [ ] Create workspaces/backstage/e2e-tests/ (if not exists)
- [ ] Copy standard config files from tech-radar reference
- [ ] Update package.json name and playwright.config.ts project name
2. Create RHDH Configuration (tests/config/)
- [ ] Create dynamic-plugins.yaml based on RHDH core dynamic-plugins.default.yaml
- [ ] Create app-config-rhdh.yaml with GitHub catalog provider config from Setup Prerequisites above
3. Migrate Test Files
- [ ] Create tests/specs/github-discovery.spec.ts using rhdh-e2e-test-utils fixtures
- [ ] Create tests/pages/catalog.page.ts
- [ ] Create tests/support/api/github.ts (API helper)
4. Verify All Tests Pass
- [ ] All 1 test case passes (currently fixme'd - may need investigation)
Test Cases (1 total - currently disabled)
Discover Organization's Catalog
Reference
- Template: workspaces/tech-radar/e2e-tests