-
Notifications
You must be signed in to change notification settings - Fork 7
/
action.ps1
436 lines (350 loc) · 15.7 KB
/
action.ps1
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
#!/usr/bin/env pwsh
$ErrorActionPreference = 'Stop'
## Make sure any modules we depend on are installed
$modulesToInstall = @(
'GitHubActions'
)
$modulesToInstall | ForEach-Object {
if (-not (Get-Module -ListAvailable -All $_)) {
Write-Output "Module [$_] not found, INSTALLING..."
Install-Module $_ -Force
}
}
## Import dependencies
Import-Module GitHubActions -Force
Write-ActionInfo "Running from [$($PSScriptRoot)]"
function splitListInput { $args[0] -split ',' | % { $_.Trim() } }
function writeListInput { $args[0] | % { Write-ActionInfo " - $_" } }
$inputs = @{
coverage_report_name = Get-ActionInput coverage_report_name
coverage_report_title = Get-ActionInput coverage_report_title
coverage_results_path = Get-ActionInput coverage_results_path -Required
github_token = Get-ActionInput github_token -Required
skip_check_run = Get-ActionInput skip_check_run
minimum_coverage = Get-ActionInput minimum_coverage
fail_below_threshold = Get-ActionInput fail_below_threshold
publish_only_summary = Get-ActionInput publish_only_summary
}
$test_results_dir = Join-Path $PWD _TMP
Write-ActionInfo "Creating test results space"
mkdir $test_results_dir
Write-ActionInfo $test_results_dir
$script:coverage_report_path = Join-Path $test_results_dir coverage-results.md
$script:coverage_summary_path = Join-Path $test_results_dir coverage-summary.md
$script:publish_only_summary = $inputs.publish_only_summary
$script:skip_check_run = $inputs.skip_check_run
# Feature 1
function Build-CoverageReport
{
Write-ActionInfo "Building human-readable code-coverage report"
$script:coverage_report_name = $inputs.coverage_report_name
$script:coverage_report_title = $inputs.coverage_report_title
$script:coverage_results_path = $inputs.coverage_results_path
if (-not $script:coverage_report_name) {
$script:coverage_report_name = "COVERAGE_RESULTS_$([datetime]::Now.ToString('yyyyMMdd_hhmmss'))"
}
if (-not $coverage_report_title) {
$script:coverage_report_title = $script:coverage_report_name
}
$script:coverage_report_path = Join-Path $test_results_dir coverage-results.md
& "$PSScriptRoot/jacoco-report/jacocoxml2md.ps1" -Verbose `
-xmlFile $script:coverage_results_path `
-mdFile $script:coverage_report_path -xslParams @{
reportTitle = $script:coverage_report_title
}
& "$PSScriptRoot/jacoco-report/embedmissedlines.ps1" -mdFile $script:coverage_report_path
}
#Feature# 2 (added to handle 65k chars limitation on Github API scenario)
function Build-CoverageSummaryReport
{
Write-ActionInfo "Building human-readable code-coverage report"
$script:coverage_report_name = $inputs.coverage_report_name
$script:coverage_report_title = $inputs.coverage_report_title
$script:coverage_results_path = $inputs.coverage_results_path
if (-not $script:coverage_report_name) {
$script:coverage_report_name = "COVERAGE_RESULTS_$([datetime]::Now.ToString('yyyyMMdd_hhmmss'))"
}
if (-not $coverage_report_title) {
$script:coverage_report_title = $script:coverage_report_name
}
$script:coverage_report_path = Join-Path $test_results_dir coverage-results.md
& "$PSScriptRoot/jacoco-report/jacocoxmlsummary2md.ps1" -Verbose `
-xmlFile $script:coverage_results_path `
-mdFile $script:coverage_report_path -xslParams @{
reportTitle = $script:coverage_report_title
}
}
#Feature 3. Added to support Github Job Summaries
function Build-SummaryReport
{
Write-ActionInfo "Building human-readable code-coverage report"
$script:coverage_report_name = $inputs.coverage_report_name
$script:coverage_report_title = $inputs.coverage_report_title
$script:coverage_results_path = $inputs.coverage_results_path
if (-not $script:coverage_report_name) {
$script:coverage_report_name = "COVERAGE_RESULTS_$([datetime]::Now.ToString('yyyyMMdd_hhmmss'))"
}
if (-not $coverage_report_title) {
$script:coverage_report_title = $script:coverage_report_name
}
$script:coverage_summary_path = Join-Path $test_results_dir coverage-summary.md
& "$PSScriptRoot/jacoco-report/buildsummary2md.ps1" -Verbose `
-xmlFile $script:coverage_results_path `
-mdFile $script:coverage_summary_path -xslParams @{
reportTitle = $script:coverage_report_title
}
}
function Parse-CoverageXML {
# Parse XML
$coverageXmlData = Select-Xml -Path $script:coverage_results_path -XPath "/report/counter[@type='LINE']"
$script:coveredLines = [int]$coverageXmlData.Node.covered
Write-Host "Covered Lines: $coveredLines"
$script:missedLines = [int]$coverageXmlData.Node.missed
$script:totalLines = [int]($coveredLines+$missedLines)
Write-Host "Missed Lines: $missedLines"
Write-Host "Total Lines: $totalLines"
}
function Format-Percentage {
# Format Percentage
if ($script:missedLines -eq 0)
{
$coveragePercentage = 100
$script:coveragePercentage = 100
Write-Output "Coverage: $coveragePercentage"
$script:coveragePercentageString = "{0:p2}" -f ($coveragePercentage/100)
}
elseif ($script:coveredLines -eq 0)
{
$coveragePercentage = 0
$script:coveragePercentage = 0
Write-Output "Coverage: $coveragePercentage"
$script:coveragePercentageString = "{0:p2}" -f ($coveragePercentage)
}
elseif ($coveredLines -eq 0 -and $missedLines -eq 0)
{
$coveragePercentage = 0
$script:coveragePercentage = 0
Write-Output "Coverage: $coveragePercentage"
$script:coveragePercentageString = "{0:p2}" -f ($coveragePercentage)
}
else
{
$coveragePercentage = [math]::Round( (($script:coveredLines/($script:coveredLines+$script:missedLines) ) * 100 ), 2)
$script:coveragePercentage = [math]::Round( (($script:coveredLines/($script:coveredLines+$script:missedLines) ) * 100 ), 2)
Write-Output "Coverage: $coveragePercentage"
$script:coveragePercentageString = "{0:p2}" -f ($coveragePercentage/100)
}
}
function Set-Output {
# Set Output
Set-ActionVariable -Name coveragePercentageString -Value ($script:coveragePercentageString)
Set-ActionVariable -Name coveragePercentage -Value ($script:coveragePercentage)
Set-ActionVariable -Name coverage_percentage -Value ($script:coveragePercentage)
Set-ActionVariable -Name covered_lines -Value ($script:coveredLines)
Set-ActionVariable -Name missed_lines -Value ($script:missedLines)
Set-ActionVariable -Name total_lines -Value ($coveredLines+$missedLines)
Set-ActionOutput -Name coveragePercentageString -Value ($script:coveragePercentageString)
Set-ActionOutput -Name coveragePercentage -Value ($script:coveragePercentage)
Set-ActionOutput -Name coverage_percentage -Value ($script:coveragePercentage)
Set-ActionOutput -Name covered_lines -Value ($script:coveredLines)
Set-ActionOutput -Name missed_lines -Value ($script:missedLines)
Set-ActionOutput -Name total_lines -Value ($script:coveredLines+$missedLines)
}
function Set-Outcome {
if ($inputs.fail_below_threshold -eq "true") {
Write-ActionInfo " * fail_below_threshold: true"
}
if (($script:coveragePercentage -lt $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "true")) {
$script:status = "failure"
$script:level = "warning"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if (($script:coveragePercentage -ge $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "true")) {
$script:status = "success"
$script:level = "notice"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if (($script:coveragePercentage -ge $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "false")) {
$script:status = "success"
$script:level = "notice"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if (($script:coveragePercentage -ge $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "")) {
$script:status = "success"
$script:level = "notice"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if (($script:coveragePercentage -lt $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "false")) {
$script:status = "success"
$script:level = "notice"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if (($script:coveragePercentage -lt $inputs.minimum_coverage) -and ($inputs.fail_below_threshold -eq "")) {
$script:status = "success"
$script:level = "notice"
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
if(($inputs.minimum_coverage -eq "") -or ($inputs.fail_below_threshold -eq "")){
$script:status = "success"
$script:level = 'notice'
$script:messageToDisplay = "Code Coverage $script:coveragePercentageString"
}
}
# Enforce Quality Gate
function Enforce-QualityGate {
if ($inputs.fail_below_threshold -eq "true") {
Write-ActionInfo " * fail_below_threshold: true"
}
if ($coveragePercentage -lt $inputs.minimum_coverage -and $inputs.fail_below_threshold -eq "true") {
$script:stepShouldFail = $true
}
if ($stepShouldFail) {
Write-ActionInfo "Thowing error as Code Coverage is less than "minimum_coverage" is not met and 'fail_below_threshold' was true."
throw "Code Coverage is less than Minimum Code Coverage Required"
}
}
# #Issue 26: FEATURE REQUEST: Display Coverage Percent along with Check
# function Update-PRCheck {
# param(
# [string]$reportData,
# [string]$reportName,
# [string]$reportTitle
# )
# Set-Outcome
# $ghToken = $inputs.github_token
# $ctx = Get-ActionContext
# $repo = Get-ActionRepo
# $repoFullName = "$($repo.Owner)/$($repo.Repo)"
# Write-ActionInfo "Resolved REF as $ref"
# Write-ActionInfo "Resolve Repo Full Name as $repoFullName"
# Write-ActionInfo "Update Annotation Check to: $checkId"
# $checkId = $script:checkId
# Write-ActionInfo "checkId: $checkId"
# $url = "https://api.github.com/repos/$repoFullName/check-runs/$checkId"
# $hdr = @{
# Accept = 'application/vnd.github+json'
# Authorization = "token $ghToken"
# }
# $bdy = @{
# name = $reportName
# status = 'completed'
# conclusion = $script:outcome
# output = @{
# title = $reportTitle
# summary = "This run completed at ``$([datetime]::Now)``"
# text = $ReportData
# }
# }
# Invoke-WebRequest -Headers $hdr $url -Method Patch -Body ($bdy | ConvertTo-Json)
# }
# Publishing Report to GH Workflow
# Function to Publish Check Run with Neutral Status # Round 1
function Publish-ToCheckRun {
param(
[string]$reportData,
[string]$reportName,
[string]$reportTitle,
[string]$outcome,
[string]$coveragePercentage
)
Write-ActionInfo "Publishing Report to GH Workflow"
$ghToken = $inputs.github_token
$ctx = Get-ActionContext
$repo = Get-ActionRepo
$repoFullName = "$($repo.Owner)/$($repo.Repo)"
Write-ActionInfo "Resolving REF"
$ref = $ctx.Sha
if ($ctx.EventName -eq 'pull_request') {
Write-ActionInfo "Resolving PR REF"
$ref = $ctx.Payload.pull_request.head.sha
if (-not $ref) {
Write-ActionInfo "Resolving PR REF as AFTER"
$ref = $ctx.Payload.after
}
}
if (-not $ref) {
Write-ActionError "Failed to resolve REF"
exit 1
}
Write-ActionInfo "Resolved REF as $ref"
Write-ActionInfo "Resolve Repo Full Name as $repoFullName"
Write-ActionInfo "Adding Check Run"
$url = "https://api.github.com/repos/$repoFullName/check-runs"
$hdr = @{
Accept = 'application/vnd.github+json'
Authorization = "token $ghToken"
}
$bdy = @{
name = $reportName
head_sha = $ref
status = 'completed'
conclusion = $outcome
output = @{
title = "Code Coverage $coveragePercentage"
summary = "This run completed at ``$([datetime]::Now)``"
text = $ReportData
}
}
Write-ActionInfo "$hdr"
Write-ActionInfo $url
Write-ActionInfo "$bdy"
Invoke-WebRequest -Headers $hdr $url -Method Post -Body ($bdy | ConvertTo-Json)
# Grab Check ID
# $checkId = ( ConvertFrom-Json $response.Content ).id
# $checkUrl = ( ConvertFrom-Json $response.Content ).url
# Write-ActionInfo "Check ID: $checkId"
# Write-ActionInfo "Check ID: $checkUrl"
# $script:checkUrl = $checkUrl
# $script:checkId = $checkId
}
Write-ActionInfo "Publishing Report to GH Workflow"
$coverage_results_path = $inputs.coverage_results_path
if ($inputs.skip_check_run -ne $true -and $inputs.publish_only_summary -eq $true )
{
Build-CoverageSummaryReport
Parse-CoverageXML
Format-Percentage
Set-Outcome
Set-Output
$coverageSummaryData = [System.IO.File]::ReadAllText($script:coverage_report_path)
Publish-ToCheckRun -ReportData $coverageSummaryData -ReportName $script:coverage_report_name -ReportTitle $script:coverage_report_title -outcome $Script:status -coveragePercentage $script:coveragePercentageString
# Update-PRCheck -ReportData $script:coverageSummaryData -ReportName $coverage_report_name -ReportTitle $script:messageToDisplay
Enforce-QualityGate
# Set-ActionOutput -Name coverageSummary -Value $script:coverageSummaryData
}
elseif ($inputs.skip_check_run -ne $true -and $inputs.publish_only_summary -ne $true )
{
Build-CoverageReport
Parse-CoverageXML
Format-Percentage
Set-Outcome
Set-Output
$coverageSummaryData = [System.IO.File]::ReadAllText($script:coverage_report_path)
Publish-ToCheckRun -ReportData $coverageSummaryData -ReportName $script:coverage_report_name -ReportTitle $script:coverage_report_title -outcome $script:status -coveragePercentage $script:coveragePercentageString
# Update-PRCheck -ReportData $script:coverageSummaryData -ReportName $coverage_report_name -ReportTitle $script:messageToDisplay
Enforce-QualityGate
# Set-ActionOutput -Name coverageSummary -Value $script:coverageSummaryData
}
elseif ($inputs.skip_check_run -eq $true -and $inputs.publish_only_summary -eq $true )
{
Build-CoverageSummaryReport
Build-SummaryReport
Parse-CoverageXML
Format-Percentage
Set-Outcome
Set-Output
# $coverageSummary = [System.IO.File]::ReadAllText($script:coverage_summary_path)
Enforce-QualityGate
# Set-ActionOutput -Name coverageSummary -Value $script:coverageSummary
}
else {
Build-CoverageReport
Build-SummaryReport
Parse-CoverageXML
Format-Percentage
Set-Outcome
Set-Output
# $coverageSummary = [System.IO.File]::ReadAllText($script:coverage_summary_path)
Enforce-QualityGate
# Set-ActionOutput -Name coverageSummary -Value $script:coverageSummary
}