Skip to content

Commit b27f0c2

Browse files
cppwfscppwfs
committed
Remove Deprecated methods from TaskConfigurationProperties.
This will require updates in other classes to have them use ComposedTaskRunnerConfigurationProperties Remove the the utilities methods from TaskServiceUtils Add Tests for ComposedTaskRunnerConfigurationProperties This test suite was originally located in the TaskServiceUtils. But upon the removal of the Deprecation these tests were removed from its suite of tests. These tests are still valid were migrated to a suite for the ComposedTaskRunnerConfigurationProperties.
1 parent 09b2149 commit b27f0c2

File tree

8 files changed

+70
-162
lines changed

8 files changed

+70
-162
lines changed

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/controller/TaskCtrController.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@ public TaskCtrController(ApplicationConfigurationMetadataResolver metadataResolv
6161
public List<ConfigurationMetadataProperty> options() {
6262
URI ctrUri = null;
6363
try {
64-
ctrUri = new URI(composedTaskRunnerConfigurationProperties.getUri() != null
65-
? composedTaskRunnerConfigurationProperties.getUri()
66-
: this.taskConfigurationProperties.getComposedTaskRunnerUri());
64+
ctrUri = new URI(composedTaskRunnerConfigurationProperties.getUri());
6765
} catch (Exception e) {
6866
throw new IllegalStateException("Invalid Compose Task Runner Resource", e);
6967
}

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/DefaultSchedulerService.java

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -224,11 +224,7 @@ public void schedule(
224224
appRegistration = new AppRegistration(
225225
ComposedTaskRunnerConfigurationProperties.COMPOSED_TASK_RUNNER_NAME,
226226
ApplicationType.task,
227-
new URI(TaskServiceUtils.getComposedTaskLauncherUri(
228-
this.taskConfigurationProperties,
229-
this.composedTaskRunnerConfigurationProperties)
230-
)
231-
);
227+
new URI(this.composedTaskRunnerConfigurationProperties.getUri()));
232228
} catch (URISyntaxException e) {
233229
throw new IllegalStateException("Invalid Compose Task Runner Resource", e);
234230
}
@@ -528,8 +524,7 @@ protected Resource getTaskResource(String taskDefinitionName, String version) {
528524
AppRegistration appRegistration = null;
529525
if (TaskServiceUtils.isComposedTaskDefinition(taskDefinition.getDslText())) {
530526
URI composedTaskUri = null;
531-
String composedTaskLauncherUri = TaskServiceUtils.getComposedTaskLauncherUri(this.taskConfigurationProperties,
532-
this.composedTaskRunnerConfigurationProperties);
527+
String composedTaskLauncherUri = this.composedTaskRunnerConfigurationProperties.getUri();
533528
try {
534529
composedTaskUri = new URI(composedTaskLauncherUri);
535530
} catch (URISyntaxException e) {

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/DefaultTaskExecutionInfoService.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,7 @@ public TaskExecutionInformation findTaskExecutionInformation(
198198
try {
199199
appRegistration = new AppRegistration(ComposedTaskRunnerConfigurationProperties.COMPOSED_TASK_RUNNER_NAME,
200200
ApplicationType.task,
201-
new URI(TaskServiceUtils.getComposedTaskLauncherUri(this.taskConfigurationProperties,
202-
this.composedTaskRunnerConfigurationProperties)));
201+
new URI(this.composedTaskRunnerConfigurationProperties.getUri()));
203202
} catch (URISyntaxException e) {
204203
throw new IllegalStateException("Invalid Compose Task Runner Resource", e);
205204
}

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/DefaultTaskExecutionService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ private void handleAccessToken(List<String> commandLineArgs, TaskExecutionInform
583583
break;
584584
}
585585
}
586-
if (TaskServiceUtils.isUseUserAccessToken(this.taskConfigurationProperties, this.composedTaskRunnerConfigurationProperties)) {
586+
if ( this.composedTaskRunnerConfigurationProperties.isUseUserAccessToken()) {
587587
useUserAccessToken = true;
588588
}
589589
if (!containsAccessToken && useUserAccessToken && oauth2TokenUtilsService != null) {

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/TaskConfigurationProperties.java

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
import org.springframework.beans.factory.annotation.Autowired;
2323
import org.springframework.boot.context.properties.ConfigurationProperties;
2424
import org.springframework.cloud.dataflow.core.DataFlowPropertyKeys;
25-
import org.springframework.util.StringUtils;
2625
import org.springframework.validation.annotation.Validated;
2726

2827
/**
@@ -76,21 +75,6 @@ public class TaskConfigurationProperties {
7675

7776
private boolean useJsonJobParameters = false;
7877

79-
@Deprecated
80-
public String getComposedTaskRunnerUri() {
81-
logDeprecationWarning("getUri");
82-
return this.composedTaskRunnerConfigurationProperties.getUri();
83-
}
84-
85-
@Deprecated
86-
public void setComposedTaskRunnerUri(String composedTaskRunnerUri) {
87-
logDeprecationWarning("setUri");
88-
89-
if (!StringUtils.hasText(this.composedTaskRunnerConfigurationProperties.getUri())) {
90-
this.composedTaskRunnerConfigurationProperties.setUri(composedTaskRunnerUri);
91-
}
92-
}
93-
9478
public DeployerProperties getDeployerProperties() {
9579
return deployerProperties;
9680
}
@@ -107,23 +91,6 @@ public void setAutoCreateTaskDefinitions(boolean autoCreateTaskDefinitions) {
10791
this.autoCreateTaskDefinitions = autoCreateTaskDefinitions;
10892
}
10993

110-
@Deprecated
111-
public boolean isUseUserAccessToken() {
112-
logDeprecationWarning();
113-
114-
return this.composedTaskRunnerConfigurationProperties.isUseUserAccessToken() == null ? false :
115-
this.composedTaskRunnerConfigurationProperties.isUseUserAccessToken();
116-
}
117-
118-
@Deprecated
119-
public void setUseUserAccessToken(boolean useUserAccessToken) {
120-
logDeprecationWarning();
121-
122-
if (this.composedTaskRunnerConfigurationProperties.isUseUserAccessToken() == null) {
123-
this.composedTaskRunnerConfigurationProperties.setUseUserAccessToken(useUserAccessToken);
124-
}
125-
}
126-
12794
public static class DeployerProperties {
12895

12996
private String[] propertyIncludes = new String[0];

‎spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/TaskServiceUtils.java

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -380,27 +380,6 @@ static void addImagePullSecretProperty(Map<String, String> taskDeploymentPropert
380380
}
381381
}
382382

383-
static String getComposedTaskLauncherUri(TaskConfigurationProperties taskConfigurationProperties,
384-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties) {
385-
if(composedTaskRunnerConfigurationProperties != null &&
386-
StringUtils.hasText(composedTaskRunnerConfigurationProperties.getUri())) {
387-
return composedTaskRunnerConfigurationProperties.getUri();
388-
}
389-
390-
return taskConfigurationProperties.getComposedTaskRunnerUri();
391-
}
392-
393-
static boolean isUseUserAccessToken(TaskConfigurationProperties taskConfigurationProperties,
394-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties) {
395-
if (composedTaskRunnerConfigurationProperties != null) {
396-
if (composedTaskRunnerConfigurationProperties.isUseUserAccessToken() != null) {
397-
return composedTaskRunnerConfigurationProperties.isUseUserAccessToken();
398-
}
399-
}
400-
401-
return taskConfigurationProperties.isUseUserAccessToken();
402-
}
403-
404383
/**
405384
* Converts command lines args into a format acceptable for CTR.
406385
* <p>The input args are copied and entries that begin with {@code 'app.'}

‎spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/service/impl/ComposedTaskRunnerConfigurationPropertiesTests.java

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*
2+
* Copyright 2024 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.cloud.dataflow.server.service.impl;
18+
19+
import org.junit.jupiter.api.Test;
20+
import static org.assertj.core.api.Assertions.assertThat;
21+
22+
public class ComposedTaskRunnerConfigurationPropertiesTests {
23+
24+
private static final String DEFAULT_URI = "https://testuri.something";
25+
26+
@Test
27+
void useUserAccessTokenFromCTRPropsTrue() {
28+
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
29+
new ComposedTaskRunnerConfigurationProperties();
30+
composedTaskRunnerConfigurationProperties.setUseUserAccessToken(true);
31+
assertThat(composedTaskRunnerConfigurationProperties.isUseUserAccessToken()).as("Use user access token should be true").isTrue();
32+
}
33+
34+
@Test
35+
void useUserAccessTokenFromCTRPropFalse() {
36+
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
37+
new ComposedTaskRunnerConfigurationProperties();
38+
composedTaskRunnerConfigurationProperties.setUseUserAccessToken(false);
39+
assertThat(composedTaskRunnerConfigurationProperties.isUseUserAccessToken()).as("Use user access token should be false").isFalse();
40+
}
41+
42+
@Test
43+
void useUserAccessTokenFromCTRPropNotSet() {
44+
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
45+
new ComposedTaskRunnerConfigurationProperties();
46+
assertThat(composedTaskRunnerConfigurationProperties.isUseUserAccessToken()).as("Use user access token should be false").isNull();
47+
}
48+
49+
@Test
50+
void uriFromComposedTaskRunnerConfigurationProperties() {
51+
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
52+
new ComposedTaskRunnerConfigurationProperties();
53+
composedTaskRunnerConfigurationProperties.setUri(DEFAULT_URI);
54+
55+
assertThat(composedTaskRunnerConfigurationProperties.getUri()).as("DEFAULT_URI is not being returned from properties").isEqualTo(DEFAULT_URI);
56+
}
57+
58+
@Test
59+
void emptyUriFromComposedTaskRunnerConfigurationProperties() {
60+
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
61+
new ComposedTaskRunnerConfigurationProperties();
62+
63+
assertThat(composedTaskRunnerConfigurationProperties.getUri()).as("URI should be empty").isNull();
64+
}
65+
}

‎spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/service/impl/TaskServiceUtilsTests.java

Lines changed: 0 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -267,108 +267,13 @@ void addProvidedImagePullSecret() {
267267
assertThat(taskDeploymentProperties.get(imagePullSecretPropertyKey)).as("Invalid imagePullSecret").isEqualTo("regcred");
268268
}
269269

270-
@Test
271-
void composedTaskRunnerUriFromTaskProps() {
272-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
273-
new ComposedTaskRunnerConfigurationProperties();
274-
TaskConfigurationProperties taskConfigurationProperties = new TaskConfigurationProperties();
275-
taskConfigurationProperties.setComposedTaskRunnerConfigurationProperties(composedTaskRunnerConfigurationProperties);
276-
taskConfigurationProperties.setComposedTaskRunnerUri("docker://something");
277-
278-
String uri = TaskServiceUtils.getComposedTaskLauncherUri(taskConfigurationProperties,
279-
composedTaskRunnerConfigurationProperties);
280-
281-
assertThat(uri).as("Invalid task runner URI string").isEqualTo("docker://something");
282-
}
283-
284-
@Test
285-
void composedTaskRunnerUriFromCTRProps() {
286-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
287-
new ComposedTaskRunnerConfigurationProperties();
288-
composedTaskRunnerConfigurationProperties.setUri("docker://something");
289-
290-
String uri = TaskServiceUtils.getComposedTaskLauncherUri(new TaskConfigurationProperties(),
291-
composedTaskRunnerConfigurationProperties);
292-
293-
assertThat(uri).as("Invalid task runner URI string").isEqualTo("docker://something");
294-
}
295-
296-
@Test
297-
void composedTaskRunnerUriFromCTRPropsOverridesTaskProps() {
298-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
299-
new ComposedTaskRunnerConfigurationProperties();
300-
composedTaskRunnerConfigurationProperties.setUri("gcr.io://something");
301-
302-
TaskConfigurationProperties taskConfigurationProperties = new TaskConfigurationProperties();
303-
taskConfigurationProperties.setComposedTaskRunnerConfigurationProperties(composedTaskRunnerConfigurationProperties);
304-
taskConfigurationProperties.setComposedTaskRunnerUri("docker://something");
305-
306-
String uri = TaskServiceUtils.getComposedTaskLauncherUri(taskConfigurationProperties,
307-
composedTaskRunnerConfigurationProperties);
308-
309-
assertThat(uri).as("Invalid task runner URI string").isEqualTo("gcr.io://something");
310-
}
311-
312270
@Test
313271
void imagePullSecretNullCTRProperties() {
314272
Map<String, String> taskDeploymentProperties = new HashMap<>();
315273
TaskServiceUtils.addImagePullSecretProperty(taskDeploymentProperties, null);
316274
assertThat(taskDeploymentProperties.containsKey("deployer.composed-task-runner.kubernetes.imagePullSecret")).as("Task deployment properties should not contain imagePullSecret").isFalse();
317275
}
318276

319-
@Test
320-
void useUserAccessTokenFromCTRPropsEnabled() {
321-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
322-
new ComposedTaskRunnerConfigurationProperties();
323-
composedTaskRunnerConfigurationProperties.setUseUserAccessToken(true);
324-
325-
boolean result = TaskServiceUtils.isUseUserAccessToken(null, composedTaskRunnerConfigurationProperties);
326-
327-
assertThat(result).as("Use user access token should be true").isTrue();
328-
}
329-
330-
@Test
331-
void useUserAccessTokenFromCTRPropsDisabled() {
332-
ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties =
333-
new ComposedTaskRunnerConfigurationProperties();
334-
composedTaskRunnerConfigurationProperties.setUseUserAccessToken(false);
335-
336-
boolean result = TaskServiceUtils.isUseUserAccessToken(null, composedTaskRunnerConfigurationProperties);
337-
338-
assertThat(result).as("Use user access token should be false").isFalse();
339-
}
340-
341-
@Test
342-
void useUserAccessTokenFromNullCTRProps() {
343-
TaskConfigurationProperties taskConfigurationProperties = new TaskConfigurationProperties();
344-
taskConfigurationProperties.setComposedTaskRunnerConfigurationProperties(new ComposedTaskRunnerConfigurationProperties());
345-
346-
boolean result = TaskServiceUtils.isUseUserAccessToken(taskConfigurationProperties, null);
347-
348-
assertThat(result).as("Use user access token should be false").isFalse();
349-
}
350-
351-
@Test
352-
void useUserAccessTokenFromTaskProps() {
353-
TaskConfigurationProperties taskConfigurationProperties = new TaskConfigurationProperties();
354-
taskConfigurationProperties.setComposedTaskRunnerConfigurationProperties(new ComposedTaskRunnerConfigurationProperties());
355-
taskConfigurationProperties.setUseUserAccessToken(true);
356-
357-
boolean result = TaskServiceUtils.isUseUserAccessToken(taskConfigurationProperties, null);
358-
359-
assertThat(result).as("Use user access token should be true").isTrue();
360-
}
361-
362-
@Test
363-
void useUserAccessTokenFromTaskPropsDefault() {
364-
TaskConfigurationProperties taskConfigurationProperties = new TaskConfigurationProperties();
365-
taskConfigurationProperties.setComposedTaskRunnerConfigurationProperties(new ComposedTaskRunnerConfigurationProperties());
366-
367-
boolean result = TaskServiceUtils.isUseUserAccessToken(taskConfigurationProperties, null);
368-
369-
assertThat(result).as("Use user access token should be false").isFalse();
370-
}
371-
372277
@Test
373278
void convertCommandLineArgsToCTRFormat() {
374279
validateSingleCTRArgs("app.a.0=foo=bar", "--composed-task-app-arguments.base64_YXBwLmEuMA=foo=bar");

0 commit comments

Comments
 (0)