-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathreport.js
More file actions
208 lines (186 loc) · 7.58 KB
/
report.js
File metadata and controls
208 lines (186 loc) · 7.58 KB
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
const core = require('@actions/core')
const table = require('markdown-table')
const replaceComment = require('@aki77/actions-replace-comment')
const gradientBadge = require('gradient-badge');
const github = require('@actions/github')
const fs = require('fs')
const csv = require('csv-parser')
const report = async(files, threshold,badgePath) => {
const moduleCoverage = await filterReport(files)
const overAllCoverageVal = await overallCoverage(moduleCoverage)
setOutputVariables(overAllCoverageVal);
const issue_number = github.context.issue.number
if (issue_number) {
let bodyText = await markdownTable(moduleCoverage, overAllCoverageVal, threshold)
core.info(bodyText)
core.info(issue_number)
core.info(github.context.repo.repo)
core.info(github.context.repo.owner)
await replaceComment.default({
token: core.getInput('token', { required: true }),
owner: github.context.repo.owner,
repo: github.context.repo.repo,
issue_number: issue_number,
body: bodyText
})
}
const svgString = gradientBadge({
subject: 'Coverage',
status: String(overAllCoverageVal['line_percent'].toFixed(2)),
style: 'flat',
gradient: ['00f2ff', '3cfa3f'],
});
if (badgePath && badgePath.length>0) {
core.info(`Write Svg to file ${badgePath}...`)
fs.writeFileSync(badgePath, svgString)
core.info('Badge saved succesfully.')
}
else{
core.info('Badge path not configured')
}
core.info(svgString)
await checkCoverageThreshold(overAllCoverageVal, threshold)
}
const checkCoverageThreshold = async(overAllCoverage, threshold) => {
const percentage = parseFloat(overAllCoverage['line_percent'])
threshold = parseFloat(threshold)
if (percentage < threshold) {
core.setFailed(`Coverage of ${percentage} is below passing threshold of ${threshold}`)
return false
}
core.info(`Coverage is above passing threshod - ${percentage}`)
return true
}
const markdownTable = async(moduleCoverage, overAllCoverage, threshold) => {
const header = [
'Category',
'Lines Coverage',
'Lines Covered / Total',
'Branches Coverage',
'Branches Covered / Total'
]
const lineCoverage = parseFloat(overAllCoverage['line_percent']).toFixed(2)
const branchCoverage = parseFloat(overAllCoverage['branch_percent']).toFixed(2)
const metrics = [
'**Total**',
`**${lineCoverage}%**`,
`**${overAllCoverage['line_covered']} / ${overAllCoverage['line_total']}**`,
`**${branchCoverage}%**`,
`**${overAllCoverage['branch_covered']} / ${overAllCoverage['branch_total']}**`
]
const coverageList = moduleCoverage.map((module) => {
return [
module['component'],
`${parseFloat(module['line_percent']).toFixed(2)}%`,
`${module['line_covered']} / ${module['line_total']}`,
`${parseFloat(module['branch_percent']).toFixed(2)}%`,
`${module['branch_covered']} / ${module['branch_total']}`
]
})
const tableText = table([header, ...coverageList, metrics])
const headerText = "## :rocket: Coverage Report "
const divider = "---"
let reportLink = null
if (core.getInput("report-url") == undefined || core.getInput("report-url") == "") {
reportLink = "*Coverage report not available*";
} else {
reportLink = `*[View full coverage report](${core.getInput("report-url")})*`
}
let failedText = null
if (lineCoverage < threshold) {
failedText = `:x: Coverage of ${lineCoverage} is below passing threshold of ${threshold}`
}
const bodyText = [headerText, failedText, tableText, divider, reportLink].filter(Boolean).join("\n");
return bodyText;
}
const overallCoverage = async(result) => {
const report = {
'report': 'Total',
'line_percent': 0.0,
'line_total': 0,
'line_covered': 0,
'line_missed': 0,
'branch_percent': 0.0,
'branch_total': 0,
'branch_covered': 0,
'branch_missed': 0
}
result.forEach(row => {
report['line_total'] += row['line_total']
report['line_covered'] += row['line_covered']
report['line_missed'] += row['line_missed']
report['branch_total'] += row['branch_total']
report['branch_covered'] += row['branch_covered']
report['branch_missed'] += row['branch_missed']
})
report['line_percent'] =
parseFloat(report['line_covered']) / parseFloat(report['line_total']) * 100.0
report['branch_percent'] =
parseFloat(report['branch_covered']) / parseFloat(report['branch_total']) * 100.0
return report
}
const filterReport = async(files) => {
const output = []
await Promise.all(files.map(async (file) => {
await parseFile(file).then(result => {
// key -> group name
// value -> object with line_covered, line_missed, branch_covered, branch_missed
Object.entries(result).forEach(([key, value]) => {
let line_covered = value['line_covered']
let line_missed = value['line_missed']
let line_total = line_covered + line_missed
let line_percent = parseFloat(line_covered) / parseFloat(line_total) * 100.0
let branch_covered = value['branch_covered']
let branch_missed = value['branch_missed']
let branch_total = branch_covered + branch_missed
let branch_percent = parseFloat(branch_covered) / parseFloat(branch_total) * 100.0
output.push({
'component': key,
'line_percent': line_percent,
'line_total': line_total,
'branch_percent': branch_percent,
'branch_total': branch_total,
...value
})
})
}).catch(error => {
core.setFailed(error.message)
})
}))
return output
}
const parseFile = async(file) => {
let data = {}
let results = []
const promise = new Promise((resolve, reject) => {
fs.createReadStream(file)
.pipe(csv())
.on('data', async(rows) => results.push(rows))
.on('error', () => reject())
.on('end', async() => {
results.forEach( (row, index) => {
let group = row.GROUP
if (group.indexOf('/') != -1) {
let groups = group.split('/')
group = groups.pop()
}
if (data[group] == undefined) {
data[group] = {'line_covered': 0, 'line_missed': 0, 'branch_covered': 0, 'branch_missed': 0}
}
data[group]['line_covered'] += parseInt(row.LINE_COVERED)
data[group]['line_missed'] += parseInt(row.LINE_MISSED)
data[group]['branch_covered'] += parseInt(row.BRANCH_COVERED)
data[group]['branch_missed'] += parseInt(row.BRANCH_MISSED)
})
resolve(data)
})
})
return await promise
}
const setOutputVariables = overAllCoverageVal => {
core.setOutput('total-coverage', overAllCoverageVal.line_percent.toFixed(2));
core.setOutput('lines-covered', overAllCoverageVal.line_covered);
core.setOutput('lines-missed', overAllCoverageVal.line_missed);
core.setOutput('total-lines', overAllCoverageVal.line_total);
}
module.exports = report;