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
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* 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 02110-1301, USA.
*/
package org.sonar.scanner.bootstrap;
import com.google.gson.Gson;
import java.io.File;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import javax.annotation.Nullable;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.api.utils.log.Profiler;
import org.sonar.core.platform.PluginInfo;
import org.sonar.core.plugin.PluginType;
import org.sonarqube.ws.client.GetRequest;
import static java.lang.String.format;
/**
* Downloads the plugins installed on server and stores them in a local user cache
*/
public class ScannerPluginInstaller implements PluginInstaller {
private static final Logger LOG = Loggers.get(ScannerPluginInstaller.class);
private static final String PLUGINS_WS_URL = "api/plugins/installed";
private final PluginFiles pluginFiles;
private final DefaultScannerWsClient wsClient;
private List<InstalledPlugin> availablePlugins;
public ScannerPluginInstaller(PluginFiles pluginFiles, DefaultScannerWsClient wsClient) {
this.pluginFiles = pluginFiles;
this.wsClient = wsClient;
}
@Override
public Map<String, ScannerPlugin> installAllPlugins() {
LOG.info("Loading all plugins");
return installPlugins(p -> true).installedPluginsByKey;
}
@Override
public Map<String, ScannerPlugin> installRequiredPlugins() {
LOG.info("Loading required plugins");
InstallResult result = installPlugins(p -> p.getRequiredForLanguages() == null || p.getRequiredForLanguages().isEmpty());
LOG.debug("Plugins not loaded because they are optional: {}", result.skippedPlugins);
return result.installedPluginsByKey;
}
@Override
public Map<String, ScannerPlugin> installPluginsForLanguages(Set<String> languageKeys) {
LOG.info("Loading plugins for detected languages");
LOG.debug("Detected languages: {}", languageKeys);
InstallResult result = installPlugins(
p -> p.getRequiredForLanguages() != null && !Collections.disjoint(p.getRequiredForLanguages(), languageKeys)
);
List<InstalledPlugin> skippedLanguagePlugins = result.skippedPlugins.stream()
.filter(p -> p.getRequiredForLanguages() != null && !p.getRequiredForLanguages().isEmpty()).toList();
LOG.debug("Optional language-specific plugins not loaded: {}", skippedLanguagePlugins);
return result.installedPluginsByKey;
}
private InstallResult installPlugins(Predicate<InstalledPlugin> pluginFilter) {
if (this.availablePlugins == null) {
this.availablePlugins = listInstalledPlugins();
}
Profiler profiler = Profiler.create(LOG).startInfo("Load/download plugins");
try {
InstallResult result = new InstallResult();
Loaded loaded = loadPlugins(result, pluginFilter);
if (!loaded.ok) {
// retry once, a plugin may have been uninstalled during downloads
this.availablePlugins = listInstalledPlugins();
result.installedPluginsByKey.clear();
loaded = loadPlugins(result, pluginFilter);
if (!loaded.ok) {
throw new IllegalStateException(format("Fail to download plugin [%s]. Not found.", loaded.notFoundPlugin));
}
}
return result;
} finally {
profiler.stopInfo();
}
}
private Loaded loadPlugins(InstallResult result, Predicate<InstalledPlugin> pluginFilter) {
List<InstalledPlugin> pluginsToInstall = availablePlugins.stream()
.filter(pluginFilter).toList();
for (InstalledPlugin plugin : pluginsToInstall) {
Optional<File> jarFile = pluginFiles.get(plugin);
if (jarFile.isEmpty()) {
return new Loaded(false, plugin.key);
}
PluginInfo info = PluginInfo.create(jarFile.get());
result.installedPluginsByKey.put(info.getKey(), new ScannerPlugin(plugin.key, plugin.updatedAt, PluginType.valueOf(plugin.type), info));
}
result.skippedPlugins = availablePlugins.stream()
.filter(Predicate.not(pluginFilter)).toList();
return new Loaded(true, null);
}
/**
* Returns empty on purpose. This method is used only by medium tests.
*/
@Override
public List<Object[]> installLocals() {
return Collections.emptyList();
}
/**
* Gets information about the plugins installed on server (filename, checksum)
*/
private List<InstalledPlugin> listInstalledPlugins() {
Profiler profiler = Profiler.create(LOG).startInfo("Load plugins index");
GetRequest getRequest = new GetRequest(PLUGINS_WS_URL);
InstalledPlugins installedPlugins;
try (Reader reader = wsClient.call(getRequest).contentReader()) {
installedPlugins = new Gson().fromJson(reader, InstalledPlugins.class);
} catch (Exception e) {
throw new IllegalStateException("Fail to parse response of " + PLUGINS_WS_URL, e);
}
profiler.stopInfo();
return installedPlugins.plugins;
}
private static class InstallResult {
Map<String, ScannerPlugin> installedPluginsByKey = new HashMap<>();
List<InstalledPlugin> skippedPlugins = new ArrayList<>();
}
private static class InstalledPlugins {
List<InstalledPlugin> plugins;
public InstalledPlugins() {
// http://stackoverflow.com/a/18645370/229031
}
}
static class InstalledPlugin {
String key;
String hash;
long updatedAt;
String type;
private Set<String> requiredForLanguages;
public InstalledPlugin() {
// http://stackoverflow.com/a/18645370/229031
}
public Set<String> getRequiredForLanguages() {
return requiredForLanguages;
}
@Override
public String toString() {
return key;
}
}
private static class Loaded {
private final boolean ok;
@Nullable
private final String notFoundPlugin;
private Loaded(boolean ok, @Nullable String notFoundPlugin) {
this.ok = ok;
this.notFoundPlugin = notFoundPlugin;
}
}
}
|
