Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Only generate time-to-live property for matching endpoints

Browse Source 
This commit makes sure that a "cache.time-to-live" property is not
generated for endpoints that do not have a main read operation (i.e. a
read operation with no parameter or only nullable parameters).

This matches the endpoint feature that provides caching for only such
operation.

Closes gh-11703
This commit is contained in:
Stephane Nicoll
2018-01-26 18:18:53 +01:00
parent 90545fb0c6
commit 5e26d04c05
11 changed files with 144 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java
View File

@@ -591,8 +591,7 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata).has(Metadata.withGroup("management.endpoint.disabled")
.fromSource(DisabledEndpoint.class));
assertThat(metadata).has(enabledFlag("disabled", false));
assertThat(metadata).has(cacheTtl("disabled"));
assertThat(metadata.getItems()).hasSize(3);
assertThat(metadata.getItems()).hasSize(2);
}
@Test
@@ -601,8 +600,7 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata).has(Metadata.withGroup("management.endpoint.enabled")
.fromSource(EnabledEndpoint.class));
assertThat(metadata).has(enabledFlag("enabled", true));
assertThat(metadata).has(cacheTtl("enabled"));
assertThat(metadata.getItems()).hasSize(3);
assertThat(metadata.getItems()).hasSize(2);
}
@Test
@@ -634,8 +632,7 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata).has(Metadata.withGroup("management.endpoint.pascal-case")
.fromSource(CamelCaseEndpoint.class));
assertThat(metadata).has(enabledFlag("PascalCase", "pascal-case", true));
assertThat(metadata).has(cacheTtl("pascal-case"));
assertThat(metadata.getItems()).hasSize(3);
assertThat(metadata.getItems()).hasSize(2);
}
@Test
@@ -658,6 +655,25 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata.getItems()).hasSize(3);
}
@Test
public void incrementalEndpointBuildChangeCacheFlag() throws Exception {
TestProject project = new TestProject(this.temporaryFolder,
IncrementalEndpoint.class);
ConfigurationMetadata metadata = project.fullBuild();
assertThat(metadata).has(Metadata.withGroup("management.endpoint.incremental")
.fromSource(IncrementalEndpoint.class));
assertThat(metadata).has(enabledFlag("incremental", true));
assertThat(metadata).has(cacheTtl("incremental"));
assertThat(metadata.getItems()).hasSize(3);
project.replaceText(IncrementalEndpoint.class, "@Nullable String param",
"String param");
metadata = project.incrementalBuild(IncrementalEndpoint.class);
assertThat(metadata).has(Metadata.withGroup("management.endpoint.incremental")
.fromSource(IncrementalEndpoint.class));
assertThat(metadata).has(enabledFlag("incremental", true));
assertThat(metadata.getItems()).hasSize(2);
}
@Test
public void incrementalEndpointBuildEnableSpecificEndpoint() throws Exception {
TestProject project = new TestProject(this.temporaryFolder,

9
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/TestConfigurationMetadataAnnotationProcessor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -48,6 +48,8 @@ public class TestConfigurationMetadataAnnotationProcessor
static final String ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.Endpoint";
static final String READ_OPERATION_ANNOTATION = "org.springframework.boot.configurationsample.ReadOperation";
private ConfigurationMetadata metadata;
private final File outputLocation;
@@ -76,6 +78,11 @@ public class TestConfigurationMetadataAnnotationProcessor
return ENDPOINT_ANNOTATION;
}
@Override
protected String readOperationAnnotation() {
return READ_OPERATION_ANNOTATION;
}
@Override
protected ConfigurationMetadata writeMetaData() throws Exception {
super.writeMetaData();

38
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ReadOperation.java Normal file
View File

@@ -0,0 +1,38 @@
/*
* Copyright 2012-2018 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.springframework.boot.configurationsample;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Alternative to Spring Boot's {@code @ReadOperation} for testing (removes the need for a
* dependency on the real annotation).
*
* @author Stephane Nicoll
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ReadOperation {
String[] produces() default {};
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/CustomPropertiesEndpoint.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -18,6 +18,7 @@ package org.springframework.boot.configurationsample.endpoint;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Endpoint;
import org.springframework.boot.configurationsample.ReadOperation;
/**
* An endpoint with additional custom properties.
@@ -30,6 +31,7 @@ public class CustomPropertiesEndpoint {
private String name = "test";
@ReadOperation
public String getName() {
return this.name;
}

12
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/EnabledEndpoint.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -17,6 +17,7 @@
package org.springframework.boot.configurationsample.endpoint;
import org.springframework.boot.configurationsample.Endpoint;
import org.springframework.boot.configurationsample.ReadOperation;
/**
* An endpoint that is enabled unless configured explicitly.
@@ -26,4 +27,13 @@ import org.springframework.boot.configurationsample.Endpoint;
@Endpoint(id = "enabled")
public class EnabledEndpoint {
public String someMethod() {
return "not a read operation";
}
@ReadOperation
public String retrieve(String parameter, Integer anotherParameter) {
return "not a main read operation";
}
}

8
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/SimpleEndpoint.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -17,6 +17,7 @@
package org.springframework.boot.configurationsample.endpoint;
import org.springframework.boot.configurationsample.Endpoint;
import org.springframework.boot.configurationsample.ReadOperation;
/**
* A simple endpoint with no default override.
@@ -26,4 +27,9 @@ import org.springframework.boot.configurationsample.Endpoint;
@Endpoint(id = "simple")
public class SimpleEndpoint {
@ReadOperation
public String invoke() {
return "test";
}
}

11
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/SpecificEndpoint.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -17,14 +17,21 @@
package org.springframework.boot.configurationsample.endpoint;
import org.springframework.boot.configurationsample.MetaEndpoint;
import org.springframework.boot.configurationsample.ReadOperation;
import org.springframework.lang.Nullable;
/**
* An meta-annotated endpoint similar to {@code @WebEndpoint} or {@code @JmxEndpoint} in
* Boot.
* Spring Boot. Also with a package private read operation that has an optional argument.
*
* @author Stephane Nicoll
*/
@MetaEndpoint(id = "specific", enableByDefault = true)
public class SpecificEndpoint {
@ReadOperation
String invoke(@Nullable String param) {
return "test";
}
}

7
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/incremental/IncrementalEndpoint.java
View File

@@ -17,6 +17,8 @@
package org.springframework.boot.configurationsample.endpoint.incremental;
import org.springframework.boot.configurationsample.Endpoint;
import org.springframework.boot.configurationsample.ReadOperation;
import org.springframework.lang.Nullable;
/**
* An endpoint that is enabled by default.
@@ -26,4 +28,9 @@ import org.springframework.boot.configurationsample.Endpoint;
@Endpoint(id = "incremental")
public class IncrementalEndpoint {
@ReadOperation
public String invoke(@Nullable String param) {
return "test";
}
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/incremental/IncrementalSpecificEndpoint.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 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.
@@ -20,7 +20,7 @@ import org.springframework.boot.configurationsample.MetaEndpoint;
/**
* An meta-annotated endpoint similar to {@code @WebEndpoint} or {@code @JmxEndpoint} in
* Boot.
* Spring Boot.
*
* @author Stephane Nicoll
*/