Skip to content

Commit 37d2390

Browse files
vergissberlinvergissberlin
committed
test(api): add CodeStats API mocks and regression tests; harden parsing and chart generation
- Add comprehensive API mocks (success, empty, many, beginner, expert, errors) - Add API validation tests and E2E-style integration tests with mocks - Harden buildChart to filter invalid/negative XP and handle errors safely - Make replaceCodestatsSection robust to invalid inputs - Fix createOptions defaults (readmeFile, graph width, git message, token) - Adjust tests to improved behavior and edge-case handling All tests passing (30/30). Coverage at 100% via v8 report.
1 parent caebc87 commit 37d2390

File tree

6 files changed

+888
-12
lines changed

6 files changed

+888
-12
lines changed

‎index.js‎

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ function createOptions() {
2424
profile: `https://codestats.net/users/${process.env.INPUT_CODESTATS_USERNAME}`
2525
},
2626
git: {
27-
username: String(process.env.GITHUB_ACTOR) || 'CodeStats bot',
28-
message: String(process.env.INPUT_COMMIT_MESSAGE) || 'Update codestats metrics',
29-
token: String(process.env.INPUT_GITHUB_TOKEN)
27+
username: process.env.GITHUB_ACTOR ? String(process.env.GITHUB_ACTOR) : 'CodeStats bot',
28+
message: process.env.INPUT_COMMIT_MESSAGE ? String(process.env.INPUT_COMMIT_MESSAGE) : 'Update codestats metrics',
29+
token: process.env.INPUT_GITHUB_TOKEN ? String(process.env.INPUT_GITHUB_TOKEN) : ''
3030
},
3131
graph: {
3232
width: Number(process.env.INPUT_GRAPH_WIDTH) || 42
3333
},
34-
readmeFile: String(process.env.INPUT_README_FILE) ? `${process.env.INPUT_README_FILE}` : `./README.md`,
34+
readmeFile: process.env.INPUT_README_FILE ? String(process.env.INPUT_README_FILE) : './README.md',
3535
show: {
3636
title: Boolean(process.env.INPUT_SHOW_TITLE) || false,
3737
link: Boolean(process.env.INPUT_SHOW_LINK) || false
@@ -84,16 +84,43 @@ const makeCommitChanges = function (opts) {
8484
const buildChart = function (data, width = 42) {
8585
let languageChart = {}
8686

87-
data.sort(function (a, b) {
87+
// Filter out invalid entries and ensure numeric xps values
88+
const validData = data.filter(([key, value]) => {
89+
return key &&
90+
value &&
91+
typeof value === 'object' &&
92+
typeof value.xps === 'number' &&
93+
value.xps >= 0 &&
94+
isFinite(value.xps)
95+
})
96+
97+
// Return empty string if no valid data
98+
if (validData.length === 0) {
99+
return ''
100+
}
101+
102+
validData.sort(function (a, b) {
88103
return b[1].xps - a[1].xps
89104
})
90-
data = data.slice(0, 6)
91-
data.forEach(([key, value]) => {
105+
const topLanguages = validData.slice(0, 6)
106+
topLanguages.forEach(([key, value]) => {
92107
languageChart = Object.assign(languageChart, {
93108
[key]: value.xps
94109
})
95110
})
96-
return bars(languageChart, { bar: '█', width })
111+
112+
// Handle empty chart case
113+
if (Object.keys(languageChart).length === 0) {
114+
return ''
115+
}
116+
117+
try {
118+
return bars(languageChart, { bar: '█', width })
119+
} catch (error) {
120+
// If bars library fails, return empty string
121+
console.error('Chart generation failed:', error)
122+
return ''
123+
}
97124
}
98125

99126
/**
@@ -106,6 +133,15 @@ const buildChart = function (data, width = 42) {
106133
* @returns {string}
107134
*/
108135
const replaceCodestatsSection = function (markdown, content, header = '', footer = '') {
136+
// Ensure all parameters are strings
137+
if (typeof markdown !== 'string') {
138+
console.error('replaceCodestatsSection: markdown must be a string')
139+
return ''
140+
}
141+
if (typeof content !== 'string') content = ''
142+
if (typeof header !== 'string') header = ''
143+
if (typeof footer !== 'string') footer = ''
144+
109145
const replacement = `<!-- START_SECTION:codestats -->\n${header}\`\`\`text\n${content}\`\`\`\n${footer}<!-- END_SECTION:codestats -->`
110146
return markdown.replace(
111147
/((<!--.*START_SECTION:codestats.*-->)([\s\S]+)(<!--.*END_SECTION:codestats.*-->))/g,

‎node_modules/.vite/vitest/da39a3ee5e6b4b0d3255bfef95601890afd80709/results.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/README.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Test Suite Documentation
2+
3+
## Overview
4+
5+
This test suite provides comprehensive validation of the CodeStats API integration and ensures regression-proof functionality.
6+
7+
## Test Structure
8+
9+
### 1. Mock Data (`mocks/codestats-api.mock.js`)
10+
11+
Provides realistic mock data based on the actual CodeStats API structure:
12+
13+
- **`mockResponses`**: Various user scenarios (beginner, expert, empty user, etc.)
14+
- **`errorResponses`**: Error scenarios (404, 500, malformed JSON, network errors)
15+
- **`mockFetch`**: Mock fetch implementation that returns different responses based on username
16+
17+
### 2. API Validation Tests (`api-validation.test.js`)
18+
19+
Comprehensive tests covering:
20+
21+
- **API Response Structure Validation**: Ensures all required fields are present
22+
- **API Usage Correctness**: Validates correct API endpoints and error handling
23+
- **Language Data Processing**: Tests sorting, limiting, and edge cases
24+
- **Environment Variable Validation**: Tests configuration handling
25+
- **Malformed Response Handling**: Tests robustness against invalid data
26+
27+
### 3. Integration Tests (`index.test.js`)
28+
29+
Extended with end-to-end mock integration:
30+
31+
- **Complete Workflow Testing**: Full process from API call to file update
32+
- **Chart Generation**: Tests with real API structure
33+
- **README Replacement**: Tests complete content replacement workflow
34+
- **Multi-scenario Testing**: Tests different user types and edge cases
35+
36+
## Mock Data Scenarios
37+
38+
### User Types
39+
40+
1. **`testuser`** - Standard user with multiple languages
41+
2. **`newuser`** - Empty user with no languages
42+
3. **`singleuser`** - User with only one language
43+
4. **`polyglot`** - User with many languages (tests 6-language limit)
44+
5. **`beginner`** - User with very low XP values
45+
6. **`expert`** - User with very high XP values
46+
47+
### Error Scenarios
48+
49+
1. **`notfound`** - Returns 404 Not Found
50+
2. **`servererror`** - Returns 500 Internal Server Error
51+
3. **`malformed`** - Returns malformed JSON
52+
4. **`networkerror`** - Throws network error
53+
54+
## API Structure Validation
55+
56+
The tests validate that the API response matches this structure:
57+
58+
```javascript
59+
{
60+
"user": "username",
61+
"languages": {
62+
"JavaScript": {
63+
"xps": 188377,
64+
"new_xps": 0
65+
}
66+
// ... more languages
67+
},
68+
"dates": {
69+
"2024-01-01": 1234
70+
// ... more dates
71+
},
72+
"machines": {
73+
"machine-name": {
74+
"xps": 12345,
75+
"new_xps": 0
76+
}
77+
},
78+
"total_xp": 123456,
79+
"new_xp": 15
80+
}
81+
```
82+
83+
## Running Tests
84+
85+
```bash
86+
# Run all tests
87+
pnpm test
88+
89+
# Run with coverage
90+
pnpm test:coverage
91+
92+
# Run specific test file
93+
pnpm test api-validation.test.js
94+
95+
# Run in watch mode
96+
pnpm test --watch
97+
```
98+
99+
## Test Coverage
100+
101+
The test suite covers:
102+
103+
- ✅ API endpoint correctness
104+
- ✅ Response structure validation
105+
- ✅ Error handling (404, 500, network errors)
106+
- ✅ Data processing and chart generation
107+
- ✅ Language sorting and limiting
108+
- ✅ Edge cases (empty data, extreme values)
109+
- ✅ Environment variable handling
110+
- ✅ README content replacement
111+
- ✅ End-to-end workflow
112+
113+
## Regression Protection
114+
115+
The tests protect against:
116+
117+
- API response structure changes
118+
- Data processing logic errors
119+
- Chart generation format changes
120+
- Error handling regressions
121+
- Environment variable parsing issues
122+
- File operation errors
123+
124+
## Adding New Tests
125+
126+
1. **API Changes**: Update `codestats-api.mock.js` with new response structure
127+
2. **New Features**: Add corresponding tests to `api-validation.test.js`
128+
3. **Integration**: Extend `index.test.js` with new end-to-end scenarios
129+
130+
## Mock vs. Real API
131+
132+
Tests use mock data by default for:
133+
- Fast execution
134+
- Consistent results
135+
- Testing error scenarios
136+
- Offline development
137+
138+
For manual verification with real API:
139+
```javascript
140+
// Temporarily replace mockFetch with real fetch
141+
global.fetch = fetch
142+
```

0 commit comments

Comments
 (0)