From 0f9f10f97ec2d439a1f4edcab533f40c17586cdf Mon Sep 17 00:00:00 2001 From: Gabriele Bianchet-David Date: Thu, 28 May 2020 15:01:31 -0400 Subject: [PATCH 1/2] Migrate legacy endpoint that have a dash in their id See gh-21615 --- .../boot/actuate/endpoint/EndpointId.java | 2 +- .../actuate/endpoint/EndpointIdTests.java | 10 ++++++ .../SampleLegacyEndpointWithHyphen.java | 35 +++++++++++++++++++ .../SampleActuatorApplicationTests.java | 10 +++++- 4 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithHyphen.java diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EndpointId.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EndpointId.java index 822403295da..269ca381aca 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EndpointId.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EndpointId.java @@ -131,7 +131,7 @@ public final class EndpointId { private static String migrateLegacyId(Environment environment, String value) { if (environment.getProperty(MIGRATE_LEGACY_NAMES_PROPERTY, Boolean.class, false)) { - return value.replace(".", ""); + return value.replaceAll("[-.]+", ""); } return value; } diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java index 0c5e03236f3..a7dece2d2c9 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java @@ -109,6 +109,16 @@ class EndpointIdTests { assertThat(output).doesNotContain("contains invalid characters"); } + @Test + void ofWhenMigratingLegacyNameRemovesHyphens(CapturedOutput output) { + EndpointId.resetLoggedWarnings(); + MockEnvironment environment = new MockEnvironment(); + environment.setProperty("management.endpoints.migrate-legacy-ids", "true"); + EndpointId endpointId = EndpointId.of(environment, "foo-bar"); + assertThat(endpointId.toString()).isEqualTo("foobar"); + assertThat(output).doesNotContain("contains invalid characters"); + } + @Test void equalsAndHashCode() { EndpointId one = EndpointId.of("foobar1"); diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithHyphen.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithHyphen.java new file mode 100644 index 00000000000..bcaff5d67cd --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithHyphen.java @@ -0,0 +1,35 @@ +/* + * Copyright 2012-2019 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 + * + * https://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 smoketest.actuator; + +import java.util.Collections; +import java.util.Map; + +import org.springframework.boot.actuate.endpoint.annotation.Endpoint; +import org.springframework.boot.actuate.endpoint.annotation.ReadOperation; +import org.springframework.stereotype.Component; + +@Component +@Endpoint(id = "another-legacy") +public class SampleLegacyEndpointWithHyphen { + + @ReadOperation + public Map example() { + return Collections.singletonMap("legacy", "legacy"); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/SampleActuatorApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/SampleActuatorApplicationTests.java index 796d873bb3a..a23567dfe07 100644 --- a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/SampleActuatorApplicationTests.java +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/SampleActuatorApplicationTests.java @@ -173,13 +173,21 @@ class SampleActuatorApplicationTests { } @Test - void testLegacy() { + void testLegacyDot() { ResponseEntity> entity = asMapEntity( this.restTemplate.withBasicAuth("user", "password").getForEntity("/actuator/legacy", Map.class)); assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK); assertThat(entity.getBody()).contains(entry("legacy", "legacy")); } + @Test + void testLegacyHyphen() { + ResponseEntity> entity = asMapEntity( + this.restTemplate.withBasicAuth("user", "password").getForEntity("/actuator/anotherlegacy", Map.class)); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(entity.getBody()).contains(entry("legacy", "legacy")); + } + @SuppressWarnings({ "unchecked", "rawtypes" }) static ResponseEntity> asMapEntity(ResponseEntity entity) { return (ResponseEntity) entity; From dd9c9fd171faf89c9ca3e19a93bbe0ac72f4dec5 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 10 Aug 2020 14:53:18 +0200 Subject: [PATCH 2/2] Polish "Migrate legacy endpoint that have a dash in their id" See gh-21615 --- .../actuate/endpoint/EndpointIdTests.java | 24 ++++++++++++------- ....java => SampleLegacyEndpointWithDot.java} | 4 ++-- 2 files changed, 18 insertions(+), 10 deletions(-) rename spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/{SampleLegacyEndpoint.java => SampleLegacyEndpointWithDot.java} (91%) diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java index a7dece2d2c9..3f272ad1f97 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/EndpointIdTests.java @@ -101,22 +101,30 @@ class EndpointIdTests { @Test void ofWhenMigratingLegacyNameRemovesDots(CapturedOutput output) { - EndpointId.resetLoggedWarnings(); - MockEnvironment environment = new MockEnvironment(); - environment.setProperty("management.endpoints.migrate-legacy-ids", "true"); - EndpointId endpointId = EndpointId.of(environment, "foo.bar"); - assertThat(endpointId.toString()).isEqualTo("foobar"); + EndpointId endpointId = migrateLegacyName("one.two.three"); + assertThat(endpointId.toString()).isEqualTo("onetwothree"); assertThat(output).doesNotContain("contains invalid characters"); } @Test void ofWhenMigratingLegacyNameRemovesHyphens(CapturedOutput output) { + EndpointId endpointId = migrateLegacyName("one-two-three"); + assertThat(endpointId.toString()).isEqualTo("onetwothree"); + assertThat(output).doesNotContain("contains invalid characters"); + } + + @Test + void ofWhenMigratingLegacyNameRemovesMixOfDashAndDot(CapturedOutput output) { + EndpointId endpointId = migrateLegacyName("one.two-three"); + assertThat(endpointId.toString()).isEqualTo("onetwothree"); + assertThat(output).doesNotContain("contains invalid characters"); + } + + private EndpointId migrateLegacyName(String name) { EndpointId.resetLoggedWarnings(); MockEnvironment environment = new MockEnvironment(); environment.setProperty("management.endpoints.migrate-legacy-ids", "true"); - EndpointId endpointId = EndpointId.of(environment, "foo-bar"); - assertThat(endpointId.toString()).isEqualTo("foobar"); - assertThat(output).doesNotContain("contains invalid characters"); + return EndpointId.of(environment, name); } @Test diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpoint.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithDot.java similarity index 91% rename from spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpoint.java rename to spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithDot.java index 913bb6e5bc6..fcc437e1fd5 100644 --- a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpoint.java +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleLegacyEndpointWithDot.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2020 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. @@ -25,7 +25,7 @@ import org.springframework.stereotype.Component; @Component @Endpoint(id = "lega.cy") -public class SampleLegacyEndpoint { +public class SampleLegacyEndpointWithDot { @ReadOperation public Map example() {