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
|
/*
* SonarQube Runner - API
* Copyright (C) 2011 SonarSource
* dev@sonar.codehaus.org
*
* 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.sonar.runner.api;
import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.util.Locale;
import java.util.Properties;
import javax.annotation.Nullable;
import org.sonar.home.cache.Logger;
import org.sonar.runner.batch.IsolatedLauncher;
import org.sonar.runner.impl.InternalProperties;
import org.sonar.runner.impl.IsolatedLauncherFactory;
/**
* Entry point to run SonarQube analysis programmatically.
* @since 2.2
*/
public class EmbeddedRunner {
private final IsolatedLauncherFactory launcherFactory;
private IsolatedLauncher launcher;
private final LogOutput logOutput;
private final Properties globalProperties = new Properties();
private final Logger logger;
EmbeddedRunner(IsolatedLauncherFactory bl, Logger logger, LogOutput logOutput) {
this.logger = logger;
this.launcherFactory = bl;
this.logOutput = logOutput;
}
public static EmbeddedRunner create(final LogOutput logOutput) {
Logger logger = new Logger() {
@Override
public void warn(String msg) {
logOutput.log(msg, LogOutput.Level.WARN);
}
@Override
public void info(String msg) {
logOutput.log(msg, LogOutput.Level.INFO);
}
@Override
public void error(String msg, Throwable t) {
StringWriter errors = new StringWriter();
t.printStackTrace(new PrintWriter(errors));
logOutput.log(msg + "\n" + errors.toString(), LogOutput.Level.ERROR);
}
@Override
public void error(String msg) {
logOutput.log(msg, LogOutput.Level.ERROR);
}
@Override
public void debug(String msg) {
logOutput.log(msg, LogOutput.Level.DEBUG);
}
};
return new EmbeddedRunner(new IsolatedLauncherFactory(logger), logger, logOutput);
}
public Properties globalProperties() {
Properties clone = new Properties();
clone.putAll(globalProperties);
return clone;
}
/**
* Declare Sonar properties, for example sonar.projectKey=>foo.
*
* @see #setProperty(String, String)
*/
public EmbeddedRunner addGlobalProperties(Properties p) {
globalProperties.putAll(p);
return this;
}
/**
* Declare a SonarQube property.
*
* @see RunnerProperties
* @see ScanProperties
*/
public EmbeddedRunner setGlobalProperty(String key, String value) {
globalProperties.setProperty(key, value);
return this;
}
public String globalProperty(String key, @Nullable String defaultValue) {
return globalProperties.getProperty(key, defaultValue);
}
/**
* User-agent used in the HTTP requests to the SonarQube server
*/
public EmbeddedRunner setApp(String app, String version) {
setGlobalProperty(InternalProperties.RUNNER_APP, app);
setGlobalProperty(InternalProperties.RUNNER_APP_VERSION, version);
return this;
}
public String app() {
return globalProperty(InternalProperties.RUNNER_APP, null);
}
public String appVersion() {
return globalProperty(InternalProperties.RUNNER_APP_VERSION, null);
}
public void runAnalysis(Properties analysisProperties) {
Properties copy = new Properties();
copy.putAll(analysisProperties);
initAnalysisProperties(copy);
String dumpToFile = copy.getProperty(InternalProperties.RUNNER_DUMP_TO_FILE);
if (dumpToFile != null) {
File dumpFile = new File(dumpToFile);
Utils.writeProperties(dumpFile, copy);
logger.info("Simulation mode. Configuration written to " + dumpFile.getAbsolutePath());
} else {
doExecute(copy);
}
}
public void start() {
initGlobalDefaultValues();
doStart();
}
public void stop() {
doStop();
}
/**
* @deprecated since 2.5 use {@link #start()}, {@link #runAnalysis(Properties)} and then {@link #stop()}
*/
@Deprecated
public final void execute() {
start();
runAnalysis(new Properties());
stop();
}
private void initGlobalDefaultValues() {
setGlobalDefaultValue(RunnerProperties.HOST_URL, "http://localhost:9000");
setGlobalDefaultValue(InternalProperties.RUNNER_APP, "SonarQubeRunner");
setGlobalDefaultValue(InternalProperties.RUNNER_APP_VERSION, RunnerVersion.version());
}
private void initAnalysisProperties(Properties p) {
initSourceEncoding(p);
new Dirs(logger).init(p);
}
void initSourceEncoding(Properties p) {
boolean onProject = Utils.taskRequiresProject(p);
if (onProject) {
String sourceEncoding = p.getProperty(ScanProperties.PROJECT_SOURCE_ENCODING, "");
boolean platformDependent = false;
if ("".equals(sourceEncoding)) {
sourceEncoding = Charset.defaultCharset().name();
platformDependent = true;
p.setProperty(ScanProperties.PROJECT_SOURCE_ENCODING, sourceEncoding);
}
logger.info("Default locale: \"" + Locale.getDefault() + "\", source code encoding: \"" + sourceEncoding + "\""
+ (platformDependent ? " (analysis is platform dependent)" : ""));
}
}
private void setGlobalDefaultValue(String key, String value) {
if (!globalProperties.containsKey(key)) {
setGlobalProperty(key, value);
}
}
protected void doStart() {
launcher = launcherFactory.createLauncher(globalProperties());
if (Utils.isAtLeast52(launcher.getVersion())) {
launcher.start(globalProperties(), new org.sonar.runner.batch.LogOutput() {
@Override
public void log(String formattedMessage, Level level) {
logOutput.log(formattedMessage, LogOutput.Level.valueOf(level.name()));
}
});
}
}
protected void doStop() {
if (Utils.isAtLeast52(launcher.getVersion())) {
launcher.stop();
}
}
protected void doExecute(Properties analysisProperties) {
if (Utils.isAtLeast52(launcher.getVersion())) {
launcher.execute(analysisProperties);
} else {
Properties prop = new Properties();
prop.putAll(globalProperties());
prop.putAll(analysisProperties);
launcher.executeOldVersion(prop);
}
}
}
|
