|
| 1 | +--- |
| 2 | +name: Test Suite Improvement |
| 3 | +about: Track systematic test suite improvements to increase pass rate |
| 4 | +title: 'test: [Component/Service] - Fix failing tests' |
| 5 | +labels: testing, technical-debt, good-first-issue |
| 6 | +assignees: '' |
| 7 | +--- |
| 8 | + |
| 9 | +## Context |
| 10 | + |
| 11 | +Part of the Test Suite Improvement Roadmap to increase test pass rate from 67.7% to 95%+. |
| 12 | + |
| 13 | +**Related**: See `docs/test-suite-improvement-roadmap.md` for full context. |
| 14 | + |
| 15 | +## Problem |
| 16 | + |
| 17 | +<!-- Describe the current test failures --> |
| 18 | + |
| 19 | +**Failing Tests**: X tests in Y file(s) |
| 20 | + |
| 21 | +**Files Affected**: |
| 22 | +- `path/to/test-file.test.ts` |
| 23 | + |
| 24 | +**Root Cause**: |
| 25 | +<!-- Brief description of why tests are failing --> |
| 26 | + |
| 27 | +## Proposed Solution |
| 28 | + |
| 29 | +<!-- Describe the fix approach --> |
| 30 | + |
| 31 | +### Changes Required |
| 32 | + |
| 33 | +1. **Mock Setup**: |
| 34 | + ```typescript |
| 35 | + // Example mock changes |
| 36 | + ``` |
| 37 | + |
| 38 | +2. **Test Refactoring**: |
| 39 | + - [ ] Convert to ES modules (if needed) |
| 40 | + - [ ] Add proper mocking |
| 41 | + - [ ] Fix timing issues |
| 42 | + - [ ] Update assertions |
| 43 | + |
| 44 | +3. **Test Infrastructure**: |
| 45 | + - [ ] Create reusable mocks (if applicable) |
| 46 | + - [ ] Document patterns |
| 47 | + |
| 48 | +### Expected Outcome |
| 49 | + |
| 50 | +- [ ] All X tests passing |
| 51 | +- [ ] TypeScript strict mode compliant |
| 52 | +- [ ] Tests run in < Y seconds |
| 53 | +- [ ] No test duplication |
| 54 | +- [ ] Proper mocking (no real API/DB calls) |
| 55 | + |
| 56 | +## Implementation Checklist |
| 57 | + |
| 58 | +### Development |
| 59 | +- [ ] Read `docs/test-suite-improvement-roadmap.md` |
| 60 | +- [ ] Review similar patterns in existing fixed tests |
| 61 | +- [ ] Set up local environment |
| 62 | +- [ ] Run failing tests to reproduce |
| 63 | +- [ ] Implement fixes incrementally |
| 64 | +- [ ] Run `npm run type-check` |
| 65 | +- [ ] Run `npm run lint` |
| 66 | +- [ ] Run affected tests: `npm run test -- path/to/test` |
| 67 | + |
| 68 | +### Testing |
| 69 | +- [ ] All targeted tests passing |
| 70 | +- [ ] No new test failures introduced |
| 71 | +- [ ] Full test suite pass rate improved |
| 72 | +- [ ] Tests complete in reasonable time |
| 73 | +- [ ] Tests are deterministic (no flakiness) |
| 74 | + |
| 75 | +### Documentation |
| 76 | +- [ ] Update test comments if needed |
| 77 | +- [ ] Document any new mock patterns |
| 78 | +- [ ] Update roadmap with progress |
| 79 | +- [ ] Add example to tests/README.md (if new pattern) |
| 80 | + |
| 81 | +### Code Review |
| 82 | +- [ ] Self-review completed |
| 83 | +- [ ] No functional code changes (test-only PR) |
| 84 | +- [ ] Follows existing test patterns |
| 85 | +- [ ] Proper commit messages |
| 86 | +- [ ] PR description includes test results |
| 87 | + |
| 88 | +## Acceptance Criteria |
| 89 | + |
| 90 | +- [ ] All X tests passing (was: Y failing) |
| 91 | +- [ ] Test suite pass rate increased by Z% |
| 92 | +- [ ] No regressions in other tests |
| 93 | +- [ ] TypeScript/ESLint passing |
| 94 | +- [ ] Documentation updated (if new patterns) |
| 95 | + |
| 96 | +## Test Results |
| 97 | + |
| 98 | +### Before |
| 99 | +``` |
| 100 | +Test Files N failed | M passed (total) |
| 101 | + Tests X failed | Y passed (total) |
| 102 | +``` |
| 103 | + |
| 104 | +### After |
| 105 | +``` |
| 106 | +Test Files 0 failed | N+M passed (total) |
| 107 | + Tests 0 failed | X+Y passed (total) |
| 108 | +``` |
| 109 | + |
| 110 | +## Related Issues |
| 111 | + |
| 112 | +<!-- Link to other test improvement issues --> |
| 113 | + |
| 114 | +- Part of: Test Suite Improvement Roadmap |
| 115 | +- Depends on: #XXX (if applicable) |
| 116 | +- Blocks: #XXX (if applicable) |
| 117 | + |
| 118 | +## Priority |
| 119 | + |
| 120 | +<!-- Select one --> |
| 121 | +- [ ] P1 - Critical (blocks production) |
| 122 | +- [ ] P2 - Important (blocks features) |
| 123 | +- [ ] P3 - Nice to have (quality improvement) |
| 124 | + |
| 125 | +## Estimated Effort |
| 126 | + |
| 127 | +<!-- Select one --> |
| 128 | +- [ ] Small (< 4 hours) |
| 129 | +- [ ] Medium (4-8 hours) |
| 130 | +- [ ] Large (1-2 days) |
| 131 | +- [ ] X-Large (> 2 days) |
| 132 | + |
| 133 | +## Notes |
| 134 | + |
| 135 | +<!-- Any additional context, gotchas, or considerations --> |
0 commit comments