Skip to content

TESTING_GUIDE.md

Latest commit

 

History

History
202 lines (158 loc) · 5.08 KB

TESTING_GUIDE.md

File metadata and controls

202 lines (158 loc) · 5.08 KB

Visual Testing & Coverage Guide

📊 Viewing Test Results Visually

1. HTML Coverage Report (Best Practice)

This gives you a detailed, interactive view of code coverage:

npm run test:coverage:view

This will:

  • Run all tests with coverage metrics
  • Automatically open the HTML report in your browser
  • Show line-by-line coverage highlighting

What to look for:

  • 🟢 Green lines = covered by tests
  • 🟡 Yellow lines = partially covered
  • 🔴 Red lines = not covered

2. Terminal Coverage Table (Quick Check)

npm run test:coverage

Shows a summary table:

File             | % Stmts | % Branch | % Funcs | % Lines
cryptoRandom.js  |   100   |   100    |   100   |   100
entropy.js       |   100   |   100    |   100   |   100
generate.js      |   100   |   100    |   100   |   100

3. Verbose Test Output (Detailed Breakdown)

npm run test:verbose

Shows each test with pass/fail status, execution time, and clear formatting.

4. Watch Mode (Real-time Feedback)

npm run test:watch

Automatically reruns tests when you save files. Perfect for development!

✅ What "Kosher" Tests Look Like

Coverage Metrics

Your current metrics:

✅ Statements:  100% - Every line of code is executed
✅ Branches:    100% - All if/else paths are tested
✅ Functions:   100% - All functions are called
✅ Lines:       100% - All lines are covered

Best Practices Checklist

  • ✅ 52 tests passing - Good test count for 3 modules
  • ✅ 100% coverage - Every line of code is tested
  • ✅ Organized structure - Tests grouped by function/feature
  • ✅ Descriptive names - Easy to understand what each test does
  • ✅ Edge cases included - Invalid inputs, boundary conditions
  • ✅ Error handling tested - Checking throw behavior
  • ✅ No console errors - Clean test output

Test Organization Structure

tests/
├── unit/
│   ├── cryptoRandom.test.js    (11 tests)
│   ├── entropy.test.js         (14 tests)
│   └── generate.test.js        (22 tests)
└── README.md

🔍 Breakdown by Module

cryptoRandom.js

  • Tests: 11
  • Coverage: 100%
  • What's tested:
    • Valid range checking (0 to maxExclusive)
    • Invalid inputs (negative, zero, exceeds limit)
    • Distribution randomness
    • Boundary conditions

entropy.js

  • Tests: 14
  • Coverage: 100%
  • What's tested:
    • Correct entropy calculations
    • Edge cases (length 0, charset size 1)
    • Password strength scenarios
    • Large number handling

generate.js

  • Tests: 22 (most complex function)
  • Coverage: 100%
  • What's tested:
    • Password length accuracy
    • Character inclusion (lowercase, uppercase, digits, symbols)
    • Character exclusion (when disabled)
    • Default parameters
    • Randomness & uniqueness
    • Error handling (no sets selected)
    • All parameter combinations

🚨 Red Flags (What NOT to Do)

❌ Low coverage - Below 80% means untested code ❌ Failing tests - Some code isn't working as expected ❌ No edge case tests - Only testing happy path ❌ Duplicate tests - Same test written multiple times ❌ Flaky tests - Tests that sometimes pass, sometimes fail ❌ Poor test names - Can't tell what the test does ❌ Testing internals only - Not testing user-facing behavior

📈 Coverage Reports in Detail

When you run npm run test:coverage:view, you'll see:

  1. Coverage Summary - Overall percentages
  2. File List - Click any file to see line-by-line coverage
  3. Color Coding:
    • Green: Covered by at least one test
    • Red: Not covered
    • Pink: Partially covered (some branches only)

Example: Click on generate.js to see:

10  ✅ export function generatePassword({
11  ✅     length = 16,
12  ✅     lowerCase = true,
    ...
    (All lines highlighted in green = fully tested)

🎯 Running Tests in Different Scenarios

Before committing code

npm test -- --coverage --detectOpenHandles

During development (live reloading)

npm run test:watch

For debugging a specific test

npm run test:debug
# Then open chrome://inspect in Chrome

CI/CD Pipeline

npm test -- --coverage --bail --detectOpenHandles
  • --bail: Stop on first failure
  • --coverage: Generate coverage reports
  • --detectOpenHandles: Find resource leaks

📋 Summary: Your Current Status

Metric Value Status
Test Suites 3 ✅ Pass
Total Tests 52 ✅ Pass
Coverage 100% ✅ Excellent
Statements 100% ✅ All covered
Branches 100% ✅ All paths tested
Functions 100% ✅ All called

Verdict: Your test suite is comprehensive and production-ready! 🎉

🔗 Next Steps

  1. View HTML report: npm run test:coverage:view
  2. Use watch mode while coding: npm run test:watch
  3. Run full validation before commits: npm test -- --coverage --detectOpenHandles
  4. Keep coverage at 100% as you add new features

All tests are looking kosher! 👍