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
|
/*
* SonarQube Runner - CLI - Distribution
* Copyright (C) 2011 SonarSource
* sonarqube@googlegroups.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.sonar.runner.cli;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Properties;
import org.sonar.runner.api.EmbeddedRunner;
/**
* Arguments :
* <ul>
* <li>runner.home: optional path to runner home (root directory with sub-directories bin, lib and conf)</li>
* <li>runner.settings: optional path to runner global settings, usually ${runner.home}/conf/sonar-runner.properties.
* This property is used only if ${runner.home} is not defined</li>
* <li>project.home: path to project root directory. If not set, then it's supposed to be the directory where the runner is executed</li>
* <li>project.settings: optional path to project settings. Default value is ${project.home}/sonar-project.properties.</li>
* </ul>
*
* @since 1.0
*/
public class Main {
private final Shutdown shutdown;
private final Cli cli;
private final Conf conf;
private EmbeddedRunner runner;
private BufferedReader inputReader;
private RunnerFactory runnerFactory;
private Logs logger;
Main(Shutdown shutdown, Cli cli, Conf conf, RunnerFactory runnerFactory, Logs logger) {
this.shutdown = shutdown;
this.cli = cli;
this.conf = conf;
this.runnerFactory = runnerFactory;
this.logger = logger;
}
public static void main(String[] args) {
Exit exit = new Exit();
Shutdown shutdown = new Shutdown(exit);
Logs logs = new Logs();
Cli cli = new Cli(exit, logs).parse(args);
cli.verify();
Main main = new Main(shutdown, cli, new Conf(cli, logs), new RunnerFactory(logs), logs);
main.execute();
}
void execute() {
Stats stats = new Stats(logger).start();
try {
Properties p = conf.properties();
init(p);
runner.start();
if (cli.isInteractive()) {
interactiveLoop(p);
} else {
runAnalysis(stats, p);
}
} catch (Exception e) {
displayExecutionResult(stats, "FAILURE");
showError("Error during Sonar runner execution", e, cli.isDisplayStackTrace());
shutdown.exit(Exit.ERROR);
}
runner.stop();
shutdown.exit(Exit.SUCCESS);
}
private void interactiveLoop(Properties p) throws IOException {
do {
Stats stats = new Stats(logger).start();
try {
runAnalysis(stats, p);
} catch (Exception e) {
displayExecutionResult(stats, "FAILURE");
showError("Error during Sonar runner execution", e, cli.isDisplayStackTrace());
}
} while (waitForUser());
}
private void init(Properties p) throws IOException {
SystemInfo.print(logger);
if (cli.isDisplayVersionOnly()) {
shutdown.exit(Exit.SUCCESS);
}
if (cli.isDisplayStackTrace()) {
logger.info("Error stacktraces are turned on.");
}
runner = runnerFactory.create(p);
}
private void runAnalysis(Stats stats, Properties p) {
runner.runAnalysis(p);
displayExecutionResult(stats, "SUCCESS");
}
private boolean waitForUser() throws IOException {
if (inputReader == null) {
inputReader = new BufferedReader(new InputStreamReader(System.in, StandardCharsets.UTF_8));
}
shutdown.signalReady(true);
if (shutdown.shouldExit()) {
// exit before displaying message
return false;
}
System.out.println("");
System.out.println("<Press enter to restart analysis or Ctrl+C to exit the interactive mode>");
String line = inputReader.readLine();
shutdown.signalReady(false);
return line != null;
}
// Visible for testing
void setInputReader(BufferedReader inputReader) {
this.inputReader = inputReader;
}
private void displayExecutionResult(Stats stats, String resultMsg) {
logger.info("------------------------------------------------------------------------");
logger.info("EXECUTION " + resultMsg);
logger.info("------------------------------------------------------------------------");
stats.stop();
logger.info("------------------------------------------------------------------------");
}
private void showError(String message, Throwable e, boolean showStackTrace) {
if (showStackTrace) {
logger.error(message, e);
if (!cli.isDebugMode()) {
logger.error("");
suggestDebugMode();
}
} else {
logger.error(message);
if (e != null) {
logger.error(e.getMessage());
String previousMsg = "";
for (Throwable cause = e.getCause(); cause != null
&& cause.getMessage() != null
&& !cause.getMessage().equals(previousMsg); cause = cause.getCause()) {
logger.error("Caused by: " + cause.getMessage());
previousMsg = cause.getMessage();
}
}
logger.error("");
logger.error("To see the full stack trace of the errors, re-run SonarQube Runner with the -e switch.");
if (!cli.isDebugMode()) {
suggestDebugMode();
}
}
}
private void suggestDebugMode() {
logger.error("Re-run SonarQube Runner using the -X switch to enable full debug logging.");
}
}
|
