-
Notifications
You must be signed in to change notification settings - Fork 199
/
HtmlReporter.groovy
334 lines (300 loc) · 13.6 KB
/
HtmlReporter.groovy
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
package com.github.benmanes.gradle.versions.reporter
import com.github.benmanes.gradle.versions.reporter.result.DependenciesGroup
import com.github.benmanes.gradle.versions.reporter.result.Dependency
import com.github.benmanes.gradle.versions.reporter.result.DependencyLatest
import com.github.benmanes.gradle.versions.reporter.result.DependencyOutdated
import com.github.benmanes.gradle.versions.reporter.result.DependencyUnresolved
import com.github.benmanes.gradle.versions.reporter.result.Result
import groovy.transform.CompileStatic
import groovy.transform.TupleConstructor
import static com.github.benmanes.gradle.versions.updates.gradle.GradleReleaseChannel.CURRENT
import static com.github.benmanes.gradle.versions.updates.gradle.GradleReleaseChannel.NIGHTLY
import static com.github.benmanes.gradle.versions.updates.gradle.GradleReleaseChannel.RELEASE_CANDIDATE
/**
* An html reporter for the dependency updates results.
*/
@CompileStatic
@TupleConstructor(callSuper = true, includeSuperProperties = true, includeSuperFields = true)
class HtmlReporter extends AbstractReporter {
String header = """
<!DOCTYPE html>
<HEAD><TITLE>Project Dependency Updates Report</TITLE></HEAD>
<style type=\"text/css\">
.body {
font:100% verdana, arial, sans-serif;
background-color:#fff
}
.currentInfo {
border-collapse: collapse;
}
.currentInfo header {
cursor:pointer;
padding: 12px 15px;
}
.currentInfo td {
border: 1px solid black;
padding: 12px 15px;
border-collapse: collapse;
}
.currentInfo tr:nth-child(even) {
background-color: #E4FFB7;
padding: 12px 15px;
border-collapse: collapse;
}
.currentInfo tr:nth-child(odd) {
background-color: #EFFFD2;
padding: 12px 15px;
border-collapse: collapse;
}
.warningInfo {
border-collapse: collapse;
}
.warningInfo header {
cursor:pointer;
padding: 12px 15px;
}
.warningInfo td {
border: 1px solid black;
padding: 12px 15px;
border-collapse: collapse;
}
.warningInfo tr:nth-child(even) {
background-color: #FFFF66;
padding: 12px 15px;
border-collapse: collapse;
}
.warningInfo tr:nth-child(odd) {
background-color: #FFFFCC;
padding: 12px 15px;
border-collapse: collapse;
}
</style>
<script src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js\"></script>
<script type="text/javascript">
\$(document).ready(function(){
/* set current to collapsed initially */
\$('#currentId').nextUntil('tr.header').slideToggle(100, function(){});
/* click callback to toggle tables */
\$('tr.header').click(function(){
\$(this).find('span').text(function(_, value){return value=='(Click to collapse)'?'(Click to expand)':'(Click to collapse)'});
\$(this).nextUntil('tr.header').slideToggle(100, function(){
});
});
});
</script>
"""
@Override
def write(printStream, Result result) {
writeHeader(printStream)
if (result.count == 0) {
printStream.println '<P>No dependencies found.</P>'
} else {
writeUpToDate(printStream, result)
writeExceedLatestFound(printStream, result)
writeUpgrades(printStream, result)
writeUnresolved(printStream, result)
}
writeGradleUpdates(printStream, result)
}
private def writeHeader(printStream) {
printStream.println header.stripMargin()
}
private def writeUpToDate(printStream, Result result) {
SortedSet<Dependency> versions = result.getCurrent().getDependencies()
if (!versions.isEmpty()) {
printStream.println("<H2>Current dependencies</H2>")
printStream.println("<p>The following dependencies are using the latest ${revision} version:<p>")
printStream.println("<table class=\"currentInfo\">")
getCurrentRows(result).each { printStream.println it }
printStream.println("</table>")
printStream.println("<br>")
}
}
private def getCurrentRows(Result result) {
List<String> rows = new ArrayList<>();
// The following dependencies are using the latest milestone version:
DependenciesGroup<Dependency> list = result.getCurrent();
rows.add("<tr class=\"header\" id = \"currentId\" ><th colspan=\"4\"><b>Current dependencies<span>(Click to expand)</span></b></th></tr>")
rows.add("<tr><td><b>Name</b></td><td><b>Group</b></td><td><b>URL</b></td><td><b>Current Version</b></td></tr>")
for (Dependency item : list.dependencies) {
String rowString;
String rowStringFmt = "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>"
rowString = String.format(rowStringFmt, item.getName(), item.getGroup(),
getUrlString(item.getProjectUrl()), getVersionString(item.getGroup(), item.getName(), getDisplayableVersion(item)))
rows.add(rowString)
}
return rows
}
private def writeExceedLatestFound(printStream, Result result) {
SortedSet<DependencyLatest> versions = result.getExceeded().getDependencies();
if (!versions.isEmpty()) {
// The following dependencies exceed the version found at the '
// + revision + ' revision level:
printStream.println("<H2>Exceeded dependencies</H2>")
printStream.println("<p>The following dependencies exceed the version found at the ${revision} revision level:<p>")
printStream.println("<table class=\"warningInfo\">")
getExceededRows(result).each { printStream.println it }
printStream.println("</table>")
printStream.println("<br>")
}
}
private def getExceededRows(Result result) {
List<String> rows = new ArrayList<>();
// The following dependencies are using the latest milestone version:
DependenciesGroup<DependencyLatest> list = result.getExceeded()
rows.add("<tr class=\"header\"><th colspan=\"5\"><b>Exceeded dependencies<span>(Click to collapse)</span></b></th></tr>")
rows.add("<tr><td><b>Name</b></td><td><b>Group</b></td><td><b>URL</b></td><td><b>Current Version</b></td><td><b>Latest Version</b></td></tr>")
for (DependencyLatest item : list.dependencies) {
String rowString;
String rowStringFmt = "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>"
rowString = String.format(rowStringFmt, item.getName(), item.getGroup(),
getUrlString(item.getProjectUrl()), getVersionString(item.getGroup(), item.getName(), item.getVersion()),
getVersionString(item.getGroup(), item.getName(), getDisplayableVersion(item)))
rows.add(rowString)
}
return rows
}
private def writeUpgrades(printStream, Result result) {
SortedSet<DependencyOutdated> versions = result.getOutdated().getDependencies();
if (!versions.isEmpty()) {
printStream.println("<H2>Later dependencies</H2>")
printStream.println("<p>The following dependencies have later ${revision} versions:<p>")
printStream.println("<table class=\"warningInfo\">")
getUpgradesRows(result).each { printStream.println it }
printStream.println("</table>")
printStream.println("<br>")
}
}
private def getUpgradesRows(Result result) {
List<String> rows = new ArrayList<>();
DependenciesGroup<DependencyOutdated> list = result.getOutdated()
rows.add("<tr class=\"header\"><th colspan=\"5\"><b>Later dependencies<span>(Click to collapse)</span></b></th></tr>")
rows.add("<tr><td><b>Name</b></td><td><b>Group</b></td><td><b>URL</b></td><td><b>Current Version</b></td><td><b>Latest Version</b></td></tr>")
for (DependencyOutdated item : list.dependencies) {
String rowString;
String rowStringFmt = "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>"
rowString = String.format(rowStringFmt, item.getName(), item.getGroup(),
getUrlString(item.getProjectUrl()), getVersionString(item.getGroup(), item.getName(), item.getVersion()),
getVersionString(item.getGroup(), item.getName(), getDisplayableVersion(item)))
rows.add(rowString)
}
return rows
}
private def String getDisplayableVersion(DependencyOutdated item) {
if (getRevision().equalsIgnoreCase("milestone")) {
return item.getAvailable().getMilestone()
} else if (getRevision().equalsIgnoreCase("release")) {
return item.getAvailable().getRelease()
} else if (getRevision().equalsIgnoreCase("integration")) {
return item.getAvailable().getIntegration()
}
return ""
}
private def String getDisplayableVersion(Dependency item) {
return item.getVersion()
}
private def writeUnresolved(printStream, Result result) {
SortedSet<DependencyUnresolved> versions = result.getUnresolved().getDependencies();
if (!versions.isEmpty()) {
printStream.println("<H2>Unresolved dependencies</H2>")
printStream.println("<p>Failed to determine the latest version for the following dependencies:<p>")
printStream.println("<table class=\"warningInfo\">")
getUnresolvedRows(result).each { printStream.println it }
printStream.println("</table>")
printStream.println("<br>")
}
}
private def getUnresolvedRows(Result result) {
List<String> rows = new ArrayList<>();
DependenciesGroup<DependencyUnresolved> list = result.getUnresolved()
rows.add("<tr class=\"header\"><th colspan=\"4\"><b>Unresolved dependencies<span>(Click to collapse)</span></b></th></tr>")
rows.add("<tr><td><b>Name</b></td><td><b>Group</b></td><td><b>URL</b></td><td><b>Current Version</b></td></tr>")
for (DependencyUnresolved item : list.dependencies) {
String rowString;
String rowStringFmt = "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>"
rowString = String.format(rowStringFmt, item.getName(), item.getGroup(),
getUrlString(item.getProjectUrl()) , getVersionString(item.getGroup(), item.getName(), getDisplayableVersion(item)))
rows.add(rowString)
}
return rows
}
private def writeGradleUpdates(printStream, Result result) {
if (!result.gradle.isEnabled()) {
return
}
printStream.println("<H2>Gradle ${gradleReleaseChannel} updates</H2>")
printStream.println("Gradle ${gradleReleaseChannel} updates:")
result.gradle.with {
// Log Gradle update checking failures.
if (current.isFailure) {
printStream.println("<P>[ERROR] [release channel: ${CURRENT.id}] " + current.reason + "</P>")
}
if ((gradleReleaseChannel == RELEASE_CANDIDATE.id || gradleReleaseChannel == NIGHTLY.id) && releaseCandidate.isFailure) {
printStream.println("<P>[ERROR] [release channel: ${RELEASE_CANDIDATE.id}] " + releaseCandidate.reason + "</P>")
}
if (gradleReleaseChannel == NIGHTLY.id && nightly.isFailure) {
printStream.println("<P>[ERROR] [release channel: ${NIGHTLY.id}] " + nightly.reason + "</P>")
}
// print Gradle updates in breadcrumb format
printStream.print("<P>Gradle: [" + getGradleVersionUrl(running.version))
boolean updatePrinted = false
if (current.isUpdateAvailable && current > running) {
updatePrinted = true
printStream.print(" -> " + getGradleVersionUrl(current.version))
}
if ((gradleReleaseChannel == RELEASE_CANDIDATE.id || gradleReleaseChannel == NIGHTLY.id) && releaseCandidate.isUpdateAvailable && releaseCandidate > current) {
updatePrinted = true
printStream.print(" -> " + getGradleVersionUrl(releaseCandidate.version))
}
if (gradleReleaseChannel == NIGHTLY.id && nightly.isUpdateAvailable && nightly > current) {
updatePrinted = true
printStream.print(" -> " + getGradleVersionUrl(nightly.version))
}
if (!updatePrinted) {
printStream.print(": UP-TO-DATE")
}
printStream.println("]<P>")
printStream.println(getGradleUrl())
}
}
private def getGradleUrl() {
return "<P>For information about Gradle releases click <a target=\"_blank\" href=\"https://gradle.org/releases/\">here</a>.";
}
private def getGradleVersionUrl(String version) {
if (version == null) {
return "https://gradle.org/releases/";
}
return String.format("<a target=\"_blank\" href=\"https://docs.gradle.org/%s/release-notes.html\">%s</a>", version, version)
}
private def getUrlString(String url) {
if (url == null) {
return "";
}
return String.format("<a target=\"_blank\" href=\"%s\">%s</a>", url, url)
}
private def getVersionString(String group, String name, String version) {
String mvn = getMvnVersionString(group, name, version)
String bintray = getBintrayVersionString(group, name, version)
return String.format("%s %s %s", version, mvn, bintray)
}
private def getMvnVersionString(String group, String name, String version) {
// https://search.maven.org/artifact/com.azure/azure-core-http-netty/1.5.4
if (version == null) {
return "";
}
String versionUrl = String.format("https://search.maven.org/artifact/%s/%s/%s/bundle", group, name, version)
return String.format("<a target=\"_blank\" href=\"%s\">%s</a>", versionUrl, "Sonatype")
}
private def getBintrayVersionString(String group, String name, String version) {
// https://bintray.com/bintray/jcenter/com.azure%3Aazure-sdk-template/1.0.3
if (version == null) {
return "";
}
String versionUrl = String.format("https://bintray.com/bintray/jcenter/%s%%3A%s/%s", group, name, version)
return String.format("<a target=\"_blank\" href=\"%s\">%s</a>", versionUrl, "Bintray")
}
@Override
def getFileExtension() {
return 'html'
}
}