-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
AbstractDependencyReportTask.java
145 lines (127 loc) · 5.33 KB
/
AbstractDependencyReportTask.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
/*
* Copyright 2015 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 org.gradle.api.Incubating;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.ConfigurationContainer;
import org.gradle.api.internal.artifacts.configurations.ConfigurationInternal;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.diagnostics.internal.ConfigurationDetails;
import org.gradle.api.tasks.diagnostics.internal.ConfigurationFinder;
import org.gradle.api.tasks.diagnostics.internal.DependencyReportRenderer;
import org.gradle.api.tasks.diagnostics.internal.ProjectDetails;
import org.gradle.api.tasks.diagnostics.internal.ReportRenderer;
import org.gradle.api.tasks.diagnostics.internal.dependencies.AsciiDependencyReportRenderer;
import org.gradle.api.tasks.options.Option;
import org.gradle.work.DisableCachingByDefault;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
/**
* Displays the dependency tree for a configuration.
*/
@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
public abstract class AbstractDependencyReportTask extends AbstractProjectBasedReportTask<AbstractDependencyReportTask.DependencyReportModel> {
private DependencyReportRenderer renderer = new AsciiDependencyReportRenderer();
private transient Set<Configuration> configurations;
@Override
public ReportRenderer getRenderer() {
return renderer;
}
/**
* Set the renderer to use to build a report. If unset, AsciiGraphRenderer will be used.
*/
public void setRenderer(DependencyReportRenderer renderer) {
this.renderer = renderer;
}
/**
* Report model.
*
* @since 7.6
*/
@Incubating
public static final class DependencyReportModel {
private final List<ConfigurationDetails> configurations;
private DependencyReportModel(List<ConfigurationDetails> configurations) {
this.configurations = configurations;
}
}
@Override
protected DependencyReportModel calculateReportModelFor(Project project) {
SortedSet<Configuration> sortedConfigurations = new TreeSet<>(Comparator.comparing(Configuration::getName));
sortedConfigurations.addAll(getReportConfigurations());
List<ConfigurationDetails> configurationDetails = new ArrayList<>(sortedConfigurations.size());
for (Configuration configuration : sortedConfigurations) {
configurationDetails.add(ConfigurationDetails.of(configuration));
}
return new DependencyReportModel(configurationDetails);
}
@Override
protected void generateReportFor(ProjectDetails project, DependencyReportModel model) {
for (ConfigurationDetails configuration : model.configurations) {
renderer.startConfiguration(configuration);
renderer.render(configuration);
renderer.completeConfiguration(configuration);
}
}
private Set<Configuration> getReportConfigurations() {
return configurations != null ? configurations : getNonDeprecatedTaskConfigurations();
}
/**
* Returns the configurations to generate the report for. Defaults to all configurations of this task's containing
* project.
*
* @return the configurations.
*/
@Internal
public Set<Configuration> getConfigurations() {
return configurations;
}
/**
* Sets the configurations to generate the report for.
*
* @param configurations The configuration. Must not be null.
*/
public void setConfigurations(Set<Configuration> configurations) {
this.configurations = configurations;
}
/**
* Sets the single configuration (by name) to generate the report for.
*
* @param configurationName name of the configuration to generate the report for
*/
@Option(option = "configuration", description = "The configuration to generate the report for.")
public void setConfiguration(String configurationName) {
this.configurations = Collections.singleton(ConfigurationFinder.find(getTaskConfigurations(), configurationName));
}
private Set<Configuration> getNonDeprecatedTaskConfigurations() {
Set<Configuration> filteredConfigurations = new HashSet<>();
for (Configuration configuration : getTaskConfigurations()) {
if (((ConfigurationInternal)configuration).isDeclarableByExtension()) {
filteredConfigurations.add(configuration);
}
}
return filteredConfigurations;
}
@Internal
public abstract ConfigurationContainer getTaskConfigurations();
}