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
|
/*
* 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 org.sonar.home.log.LogListener;
import org.sonar.runner.impl.Logs;
import org.sonar.runner.impl.InternalProperties;
import javax.annotation.Nullable;
import java.io.File;
import java.util.Properties;
/**
* @since 2.2
*/
public abstract class Runner<T extends Runner> {
private final Properties globalProperties = new Properties();
protected Runner() {
}
public Properties globalProperties() {
Properties clone = new Properties();
clone.putAll(globalProperties);
return clone;
}
/**
* Set a log stream. All log events will be redirected to the listener.
* By default, all logs are sent to stdout, except for logs of ERROR level, which are sent to stderr.
* If null is given, the default is behavior is set.
*/
public T setLogListener(LogListener stream) {
Logs.setListener(stream);
return (T) this;
}
/**
* Declare Sonar properties, for example sonar.projectKey=>foo.
*
* @see #setProperty(String, String)
*/
public T addGlobalProperties(Properties p) {
globalProperties.putAll(p);
return (T) this;
}
/**
* Declare a Sonar property.
*
* @see RunnerProperties
* @see ScanProperties
*/
public T setGlobalProperty(String key, String value) {
globalProperties.setProperty(key, value);
return (T) this;
}
public String globalProperty(String key, @Nullable String defaultValue) {
return globalProperties.getProperty(key, defaultValue);
}
/**
* User-agent used in the HTTP requests to the Sonar server
*/
public T setApp(String app, String version) {
setGlobalProperty(InternalProperties.RUNNER_APP, app);
setGlobalProperty(InternalProperties.RUNNER_APP_VERSION, version);
return (T) 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);
Logs.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();
}
protected abstract void doStart();
protected abstract void doStop();
protected abstract void doExecute(Properties analysisProperties);
private void initGlobalDefaultValues() {
setGlobalDefaultValue(RunnerProperties.HOST_URL, "http://localhost:9000");
setGlobalDefaultValue(InternalProperties.RUNNER_APP, "SonarQubeRunner");
setGlobalDefaultValue(InternalProperties.RUNNER_APP_VERSION, RunnerVersion.version());
}
private static void initAnalysisProperties(Properties p) {
SourceEncoding.init(p);
Dirs.init(p);
}
private void setGlobalDefaultValue(String key, String value) {
if (!globalProperties.containsKey(key)) {
setGlobalProperty(key, value);
}
}
}
|
