- mkdocs.yml: Material theme with dark/light mode, search, tabs, sitemap - scripts/generate-docs.py: auto-generates docs from all SKILL.md files - docs/index.md: landing page with domain overview and quick install - docs/getting-started.md: installation guide for Claude Code, Codex, OpenClaw - docs/skills/: 170 skill pages + 9 domain index pages - .github/workflows/static.yml: MkDocs build + GitHub Pages deploy - .gitignore: exclude site/ build output Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
173 lines
4.6 KiB
Markdown
173 lines
4.6 KiB
Markdown
---
|
|
title: "BrowserStack Integration"
|
|
description: "BrowserStack Integration - Claude Code skill from the Engineering - Core domain."
|
|
---
|
|
|
|
# BrowserStack Integration
|
|
|
|
**Domain:** Engineering - Core | **Skill:** `browserstack` | **Source:** [`engineering-team/playwright-pro/skills/browserstack/SKILL.md`](https://github.com/alirezarezvani/claude-skills/tree/main/engineering-team/playwright-pro/skills/browserstack/SKILL.md)
|
|
|
|
---
|
|
|
|
|
|
# BrowserStack Integration
|
|
|
|
Run Playwright tests on BrowserStack's cloud grid for cross-browser and cross-device testing.
|
|
|
|
## Prerequisites
|
|
|
|
Environment variables must be set:
|
|
- `BROWSERSTACK_USERNAME` — your BrowserStack username
|
|
- `BROWSERSTACK_ACCESS_KEY` — your access key
|
|
|
|
If not set, inform the user how to get them from [browserstack.com/accounts/settings](https://www.browserstack.com/accounts/settings) and stop.
|
|
|
|
## Capabilities
|
|
|
|
### 1. Configure for BrowserStack
|
|
|
|
```
|
|
/pw:browserstack setup
|
|
```
|
|
|
|
Steps:
|
|
1. Check current `playwright.config.ts`
|
|
2. Add BrowserStack connect options:
|
|
|
|
```typescript
|
|
// Add to playwright.config.ts
|
|
import { defineConfig } from '@playwright/test';
|
|
|
|
const isBS = !!process.env.BROWSERSTACK_USERNAME;
|
|
|
|
export default defineConfig({
|
|
// ... existing config
|
|
projects: isBS ? [
|
|
{
|
|
name: 'chrome@latest:Windows 11',
|
|
use: {
|
|
connectOptions: {
|
|
wsEndpoint: `wss://cdp.browserstack.com/playwright?caps=${encodeURIComponent(JSON.stringify({
|
|
'browser': 'chrome',
|
|
'browser_version': 'latest',
|
|
'os': 'Windows',
|
|
'os_version': '11',
|
|
'browserstack.username': process.env.BROWSERSTACK_USERNAME,
|
|
'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY,
|
|
}))}`,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'firefox@latest:Windows 11',
|
|
use: {
|
|
connectOptions: {
|
|
wsEndpoint: `wss://cdp.browserstack.com/playwright?caps=${encodeURIComponent(JSON.stringify({
|
|
'browser': 'playwright-firefox',
|
|
'browser_version': 'latest',
|
|
'os': 'Windows',
|
|
'os_version': '11',
|
|
'browserstack.username': process.env.BROWSERSTACK_USERNAME,
|
|
'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY,
|
|
}))}`,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'webkit@latest:OS X Ventura',
|
|
use: {
|
|
connectOptions: {
|
|
wsEndpoint: `wss://cdp.browserstack.com/playwright?caps=${encodeURIComponent(JSON.stringify({
|
|
'browser': 'playwright-webkit',
|
|
'browser_version': 'latest',
|
|
'os': 'OS X',
|
|
'os_version': 'Ventura',
|
|
'browserstack.username': process.env.BROWSERSTACK_USERNAME,
|
|
'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY,
|
|
}))}`,
|
|
},
|
|
},
|
|
},
|
|
] : [
|
|
// ... local projects fallback
|
|
],
|
|
});
|
|
```
|
|
|
|
3. Add npm script: `"test:e2e:cloud": "npx playwright test --project='chrome@*' --project='firefox@*' --project='webkit@*'"`
|
|
|
|
### 2. Run Tests on BrowserStack
|
|
|
|
```
|
|
/pw:browserstack run
|
|
```
|
|
|
|
Steps:
|
|
1. Verify credentials are set
|
|
2. Run tests with BrowserStack projects:
|
|
```bash
|
|
BROWSERSTACK_USERNAME=$BROWSERSTACK_USERNAME \
|
|
BROWSERSTACK_ACCESS_KEY=$BROWSERSTACK_ACCESS_KEY \
|
|
npx playwright test --project='chrome@*' --project='firefox@*'
|
|
```
|
|
3. Monitor execution
|
|
4. Report results per browser
|
|
|
|
### 3. Get Build Results
|
|
|
|
```
|
|
/pw:browserstack results
|
|
```
|
|
|
|
Steps:
|
|
1. Call `browserstack_get_builds` MCP tool
|
|
2. Get latest build's sessions
|
|
3. For each session:
|
|
- Status (pass/fail)
|
|
- Browser and OS
|
|
- Duration
|
|
- Video URL
|
|
- Log URLs
|
|
4. Format as summary table
|
|
|
|
### 4. Check Available Browsers
|
|
|
|
```
|
|
/pw:browserstack browsers
|
|
```
|
|
|
|
Steps:
|
|
1. Call `browserstack_get_browsers` MCP tool
|
|
2. Filter for Playwright-compatible browsers
|
|
3. Display available browser/OS combinations
|
|
|
|
### 5. Local Testing
|
|
|
|
```
|
|
/pw:browserstack local
|
|
```
|
|
|
|
For testing localhost or staging behind firewall:
|
|
1. Install BrowserStack Local: `npm install -D browserstack-local`
|
|
2. Add local tunnel to config
|
|
3. Provide setup instructions
|
|
|
|
## MCP Tools Used
|
|
|
|
| Tool | When |
|
|
|---|---|
|
|
| `browserstack_get_plan` | Check account limits |
|
|
| `browserstack_get_browsers` | List available browsers |
|
|
| `browserstack_get_builds` | List recent builds |
|
|
| `browserstack_get_sessions` | Get sessions in a build |
|
|
| `browserstack_get_session` | Get session details (video, logs) |
|
|
| `browserstack_update_session` | Mark pass/fail |
|
|
| `browserstack_get_logs` | Get text/network logs |
|
|
|
|
## Output
|
|
|
|
- Cross-browser test results table
|
|
- Per-browser pass/fail status
|
|
- Links to BrowserStack dashboard for video/screenshots
|
|
- Any browser-specific failures highlighted
|