Support Object property values in MockEnvironment

The setProperty() and withProperty() methods in MockEnvironment were
originally introduced with (String, String) signatures; however, they
should have always had (String, Object) signatures in order to comply
with the MockPropertySource and PropertySource APIs.

To address that, this commit introduces variants of these methods that
accept Object values for properties.

Closes gh-34947
This commit is contained in:
Sam Brannen 2025-05-26 17:22:52 +02:00
parent 6a6abac003
commit d0efc2230c
1 changed files with 34 additions and 10 deletions

View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 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.
@ -26,7 +26,7 @@ import org.springframework.core.env.ConfigurableEnvironment;
* @author Chris Beams
* @author Sam Brannen
* @since 3.2
* @see org.springframework.mock.env.MockPropertySource
* @see MockPropertySource
*/
public class MockEnvironment extends AbstractEnvironment {
@ -43,19 +43,43 @@ public class MockEnvironment extends AbstractEnvironment {
/**
* Set a property on the underlying {@link MockPropertySource} for this environment.
* @since 6.2.8
* @see MockPropertySource#setProperty(String, Object)
*/
public void setProperty(String key, String value) {
this.propertySource.setProperty(key, value);
public void setProperty(String name, Object value) {
this.propertySource.setProperty(name, value);
}
/**
* Convenient synonym for {@link #setProperty} that returns the current instance.
* Useful for method chaining and fluent-style use.
* @return this {@link MockEnvironment} instance
* @see MockPropertySource#withProperty
* Set a property on the underlying {@link MockPropertySource} for this environment.
* @see #setProperty(String, Object)
*/
public MockEnvironment withProperty(String key, String value) {
setProperty(key, value);
public void setProperty(String name, String value) {
this.propertySource.setProperty(name, value);
}
/**
* Convenient synonym for {@link #setProperty(String, Object)} that returns
* the current instance.
* <p>Useful for method chaining and fluent-style use.
* @return this {@link MockEnvironment} instance
* @since 6.2.8
* @see MockPropertySource#withProperty(String, Object)
*/
public MockEnvironment withProperty(String name, Object value) {
setProperty(name, value);
return this;
}
/**
* Convenient synonym for {@link #setProperty(String, String)} that returns
* the current instance.
* <p>Useful for method chaining and fluent-style use.
* @return this {@link MockEnvironment} instance
* @see #withProperty(String, Object)
*/
public MockEnvironment withProperty(String name, String value) {
setProperty(name, value);
return this;
}