forked from spring-projects/spring-boot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ignore top-level ConfigurationProperty binding failures
Fixes spring-projectsgh-12357
- Loading branch information
Showing
4 changed files
with
171 additions
and
1 deletion.
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
45 changes: 45 additions & 0 deletions
45
...work/boot/context/properties/bind/handler/IgnoreTopLevelConverterNotFoundBindHandler.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,45 @@ | ||
/* | ||
* 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.context.properties.bind.handler; | ||
|
||
import org.springframework.boot.context.properties.bind.AbstractBindHandler; | ||
import org.springframework.boot.context.properties.bind.BindContext; | ||
import org.springframework.boot.context.properties.bind.BindHandler; | ||
import org.springframework.boot.context.properties.bind.Bindable; | ||
import org.springframework.boot.context.properties.source.ConfigurationPropertyName; | ||
import org.springframework.core.convert.ConverterNotFoundException; | ||
|
||
/** | ||
* {@link BindHandler} that can be used to ignore top-level {@link ConverterNotFoundException}s. | ||
* | ||
* @author Madhura Bhave | ||
* @since 2.0.0 | ||
*/ | ||
public class IgnoreTopLevelConverterNotFoundBindHandler extends AbstractBindHandler { | ||
|
||
@Override | ||
public Object onFailure(ConfigurationPropertyName name, Bindable<?> target, | ||
BindContext context, Exception error) throws Exception { | ||
if (context.getDepth() == 0 && error instanceof ConverterNotFoundException) { | ||
return null; | ||
} | ||
throw error; | ||
} | ||
|
||
} | ||
|
||
|
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
119 changes: 119 additions & 0 deletions
119
...boot/context/properties/bind/handler/IgnoreTopLevelConverterNotFoundBindHandlerTests.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,119 @@ | ||
/* | ||
* 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.context.properties.bind.handler; | ||
|
||
import java.util.ArrayList; | ||
import java.util.List; | ||
import java.util.Map; | ||
|
||
import org.junit.After; | ||
import org.junit.Before; | ||
import org.junit.Rule; | ||
import org.junit.Test; | ||
import org.junit.rules.ExpectedException; | ||
|
||
import org.springframework.boot.context.properties.bind.BindException; | ||
import org.springframework.boot.context.properties.bind.Bindable; | ||
import org.springframework.boot.context.properties.bind.Binder; | ||
import org.springframework.boot.context.properties.source.ConfigurationPropertySource; | ||
import org.springframework.boot.context.properties.source.MockConfigurationPropertySource; | ||
import org.springframework.core.convert.ConverterNotFoundException; | ||
|
||
import static org.hamcrest.Matchers.instanceOf; | ||
|
||
/** | ||
* Tests for {@link IgnoreTopLevelConverterNotFoundBindHandler}. | ||
* | ||
* @author Madhura Bhave | ||
*/ | ||
public class IgnoreTopLevelConverterNotFoundBindHandlerTests { | ||
|
||
@Rule | ||
public ExpectedException thrown = ExpectedException.none(); | ||
|
||
private List<ConfigurationPropertySource> sources = new ArrayList<>(); | ||
|
||
private Binder binder; | ||
|
||
@Before | ||
public void setup() { | ||
MockConfigurationPropertySource source = new MockConfigurationPropertySource(); | ||
source.put("example", "bar"); | ||
this.sources.add(source); | ||
this.binder = new Binder(this.sources); | ||
} | ||
|
||
@After | ||
public void tearDown() { | ||
this.sources.clear(); | ||
} | ||
|
||
@Test | ||
public void bindWhenHandlerNotPresentShouldFail() { | ||
this.thrown.expectCause(instanceOf(ConverterNotFoundException.class)); | ||
this.binder.bind("example", Bindable.of(Example.class)); | ||
} | ||
|
||
@Test | ||
public void bindWhenTopLevelContextAndExceptionIgnorableShouldNotFail() { | ||
this.binder.bind("example", Bindable.of(Example.class), new IgnoreTopLevelConverterNotFoundBindHandler()); | ||
} | ||
|
||
@Test | ||
public void bindWhenExceptionNotIgnorableShouldNotFail() { | ||
MockConfigurationPropertySource source = new MockConfigurationPropertySource(); | ||
source.put("example.foo", "1"); | ||
this.sources.add(source); | ||
this.thrown.expectCause(instanceOf(IllegalStateException.class)); | ||
this.binder.bind("example", Bindable.of(Example.class), new IgnoreTopLevelConverterNotFoundBindHandler()); | ||
} | ||
|
||
@Test | ||
public void bindWhenExceptionInNestedContextShouldFail() { | ||
MockConfigurationPropertySource source = new MockConfigurationPropertySource(); | ||
source.put("example.map", "hello"); | ||
this.sources.add(source); | ||
this.thrown.expect(BindException.class); | ||
this.thrown.expectCause(instanceOf(ConverterNotFoundException.class)); | ||
this.binder.bind("example", Bindable.of(Example.class), new IgnoreTopLevelConverterNotFoundBindHandler()); | ||
} | ||
|
||
public static class Example { | ||
|
||
private int foo; | ||
|
||
private Map<String, String> map; | ||
|
||
public int getFoo() { | ||
return this.foo; | ||
} | ||
|
||
public void setFoo(int foo) { | ||
throw new IllegalStateException(); | ||
} | ||
|
||
public Map<String, String> getMap() { | ||
return this.map; | ||
} | ||
|
||
public void setMap(Map<String, String> map) { | ||
this.map = map; | ||
} | ||
|
||
} | ||
|
||
} |