-
Task
-
Resolution: Unresolved
-
Blocker
-
None
-
None
-
False
-
-
False
-
-
Description
Migrate TechDocs plugin 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
TechDocs Plugin Enabled: Frontend and backend TechDocs plugins
TechDocs Builder: Local or external builder configured
Based on RHDH core config (.ibm/pipelines/resources/config_map/app-config-rhdh.yaml):
techdocs:
cache:
ttl: 3600000 # 1 hour
Test Entity: Catalog entity with TechDocs configured (e.g., Red Hat Developer Hub docs)
Source Files (RHDH Core)
| File | Path |
|---|---|
| Test spec | e2e-tests/playwright/e2e/techdocs.spec.ts |
| Page Object | e2e-tests/playwright/support/pages/catalog.ts |
Plugin Packages
| Package | Type |
|---|---|
| backstage-plugin-techdocs | Frontend |
| backstage-plugin-techdocs-backend-dynamic | Backend |
| backstage-plugin-techdocs-module-addons-contrib | Frontend (addons) |
Acceptance Criteria
1. Create Workspace Structure
- [ ] Reuse workspaces/backstage/e2e-tests/
2. Create RHDH Configuration (tests/config/)
- [ ] Add techdocs plugins to dynamic-plugins.yaml
- [ ] Configure techdocs cache settings
3. Migrate Test Files
- [ ] Create tests/specs/techdocs.spec.ts
4. Verify All Tests Pass
- [ ] All 5 test cases pass
Test Cases (5 total)
Verify that TechDocs is visible in sidebar
Verify that TechDocs Docs page for Red Hat Developer Hub works
Verify that TechDocs entity tab page for Red Hat Developer Hub works
Verify that TechDocs Docs page for ReportIssue addon works
Verify that TechDocs entity tab page for ReportIssue addon works
Reference
- Template: workspaces/tech-radar/e2e-tests
