-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
PropertyReportTask.java
148 lines (132 loc) · 5.14 KB
/
PropertyReportTask.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
/*
* 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 org.gradle.api.Incubating;
import org.gradle.api.Project;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.diagnostics.internal.ProjectDetails;
import org.gradle.api.tasks.diagnostics.internal.PropertyReportRenderer;
import org.gradle.api.tasks.diagnostics.internal.ReportRenderer;
import org.gradle.api.tasks.options.Option;
import org.gradle.internal.Pair;
import org.gradle.work.DisableCachingByDefault;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
/**
* Displays the properties of a project. An instance of this type is used when you execute the {@code properties} task
* from the command-line.
*/
@DisableCachingByDefault(because = "Not worth caching")
public abstract class PropertyReportTask extends AbstractProjectBasedReportTask<PropertyReportTask.PropertyReportModel> {
private PropertyReportRenderer renderer = new PropertyReportRenderer();
private final Property<String> property = getProject().getObjects().property(String.class);
/**
* Defines a specific property to report. If not set then all properties will appear in the report.
*
* @since 7.5
*/
@Incubating
@Input
@Optional
@Option(option = "property", description = "A specific property to output")
public Property<String> getProperty() {
return property;
}
@Internal
@Override
public ReportRenderer getRenderer() {
return renderer;
}
public void setRenderer(PropertyReportRenderer renderer) {
this.renderer = renderer;
}
@Override
protected PropertyReportModel calculateReportModelFor(Project project) {
return computePropertyReportModel(project);
}
private PropertyReportTask.PropertyReportModel computePropertyReportModel(Project project) {
PropertyReportModel model = new PropertyReportModel();
Map<String, ?> projectProperties = project.getProperties();
if (property.isPresent()) {
String propertyName = property.get();
if ("properties".equals(propertyName)) {
model.putProperty(propertyName, "{...}");
} else {
model.putProperty(propertyName, projectProperties.get(propertyName));
}
} else {
for (Map.Entry<String, ?> entry : new TreeMap<>(projectProperties).entrySet()) {
if ("properties".equals(entry.getKey())) {
model.putProperty(entry.getKey(), "{...}");
} else {
model.putProperty(entry.getKey(), entry.getValue());
}
}
}
return model;
}
@Override
protected void generateReportFor(ProjectDetails project, PropertyReportModel model) {
for (PropertyWarning warning : model.warnings) {
getLogger().warn(
"Rendering of the property '{}' with value type '{}' failed with exception",
warning.name, warning.valueClass, warning.exception
);
}
for (Pair<String, String> entry : model.properties) {
renderer.addProperty(entry.getLeft(), entry.getRight());
}
}
/**
* Model for the report.
*
* @since 7.6
*/
@Incubating
public static final class PropertyReportModel {
private PropertyReportModel() {
}
private final List<PropertyWarning> warnings = new ArrayList<>();
private final List<Pair<String, String>> properties = new ArrayList<>();
private void putProperty(String name, @Nullable Object value) {
String strValue;
try {
strValue = String.valueOf(value);
} catch (Exception e) {
String valueClass = value != null ? String.valueOf(value.getClass()) : "null";
warnings.add(new PropertyWarning(name, valueClass, e));
strValue = valueClass + " [Rendering failed]";
}
properties.add(Pair.of(name, strValue));
}
}
private static class PropertyWarning {
private final String name;
private final String valueClass;
private final Exception exception;
private PropertyWarning(String name, String valueClass, Exception exception) {
this.name = name;
this.valueClass = valueClass;
this.exception = exception;
}
}
}