Skip to content

Commit 628a605

Browse files
committed
Review fixes
Adjusted annotation parameter name to `value()`. Scrapped duplicate configurationParametersResources method on discovery request builder. (Is now var-args)
1 parent fd45908 commit 628a605

File tree

8 files changed

+36
-34
lines changed

8 files changed

+36
-34
lines changed

junit-platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ LauncherDiscoveryRequest toDiscoveryRequest(TestDiscoveryOptions options) {
5454
requestBuilder.selectors(selectors);
5555
addFilters(requestBuilder, options, selectors);
5656
requestBuilder.configurationParameters(options.getConfigurationParameters());
57-
requestBuilder.configurationParametersResources(options.getConfigurationParametersResources());
57+
requestBuilder.configurationParametersResources(
58+
options.getConfigurationParametersResources().toArray(new String[0]));
5859
return requestBuilder.build();
5960
}
6061

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/LauncherDiscoveryRequestBuilder.java

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import java.util.ArrayList;
1717
import java.util.Arrays;
18+
import java.util.Collections;
1819
import java.util.HashMap;
1920
import java.util.List;
2021
import java.util.Map;
@@ -199,27 +200,15 @@ public LauncherDiscoveryRequestBuilder configurationParameters(Map<String, Strin
199200
return this;
200201
}
201202

