-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
TaskReportTask.java
287 lines (252 loc) · 9.73 KB
/
TaskReportTask.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
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
/*
* Copyright 2008 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.tasks.diagnostics;
import com.google.common.base.Strings;
import org.gradle.api.Incubating;
import org.gradle.api.Project;
import org.gradle.api.internal.project.ProjectState;
import org.gradle.api.internal.project.ProjectStateRegistry;
import org.gradle.api.internal.project.ProjectTaskLister;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Console;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.diagnostics.internal.AggregateMultiProjectTaskReportModel;
import org.gradle.api.tasks.diagnostics.internal.DefaultGroupTaskReportModel;
import org.gradle.api.tasks.diagnostics.internal.ProjectDetails;
import org.gradle.api.tasks.diagnostics.internal.ReportRenderer;
import org.gradle.api.tasks.diagnostics.internal.RuleDetails;
import org.gradle.api.tasks.diagnostics.internal.SingleProjectTaskReportModel;
import org.gradle.api.tasks.diagnostics.internal.TaskDetails;
import org.gradle.api.tasks.diagnostics.internal.TaskDetailsFactory;
import org.gradle.api.tasks.diagnostics.internal.TaskReportRenderer;
import org.gradle.api.tasks.options.Option;
import org.gradle.internal.Try;
import org.gradle.internal.serialization.Cached;
import org.gradle.work.DisableCachingByDefault;
import javax.inject.Inject;
import java.util.ArrayList;
import java.util.List;
import java.util.TreeSet;
import java.util.stream.Collectors;
import static java.util.Collections.emptyList;
/**
* <p>Displays a list of tasks in the project. An instance of this type is used when you execute the {@code tasks} task
* from the command-line.</p>
*
* By default, this report shows only those tasks which have been assigned to a task group, so-called <i>visible</i>
* tasks. Tasks which have not been assigned to a task group, so-called <i>hidden</i> tasks, can be included in the report
* by enabling the command line option {@code --all}.
*/
@DisableCachingByDefault(because = "Not worth caching")
public abstract class TaskReportTask extends ConventionReportTask {
private boolean detail;
private final Property<Boolean> showTypes = getProject().getObjects().property(Boolean.class);
private String group;
private List<String> groups;
private final Cached<TaskReportModel> model = Cached.of(this::computeTaskReportModel);
private transient TaskReportRenderer renderer;
@Override
public ReportRenderer getRenderer() {
if (renderer == null) {
renderer = new TaskReportRenderer();
}
return renderer;
}
public void setRenderer(TaskReportRenderer renderer) {
this.renderer = renderer;
}
/**
* Sets whether to show "invisible" tasks without a group or dependent tasks.
*
* This property can be set via command-line option '--all'.
*/
@Option(option = "all", description = "Show additional tasks and detail.")
public void setShowDetail(boolean detail) {
this.detail = detail;
}
// TODO config-cache - should invalidate the cache or the filtering and merging should be moved to task execution time
@Console
public boolean isDetail() {
return detail;
}
/**
* Set a specific task group to be displayed.
*
* @since 5.1
*/
@Option(option = "group", description = "Show tasks for a specific group.")
public void setDisplayGroup(String group) {
this.group = group;
}
/**
* Returns the task group to be displayed.
*
* This property can be set via command-line option '--group'.
*
* @since 5.1
*/
@Console
public String getDisplayGroup() {
return group;
}
/**
* Add a specific task group to be displayed.
* Same functionality as the '--group' option, but unlike '--group', '--groups' can be chained.
*
* @since 7.5
*/
@Incubating
@Option(option = "groups", description = "Show tasks for specific groups (can be used multiple times to specify multiple groups).")
public void setDisplayGroups(List<String> groups) {
if (this.groups == null) {
this.groups = new ArrayList<>();
}
this.groups.addAll(groups);
}
/**
* Returns the task groups to be displayed.
*
* Task groups can be added via command-line option '--groups'.
*
* @since 7.5
*/
@Incubating
@Console
public List<String> getDisplayGroups() {
return groups == null ? new ArrayList<>() : groups;
}
/**
* Whether to show the task types next to their names in the output.
*
* This property can be set via command-line option '--types'.
*
* @since 7.4
*/
@Console
@Option(option = "types", description = "Show task class types")
public Property<Boolean> getShowTypes() {
return showTypes;
}
@TaskAction
void generate() {
reportGenerator().generateReport(
model.get().projects,
projectModel -> projectModel.get().project,
projectModel -> {
render(projectModel.get());
logClickableOutputFileUrl();
}
);
}
private TaskReportModel computeTaskReportModel() {
return new TaskReportModel(computeProjectModels());
}
private List<Try<ProjectReportModel>> computeProjectModels() {
List<Try<ProjectReportModel>> result = new ArrayList<>();
for (Project project : new TreeSet<>(getProjects())) {
result.add(Try.ofFailable(() -> projectReportModelFor(project)));
}
return result;
}
private static class TaskReportModel {
final List<Try<ProjectReportModel>> projects;
public TaskReportModel(List<Try<ProjectReportModel>> projects) {
this.projects = projects;
}
}
private static class ProjectReportModel {
public final ProjectDetails project;
public final List<String> defaultTasks;
public final DefaultGroupTaskReportModel tasks;
public final List<RuleDetails> rules;
public ProjectReportModel(
ProjectDetails project,
List<String> defaultTasks,
DefaultGroupTaskReportModel tasks,
List<RuleDetails> rules
) {
this.project = project;
this.defaultTasks = defaultTasks;
this.tasks = tasks;
this.rules = rules;
}
}
private ProjectReportModel projectReportModelFor(Project project) {
return new ProjectReportModel(
ProjectDetails.of(project),
project.getDefaultTasks(),
taskReportModelFor(project, isDetail()),
(Strings.isNullOrEmpty(group) && (groups == null || groups.isEmpty())) ? ruleDetailsFor(project) : emptyList()
);
}
private void render(ProjectReportModel reportModel) {
renderer.showDetail(isDetail());
renderer.showTypes(getShowTypes().get());
renderer.addDefaultTasks(reportModel.defaultTasks);
DefaultGroupTaskReportModel model = reportModel.tasks;
for (String group : model.getGroups()) {
renderer.startTaskGroup(group);
for (TaskDetails task : model.getTasksForGroup(group)) {
renderer.addTask(task);
}
}
renderer.completeTasks();
for (RuleDetails rule : reportModel.rules) {
renderer.addRule(rule);
}
}
private List<RuleDetails> ruleDetailsFor(Project project) {
return project.getTasks().getRules().stream().map(rule -> RuleDetails.of(rule.getDescription())).collect(Collectors.toList());
}
private DefaultGroupTaskReportModel taskReportModelFor(Project project, boolean detail) {
final AggregateMultiProjectTaskReportModel aggregateModel = new AggregateMultiProjectTaskReportModel(!detail, detail, getDisplayGroup(), getDisplayGroups());
final TaskDetailsFactory taskDetailsFactory = new TaskDetailsFactory(project);
final SingleProjectTaskReportModel projectTaskModel = buildTaskReportModelFor(taskDetailsFactory, project);
aggregateModel.add(projectTaskModel);
for (final Project subproject : project.getSubprojects()) {
aggregateModel.add(buildTaskReportModelFor(taskDetailsFactory, subproject));
}
aggregateModel.build();
return DefaultGroupTaskReportModel.of(aggregateModel);
}
private SingleProjectTaskReportModel buildTaskReportModelFor(
final TaskDetailsFactory taskDetailsFactory,
final Project subproject
) {
return projectStateFor(subproject).fromMutableState(
project -> SingleProjectTaskReportModel.forTasks(
getProjectTaskLister().listProjectTasks(project),
taskDetailsFactory
)
);
}
private ProjectState projectStateFor(Project subproject) {
return getProjectStateRegistry().stateFor(subproject);
}
/**
* Injects a {@code ProjectStateRegistry} service.
*
* @since 5.0
*/
@Inject
protected ProjectStateRegistry getProjectStateRegistry() {
throw new UnsupportedOperationException();
}
@Inject
protected ProjectTaskLister getProjectTaskLister() {
throw new UnsupportedOperationException();
}
}