How to mock class with @ConfigurationProperties in Spring Boot

Question

I have a class that Autowires another class with @ConfigurationProperties.

Class with @ConfigurationProperties

@ConfigurationProperties(prefix = "report")
public class SomeProperties {
    private String property1;
    private String property2;
...

Class that Autowires above class SomeProperties

@Service
@Transactional
public class SomeService {
    ....
    @Autowired
    private SomeProperties someProperties;
    .... // There are other things

Now, I want to test SomeService class and in my test class when I mock SomeProperties class, I am getting null value for all the properties.

Test class

@RunWith(SpringRunner.class)
@SpringBootTest(classes = SomeProperties.class)
@ActiveProfiles("test")
@EnableConfigurationProperties
public class SomeServiceTest {
    @InjectMocks
    private SomeService someService;

    @Mock // I tried @MockBean as well, it did not work
    private SomeProperties someProperties;

How can I mock SomeProperties having properties from application-test.properties file.

Use constructor injection, not field injection.

chrylis -cautiouslyoptimistic-
– chrylis -cautiouslyoptimistic-

2020-09-11 14:56:11 +00:00
Commented Sep 11, 2020 at 14:56 — chrylis -cautiouslyoptimistic-
– chrylis -cautiouslyoptimistic-, Commented Sep 11, 2020 at 14:56

夢のの夢 · Accepted Answer · 2020-09-11 20:27:27Z

4

You are not mocking SomeProperties if you intend to bind values from a properties file, in which case an actual instance of SomeProperties would be provided.

Mock:

@RunWith(MockitoJUnitRunner.class)
public class SomeServiceTest {

    @InjectMocks
    private SomeService someService;

    @Mock
    private SomeProperties someProperties;

    @Test
    public void foo() {
        // you need to provide a return behavior whenever someProperties methods/props are invoked in someService
        when(someProperties.getProperty1()).thenReturn(...)
    }

No Mock (someProperties is an real object that binds its values from some propertysource):

@RunWith(SpringRunner.class)
@EnableConfigurationProperties(SomeConfig.class)
@TestPropertySource("classpath:application-test.properties")
public class SomeServiceTest {
   
    private SomeService someService;

    @Autowired
    private SomeProperties someProperties;

    @Before
    public void setup() {
        someService = new someService(someProperties); // Constructor Injection
    }
    ...

answered Sep 11, 2020 at 20:27

夢のの夢

6,01811 gold badges43 silver badges72 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

12kadir12 Over a year ago

Do we need constructor injection for the autowired property

夢のの夢 Over a year ago

@12kadir12 What''s being @Autowired here doesn't have dependency on other Beans. So no. But in the case where dependency beans are present in the @Autowired bean, you could mock the dependency beans with @MockBean and provide stubbing for them.

12kadir12 Over a year ago

I tried this solution but it doesn't work, the only difference is that I am using the .yml file instead of the properties file. Maybe the spring boot version is old since the project is legacy :) Do you have any idea?

Nikita Kobtsev Over a year ago

@12kadir12 the reason is @TestPropertySource does not support YAML property files. Instead of this annotation you have provide special initializer via @ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class) or ConfigFileApplicationContextInitializer.class if you're using Spring Boot older than 2.4.

12kadir12 Over a year ago

@NikitaKobtsev thank you for the explanation. I changed my yaml property files with original ones. but now, i know why i couldn't use @ TestPropertySource :)

Nakul Goyal · Accepted Answer · 2020-09-11 17:11:45Z

3

You need to stub all the property values in @Test/@Before methods of SomeServiceTest.java like :

ReflectionTestUtils.setField(someProperties, "property1", "value1");

ReflectionTestUtils.setField(object, name, value);

You can also mock the reponse for dependent classes via Mockito.when()

answered Sep 11, 2020 at 17:11

Nakul Goyal

6696 silver badges12 bronze badges

Comments

Umesh Sanwal · Accepted Answer · 2020-09-11 15:05:44Z

1

If you are using @Mock , you need to stub the values as well. By default the value will be null for all the properties.

edited Sep 11, 2020 at 15:05

answered Sep 11, 2020 at 14:54

Umesh Sanwal

7976 silver badges14 bronze badges

Collectives™ on Stack Overflow

How to mock class with @ConfigurationProperties in Spring Boot

Class with @ConfigurationProperties

Class that Autowires above class SomeProperties

Test class

3 Answers 3

5 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Class with @ConfigurationProperties

Class that Autowires above class SomeProperties

Test class

3 Answers 3

5 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related