|
| 1 | +/** |
| 2 | + * @fileoverview Unit tests for coverage output formatters. |
| 3 | + * |
| 4 | + * Covers `formatCoverage` (default/simple/json formats) and |
| 5 | + * `getCoverageEmoji` (every threshold band). |
| 6 | + */ |
| 7 | + |
| 8 | +import { describe, expect, it } from 'vitest' |
| 9 | + |
| 10 | +import { |
| 11 | + formatCoverage, |
| 12 | + getCoverageEmoji, |
| 13 | +} from '@socketsecurity/lib/cover/formatters' |
| 14 | + |
| 15 | +const sampleCode = { |
| 16 | + statements: { covered: 85, total: 100, percent: '85.00' }, |
| 17 | + branches: { covered: 80, total: 100, percent: '80.00' }, |
| 18 | + functions: { covered: 90, total: 100, percent: '90.00' }, |
| 19 | + lines: { covered: 88, total: 100, percent: '88.00' }, |
| 20 | +} |
| 21 | + |
| 22 | +describe('cover/formatters', () => { |
| 23 | + describe('getCoverageEmoji', () => { |
| 24 | + it('returns rocket for >= 99%', () => { |
| 25 | + expect(getCoverageEmoji(99)).toBe(' 🚀') |
| 26 | + expect(getCoverageEmoji(100)).toBe(' 🚀') |
| 27 | + }) |
| 28 | + |
| 29 | + it('returns target for >= 95%', () => { |
| 30 | + expect(getCoverageEmoji(95)).toBe(' 🎯') |
| 31 | + expect(getCoverageEmoji(98.99)).toBe(' 🎯') |
| 32 | + }) |
| 33 | + |
| 34 | + it('returns sparkles for >= 90%', () => { |
| 35 | + expect(getCoverageEmoji(90)).toBe(' ✨') |
| 36 | + expect(getCoverageEmoji(94.99)).toBe(' ✨') |
| 37 | + }) |
| 38 | + |
| 39 | + it('returns heart for >= 85%', () => { |
| 40 | + expect(getCoverageEmoji(85)).toBe(' 💚') |
| 41 | + expect(getCoverageEmoji(89.99)).toBe(' 💚') |
| 42 | + }) |
| 43 | + |
| 44 | + it('returns check for >= 80%', () => { |
| 45 | + expect(getCoverageEmoji(80)).toBe(' ✅') |
| 46 | + }) |
| 47 | + |
| 48 | + it('returns green-circle for >= 70%', () => { |
| 49 | + expect(getCoverageEmoji(70)).toBe(' 🟢') |
| 50 | + }) |
| 51 | + |
| 52 | + it('returns yellow-circle for >= 60%', () => { |
| 53 | + expect(getCoverageEmoji(60)).toBe(' 🟡') |
| 54 | + }) |
| 55 | + |
| 56 | + it('returns hammer for >= 50%', () => { |
| 57 | + expect(getCoverageEmoji(50)).toBe(' 🔨') |
| 58 | + }) |
| 59 | + |
| 60 | + it('returns warning for < 50%', () => { |
| 61 | + expect(getCoverageEmoji(49)).toBe(' ⚠️') |
| 62 | + expect(getCoverageEmoji(0)).toBe(' ⚠️') |
| 63 | + }) |
| 64 | + |
| 65 | + it('handles negative percentages by returning empty string', () => { |
| 66 | + // No threshold matches; .find returns undefined → '' fallback. |
| 67 | + expect(getCoverageEmoji(-1)).toBe('') |
| 68 | + }) |
| 69 | + }) |
| 70 | + |
| 71 | + describe('formatCoverage', () => { |
| 72 | + it('produces a default human-readable report', () => { |
| 73 | + const out = formatCoverage({ code: sampleCode }) |
| 74 | + expect(out).toContain('Code Coverage:') |
| 75 | + expect(out).toContain('Statements: 85.00%') |
| 76 | + expect(out).toContain('Branches: 80.00%') |
| 77 | + expect(out).toContain('Functions: 90.00%') |
| 78 | + expect(out).toContain('Lines: 88.00%') |
| 79 | + expect(out).toContain('Overall: 85.75%') |
| 80 | + }) |
| 81 | + |
| 82 | + it('returns JSON when format=json', () => { |
| 83 | + const out = formatCoverage({ code: sampleCode, format: 'json' }) |
| 84 | + const parsed = JSON.parse(out) |
| 85 | + expect(parsed.code).toEqual(sampleCode) |
| 86 | + }) |
| 87 | + |
| 88 | + it('returns just the overall percent when format=simple', () => { |
| 89 | + const out = formatCoverage({ code: sampleCode, format: 'simple' }) |
| 90 | + expect(out).toBe('85.75') |
| 91 | + }) |
| 92 | + |
| 93 | + it('includes type coverage section when present', () => { |
| 94 | + const out = formatCoverage({ |
| 95 | + code: sampleCode, |
| 96 | + type: { covered: 1500, total: 2000, percent: '75.00' }, |
| 97 | + }) |
| 98 | + expect(out).toContain('Type Coverage:') |
| 99 | + expect(out).toContain('75.00% (1500/2000)') |
| 100 | + }) |
| 101 | + |
| 102 | + it('includes type in overall average when present', () => { |
| 103 | + const out = formatCoverage({ |
| 104 | + code: sampleCode, |
| 105 | + type: { covered: 5, total: 10, percent: '50.00' }, |
| 106 | + format: 'simple', |
| 107 | + }) |
| 108 | + // average of (85, 80, 90, 88, 50) = 78.6 |
| 109 | + expect(out).toBe('78.60') |
| 110 | + }) |
| 111 | + |
| 112 | + it('handles NaN percent values as 0', () => { |
| 113 | + const broken = { |
| 114 | + statements: { covered: 0, total: 0, percent: 'NaN' }, |
| 115 | + branches: { covered: 0, total: 0, percent: 'NaN' }, |
| 116 | + functions: { covered: 0, total: 0, percent: 'NaN' }, |
| 117 | + lines: { covered: 0, total: 0, percent: 'NaN' }, |
| 118 | + } |
| 119 | + const out = formatCoverage({ code: broken, format: 'simple' }) |
| 120 | + expect(out).toBe('0.00') |
| 121 | + }) |
| 122 | + |
| 123 | + it('appends an emoji to the overall line in default format', () => { |
| 124 | + const out = formatCoverage({ code: sampleCode }) |
| 125 | + // 85.75% overall → 💚 band. |
| 126 | + expect(out).toContain('💚') |
| 127 | + }) |
| 128 | + }) |
| 129 | +}) |
0 commit comments