Skip to content

Commit

Permalink
Fix status handling of /application/env/{propertyName}
Browse files Browse the repository at this point in the history
This commit makes sure to return a 404 status if the env endpoint is
invoked with a property that does not exist in the environment.

Closes spring-projectsgh-10179
  • Loading branch information
snicoll committed Sep 27, 2017
1 parent c2c6f49 commit 3894229
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@

import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.env.EnvironmentEndpoint;
import org.springframework.boot.actuate.env.EnvironmentWebEndpointExtension;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
Expand Down Expand Up @@ -55,4 +57,13 @@ public EnvironmentEndpoint environmentEndpoint(Environment environment) {
return endpoint;
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint
@ConditionalOnBean(EnvironmentEndpoint.class)
public EnvironmentWebEndpointExtension environmentWebEndpointExtension(
EnvironmentEndpoint environmentEndpoint) {
return new EnvironmentWebEndpointExtension(environmentEndpoint);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Copyright 2012-2017 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.actuate.env;

import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
import org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointExtension;
import org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentEntryDescriptor;

/**
* {@link WebEndpointExtension} for the {@link EnvironmentEndpoint}.
*
* @author Stephane Nicoll
* @since 2.0.0
*/
@WebEndpointExtension(endpoint = EnvironmentEndpoint.class)
public class EnvironmentWebEndpointExtension {

private final EnvironmentEndpoint delegate;

public EnvironmentWebEndpointExtension(EnvironmentEndpoint delegate) {
this.delegate = delegate;
}

@ReadOperation
public WebEndpointResponse<EnvironmentEntryDescriptor> environmentEntry(
@Selector String toMatch) {
EnvironmentEntryDescriptor descriptor = this.delegate.environmentEntry(toMatch);
int status = descriptor.getProperty() != null ? WebEndpointResponse.STATUS_OK
: WebEndpointResponse.STATUS_NOT_FOUND;
return new WebEndpointResponse<>(descriptor, status);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@ public void nestedPathWithSensitivePlaceholderShouldSanitize() throws Exception
.jsonPath(forPropertyEntry("placeholder")).isEqualTo("******");
}

@Test
public void nestedPathForUnknownKeyShouldReturn404AndBody() throws Exception {
client.get().uri("/application/env/this.does.not.exist").exchange().expectStatus()
.isNotFound()
.expectBody()
.jsonPath("property").doesNotExist()
.jsonPath("propertySources[?(@.name=='test')]").exists()
.jsonPath("propertySources[?(@.name=='systemProperties')]").exists()
.jsonPath("propertySources[?(@.name=='systemEnvironment')]").exists();
}

@Test
public void nestedPathMatchedByRegexWhenPlaceholderCannotBeResolvedShouldReturnUnresolvedProperty()
throws Exception {
Expand Down Expand Up @@ -140,6 +151,12 @@ public EnvironmentEndpoint endpoint(Environment environment) {
return new EnvironmentEndpoint(environment);
}

@Bean
public EnvironmentWebEndpointExtension webEndpointExtension(
EnvironmentEndpoint endpoint) {
return new EnvironmentWebEndpointExtension(endpoint);
}

}

}

0 comments on commit 3894229

Please sign in to comment.