BirdOne Quality Engineering — VS Code Extension (V1.0)
The official VS Code extension for BirdOne — Universal Quality Engineering Platform. It connects to a running BirdOne backend (http://localhost:3000 by default) to browse projects, trigger test runs across all five integrated quality engines (Selenium WebDriver, Playwright, Postman, Apache JMeter, and Grafana k6), evaluate CI/CD Quality Gates, inspect execution history, and preview screenshots and structured JSON evidence directly inside VS Code.
Features
- Activity Bar Navigation (
BirdOne Quality Engineering):
- Projects & Test Engines View (
birdone.projectsView): Shows real-time backend connection status, Quality Dashboard pass-rate summary, BirdOne projects ([KEY] Name), and all five testing engines under each project with host CLI availability indicators for JMeter and k6.
- Execution History View (
birdone.historyView): Browse historical test executions with engine (ALL, SELENIUM, PLAYWRIGHT, POSTMAN, JMETER, K6) and status (ALL, PASSED, FAILED, ERROR) filters. Click any execution to inspect full metrics and evidence.
- Interactive Quality Engineering Cockpit Webview:
- Switch active BirdOne projects and view live PostgreSQL dashboard metrics (
Total Executions, Passed, Failed / Error, Pass Rate).
- Run Selenium and Playwright browser tests (sample presets or custom
testName, targetUrl, and expectedTitle).
- Import and execute Postman Collection v2.1 API suites (built-in passing/failing samples or
.json files from the workspace).
- Import and execute Apache JMeter
.jmx load plans and Grafana k6 .js performance scripts with bounded runtime parameters (threads/vus, rampUpSeconds, durationSeconds, p95ThresholdMs).
- Evaluate CI/CD Quality Gates (
verdict: "PASSED" | "FAILED" | "NO_DATA") and view Jira defect & Dynatrace SLO correlation summaries.
- Preview PNG browser screenshots (
SELENIUM, PLAYWRIGHT), redacted HTTP traces (POSTMAN), JTL latency percentiles (JMETER), and --summary-export threshold evaluations (K6), or open raw JSON evidence in a side-by-side VS Code editor tab.
- Secure API Token Authentication via VS Code
SecretStorage:
- Supports authenticated BirdOne backends (
BIRDONE_AUTH_MODE="token" / "shared" / "remote" or BIRDONE_API_TOKEN set).
- API tokens are stored exclusively in VS Code's encrypted OS keychain (
context.secrets under birdone.apiToken) — never in settings.json, workspace files, URLs, or logs.
- Automatically sends
Authorization: Bearer <token> on all JSON API calls and evidence fetches (GET /api/executions/:id/evidence).
- Honest CLI Availability & Metric Fidelity:
- Clearly surfaces when
jmeter or k6 is not installed on the host machine along with setup instructions.
- Never simulates or fabricates load-test results: runs triggered without the host CLI are displayed with their true backend outcome (
status: "ERROR", executed: false, and N/A (Unavailable) for null metrics, strictly distinct from 0).
Reused BirdOne Backend API Contracts
The extension contains zero duplicated testing engines, business logic, or database queries. It communicates exclusively with the BirdOne Next.js REST API:
| Capability |
Existing Endpoint |
| Connection & Dashboard Metrics |
GET /api/dashboard |
| Project Listing |
GET /api/projects |
| Selenium Execution |
GET & POST /api/projects/:id/selenium |
| Playwright Execution |
GET & POST /api/projects/:id/playwright |
| Postman Collections & Runs |
GET & POST /api/projects/:id/postman (import, run_request, run_collection) |
| Apache JMeter Plans & Runs |
GET & POST /api/projects/:id/jmeter (import, run) |
| Grafana k6 Scripts & Runs |
GET & POST /api/projects/:id/k6 (import, run) |
| Enterprise Integrations & Quality Gate |
GET & POST /api/projects/:id/integrations (evaluate_gate) |
| Project Execution History |
GET /api/projects/:id/executions?status=...&tool=... |
| Execution Detail |
GET /api/executions/:executionId |
| Authorized Evidence Stream |
GET /api/executions/:executionId/evidence (image/png or application/json) |
Configuration Settings & SecretStorage Authentication
| Setting |
Default |
Description |
birdone.backendUrl |
"http://localhost:3000" |
Base URL of the running BirdOne backend server. |
birdone.requestTimeoutMs |
65000 |
Request timeout in milliseconds (3000–120000). |
birdone.allowRemoteBackend |
false |
Restricts connections to localhost / 127.0.0.1 / ::1 by default. Set true only if intentionally connecting to a non-local BirdOne instance. |
Configuring & Rotating the API Token (SecretStorage)
- Set or Rotate Token: Run
BirdOne: Set API Token (SecretStorage) (birdone.configureApiToken) from the Command Palette (Ctrl+Shift+P) or click the key icon in the BirdOne Activity Bar title menu. Enter the token matching the backend's BIRDONE_API_TOKEN.
- Clear Token: Run
BirdOne: Clear Stored API Token (birdone.clearApiToken) to remove the credential from VS Code SecretStorage.
Commands
BirdOne: Open Quality Engineering Cockpit (birdone.openCockpit)
BirdOne: Refresh Projects & History (birdone.refresh)
BirdOne: Configure Backend URL (birdone.configureBackendUrl)
BirdOne: Set API Token (SecretStorage) (birdone.configureApiToken)
BirdOne: Clear Stored API Token (birdone.clearApiToken)
BirdOne: Select Active Project (birdone.selectProject)
BirdOne: Open Testing Engine (birdone.selectEngine)
BirdOne: Run Selenium Browser Test (birdone.runSeleniumTest)
BirdOne: Run Playwright Browser Test (birdone.runPlaywrightTest)
BirdOne: Run Postman API Collection (birdone.runPostmanTest)
BirdOne: Run Apache JMeter Load Plan (birdone.runJMeterTest)
BirdOne: Run Grafana k6 Performance Script (birdone.runK6Test)
BirdOne: View Execution Details & Evidence (birdone.viewExecutionDetail)
BirdOne: Open Execution Evidence in Editor (birdone.openEvidenceInEditor)
BirdOne: Filter Execution History by Engine (birdone.filterHistoryByTool)
BirdOne: Filter Execution History by Status (birdone.filterHistoryByStatus)
Local Development & Manual Validation in VS Code
Start the BirdOne Backend:
npm run dev
Verify the server is running at http://localhost:3000 and PostgreSQL is active.
Compile the VS Code Extension:
npm run ext:compile
This compiles vscode-extension/src/**/*.ts into vscode-extension/dist/extension.js.
Launch in VS Code Extension Development Host:
- Open the repository root (
BirOne) in VS Code.
- Press
F5 (which runs the .vscode/launch.json configuration "Run BirdOne VS Code Extension").
- If the backend has
BIRDONE_API_TOKEN enabled, run BirdOne: Set API Token (SecretStorage) in the Extension Development Host and enter your token.
| |