202-
/**
203-
* Add the supplied configuration parameters resource file to the request.
204-
* @param propertiesFile the classpath location of the properties file
205-
* never {@code null}
206-
* @return this builder for method chaining
207-
*/
208-
public LauncherDiscoveryRequestBuilder configurationParametersResource(String propertiesFile) {
209-
Preconditions.notNull(propertiesFile, "properties file must not be null");
210-
configurationParametersResources.add(propertiesFile);
211-
return this;
212-
}
213-
214203
/**
215204
* Add all of the supplied configuration parameters resource files to the request.
216-
* @param propertiesFiles the classpath locations of the properties files
205+
* @param paths the classpath locations of the properties files
217206
* never {@code null}
218207
* @return this builder for method chaining
219208
*/
220-
public LauncherDiscoveryRequestBuilder configurationParametersResources(List<String> propertiesFiles) {
221-
Preconditions.notNull(propertiesFiles, "properties files must not be null");
222-
propertiesFiles.forEach(this::configurationParametersResource);
209+
public LauncherDiscoveryRequestBuilder configurationParametersResources(String... paths) {
210+
Preconditions.notNull(paths, "property file paths must not be null");
211+
Collections.addAll(configurationParametersResources, paths);
223212
return this;
224213
}
225214

junit-platform-suite-api/src/main/java/org/junit/platform/suite/api/ConfigurationParametersResource.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,19 @@
3232
* @see Suite
3333
* @see org.junit.platform.runner.JUnitPlatform
3434
* @see org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder#configurationParameter(String, String)
35+
* @see org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder#configurationParametersResource(String)
3536
*/
3637
@Retention(RetentionPolicy.RUNTIME)
3738
@Target(ElementType.TYPE)
3839
@Inherited
3940
@Documented
40-
// TODO: Before PR merge, change to STABLE/MAINTAINED
41-
// TODO: Is version 1.11 correct?
4241
@API(status = EXPERIMENTAL, since = "1.11")
4342
@Repeatable(ConfigurationParametersResources.class)
4443
public @interface ConfigurationParametersResource {
4544

4645
/**
4746
* The classpath location for the desired properties file; never {@code null} or blank.
4847
*/
49-
String resource();
48+
String value();
5049

5150
}

junit-platform-suite-api/src/main/java/org/junit/platform/suite/api/ConfigurationParametersResources.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@
3636
@Target(ElementType.TYPE)
3737
@Inherited
3838
@Documented
39-
// TODO: Before PR merge, change to STABLE/MAINTAINED
40-
// TODO: Is version 1.11 correct?
4139
@API(status = EXPERIMENTAL, since = "1.11")
4240
public @interface ConfigurationParametersResources {
4341

junit-platform-suite-commons/src/main/java/org/junit/platform/suite/commons/SuiteLauncherDiscoveryRequestBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ public SuiteLauncherDiscoveryRequestBuilder configurationParameters(Map<String,
116116
return this;
117117
}
118118

119-
public SuiteLauncherDiscoveryRequestBuilder configurationParametersResource(String resourceFile) {
120-
delegate.configurationParametersResource(resourceFile);
119+
public SuiteLauncherDiscoveryRequestBuilder configurationParametersResource(String path) {
120+
delegate.configurationParametersResources(path);
121121
return this;
122122
}
123123

@@ -140,7 +140,7 @@ public SuiteLauncherDiscoveryRequestBuilder suite(Class<?> suiteClass) {
140140
findRepeatableAnnotations(suiteClass, ConfigurationParameter.class)
141141
.forEach(configuration -> configurationParameter(configuration.key(), configuration.value()));
142142
findRepeatableAnnotations(suiteClass, ConfigurationParametersResource.class)
143-
.forEach(configResource -> configurationParametersResource(configResource.resource()));
143+
.forEach(configResource -> configurationParametersResource(configResource.value()));
144144
findAnnotation(suiteClass, DisableParentConfigurationParameters.class)
145145
.ifPresent(__ -> enableParentConfigurationParameters = false);
146146
findAnnotationValues(suiteClass, ExcludeClassNamePatterns.class, ExcludeClassNamePatterns::value)

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,22 @@ void convertsConfigurationParameters() {
317317
assertThat(configurationParameters.getBoolean("baz")).contains(true);
318318
}
319319

320+
@Test
321+
@SuppressWarnings("deprecation")
322+
void convertsConfigurationParametersResources() {
323+
options.setScanClasspath(true);
324+
options.setConfigurationParameters(mapOf(entry("foo", "bar"), entry("com.example.prop.first", "baz")));
325+
options.setConfigurationParametersResources(List.of("config-test.properties"));
326+
327+
var request = convert();
328+
var configurationParameters = request.getConfigurationParameters();
329+
330+
assertThat(configurationParameters.size()).isEqualTo(2);
331+
assertThat(configurationParameters.get("foo")).contains("bar");
332+
assertThat(configurationParameters.get("com.example.prop.first")).contains("baz");
333+
assertThat(configurationParameters.get("com.example.prop.second")).contains("second value");
334+
}
335+
320336
private LauncherDiscoveryRequest convert() {
321337
var creator = new DiscoveryRequestCreator();
322338
return creator.toDiscoveryRequest(options);

platform-tests/src/test/java/org/junit/platform/launcher/core/LauncherDiscoveryRequestBuilderTests.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ void multipleConfigurationParametersAddedByMap_areStoredInDiscoveryRequest() {
318318
void configurationParametersResource_areStoredInDiscoveryRequest() {
319319
// @formatter:off
320320
var discoveryRequest = request()
321-
.configurationParametersResource("config-test.properties")
321+
.configurationParametersResources("config-test.properties")
322322
.build();
323323
// @formatter:on
324324

@@ -332,7 +332,7 @@ void configurationParametersResource_areStoredInDiscoveryRequest() {
332332
void configurationParametersResource_explicitConfigParametersOverrideResource() {
333333
// @formatter:off
334334
var discoveryRequest = request()
335-
.configurationParametersResource("config-test.properties")
335+
.configurationParametersResources("config-test.properties")
336336
.configurationParameter("com.example.prop.first", "first value override")
337337
.build();
338338
// @formatter:on
@@ -346,8 +346,8 @@ void configurationParametersResource_explicitConfigParametersOverrideResource()
346346
void configurationParametersResource_lastDeclaredResourceFileWins() {
347347
// @formatter:off
348348
var discoveryRequest = request()
349-
.configurationParametersResource("config-test.properties")
350-
.configurationParametersResource("config-test-override.properties")
349+
.configurationParametersResources("config-test.properties")
350+
.configurationParametersResources("config-test-override.properties")
351351
.build();
352352
// @formatter:on
353353

platform-tests/src/test/java/org/junit/platform/suite/commons/SuiteLauncherDiscoveryRequestBuilderTests.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353
import org.junit.platform.launcher.PostDiscoveryFilter;
5454
import org.junit.platform.suite.api.ConfigurationParameter;
5555
import org.junit.platform.suite.api.ConfigurationParametersResource;
56-
import org.junit.platform.suite.api.ConfigurationParametersResources;
5756
import org.junit.platform.suite.api.DisableParentConfigurationParameters;
5857
import org.junit.platform.suite.api.ExcludeClassNamePatterns;
5958
import org.junit.platform.suite.api.ExcludeEngines;
@@ -90,7 +89,7 @@ class Suite {
9089

9190
@Test
9291
void configurationParametersResource() {
93-
@ConfigurationParametersResource(resource = "config-test.properties")
92+
@ConfigurationParametersResource("config-test.properties")
9493
class Suite {
9594
}
9695

@@ -102,8 +101,8 @@ class Suite {
102101

103102
@Test
104103
void configurationParametersResources() {
105-
@ConfigurationParametersResources({ @ConfigurationParametersResource(resource = "config-test.properties"),
106-
@ConfigurationParametersResource(resource = "config-test-override.properties") })
104+
@ConfigurationParametersResource("config-test.properties")
105+
@ConfigurationParametersResource("config-test-override.properties")
107106
class Suite {
108107
}
109108

@@ -117,7 +116,7 @@ class Suite {
117116

118117
@Test
119118
void configurationParametersResource_explicitParametersTakePrecedence() {
120-
@ConfigurationParametersResource(resource = "config-test.properties")
119+
@ConfigurationParametersResource("config-test.properties")
121120
@ConfigurationParameter(key = "com.example.prop.first", value = "first value from explicit parameter")
122121
class Suite {
123122
}

0 commit comments

Comments
 (0)