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
|
/*
* SonarQube Scanner
* Copyright (C) 2011-2016 SonarSource SA
* mailto:contact 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.sonarsource.scanner.cli;
import java.io.IOException;
import java.util.Properties;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
import org.sonarsource.scanner.api.EmbeddedScanner;
import org.sonarsource.scanner.api.ScanProperties;
import static org.fest.assertions.Assertions.assertThat;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
public class MainTest {
@Mock
private Exit exit;
@Mock
private Cli cli;
@Mock
private Conf conf;
@Mock
private Properties properties;
@Mock
private ScannerFactory runnerFactory;
@Mock
private EmbeddedScanner runner;
@Mock
private Logs logs;
@Before
public void setUp() throws IOException {
MockitoAnnotations.initMocks(this);
when(runnerFactory.create(any(Properties.class))).thenReturn(runner);
when(conf.properties()).thenReturn(properties);
}
@Test
public void should_execute_runner() {
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
verify(exit).exit(Exit.SUCCESS);
verify(runnerFactory).create(properties);
verify(runner, times(1)).start();
verify(runner, times(1)).runAnalysis(properties);
verify(runner, times(1)).stop();
}
@Test
public void should_stop_on_error() {
EmbeddedScanner runner = mock(EmbeddedScanner.class);
Exception e = new NullPointerException("NPE");
e = new IllegalStateException("Error", e);
doThrow(e).when(runner).runAnalysis(any(Properties.class));
when(runnerFactory.create(any(Properties.class))).thenReturn(runner);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
verify(runner).stop();
verify(exit).exit(Exit.ERROR);
verify(logs).error("Caused by: NPE");
}
@Test
public void show_error_stacktrace() {
Exception e = show_error(false, true);
verify(logs).error("Error during SonarQube Scanner execution", e);
verify(logs).error("Re-run SonarQube Scanner using the -X switch to enable full debug logging.");
}
@Test
public void show_error_debug() {
Exception e = show_error(true, false);
verify(logs).error("Error during SonarQube Scanner execution", e);
verify(logs, never()).error("Re-run SonarQube Scanner using the -X switch to enable full debug logging.");
}
@Test
public void show_error_debug_stack() {
Exception e = show_error(true, true);
verify(logs).error("Error during SonarQube Scanner execution", e);
verify(logs, never()).error("Re-run SonarQube Scanner using the -X switch to enable full debug logging.");
}
private Exception show_error(boolean debugEnabled, boolean stackTraceEnabled) {
Exception e = new NullPointerException("NPE");
e = new IllegalStateException("Error", e);
when(cli.isDebugEnabled()).thenReturn(debugEnabled);
when(cli.isDisplayStackTrace()).thenReturn(stackTraceEnabled);
EmbeddedScanner runner = mock(EmbeddedScanner.class);
doThrow(e).when(runner).runAnalysis(any(Properties.class));
when(runnerFactory.create(any(Properties.class))).thenReturn(runner);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
verify(runner).stop();
verify(exit).exit(Exit.ERROR);
return e;
}
@Test
public void should_only_display_version() throws IOException {
Properties p = new Properties();
when(cli.isDisplayVersionOnly()).thenReturn(true);
when(conf.properties()).thenReturn(p);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
InOrder inOrder = Mockito.inOrder(exit, runnerFactory);
inOrder.verify(exit, times(1)).exit(Exit.SUCCESS);
inOrder.verify(runnerFactory, times(1)).create(p);
inOrder.verify(exit, times(1)).exit(Exit.SUCCESS);
}
@Test
public void should_skip() throws IOException {
Properties p = new Properties();
p.setProperty(ScanProperties.SKIP, "true");
when(conf.properties()).thenReturn(p);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
verify(logs).info("SonarQube Scanner analysis skipped");
InOrder inOrder = Mockito.inOrder(exit, runnerFactory);
inOrder.verify(exit, times(1)).exit(Exit.SUCCESS);
inOrder.verify(runnerFactory, times(1)).create(p);
inOrder.verify(exit, times(1)).exit(Exit.SUCCESS);
}
@Test
public void shouldLogServerVersion() throws IOException {
when(runner.serverVersion()).thenReturn("5.5");
Properties p = new Properties();
when(cli.isDisplayVersionOnly()).thenReturn(true);
when(conf.properties()).thenReturn(p);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
verify(logs).info("SonarQube server 5.5");
}
@Test
public void should_configure_logging() throws IOException {
Properties analysisProps = testLogging("sonar.verbose", "true");
assertThat(analysisProps.getProperty("sonar.verbose")).isEqualTo("true");
}
@Test
public void should_configure_logging_trace() throws IOException {
Properties analysisProps = testLogging("sonar.log.level", "TRACE");
assertThat(analysisProps.getProperty("sonar.log.level")).isEqualTo("TRACE");
}
@Test
public void should_configure_logging_debug() throws IOException {
Properties analysisProps = testLogging("sonar.log.level", "DEBUG");
assertThat(analysisProps.getProperty("sonar.log.level")).isEqualTo("DEBUG");
}
private Properties testLogging(String propKey, String propValue) throws IOException {
Properties p = new Properties();
p.put(propKey, propValue);
when(conf.properties()).thenReturn(p);
Main main = new Main(exit, cli, conf, runnerFactory, logs);
main.execute();
// Logger used for callback should have debug enabled
verify(logs).setDebugEnabled(true);
verify(logs).setDisplayStackTrace(true);
ArgumentCaptor<Properties> propertiesCapture = ArgumentCaptor.forClass(Properties.class);
verify(runner).runAnalysis(propertiesCapture.capture());
return propertiesCapture.getValue();
}
}
|
