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
|
/*
* SonarSource :: IT :: SonarQube Scanner
* Copyright (C) 2009-2019 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 com.sonarsource.scanner.it;
import com.sonar.orchestrator.build.BuildResult;
import com.sonar.orchestrator.build.SonarScanner;
import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.stream.Collectors;
import org.assertj.core.api.Condition;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonarqube.ws.WsMeasures.Measure;
import static java.lang.Integer.parseInt;
import static org.assertj.core.api.Assertions.assertThat;
public class ScannerTest extends ScannerTestCase {
@Rule
public TemporaryFolder temp = new TemporaryFolder();
@After
public void cleanup() {
orchestrator.resetData();
}
@Test
public void basedir_contains_sources() {
SonarScanner build = newScanner(new File("projects/basedir-with-source"));
orchestrator.executeBuild(build);
Map<String, Measure> projectMeasures = getMeasures("java:basedir-with-source", "files", "ncloc");
assertThat(parseInt(projectMeasures.get("files").getValue())).isEqualTo(1);
assertThat(parseInt(projectMeasures.get("ncloc").getValue())).isGreaterThan(1);
}
/**
* Replace the maven format groupId:artifactId by a single key
*/
@Test
public void should_support_simple_project_keys() {
SonarScanner build = newScanner(new File("projects/simple-sample"))
.setProjectKey("SAMPLE");
orchestrator.executeBuild(build);
Map<String, Measure> projectMeasures = getMeasures("SAMPLE", "files", "ncloc");
assertThat(parseInt(projectMeasures.get("files").getValue())).isEqualTo(2);
assertThat(parseInt(projectMeasures.get("ncloc").getValue())).isGreaterThan(1);
}
/**
* SONARPLUGINS-1230
*/
@Test
public void should_override_working_dir_with_relative_path() {
SonarScanner build = newScanner(new File("projects/override-working-dir"))
.setProperty("sonar.working.directory", ".overridden-relative-sonar");
orchestrator.executeBuild(build);
assertThat(new File("projects/override-working-dir/.sonar")).doesNotExist();
assertThat(new File("projects/override-working-dir/.overridden-relative-sonar")).exists().isDirectory();
}
/**
* SONARPLUGINS-1230
*/
@Test
public void should_override_working_dir_with_absolute_path() {
File projectHome = new File("projects/override-working-dir");
SonarScanner build = newScanner(projectHome)
.setProperty("sonar.working.directory", new File(projectHome, ".overridden-absolute-sonar").getAbsolutePath());
orchestrator.executeBuild(build);
assertThat(new File("projects/override-working-dir/.sonar")).doesNotExist();
assertThat(new File("projects/override-working-dir/.overridden-absolute-sonar")).exists().isDirectory();
}
/**
* SONARPLUGINS-1856
*/
@Test
public void should_fail_if_source_dir_does_not_exist() {
SonarScanner build = newScanner(new File("projects/bad-source-dirs"));
BuildResult result = orchestrator.executeBuildQuietly(build);
assertThat(result.getStatus()).isNotEqualTo(0);
// with the following message
assertThat(result.getLogs()).contains("Invalid value of sonar.sources for bad-source-dirs");
}
/**
* SONARPLUGINS-2256
*/
@Test
public void should_warn_when_analysis_is_platform_dependent() {
SonarScanner build = newScanner(new File("projects/simple-sample"))
// ORCH-243
.setSourceEncoding("");
String log = orchestrator.executeBuild(build).getLogs();
// Note: we can't really check the locale value and the charset because the ones used during the Sonar analysis may not be the ones
// used to launch the tests. But we can check that the analysis is platform dependent (i.e. "sonar.sourceEncoding" hasn't been set).
assertThat(log).contains("Default locale:");
assertThat(log).contains(", source code encoding:");
assertThat(log).contains("(analysis is platform dependent)");
}
/**
* SONARUNNER-153
*/
@Test
public void should_enable_verbose() {
// this line should appear in all versions (LTS-DEV) in debug only
String expectedLog = "Available languages:";
SonarScanner build = newScanner(new File("projects/simple-sample"))
.setProperty("sonar.verbose", "true");
String logs = orchestrator.executeBuild(build).getLogs();
assertThat(logs).contains(expectedLog);
}
@Test
public void should_use_environment_props() {
SonarScanner build = newScanner(new File("projects/simple-sample-no-properties"))
.setEnvironmentVariable("SONARQUBE_SCANNER_PARAMS", "{"
+ "\"sonar.projectKey\" : \"sample\"," +
"\"sonar.projectName\" : \"Sample, with comma\"," +
"\"sonar.projectDescription\" : \"This is a sample\"," +
"\"sonar.projectVersion\" : \"1.2.3\"," +
"\"sonar.sources\" : \"src\" }");
orchestrator.executeBuild(build);
}
@Test
public void should_skip_analysis() {
SonarScanner build = newScanner(new File("projects/simple-sample"))
.setProperty("sonar.host.url", "http://foo")
.setEnvironmentVariable("SONARQUBE_SCANNER_PARAMS", "{ \"sonar.scanner.skip\":\"true\" }");
BuildResult result = orchestrator.executeBuild(build);
assertThat(result.getLogs()).contains("SonarQube Scanner analysis skipped");
}
@Test
public void should_fail_if_unable_to_connect() {
SonarScanner build = newScanner(new File("projects/simple-sample"))
.setProperty("sonar.host.url", "http://foo");
BuildResult result = orchestrator.executeBuildQuietly(build);
// expect build failure
assertThat(result.getStatus()).isNotEqualTo(0);
// with the following message
assertThat(result.getLogs()).contains("SonarQube server [http://foo] can not be reached");
}
// SONARPLUGINS-3574
@Test
public void run_from_external_location() throws IOException {
File tempDir = temp.newFolder();
SonarScanner build = newScanner(tempDir)
.setProperty("sonar.projectBaseDir", new File("projects/simple-sample").getAbsolutePath())
.addArguments("-e");
orchestrator.executeBuild(build);
assertThat(getComponent("sample").getDescription()).isEqualTo("This is a sample");
Map<String, Measure> projectMeasures = getMeasures("sample", "files", "ncloc", "classes", "violations");
assertThat(projectMeasures.values().stream().filter(measure -> measure.getValue() != null).collect(Collectors.toList())).hasSize(4);
}
@Test
public void verify_env_variable() {
SonarScanner build = newScanner(new File("projects/simple-sample"))
.setEnvironmentVariable("SONAR_SCANNER_OPTS", "-Xmx2m");
BuildResult executeBuild = orchestrator.executeBuildQuietly(build);
assertThat(executeBuild.getStatus()).isNotEqualTo(0);
String logs = executeBuild.getLogs();
assertThat(logs).is(new Condition<String>("Contain error message about OOM") {
@Override
public boolean matches(String value) {
return value.contains("java.lang.OutOfMemoryError")
|| value.contains("GC overhead limit exceeded") || value.contains("Java heap space");
}
});
}
}
|
