-
Notifications
You must be signed in to change notification settings - Fork 135
/
CitrusSettings.java
436 lines (385 loc) · 17.1 KB
/
CitrusSettings.java
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*
* Copyright the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.citrusframework;
import org.citrusframework.common.TestLoader;
import org.citrusframework.message.MessageType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.InputStream;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.stream.Stream;
import static java.lang.Boolean.parseBoolean;
import static java.lang.System.getProperty;
import static java.lang.System.getenv;
import static java.lang.System.setProperty;
import static java.nio.charset.Charset.defaultCharset;
import static java.util.Collections.emptySet;
import static java.util.logging.LogManager.getLogManager;
import static java.util.stream.Collectors.toSet;
import static org.citrusframework.common.TestLoader.GROOVY;
import static org.citrusframework.common.TestLoader.SPRING;
import static org.citrusframework.common.TestLoader.YAML;
/**
* @author Christoph Deppisch
*/
public final class CitrusSettings {
/**
* Logger
*/
private static final Logger logger = LoggerFactory.getLogger(CitrusSettings.class);
private CitrusSettings() {
// prevent instantiation
}
/**
* Optional application property file
*/
private static final String APPLICATION_PROPERTY_FILE_PROPERTY = "citrus.application.properties";
private static final String APPLICATION_PROPERTY_FILE_ENV = "CITRUS_APPLICATION_PROPERTIES";
private static final String APPLICATION_PROPERTY_FILE = getProperty(
APPLICATION_PROPERTY_FILE_PROPERTY,
getenv(APPLICATION_PROPERTY_FILE_ENV) != null ? getenv(APPLICATION_PROPERTY_FILE_ENV) : "citrus-application.properties");
public static final String OUTBOUND_SCHEMA_VALIDATION_ENABLED_PROPERTY = "citrus.validation.outbound.schema.enabled";
public static final String OUTBOUND_SCHEMA_VALIDATION_ENABLED_ENV = "CITRUS_VALIDATION_OUTBOUND_SCHEMA_ENABLED";
public static final String OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_PROPERTY = "citrus.validation.outbound.json.schema.enabled";
public static final String OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_ENV = "CITRUS_VALIDATION_OUTBOUND_JSON_SCHEMA_ENABLED";
public static final String OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_PROPERTY = "citrus.validation.outbound.xml.schema.enabled";
public static final String OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_ENV = "CITRUS_VALIDATION_OUTBOUND_XML_SCHEMA_ENABLED";
/* Load application properties */
static {
String applicationPropertiesFile = APPLICATION_PROPERTY_FILE;
if (applicationPropertiesFile.startsWith("classpath:")) {
applicationPropertiesFile = applicationPropertiesFile.substring("classpath:".length());
}
try (final InputStream in = CitrusSettings.class.getClassLoader().getResourceAsStream(applicationPropertiesFile)) {
Properties applicationProperties = new Properties();
applicationProperties.load(in);
logger.debug("Loading Citrus application properties");
for (Map.Entry<Object, Object> property : applicationProperties.entrySet()) {
if (getProperty(property.getKey().toString(), "").isEmpty()) {
logger.debug("Setting application property {}={}", property.getKey(), property.getValue());
setProperty(property.getKey().toString(), property.getValue().toString());
}
}
} catch (Exception e) {
if (logger.isTraceEnabled()) {
logger.trace("Unable to locate Citrus application properties", e);
} else {
logger.debug("Unable to locate Citrus application properties");
}
}
try (InputStream is = CitrusSettings.class.getClassLoader().getResourceAsStream("logging.properties")) {
if (is != null) {
getLogManager().readConfiguration(is);
}
} catch (Exception e) {
if (logger.isTraceEnabled()) {
logger.trace("Unable to configure Java util logging", e);
} else {
logger.info("Unable to configure Java util logging");
}
}
}
/**
* Default variable names
*/
public static final String TEST_NAME_VARIABLE_PROPERTY = "citrus.test.name.variable";
public static final String TEST_NAME_VARIABLE_ENV = "CITRUS_TEST_NAME_VARIABLE";
public static final String TEST_NAME_VARIABLE = getPropertyEnvOrDefault(
TEST_NAME_VARIABLE_PROPERTY,
TEST_NAME_VARIABLE_ENV,
"citrus.test.name");
public static final String TEST_PACKAGE_VARIABLE_PROPERTY = "citrus.test.package.variable";
public static final String TEST_PACKAGE_VARIABLE_ENV = "CITRUS_TEST_PACKAGE_VARIABLE";
public static final String TEST_PACKAGE_VARIABLE = getPropertyEnvOrDefault(
TEST_PACKAGE_VARIABLE_PROPERTY,
TEST_PACKAGE_VARIABLE_ENV,
"citrus.test.package");
/**
* File encoding system property
*/
public static final String CITRUS_FILE_ENCODING_PROPERTY = "citrus.file.encoding";
public static final String CITRUS_FILE_ENCODING_ENV = "CITRUS_FILE_ENCODING";
public static final String CITRUS_FILE_ENCODING = getPropertyEnvOrDefault(
CITRUS_FILE_ENCODING_PROPERTY,
CITRUS_FILE_ENCODING_ENV,
defaultCharset().displayName());
/**
* Prefix/sufix used to identify variable expressions
*/
public static final String VARIABLE_PREFIX = "${";
public static final String VARIABLE_SUFFIX = "}";
public static final String VARIABLE_ESCAPE = "//";
/**
* Default application context class
*/
public static final String DEFAULT_CONFIG_CLASS_PROPERTY = "citrus.java.config";
public static final String DEFAULT_CONFIG_CLASS_ENV = "CITRUS_JAVA_CONFIG";
public static final String DEFAULT_CONFIG_CLASS = getPropertyEnvOrDefault(
DEFAULT_CONFIG_CLASS_PROPERTY,
DEFAULT_CONFIG_CLASS_ENV,
null);
/**
* Default test directories
*/
public static final String DEFAULT_TEST_SRC_DIRECTORY_PROPERTY = "citrus.default.src.directory";
public static final String DEFAULT_TEST_SRC_DIRECTORY_ENV = "CITRUS_DEFAULT_SRC_DIRECTORY";
public static final String DEFAULT_TEST_SRC_DIRECTORY = getPropertyEnvOrDefault(
DEFAULT_TEST_SRC_DIRECTORY_PROPERTY,
DEFAULT_TEST_SRC_DIRECTORY_ENV,
"src" + File.separator + "test" + File.separator);
/**
* Placeholder used in messages to ignore elements
*/
public static final String IGNORE_PLACEHOLDER = "@ignore@";
/**
* Prefix/suffix used to identify validation matchers
*/
public static final String VALIDATION_MATCHER_PREFIX = "@";
public static final String VALIDATION_MATCHER_SUFFIX = "@";
public static final String GROOVY_TEST_FILE_NAME_PATTERN_PROPERTY = "citrus.groovy.file.name.pattern";
public static final String GROOVY_TEST_FILE_NAME_PATTERN_ENV = "CITRUS_GROOVY_FILE_NAME_PATTERN";
public static final String GROOVY_TEST_FILE_NAME_PATTERN = getPropertyEnvOrDefault(
GROOVY_TEST_FILE_NAME_PATTERN_PROPERTY,
GROOVY_TEST_FILE_NAME_PATTERN_ENV,
".*test\\.groovy,.*it\\.groovy");
public static final String YAML_TEST_FILE_NAME_PATTERN_PROPERTY = "citrus.yaml.file.name.pattern";
public static final String YAML_TEST_FILE_NAME_PATTERN_ENV = "CITRUS_YAML_FILE_NAME_PATTERN";
public static final String YAML_TEST_FILE_NAME_PATTERN = getPropertyEnvOrDefault(
YAML_TEST_FILE_NAME_PATTERN_PROPERTY,
YAML_TEST_FILE_NAME_PATTERN_ENV,
".*test\\.yaml,.*it\\.yaml");
public static final String XML_TEST_FILE_NAME_PATTERN_PROPERTY = "citrus.xml.file.name.pattern";
public static final String XML_TEST_FILE_NAME_PATTERN_ENV = "CITRUS_XML_FILE_NAME_PATTERN";
public static final String XML_TEST_FILE_NAME_PATTERN = getPropertyEnvOrDefault(
XML_TEST_FILE_NAME_PATTERN_PROPERTY,
XML_TEST_FILE_NAME_PATTERN_ENV,
".*Test\\.xml,.*IT\\.xml,.*test\\.xml,.*it\\.xml");
public static final String JAVA_TEST_FILE_NAME_PATTERN_PROPERTY = "citrus.java.file.name.pattern";
public static final String JAVA_TEST_FILE_NAME_PATTERN_ENV = "CITRUS_JAVA_FILE_NAME_PATTERN";
public static final String JAVA_TEST_FILE_NAME_PATTERN = getPropertyEnvOrDefault(
JAVA_TEST_FILE_NAME_PATTERN_PROPERTY,
JAVA_TEST_FILE_NAME_PATTERN_ENV,
".*Test\\.java,.*IT\\.java");
/**
* Default message type used in message validation mechanism
*/
public static final String DEFAULT_MESSAGE_TYPE_PROPERTY = "citrus.default.message.type";
public static final String DEFAULT_MESSAGE_TYPE_ENV = "CITRUS_DEFAULT_MESSAGE_TYPE";
public static final String DEFAULT_MESSAGE_TYPE = getPropertyEnvOrDefault(
DEFAULT_MESSAGE_TYPE_PROPERTY,
DEFAULT_MESSAGE_TYPE_ENV,
MessageType.XML.toString());
/**
* Flag to allow deactivation of the http message builder citrus header update. See <a href="https://github.com/citrusframework/citrus/issues/1143">ISSUE-1143</a> for details.
*/
public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_PROPERTY = "citrus.http.message.builder.force.citrus.header.update.enabled";
public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_ENV = "CITRUS_HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED";
public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_DEFAULT = "true";
/**
* Default message trace output directory
*/
public static final String MESSAGE_TRACE_DIRECTORY_PROPERTY = "citrus.message.trace.directory";
public static final String MESSAGE_TRACE_DIRECTORY_ENV = "CITRUS_MESSAGE_TRACE_DIRECTORY";
public static final String MESSAGE_TRACE_DIRECTORY_DEFAULT = "target/citrus-logs/trace/messages";
/**
* Default type converter
*/
public static final String TYPE_CONVERTER_PROPERTY = "citrus.type.converter";
public static final String TYPE_CONVERTER_ENV = "CITRUS_TYPE_CONVERTER";
public static final String TYPE_CONVERTER_DEFAULT = "default";
/**
* Flag to enable/disable message pretty print
*/
public static final String PRETTY_PRINT_PROPERTY = "citrus.message.pretty.print";
public static final String PRETTY_PRINT_ENV = "CITRUS_MESSAGE_PRETTY_PRINT";
public static final String PRETTY_PRINT_DEFAULT = Boolean.TRUE.toString();
/**
* Flag to enable/disable logger modifier
*/
public static final String LOG_MODIFIER_PROPERTY = "citrus.logger.modifier";
public static final String LOG_MODIFIER_ENV = "CITRUS_LOG_MODIFIER";
public static final String LOG_MODIFIER_DEFAULT = Boolean.TRUE.toString();
/**
* Default logger modifier mask value
*/
public static final String LOG_MASK_VALUE_PROPERTY = "citrus.logger.mask.value";
public static final String LOG_MASK_VALUE_ENV = "CITRUS_LOG_MASK_VALUE";
public static final String LOG_MASK_VALUE_DEFAULT = "****";
/**
* Default logger modifier keywords
*/
public static final String LOG_MASK_KEYWORDS_PROPERTY = "citrus.logger.mask.keywords";
public static final String LOG_MASK_KEYWORDS_ENV = "CITRUS_LOG_MASK_KEYWORDS";
public static final String LOG_MASK_KEYWORDS_DEFAULT = "password,secret,secretKey";
/**
* File path charset parameter
*/
public static final String FILE_PATH_CHARSET_PARAMETER_PROPERTY = "citrus.file.path.charset.parameter";
public static final String FILE_PATH_CHARSET_PARAMETER_ENV = "CITRUS_FILE_PATH_CHARSET_PARAMETER";
public static final String FILE_PATH_CHARSET_PARAMETER_DEFAULT = "; charset=";
/**
* Gets set of file name patterns for Groovy test files.
*
* @return
*/
public static Set<String> getGroovyTestFileNamePattern() {
return Stream.of(GROOVY_TEST_FILE_NAME_PATTERN.split(",")).collect(toSet());
}
/**
* Gets set of file name patterns for YAML test files.
*
* @return
*/
public static Set<String> getYamlTestFileNamePattern() {
return Stream.of(YAML_TEST_FILE_NAME_PATTERN.split(",")).collect(toSet());
}
/**
* Gets set of file name patterns for XML test files.
*
* @return
*/
public static Set<String> getXmlTestFileNamePattern() {
return Stream.of(XML_TEST_FILE_NAME_PATTERN.split(",")).collect(toSet());
}
/**
* Gets set of file name patterns for Java test files.
*
* @return
*/
public static Set<String> getJavaTestFileNamePattern() {
return Stream.of(JAVA_TEST_FILE_NAME_PATTERN.split(",")).collect(toSet());
}
/**
* Gets the directory where to put message trace files.
*
* @return
*/
public static String getMessageTraceDirectory() {
return getPropertyEnvOrDefault(
MESSAGE_TRACE_DIRECTORY_PROPERTY,
MESSAGE_TRACE_DIRECTORY_ENV,
MESSAGE_TRACE_DIRECTORY_DEFAULT);
}
/**
* Gets the type converter to use by default.
*
* @return
*/
public static String getTypeConverter() {
return getPropertyEnvOrDefault(
TYPE_CONVERTER_PROPERTY,
TYPE_CONVERTER_ENV,
TYPE_CONVERTER_DEFAULT);
}
/**
* Gets the message payload pretty print enabled/disabled setting.
*
* @return
*/
public static boolean isPrettyPrintEnabled() {
return parseBoolean(getPropertyEnvOrDefault(
PRETTY_PRINT_PROPERTY,
PRETTY_PRINT_ENV,
PRETTY_PRINT_DEFAULT));
}
/**
* Gets the logger modifier enabled/disabled setting.
*
* @return
*/
public static boolean isLogModifierEnabled() {
return parseBoolean(getPropertyEnvOrDefault(
LOG_MODIFIER_PROPERTY,
LOG_MODIFIER_ENV,
LOG_MODIFIER_DEFAULT));
}
/**
* Get logger mask value.
*
* @return
*/
public static String getLogMaskValue() {
return getPropertyEnvOrDefault(
LOG_MASK_VALUE_PROPERTY,
LOG_MASK_VALUE_ENV,
LOG_MASK_VALUE_DEFAULT);
}
/**
* Get the file path charset parameter.
*
* @return
*/
public static String getFilePathCharsetParameter() {
return getPropertyEnvOrDefault(
FILE_PATH_CHARSET_PARAMETER_PROPERTY,
FILE_PATH_CHARSET_PARAMETER_ENV,
FILE_PATH_CHARSET_PARAMETER_DEFAULT);
}
/**
* Get logger mask keywords.
*
* @return
*/
public static Set<String> getLogMaskKeywords() {
return Stream.of(getPropertyEnvOrDefault(
LOG_MASK_KEYWORDS_PROPERTY,
LOG_MASK_KEYWORDS_ENV,
LOG_MASK_KEYWORDS_DEFAULT)
.split(","))
.map(String::trim)
.collect(toSet());
}
/**
* Gets the http message builder force citrus header update enabled/disabled setting, which controls
* whether the citrus message builder always creates messages with unique ids.
*
* @return
*/
public static boolean isHttpMessageBuilderForceCitrusHeaderUpdateEnabled() {
return parseBoolean(getPropertyEnvOrDefault(
HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_PROPERTY,
HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_ENV,
HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_DEFAULT));
}
/**
* Gets the test file name pattern for given type or empty patterns for unknown type.
*
* @param type
* @return
*/
public static Set<String> getTestFileNamePattern(String type) {
return switch (type) {
case TestLoader.XML, SPRING -> getXmlTestFileNamePattern();
case GROOVY -> getGroovyTestFileNamePattern();
case YAML -> getYamlTestFileNamePattern();
default -> emptySet();
};
}
/**
* Gets in the respective order, a system property, an environment variable or the default
*
* @param prop the name of the system property to get
* @param env the name of the environment variable to get
* @param def the default value
* @return first value encountered, which is not null. May return null, if default value is null.
*/
private static String getPropertyEnvOrDefault(String prop, String env, String def) {
return getProperty(prop, getenv(env) != null ? getenv(env) : def);
}
}