-
Notifications
You must be signed in to change notification settings - Fork 0
/
generate-test-enumeration.js
99 lines (74 loc) · 2.63 KB
/
generate-test-enumeration.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
const jest = require('jest');
const fs = require('fs');
async function runTests() {
try {
const config = {
preset: 'ts-jest',
testEnvironment: 'node',
clearMocks: true,
restoreMocks: true,
coverageProvider: "v8",
moduleFileExtensions: ["js", "jsx", "ts", "tsx", "json", "node"],
transform: {
"^.+\\.(ts|tsx|js)$": "ts-jest",
},
};
const { results } = await jest.runCLI(config, [process.cwd()]);
// Generate Markdown file
generateMarkdown(results.testResults);
if (results.success) {
console.log('All tests passed!');
} else {
console.log('Some tests failed.');
}
} catch (error) {
console.error('Error running Jest tests:', error);
}
}
function generateMarkdown(jsonData) {
const testResults = [];
for (let index = 0; index < jsonData.length; index++) {
const element = jsonData[index].testResults.map(formatTestResult).join('\n');
testResults.push(element);
}
const markdownContent = `
# OSW Data Service Unit Test Cases
THIS IS AUTOGENERATED DOCUMENT via generate-test-enumeration.js script
## Purpose
This document details the unit test cases for the [OSW Data Service](https://github.com/TaskarCenterAtUW/TDEI-osw-datasvc-ts)
------------
## Test Framework
Unit test cases are to be written using [Jest](https://jestjs.io/ "Jest")
------------
### Jest code pattern
\`\`\`javascript
describe("User Controller", () => {
describe("Get List", () => {
describe("Functional", () => {
const getTestData => return {};
it('{{Scenario}}, {{Expectation}}', () => {
//Arrange
let testData = getTestData();
let controller = new controller();
//Act
const result = controller.getVersions();
//Assert
expect(result.status).toBe(200);
expect(result.myAwesomeField).toBe('valid');
});
});
});
});
\`\`\`
------------
## Test Cases
|Feature Under Test | Test Case Description | Status |
|-------------------------------------------------------------------------------------|---------|---------------|
${testResults.join('\n')}`;
fs.writeFileSync('test-enumeration.md', markdownContent);
}
function formatTestResult(testResult) {
return `| ${testResult.ancestorTitles.join(' -> ')} | ${testResult.title} | ${testResult.status} |`;
}
// Run the tests
runTests();