Story 4.2: Fix lint errors and code review findings
- Remove unused StripOverlayLayer import and stripOverlayLayer variable from module.js - Add comprehensive JSDoc annotations to FoundryAdapter.js methods (settings, socket, users, scenes, notifications, hooks) - Add /* global Dialog */ comment to PlayerPrivacyPanel.js for ESLint - Remove unused _force parameter from GMPlayerPrivacySelector.js render() method - Fix PlayerPrivacyPanelMenu.js: add constructor() to fallback class and call super() All 862 unit tests passing. All Story 4.2 acceptance criteria met. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
@@ -0,0 +1,176 @@
|
||||
---
|
||||
name: bmad-qa-generate-e2e-tests
|
||||
description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"'
|
||||
---
|
||||
|
||||
# QA Generate E2E Tests Workflow
|
||||
|
||||
**Goal:** Generate automated API and E2E tests for implemented code.
|
||||
|
||||
**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that).
|
||||
|
||||
## Conventions
|
||||
|
||||
- Bare paths (e.g. `checklist.md`) resolve from the skill root.
|
||||
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||
- `{skill-name}` resolves to the skill directory's basename.
|
||||
|
||||
## On Activation
|
||||
|
||||
### Step 1: Resolve the Workflow Block
|
||||
|
||||
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||
|
||||
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
||||
|
||||
1. `{skill-root}/customize.toml` — defaults
|
||||
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||
|
||||
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
||||
|
||||
### Step 2: Execute Prepend Steps
|
||||
|
||||
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||
|
||||
### Step 3: Load Persistent Facts
|
||||
|
||||
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
||||
|
||||
### Step 4: Load Config
|
||||
|
||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `user_name`
|
||||
- `communication_language`, `document_output_language`
|
||||
- `implementation_artifacts`
|
||||
- `date` as system-generated current datetime
|
||||
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Step 5: Greet the User
|
||||
|
||||
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||
|
||||
### Step 6: Execute Append Steps
|
||||
|
||||
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||
|
||||
Activation is complete. Begin the workflow below.
|
||||
|
||||
## Paths
|
||||
|
||||
- `test_dir` = `{project-root}/tests`
|
||||
- `source_dir` = `{project-root}`
|
||||
- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md`
|
||||
|
||||
## Execution
|
||||
|
||||
### Step 0: Detect Test Framework
|
||||
|
||||
Check project for existing test framework:
|
||||
|
||||
- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.)
|
||||
- Check for existing test files to understand patterns
|
||||
- Use whatever test framework the project already has
|
||||
- If no framework exists:
|
||||
- Analyze source code to determine project type (React, Vue, Node API, etc.)
|
||||
- Search online for current recommended test framework for that stack
|
||||
- Suggest the meta framework and use it (or ask user to confirm)
|
||||
|
||||
### Step 1: Identify Features
|
||||
|
||||
Ask user what to test:
|
||||
|
||||
- Specific feature/component name
|
||||
- Directory to scan (e.g., `src/components/`)
|
||||
- Or auto-discover features in the codebase
|
||||
|
||||
### Step 2: Generate API Tests (if applicable)
|
||||
|
||||
For API endpoints/services, generate tests that:
|
||||
|
||||
- Test status codes (200, 400, 404, 500)
|
||||
- Validate response structure
|
||||
- Cover happy path + 1-2 error cases
|
||||
- Use project's existing test framework patterns
|
||||
|
||||
### Step 3: Generate E2E Tests (if UI exists)
|
||||
|
||||
For UI features, generate tests that:
|
||||
|
||||
- Test user workflows end-to-end
|
||||
- Use semantic locators (roles, labels, text)
|
||||
- Focus on user interactions (clicks, form fills, navigation)
|
||||
- Assert visible outcomes
|
||||
- Keep tests linear and simple
|
||||
- Follow project's existing test patterns
|
||||
|
||||
### Step 4: Run Tests
|
||||
|
||||
Execute tests to verify they pass (use project's test command).
|
||||
|
||||
If failures occur, fix them immediately.
|
||||
|
||||
### Step 5: Create Summary
|
||||
|
||||
Output markdown summary:
|
||||
|
||||
```markdown
|
||||
# Test Automation Summary
|
||||
|
||||
## Generated Tests
|
||||
|
||||
### API Tests
|
||||
- [x] tests/api/endpoint.spec.ts - Endpoint validation
|
||||
|
||||
### E2E Tests
|
||||
- [x] tests/e2e/feature.spec.ts - User workflow
|
||||
|
||||
## Coverage
|
||||
- API endpoints: 5/10 covered
|
||||
- UI features: 3/8 covered
|
||||
|
||||
## Next Steps
|
||||
- Run tests in CI
|
||||
- Add more edge cases as needed
|
||||
```
|
||||
|
||||
## Keep It Simple
|
||||
|
||||
**Do:**
|
||||
|
||||
- Use standard test framework APIs
|
||||
- Focus on happy path + critical errors
|
||||
- Write readable, maintainable tests
|
||||
- Run tests to verify they pass
|
||||
|
||||
**Avoid:**
|
||||
|
||||
- Complex fixture composition
|
||||
- Over-engineering
|
||||
- Unnecessary abstractions
|
||||
|
||||
**For Advanced Features:**
|
||||
|
||||
If the project needs:
|
||||
|
||||
- Risk-based test strategy
|
||||
- Test design planning
|
||||
- Quality gates and NFR assessment
|
||||
- Comprehensive coverage analysis
|
||||
- Advanced testing patterns and utilities
|
||||
|
||||
> **Install Test Architect (TEA) module**: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
||||
|
||||
## Output
|
||||
|
||||
Save summary to: `{default_output_file}`
|
||||
|
||||
**Done!** Tests generated and verified. Validate against `./checklist.md`.
|
||||
|
||||
## On Complete
|
||||
|
||||
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||
|
||||
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||
@@ -0,0 +1,33 @@
|
||||
# QA Automate - Validation Checklist
|
||||
|
||||
## Test Generation
|
||||
|
||||
- [ ] API tests generated (if applicable)
|
||||
- [ ] E2E tests generated (if UI exists)
|
||||
- [ ] Tests use standard test framework APIs
|
||||
- [ ] Tests cover happy path
|
||||
- [ ] Tests cover 1-2 critical error cases
|
||||
|
||||
## Test Quality
|
||||
|
||||
- [ ] All generated tests run successfully
|
||||
- [ ] Tests use proper locators (semantic, accessible)
|
||||
- [ ] Tests have clear descriptions
|
||||
- [ ] No hardcoded waits or sleeps
|
||||
- [ ] Tests are independent (no order dependency)
|
||||
|
||||
## Output
|
||||
|
||||
- [ ] Test summary created
|
||||
- [ ] Tests saved to appropriate directories
|
||||
- [ ] Summary includes coverage metrics
|
||||
|
||||
## Validation
|
||||
|
||||
Run the tests using your project's test command.
|
||||
|
||||
**Expected**: All tests pass ✅
|
||||
|
||||
---
|
||||
|
||||
**Need more comprehensive testing?** Install [Test Architect (TEA)](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/) for advanced workflows.
|
||||
@@ -0,0 +1,41 @@
|
||||
# DO NOT EDIT -- overwritten on every update.
|
||||
#
|
||||
# Workflow customization surface for bmad-qa-generate-e2e-tests. Mirrors the
|
||||
# agent customization shape under the [workflow] namespace.
|
||||
|
||||
[workflow]
|
||||
|
||||
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||
|
||||
# Steps to run before the standard activation (config load, greet).
|
||||
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||
|
||||
activation_steps_prepend = []
|
||||
|
||||
# Steps to run after greet but before the workflow begins.
|
||||
# Overrides append. Use for context-heavy setup that should happen
|
||||
# once the user has been acknowledged.
|
||||
|
||||
activation_steps_append = []
|
||||
|
||||
# Persistent facts the workflow keeps in mind for the whole run
|
||||
# (standards, compliance constraints, stylistic guardrails).
|
||||
# Distinct from the runtime memory sidecar — these are static context
|
||||
# loaded on activation. Overrides append.
|
||||
#
|
||||
# Each entry is either:
|
||||
# - a literal sentence, e.g. "All tests must follow the project's existing test framework patterns."
|
||||
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||
|
||||
persistent_facts = [
|
||||
"file:{project-root}/**/project-context.md",
|
||||
]
|
||||
|
||||
# Scalar: executed when the workflow reaches Step 5 (Create Summary),
|
||||
# after all tests pass and the summary document is saved. Override wins.
|
||||
# Leave empty for no custom post-completion behavior.
|
||||
|
||||
on_complete = ""
|
||||
Reference in New Issue
Block a user