-
Notifications
You must be signed in to change notification settings - Fork 92
/
SonarQubePlugin.java
197 lines (172 loc) · 9.13 KB
/
SonarQubePlugin.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
/*
* SonarQube Scanner for Gradle
* Copyright (C) 2015-2024 SonarSource
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonarqube.gradle;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.Callable;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.UnknownTaskException;
import org.gradle.api.logging.Logger;
import org.gradle.api.logging.Logging;
import org.gradle.api.plugins.JavaBasePlugin;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Provider;
import org.gradle.testing.jacoco.plugins.JacocoPlugin;
import org.gradle.testing.jacoco.tasks.JacocoReport;
import org.gradle.util.GradleVersion;
import static org.sonarqube.gradle.SonarUtils.capitalize;
import static org.sonarqube.gradle.SonarUtils.isAndroidProject;
/**
* A plugin for analyzing projects with the <a href="http://redirect.sonarsource.com/doc/analyzing-with-sq-gradle.html">SonarScanner for Gradle</a>.
* When applied to a project, both the project itself and its subprojects will be analyzed (in a single run).
*/
public class SonarQubePlugin implements Plugin<Project> {
private static final Logger LOGGER = Logging.getLogger(SonarQubePlugin.class);
private static ActionBroadcast<SonarProperties> addBroadcaster(Map<String, ActionBroadcast<SonarProperties>> actionBroadcastMap, Project project) {
return actionBroadcastMap.computeIfAbsent(project.getPath(), s -> new ActionBroadcast<>());
}
private static boolean addTaskByName(Project p, String name, List<Task> allCompileTasks) {
try {
allCompileTasks.add(p.getTasks().getByName(name));
return true;
} catch (UnknownTaskException e) {
return false;
}
}
@Override
public void apply(Project project) {
// don't try to see if the task was added to any project in the hierarchy. If you do it, it will try to resolve recursively the configuration of all
// the projects, failing if a project has a sonarqube configuration since the extension wasn't added to it yet.
if (project.getExtensions().findByName(SonarExtension.SONAR_EXTENSION_NAME) == null) {
Map<String, ActionBroadcast<SonarProperties>> actionBroadcastMap = new HashMap<>();
addExtensions(project, SonarExtension.SONAR_EXTENSION_NAME, actionBroadcastMap);
addExtensions(project, SonarExtension.SONAR_DEPRECATED_EXTENSION_NAME, actionBroadcastMap);
LOGGER.debug("Adding '{}' task to '{}'", SonarExtension.SONAR_TASK_NAME, project);
SonarTask sonarqubeTask = project.getTasks().create(SonarExtension.SONAR_DEPRECATED_TASK_NAME, SonarTask.class);
sonarqubeTask.setDescription("Analyzes " + project + " and its subprojects with Sonar. This task is deprecated. Use 'sonar' instead.");
sonarqubeTask.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
SonarTask sonarTask = project.getTasks().create(SonarExtension.SONAR_TASK_NAME, SonarTask.class);
sonarTask.setDescription("Analyzes " + project + " and its subprojects with Sonar.");
sonarTask.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
configureTask(sonarqubeTask, project, actionBroadcastMap);
configureTask(sonarTask, project, actionBroadcastMap);
}
}
private static void addExtensions(Project project, String name, Map<String, ActionBroadcast<SonarProperties>> actionBroadcastMap) {
project.getAllprojects().forEach(p -> {
LOGGER.debug("Adding " + name + " extension to " + p);
ActionBroadcast<SonarProperties> actionBroadcast = addBroadcaster(actionBroadcastMap, p);
p.getExtensions().create(name, SonarExtension.class, actionBroadcast);
});
}
private static void configureTask(SonarTask sonarTask, Project project, Map<String, ActionBroadcast<SonarProperties>> actionBroadcastMap) {
Provider<Map<String, String>> conventionProvider = project.provider(() -> new SonarPropertyComputer(actionBroadcastMap, project).computeSonarProperties())
.map(m -> m.entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey, e -> (String) e.getValue())));
if (isGradleVersionGreaterOrEqualTo("6.1")) {
MapProperty<String, String> mapProperty = project.getObjects().mapProperty(String.class, String.class);
mapProperty.convention(conventionProvider);
mapProperty.finalizeValueOnRead();
sonarTask.setProperties(mapProperty);
} else {
sonarTask.setProperties(conventionProvider);
}
sonarTask.mustRunAfter(getJavaCompileTasks(project));
sonarTask.mustRunAfter(getAndroidCompileTasks(project));
sonarTask.mustRunAfter(getJavaTestTasks(project));
sonarTask.mustRunAfter(getJacocoTasks(project));
setNotCompatibleWithConfigurationCache(sonarTask);
}
private static void setNotCompatibleWithConfigurationCache(SonarTask sonarQubeTask) {
if (isGradleVersionGreaterOrEqualTo("7.4.0")) {
sonarQubeTask.notCompatibleWithConfigurationCache("Plugin is not compatible with configuration cache");
}
}
private static boolean isGradleVersionGreaterOrEqualTo(String version) {
return GradleVersion.current().compareTo(GradleVersion.version(version)) >= 0;
}
private static Callable<Iterable<? extends Task>> getJacocoTasks(Project project) {
return () -> project.getAllprojects().stream()
.filter(p -> p.getPlugins().hasPlugin(JacocoPlugin.class) && notSkipped(p))
.map(p -> p.getTasks().withType(JacocoReport.class))
.flatMap(Collection::stream)
.collect(Collectors.toList());
}
private static Callable<Iterable<? extends Task>> getJavaTestTasks(Project project) {
return () -> project.getAllprojects().stream()
.filter(p -> p.getPlugins().hasPlugin(JavaPlugin.class) && notSkipped(p))
.map(p -> p.getTasks().getByName(JavaPlugin.TEST_TASK_NAME))
.collect(Collectors.toList());
}
private static Callable<Iterable<? extends Task>> getJavaCompileTasks(Project project) {
return () -> project.getAllprojects().stream()
.filter(p -> p.getPlugins().hasPlugin(JavaPlugin.class) && notSkipped(p))
.flatMap(p -> Stream.of(p.getTasks().getByName(JavaPlugin.COMPILE_JAVA_TASK_NAME), p.getTasks().getByName(JavaPlugin.COMPILE_TEST_JAVA_TASK_NAME)))
.collect(Collectors.toList());
}
static boolean notSkipped(Project p) {
return !isSkipped(p);
}
static boolean isSkipped(Project p) {
return getSonarExtensions(p).stream().anyMatch(SonarExtension::isSkipProject);
}
private static List<SonarExtension> getSonarExtensions(Project p) {
return Stream.of(SonarExtension.SONAR_EXTENSION_NAME, SonarExtension.SONAR_DEPRECATED_EXTENSION_NAME)
.map(name -> (SonarExtension) p.getExtensions().getByName(name))
.collect(Collectors.toList());
}
@Nullable
static String getConfiguredAndroidVariant(Project p) {
return getSonarExtensions(p).stream()
.map(SonarExtension::getAndroidVariant)
.filter(Objects::nonNull)
.findFirst().orElse(null);
}
private static Callable<Iterable<? extends Task>> getAndroidCompileTasks(Project project) {
return () -> project.getAllprojects().stream()
.filter(p -> isAndroidProject(p) && notSkipped(p))
.map(p -> {
AndroidUtils.AndroidVariantAndExtension androidVariantAndExtension = AndroidUtils.findVariantAndExtension(p, getConfiguredAndroidVariant(p));
List<Task> allCompileTasks = new ArrayList<>();
if (androidVariantAndExtension != null && androidVariantAndExtension.getVariant() != null) {
final String compileTaskPrefix = "compile" + capitalize(androidVariantAndExtension.getVariant().getName());
boolean unitTestTaskDepAdded = addTaskByName(p, compileTaskPrefix + "UnitTestJavaWithJavac", allCompileTasks);
boolean androidTestTaskDepAdded = addTaskByName(p, compileTaskPrefix + "AndroidTestJavaWithJavac", allCompileTasks);
// unit test compile and android test compile tasks already depends on main code compile so don't add a useless dependency
// that would lead to run main compile task several times
if (!unitTestTaskDepAdded && !androidTestTaskDepAdded) {
addTaskByName(p, compileTaskPrefix + "JavaWithJavac", allCompileTasks);
}
}
return allCompileTasks;
})
.flatMap(List::stream)
.collect(Collectors.toList());
}
}