-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
GenerateBuildDashboard.java
219 lines (198 loc) · 7.16 KB
/
GenerateBuildDashboard.java
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
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.reporting;
import com.google.common.collect.Sets;
import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.DefaultTask;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.internal.CollectionCallbackActionDecorator;
import org.gradle.api.reporting.internal.BuildDashboardGenerator;
import org.gradle.api.reporting.internal.DefaultBuildDashboardReports;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.TaskAction;
import org.gradle.internal.Cast;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.util.internal.ClosureBackedAction;
import org.gradle.util.internal.CollectionUtils;
import org.gradle.work.DisableCachingByDefault;
import javax.inject.Inject;
import java.io.File;
import java.io.Serializable;
import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* Generates build dashboard report.
*/
@DisableCachingByDefault(because = "Not made cacheable, yet")
public abstract class GenerateBuildDashboard extends DefaultTask implements Reporting<BuildDashboardReports> {
private final Set<Reporting<? extends ReportContainer<?>>> aggregated = new LinkedHashSet<Reporting<? extends ReportContainer<?>>>();
private final BuildDashboardReports reports;
public GenerateBuildDashboard() {
reports = getInstantiator().newInstance(DefaultBuildDashboardReports.class, this, getCollectionCallbackActionDecorator());
reports.getHtml().getRequired().set(true);
}
@Inject
protected Instantiator getInstantiator() {
throw new UnsupportedOperationException();
}
@Inject
protected CollectionCallbackActionDecorator getCollectionCallbackActionDecorator() {
throw new UnsupportedOperationException();
}
@Input
public Set<ReportState> getInputReports() {
Set<ReportState> inputs = new LinkedHashSet<ReportState>();
for (Report report : getEnabledInputReports()) {
if (getReports().contains(report)) {
// A report to be generated, ignore
continue;
}
File outputLocation = report.getOutputLocation().get().getAsFile();
inputs.add(new ReportState(report.getDisplayName(), outputLocation, outputLocation.exists()));
}
return inputs;
}
private Set<Report> getEnabledInputReports() {
HashSet<Reporting<? extends ReportContainer<?>>> allAggregatedReports = Sets.newHashSet(aggregated);
allAggregatedReports.addAll(getAggregatedTasks());
Set<NamedDomainObjectSet<? extends Report>> enabledReportSets = CollectionUtils.collect(
allAggregatedReports, reporting -> reporting.getReports().getEnabled()
);
return new LinkedHashSet<Report>(CollectionUtils.flattenCollections(Report.class, enabledReportSets));
}
private Set<Reporting<? extends ReportContainer<?>>> getAggregatedTasks() {
final Set<Reporting<? extends ReportContainer<?>>> reports = new HashSet<>();
getProject().allprojects(new Action<Project>() {
@Override
public void execute(Project project) {
project.getTasks().all(new Action<Task>() {
@Override
public void execute(Task task) {
if (!(task instanceof Reporting)) {
return;
}
reports.add(Cast.uncheckedNonnullCast(task));
}
});
}
});
return reports;
}
/**
* Configures which reports are to be aggregated in the build dashboard report generated by this task.
*
* <pre>
* buildDashboard {
* aggregate codenarcMain, checkstyleMain
* }
* </pre>
*
* @param reportings an array of {@link Reporting} instances that are to be aggregated
*/
@SuppressWarnings("unchecked")
public void aggregate(Reporting<? extends ReportContainer<?>>... reportings) {
aggregated.addAll(Arrays.asList(reportings));
}
/**
* The reports to be generated by this task.
*
* @return The reports container
*/
@Nested
@Override
public BuildDashboardReports getReports() {
return reports;
}
/**
* Configures the reports to be generated by this task.
*
* The contained reports can be configured by name and closures.
*
* <pre>
* buildDashboard {
* reports {
* html {
* destination "build/dashboard.html"
* }
* }
* }
* </pre>
*
* @param closure The configuration
* @return The reports container
*/
@Override
public BuildDashboardReports reports(Closure closure) {
return reports(new ClosureBackedAction<BuildDashboardReports>(closure));
}
/**
* Configures the reports to be generated by this task.
*
* The contained reports can be configured by name and closures.
*
* <pre>
* buildDashboard {
* reports {
* html {
* destination "build/dashboard.html"
* }
* }
* }
* </pre>
*
* @param configureAction The configuration
* @return The reports container
*/
@Override
public BuildDashboardReports reports(Action<? super BuildDashboardReports> configureAction) {
configureAction.execute(reports);
return reports;
}
@TaskAction
void run() {
if (getReports().getHtml().getRequired().get()) {
BuildDashboardGenerator generator = new BuildDashboardGenerator();
generator.render(getEnabledInputReports(), reports.getHtml().getEntryPoint());
} else {
setDidWork(false);
}
}
private static class ReportState implements Serializable {
private final String name;
private final File destination;
private final boolean available;
private ReportState(String name, File destination, boolean available) {
this.name = name;
this.destination = destination;
this.available = available;
}
@Override
public boolean equals(Object obj) {
ReportState other = (ReportState) obj;
return name.equals(other.name) && destination.equals(other.destination) && available == other.available;
}
@Override
public int hashCode() {
return name.hashCode() ^ destination.hashCode();
}
}
}