Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Configure existing probes at additional path when necessary
Fixes gh-30612
- Loading branch information
Showing
6 changed files
with
217 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
...t/actuate/autoconfigure/availability/DelegatingAvailabilityProbesHealthEndpointGroup.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
/* | ||
* Copyright 2012-2022 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 org.springframework.boot.actuate.autoconfigure.availability; | ||
|
||
import org.springframework.boot.actuate.endpoint.SecurityContext; | ||
import org.springframework.boot.actuate.health.AdditionalHealthEndpointPath; | ||
import org.springframework.boot.actuate.health.HealthEndpointGroup; | ||
import org.springframework.boot.actuate.health.HttpCodeStatusMapper; | ||
import org.springframework.boot.actuate.health.StatusAggregator; | ||
import org.springframework.util.Assert; | ||
|
||
/** | ||
* {@link HealthEndpointGroup} used to support availability probes that delegates to an | ||
* existing group. | ||
* | ||
* @author Madhura Bhave | ||
*/ | ||
class DelegatingAvailabilityProbesHealthEndpointGroup implements HealthEndpointGroup { | ||
|
||
private final HealthEndpointGroup delegate; | ||
|
||
private final AdditionalHealthEndpointPath additionalPath; | ||
|
||
DelegatingAvailabilityProbesHealthEndpointGroup(HealthEndpointGroup delegate, | ||
AdditionalHealthEndpointPath additionalPath) { | ||
Assert.notNull(delegate, "Delegate must not be null"); | ||
this.delegate = delegate; | ||
this.additionalPath = additionalPath; | ||
} | ||
|
||
@Override | ||
public boolean isMember(String name) { | ||
return this.delegate.isMember(name); | ||
} | ||
|
||
@Override | ||
public boolean showComponents(SecurityContext securityContext) { | ||
return this.delegate.showComponents(securityContext); | ||
} | ||
|
||
@Override | ||
public boolean showDetails(SecurityContext securityContext) { | ||
return this.delegate.showDetails(securityContext); | ||
} | ||
|
||
@Override | ||
public StatusAggregator getStatusAggregator() { | ||
return this.delegate.getStatusAggregator(); | ||
} | ||
|
||
@Override | ||
public HttpCodeStatusMapper getHttpCodeStatusMapper() { | ||
return this.delegate.getHttpCodeStatusMapper(); | ||
} | ||
|
||
@Override | ||
public AdditionalHealthEndpointPath getAdditionalPath() { | ||
return this.additionalPath; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
...uate/autoconfigure/availability/DelegatingAvailabilityProbesHealthEndpointGroupTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* | ||
* Copyright 2012-2021 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 org.springframework.boot.actuate.autoconfigure.availability; | ||
|
||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import org.springframework.boot.actuate.health.AdditionalHealthEndpointPath; | ||
import org.springframework.boot.actuate.health.HealthEndpointGroup; | ||
import org.springframework.boot.actuate.health.HttpCodeStatusMapper; | ||
import org.springframework.boot.actuate.health.StatusAggregator; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.mockito.ArgumentMatchers.any; | ||
import static org.mockito.BDDMockito.given; | ||
import static org.mockito.Mockito.mock; | ||
|
||
/** | ||
* Tests for {@link DelegatingAvailabilityProbesHealthEndpointGroup}. | ||
* | ||
* @author Madhura Bhave | ||
*/ | ||
class DelegatingAvailabilityProbesHealthEndpointGroupTests { | ||
|
||
private DelegatingAvailabilityProbesHealthEndpointGroup group; | ||
|
||
private HttpCodeStatusMapper mapper; | ||
|
||
private StatusAggregator aggregator; | ||
|
||
@BeforeEach | ||
void setup() { | ||
HealthEndpointGroup delegate = mock(HealthEndpointGroup.class); | ||
this.mapper = mock(HttpCodeStatusMapper.class); | ||
this.aggregator = mock(StatusAggregator.class); | ||
given(delegate.getHttpCodeStatusMapper()).willReturn(this.mapper); | ||
given(delegate.getStatusAggregator()).willReturn(this.aggregator); | ||
given(delegate.showComponents(any())).willReturn(true); | ||
given(delegate.showDetails(any())).willReturn(false); | ||
given(delegate.isMember("test")).willReturn(true); | ||
this.group = new DelegatingAvailabilityProbesHealthEndpointGroup(delegate, | ||
AdditionalHealthEndpointPath.from("server:test")); | ||
} | ||
|
||
@Test | ||
void groupDelegatesToDelegate() { | ||
assertThat(this.group.getHttpCodeStatusMapper()).isEqualTo(this.mapper); | ||
assertThat(this.group.getStatusAggregator()).isEqualTo(this.aggregator); | ||
assertThat(this.group.isMember("test")).isTrue(); | ||
assertThat(this.group.showDetails(null)).isFalse(); | ||
assertThat(this.group.showComponents(null)).isTrue(); | ||
assertThat(this.group.getAdditionalPath().getValue()).isEqualTo("test"); | ||
} | ||
|
||
} |