|
| 1 | +# Color Palette Generator - Test Suite |
| 2 | + |
| 3 | +Comprehensive test suite for the Color Palette Generator web application. |
| 4 | + |
| 5 | +## Running Tests |
| 6 | + |
| 7 | +### Browser Tests (Recommended) |
| 8 | + |
| 9 | +Open `test.html` in a web browser: |
| 10 | + |
| 11 | +```bash |
| 12 | +# From the webapp/tests directory |
| 13 | +open test.html # macOS |
| 14 | +xdg-open test.html # Linux |
| 15 | +start test.html # Windows |
| 16 | +``` |
| 17 | + |
| 18 | +Or use a local server: |
| 19 | + |
| 20 | +```bash |
| 21 | +# From the webapp directory |
| 22 | +python -m http.server 8000 |
| 23 | +# Then navigate to http://localhost:8000/tests/test.html |
| 24 | +``` |
| 25 | + |
| 26 | +The tests will run automatically when the page loads. You can also click the "Run All Tests" button to re-run them. |
| 27 | + |
| 28 | +## Test Coverage |
| 29 | + |
| 30 | +### 1. Color Generation (3 tests) |
| 31 | +- ✓ Validates hex color format generation |
| 32 | +- ✓ Ensures randomness in color generation |
| 33 | +- ✓ Validates color name generation |
| 34 | + |
| 35 | +### 2. Palette Generation (4 tests) |
| 36 | +- ✓ Confirms 5 colors are generated |
| 37 | +- ✓ Validates palette structure (hex + name) |
| 38 | +- ✓ Checks DOM element creation |
| 39 | +- ✓ Verifies hex code display formatting |
| 40 | + |
| 41 | +### 3. Color Locking (3 tests) |
| 42 | +- ✓ Tests lock toggle functionality |
| 43 | +- ✓ Validates unlock functionality |
| 44 | +- ✓ Ensures locked colors persist across regenerations |
| 45 | + |
| 46 | +### 4. Palette Storage (4 tests) |
| 47 | +- ✓ Tests saving to localStorage |
| 48 | +- ✓ Validates saved palette structure |
| 49 | +- ✓ Tests loading saved palettes |
| 50 | +- ✓ Verifies clear functionality |
| 51 | + |
| 52 | +### 5. UI Interactions (4 tests) |
| 53 | +- ✓ Copy indicator visibility |
| 54 | +- ✓ Saved palettes display/hide logic |
| 55 | +- ✓ Lock icon state changes |
| 56 | +- ✓ UI element updates |
| 57 | + |
| 58 | +### 6. Hex Color Validation (2 tests) |
| 59 | +- ✓ Validates hex color range (0x000000 to 0xFFFFFF) |
| 60 | +- ✓ Ensures proper padding of hex values |
| 61 | + |
| 62 | +## Test Framework |
| 63 | + |
| 64 | +The test suite uses a custom lightweight test framework that includes: |
| 65 | + |
| 66 | +- **Test Runner**: Organizes and executes test suites |
| 67 | +- **Assertions**: Comprehensive assertion library |
| 68 | +- **Async Support**: Handles asynchronous operations |
| 69 | +- **Visual Feedback**: Real-time test results with pass/fail indicators |
| 70 | +- **Summary Statistics**: Overview of test execution |
| 71 | + |
| 72 | +## Assertions Available |
| 73 | + |
| 74 | +```javascript |
| 75 | +assert.equals(actual, expected, message) |
| 76 | +assert.true(value, message) |
| 77 | +assert.false(value, message) |
| 78 | +assert.exists(value, message) |
| 79 | +assert.isType(value, type, message) |
| 80 | +assert.matches(value, regex, message) |
| 81 | +assert.greaterThan(actual, expected, message) |
| 82 | +assert.arrayLength(array, length, message) |
| 83 | +assert.includes(container, value, message) |
| 84 | +``` |
| 85 | + |
| 86 | +## Test Structure |
| 87 | + |
| 88 | +Each test suite follows this pattern: |
| 89 | + |
| 90 | +```javascript |
| 91 | +runner.suite('Suite Name', ({ test }) => { |
| 92 | + test('test description', async () => { |
| 93 | + // Test implementation |
| 94 | + const appWindow = await loadApp(); |
| 95 | + // Assertions |
| 96 | + assert.equals(actual, expected); |
| 97 | + }); |
| 98 | +}); |
| 99 | +``` |
| 100 | + |
| 101 | +## Key Features Tested |
| 102 | + |
| 103 | +1. **Core Functionality** |
| 104 | + - Random color generation |
| 105 | + - Palette initialization |
| 106 | + - Color locking mechanism |
| 107 | + |
| 108 | +2. **Persistence** |
| 109 | + - LocalStorage integration |
| 110 | + - Save/load operations |
| 111 | + - Clear functionality |
| 112 | + |
| 113 | +3. **User Interface** |
| 114 | + - DOM manipulation |
| 115 | + - Event handling |
| 116 | + - Visual feedback |
| 117 | + |
| 118 | +4. **Data Validation** |
| 119 | + - Hex color format |
| 120 | + - Color range validation |
| 121 | + - Palette structure |
| 122 | + |
| 123 | +## Expected Results |
| 124 | + |
| 125 | +All tests should pass when the Color Palette Generator is functioning correctly. The test summary will show: |
| 126 | + |
| 127 | +- Total tests: 20 |
| 128 | +- All tests should pass (green) |
| 129 | +- Duration: typically under 500ms |
| 130 | + |
| 131 | +## Troubleshooting |
| 132 | + |
| 133 | +### Tests Not Running |
| 134 | + |
| 135 | +1. Ensure you're accessing `test.html` via a web server or `file://` protocol |
| 136 | +2. Check browser console for any errors |
| 137 | +3. Verify `../index.html` path is correct relative to test file |
| 138 | + |
| 139 | +### Test Failures |
| 140 | + |
| 141 | +If tests fail, check: |
| 142 | + |
| 143 | +1. The main `index.html` file has all required functions |
| 144 | +2. localStorage is enabled in your browser |
| 145 | +3. The app initializes correctly in an iframe |
| 146 | + |
| 147 | +### Cross-Browser Testing |
| 148 | + |
| 149 | +This test suite has been designed to work in: |
| 150 | +- Chrome/Edge (latest) |
| 151 | +- Firefox (latest) |
| 152 | +- Safari (latest) |
| 153 | + |
| 154 | +## Continuous Integration |
| 155 | + |
| 156 | +To integrate these tests into a CI/CD pipeline, consider using: |
| 157 | + |
| 158 | +- **Playwright**: For headless browser testing |
| 159 | +- **Puppeteer**: For Chrome-based automated testing |
| 160 | +- **Selenium**: For multi-browser testing |
| 161 | + |
| 162 | +Example Playwright test runner: |
| 163 | + |
| 164 | +```javascript |
| 165 | +const { chromium } = require('playwright'); |
| 166 | + |
| 167 | +(async () => { |
| 168 | + const browser = await chromium.launch(); |
| 169 | + const page = await browser.newPage(); |
| 170 | + await page.goto('file://path/to/tests/test.html'); |
| 171 | + await page.waitForTimeout(2000); |
| 172 | + const failed = await page.locator('#failed-tests').textContent(); |
| 173 | + await browser.close(); |
| 174 | + process.exit(parseInt(failed) === 0 ? 0 : 1); |
| 175 | +})(); |
| 176 | +``` |
| 177 | + |
| 178 | +## Future Enhancements |
| 179 | + |
| 180 | +Potential additions to the test suite: |
| 181 | + |
| 182 | +- [ ] Clipboard functionality tests |
| 183 | +- [ ] Keyboard shortcut tests (SPACE key) |
| 184 | +- [ ] Animation timing tests |
| 185 | +- [ ] Accessibility tests |
| 186 | +- [ ] Performance benchmarks |
| 187 | +- [ ] Visual regression tests |
| 188 | +- [ ] Edge case handling (invalid colors, storage limits) |
| 189 | + |
| 190 | +## Contributing |
| 191 | + |
| 192 | +When adding new features to the Color Palette Generator: |
| 193 | + |
| 194 | +1. Add corresponding tests to this suite |
| 195 | +2. Ensure all existing tests still pass |
| 196 | +3. Update this README with new test coverage |
| 197 | +4. Follow the existing test structure and naming conventions |
0 commit comments