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
|
/*
* SonarQube
* Copyright (C) 2009-2025 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 org.sonar.application.config;
import java.io.File;
import java.net.InetAddress;
import java.util.Properties;
import org.apache.commons.io.FileUtils;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonar.process.MessageException;
import org.sonar.process.Props;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.sonar.application.config.JdbcSettings.Provider;
import static org.sonar.process.ProcessProperties.Property.JDBC_ADDITIONAL_LIB_PATHS;
import static org.sonar.process.ProcessProperties.Property.JDBC_DRIVER_PATH;
import static org.sonar.process.ProcessProperties.Property.JDBC_URL;
import static org.sonar.process.ProcessProperties.Property.PATH_HOME;
public class JdbcSettingsTest {
@Rule
public TemporaryFolder temp = new TemporaryFolder();
private final JdbcSettings underTest = new JdbcSettings();
private File homeDir;
@Before
public void setUp() throws Exception {
homeDir = temp.newFolder();
}
@Test
public void resolve_H2_provider_when_props_is_empty_and_set_URL_to_default_H2() {
Props props = newProps();
assertThat(underTest.resolveProviderAndEnforceNonnullJdbcUrl(props))
.isEqualTo(Provider.H2);
assertThat(props.nonNullValue(JDBC_URL.getKey())).isEqualTo(String.format("jdbc:h2:tcp://%s:9092/sonar;NON_KEYWORDS=VALUE", InetAddress.getLoopbackAddress().getHostAddress()));
}
@Test
public void resolve_Oracle_when_jdbc_url_contains_oracle_in_any_case() {
checkProviderForUrlAndUnchangedUrl("jdbc:oracle:foo", Provider.ORACLE);
checkProviderForUrlAndUnchangedUrl("jdbc:OrAcLe:foo", Provider.ORACLE);
}
@Test
public void resolve_SqlServer_when_jdbc_url_contains_sqlserver_in_any_case() {
checkProviderForUrlAndUnchangedUrl("jdbc:sqlserver:foo", Provider.SQLSERVER);
checkProviderForUrlAndUnchangedUrl("jdbc:SQLSeRVeR:foo", Provider.SQLSERVER);
}
@Test
public void resolve_POSTGRESQL_when_jdbc_url_contains_POSTGRESQL_in_any_case() {
checkProviderForUrlAndUnchangedUrl("jdbc:postgresql:foo", Provider.POSTGRESQL);
checkProviderForUrlAndUnchangedUrl("jdbc:POSTGRESQL:foo", Provider.POSTGRESQL);
}
private void checkProviderForUrlAndUnchangedUrl(String url, Provider expected) {
Props props = newProps(JDBC_URL.getKey(), url);
assertThat(underTest.resolveProviderAndEnforceNonnullJdbcUrl(props)).isEqualTo(expected);
assertThat(props.nonNullValue(JDBC_URL.getKey())).isEqualTo(url);
}
@Test
public void fail_with_MessageException_when_provider_is_not_supported() {
Props props = newProps(JDBC_URL.getKey(), "jdbc:microsoft:sqlserver://localhost");
assertThatThrownBy(() -> underTest.resolveProviderAndEnforceNonnullJdbcUrl(props))
.isInstanceOf(MessageException.class)
.hasMessage("Unsupported JDBC driver provider: microsoft");
}
@Test
public void fail_with_MessageException_when_url_does_not_have_jdbc_prefix() {
Props props = newProps(JDBC_URL.getKey(), "oracle:thin:@localhost/XE");
assertThatThrownBy(() -> underTest.resolveProviderAndEnforceNonnullJdbcUrl(props))
.isInstanceOf(MessageException.class)
.hasMessage("Bad format of JDBC URL: oracle:thin:@localhost/XE");
}
@Test
public void checkAndComplete_sets_driver_path_for_oracle() throws Exception {
File driverFile = new File(homeDir, "extensions/jdbc-driver/oracle/ojdbc6.jar");
FileUtils.touch(driverFile);
Props props = newProps(JDBC_URL.getKey(), "jdbc:oracle:thin:@localhost/XE");
underTest.accept(props);
assertThat(props.nonNullValueAsFile(JDBC_DRIVER_PATH.getKey())).isEqualTo(driverFile);
}
@Test
public void sets_driver_path_for_h2() throws Exception {
File driverFile = new File(homeDir, "lib/jdbc/h2/h2.jar");
FileUtils.touch(driverFile);
Props props = newProps(JDBC_URL.getKey(), "jdbc:h2:tcp://localhost:9092/sonar");
underTest.accept(props);
assertThat(props.nonNullValueAsFile(JDBC_DRIVER_PATH.getKey())).isEqualTo(driverFile);
}
@Test
public void checkAndComplete_sets_driver_path_for_postgresql() throws Exception {
File driverFile = new File(homeDir, "lib/jdbc/postgresql/pg.jar");
FileUtils.touch(driverFile);
Props props = newProps(JDBC_URL.getKey(), "jdbc:postgresql://localhost/sonar");
underTest.accept(props);
assertThat(props.nonNullValueAsFile(JDBC_DRIVER_PATH.getKey())).isEqualTo(driverFile);
}
@Test
public void checkAndComplete_sets_driver_path_for_mssql() throws Exception {
File driverFile = new File(homeDir, "lib/jdbc/mssql/mssql-jdbc.jar");
File additionalDriveFile = new File(homeDir, "lib/jdbc/mssql/entraid.jar");
FileUtils.touch(driverFile);
FileUtils.touch(additionalDriveFile);
Props props = newProps(JDBC_URL.getKey(), "jdbc:sqlserver://localhost/sonar;SelectMethod=Cursor");
underTest.accept(props);
assertThat(props.nonNullValueAsFile(JDBC_DRIVER_PATH.getKey())).isEqualTo(driverFile);
assertThat(props.nonNullValueAsFile(JDBC_ADDITIONAL_LIB_PATHS.getKey())).isEqualTo(additionalDriveFile);
}
@Test
public void driver_file() throws Exception {
File driverFile = new File(homeDir, "extensions/jdbc-driver/oracle/ojdbc6.jar");
FileUtils.touch(driverFile);
String path = underTest.driverPath(homeDir, Provider.ORACLE);
assertThat(path).isEqualTo(driverFile.getAbsolutePath());
}
@Test
public void driver_dir_does_not_exist() {
assertThatThrownBy(() -> underTest.driverPath(homeDir, Provider.ORACLE))
.isInstanceOf(MessageException.class)
.hasMessage("Directory does not exist: extensions/jdbc-driver/oracle");
}
@Test
public void no_files_in_driver_dir() throws Exception {
FileUtils.forceMkdir(new File(homeDir, "extensions/jdbc-driver/oracle"));
assertThatThrownBy(() -> underTest.driverPath(homeDir, Provider.ORACLE))
.isInstanceOf(MessageException.class)
.hasMessage("Directory does not contain JDBC driver: extensions/jdbc-driver/oracle");
}
@Test
public void too_many_files_in_driver_dir() throws Exception {
FileUtils.touch(new File(homeDir, "extensions/jdbc-driver/oracle/ojdbc5.jar"));
FileUtils.touch(new File(homeDir, "extensions/jdbc-driver/oracle/ojdbc6.jar"));
assertThatThrownBy(() -> underTest.driverPath(homeDir, Provider.ORACLE))
.isInstanceOf(MessageException.class)
.hasMessage("Directory must contain only one JAR file: extensions/jdbc-driver/oracle");
}
private Props newProps(String... params) {
Properties properties = new Properties();
for (int i = 0; i < params.length; i++) {
properties.setProperty(params[i], params[i + 1]);
i++;
}
properties.setProperty(PATH_HOME.getKey(), homeDir.getAbsolutePath());
return new Props(properties);
}
}
|
