Spring PropertySource using YAML

Question

Spring Boot allows us to replace our application properties files with YAML equivalents  However I seem to hit a snag with my tests  If I annotate my TestConfiguration  a simple Java config   it is expecting a properties file   For example this doesn t work   PropertySource value    classpath application-test yml    If I have this in my YAML file   db    url  jdbc oracle thin  pathToMyDb   username  someUser   password  fakePassword   And I d be leveraging those values with something like this    Value    db username    String username   However  I end up with and error like so   Could not resolve placeholder  db username  in string value    db username     How can I leverage the YAML goodness in my tests as well

User · Accepted Answer

Spring-boot has a helper for this  just add   ContextConfiguration initializers   ConfigFileApplicationContextInitializer class    at the top of your test classes or an abstract test superclass   Edit  I wrote this answer five years ago  It doesn t work with recent versions of Spring Boot  This is what I do now  please translate the Kotlin to Java if necessary     TestPropertySource locations   classpath application yml     ContextConfiguration          initializers  ConfigFileApplicationContextInitializer  class      is added to the top  then       Configuration     open class TestConfig             Bean         open fun propertiesResolver    PropertySourcesPlaceholderConfigurer               return PropertySourcesPlaceholderConfigurer                     to the context

User · Answer

I needed to read some properties into my code and this works with spring-boot 1 3 0 RELEASE   Autowired private ConfigurableListableBeanFactory beanFactory      access a properties yml file like properties  Bean public PropertySource properties         PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer   new PropertySourcesPlaceholderConfigurer        YamlPropertiesFactoryBean yaml   new YamlPropertiesFactoryBean        yaml setResources new ClassPathResource  properties yml         propertySourcesPlaceholderConfigurer setProperties yaml getObject            properties need to be processed by beanfactory to be accessible after     propertySourcesPlaceholderConfigurer postProcessBeanFactory beanFactory       return propertySourcesPlaceholderConfigurer getAppliedPropertySources   get PropertySourcesPlaceholderConfigurer LOCAL PROPERTIES PROPERTY SOURCE NAME

User · Answer

i had this similar problem  I m using SpringBoot 2 4 1  If you face similar problem i e  cannot load yml files  try adding this class-level annotation in your test   SpringJUnitConfig      classes     UserAccountPropertiesTest TestConfig class        initializers     ConfigDataApplicationContextInitializer class     class UserAccountPropertiesTest         Configuration      EnableConfigurationProperties UserAccountProperties class      static class TestConfig           Autowired     UserAccountProperties userAccountProperties        Test     void getAccessTokenExpireIn            assertThat userAccountProperties getAccessTokenExpireIn    isEqualTo 120               Test     void getRefreshTokenExpireIn             assertThat userAccountProperties getRefreshTokenExpireIn    isEqualTo 604800            the ConfigDataApplicationContextInitializer from import org springframework boot test context ConfigDataApplicationContextInitializer   is the one that  quot help quot  translate the yml files i think  I m able to run my test successfully

User · Answer

I have tried all of the listed questions  but all of them not work for my task  using specific yaml file for some unit test  In my case  it works like this   RunWith SpringJUnit4ClassRunner class   ContextConfiguration initializers    ConfigFileApplicationContextInitializer class    TestPropertySource properties     quot spring config location file    path to specific config application yml quot    public class SomeTest          Value  quot   my property value   null   quot       private String value        Test     public void test             System out println  quot value    quot    value

User · Answer

From Spring Boot 1 4  you can use the new  SpringBootTest annotation to achieve this more easily  and to simplify your integration test setup in general  by bootstrapping your integration tests using Spring Boot support   Details on the Spring Blog   As far as I can tell  this means you get all the benefits of Spring Boot s externalized config goodness just like in your production code  including automatically picking up YAML config from the classpath   By default  this annotation will          first attempt to load  Configuration from any inner-classes  and if that fails  it will search for your primary  SpringBootApplication class    but you can specify other configuration classes if required   For this particular case  you can combine  SpringBootTest with  ActiveProfiles   test    and Spring will pick up your YAML config  provided it follows the normal Boot naming standards  i e  application-test yml     RunWith  SpringRunner class    SpringBootTest  ActiveProfiles   test    public class SpringBootITest         Value    db username        private String username        Autowired     private MyBean myBean                Note  SpringRunner class is the new name for SpringJUnit4ClassRunner class

User · Answer

lt dependency gt     lt groupId gt com github yingzhuo lt  groupId gt     lt artifactId gt spring-boot-stater-env lt  artifactId gt     lt version gt 0 0 3 lt  version gt   lt  dependency gt    Welcome to use my library  Now yaml  toml  hocon is supported   Source  github com

User · Answer

The approach to loading the yaml properties  IMHO can be done in two ways   a  You can put the configuration in a standard location - application yml in the classpath root - typically src main resources and this yaml property should automatically get loaded by Spring boot with the flattened path name that you have mentioned   b  The second approach is a little more extensive  basically define a class to hold your properties this way    ConfigurationProperties path  classpath  appprops yml   name  db   public class DbProperties       private String url      private String username      private String password          So essentially this is saying that load the yaml file and populate the DbProperties class based on the root element of  db    Now to use it in any class you will have to do this    EnableConfigurationProperties DbProperties class  public class PropertiesUsingService         Autowired private DbProperties dbProperties       Either of these approaches should work for you cleanly using Spring-boot

User · Answer

it s because you have not configure snakeyml   spring boot come with  EnableAutoConfiguration feature  there is snakeyml config too when u call this annotation    this is my way    Configuration  EnableAutoConfiguration public class AppContextTest       here is my test    RunWith SpringJUnit4ClassRunner class   SpringApplicationConfiguration          classes                     AppContextTest class                  JaxbConfiguration class               public class JaxbTest     tests are ommited

User · Answer

Loading custom yml file with multiple profile config in Spring Boot    1  Add the property bean with SpringBootApplication start up as follows   SpringBootApplication  ComponentScan   com example as      public class TestApplication        public static void main String   args            SpringApplication run TestApplication class  args               Bean      Profile  dev       public PropertySourcesPlaceholderConfigurer propertiesStage             return properties  dev                Bean      Profile  stage       public PropertySourcesPlaceholderConfigurer propertiesDev             return properties  stage                Bean      Profile  default       public PropertySourcesPlaceholderConfigurer propertiesDefault             return properties  default                        Update custom specific yml file with profile configuration         param profile        return            public static PropertySourcesPlaceholderConfigurer properties String profile           PropertySourcesPlaceholderConfigurer propertyConfig   null         YamlPropertiesFactoryBean yaml    null          propertyConfig    new PropertySourcesPlaceholderConfigurer           yaml   new YamlPropertiesFactoryBean           yaml setDocumentMatchers new SpringProfileDocumentMatcher profile      load profile filter         yaml setResources new ClassPathResource  env config test-service-config yml            propertyConfig setProperties yaml getObject            return propertyConfig            2  Config the Java pojo object as follows   Component  JsonIgnoreProperties ignoreUnknown   true   JsonInclude Include NON NULL   ConfigurationProperties prefix    test-service   public class TestConfig         JsonProperty  id        private  String id        JsonProperty  name       private String name       public String getId             return id             public void setId String id            this id   id             public String getName             return name             public void setName String name            this name   name                3  Create  the custom yml  and place it under resource path as follows  YML File name   test-service-config yml  Eg Config in the yml file   test-service       id  default id     name  Default application config --- spring    profiles  dev  test-service     id  dev id   name  dev application config  ---  spring    profiles  stage  test-service     id  stage id   name  stage application config

User · Answer

PropertySource only supports properties files  it s a limitation from Spring  not Boot itself   Feel free to open a feature request ticket in JIRA

User · Answer

There is no need to add like YamlPropertyLoaderFactory or YamlFileApplicationContextInitializer  You should convert your idea  just like common spring project  You know  not using Java config  Just   xml Follow these steps  Just add applicationContext xml like  lt  xml version  quot 1 0 quot  encoding  quot UTF-8 quot   gt   lt beans xmlns  quot http   www springframework org schema beans quot         xmlns xsi  quot http   www w3 org 2001 XMLSchema-instance quot         xmlns context  quot http   www springframework org schema context quot         xsi schemaLocation  quot http   www springframework org schema beans http   www springframework org schema beans spring-beans-2 5 xsd         http   www springframework org schema context http   www springframework org schema context spring-context-2 5 xsd quot         default-autowire  quot byName quot  gt        lt context property-placeholder location  quot classpath    yml quot   gt   lt  beans gt   then add  ImportResource   quot classpath applicationContext xml quot     to your ApplicationMainClass  This can help scan your application-test yml db    url  jdbc oracle thin  pathToMyDb   username  someUser   password  fakePassword

User · Answer

PropertySource can be configured by factory argument  So you can do something like    PropertySource value    classpath application-test yml   factory   YamlPropertyLoaderFactory class    Where YamlPropertyLoaderFactory is your custom property loader   public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory        Override     public PropertySource lt   gt  createPropertySource String name  EncodedResource resource  throws IOException           if  resource    null               return super createPropertySource name  resource                      return new YamlPropertySourceLoader   load resource getResource   getFilename    resource getResource    null             Inspired by https   stackoverflow com a 45882447 4527110

User · Answer

Another option is to set the spring config location through  TestPropertySource    TestPropertySource properties      spring config location   classpath  lt path-to-your-yml-file gt

User · Answer

I was in a particular situation where I couldn t load a  ConfigurationProperties class due to custom file property naming  At the end the only thing that worked is  thanks  Mateusz Balbus    import java io File  import java io FileInputStream  import java io IOException  import java util List   import org apache commons io IOUtils  import org junit Test  import org junit runner RunWith  import org springframework beans factory annotation Autowired  import org springframework beans factory annotation Qualifier  import org springframework boot context properties bind Bindable  import org springframework boot context properties bind Binder  import org springframework boot env YamlPropertySourceLoader  import org springframework boot test context TestConfiguration  import org springframework context ApplicationContext  import org springframework context annotation Bean  import org springframework context annotation ComponentScan  import org springframework context annotation Configuration  import org springframework core env ConfigurableEnvironment  import org springframework core env PropertySource  import org springframework core io Resource  import org springframework test context ContextConfiguration  import org springframework test context junit4 SpringRunner    RunWith SpringRunner class   ContextConfiguration classes    MyTest ContextConfiguration class   public class MyTest         TestConfiguration     public static class ContextConfiguration             Autowired         ApplicationContext applicationContext            Bean         public ConfigurationPropertiesBean myConfigurationPropertiesBean   throws IOException               Resource resource   applicationContext getResource  classpath my-properties-file yml                 YamlPropertySourceLoader sourceLoader   new YamlPropertySourceLoader                List lt PropertySource lt   gt  gt  loadedSources   sourceLoader load  yamlTestProperties   resource               PropertySource lt   gt  yamlTestProperties   loadedSources get 0               ConfigurableEnvironment configurableEnvironment    ConfigurableEnvironment applicationContext getEnvironment                configurableEnvironment getPropertySources   addFirst yamlTestProperties                Binder binder   Binder get applicationContext getEnvironment                 ConfigurationPropertiesBean configurationPropertiesBean   binder bind  my-properties-file-prefix   Bindable of ConfigurationPropertiesBean class   get                return configurationPropertiesBean                         Autowired     ConfigurationPropertiesBean configurationPropertiesBean        Test     public void test              configurationPropertiesBean getMyProperty

User · Answer

As it was mentioned  PropertySource doesn t load yaml file  As a workaround load the file on your own and add loaded properties to Environment   Implemement ApplicationContextInitializer   public class YamlFileApplicationContextInitializer implements ApplicationContextInitializer lt ConfigurableApplicationContext gt       Override   public void initialize ConfigurableApplicationContext applicationContext        try           Resource resource   applicationContext getResource  classpath file yml            YamlPropertySourceLoader sourceLoader   new YamlPropertySourceLoader            PropertySource lt   gt  yamlTestProperties   sourceLoader load  yamlTestProperties   resource  null           applicationContext getEnvironment   getPropertySources   addFirst yamlTestProperties         catch  IOException e            throw new RuntimeException e                 Add your initializer to your test    RunWith SpringJUnit4ClassRunner class   SpringApplicationConfiguration classes   Application class  initializers   YamlFileApplicationContextInitializer class  public class SimpleTest      Test   public test           test your properties

User · Answer

I found a workaround by using  ActiveProfiles  test   and adding an application-test yml file to src test resources   It ended up looking like this    SpringApplicationConfiguration classes   Application class  initializers   ConfigFileApplicationContextInitializer class   ActiveProfiles  test   public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests        The file application-test yml just contains the properties that I want to override from application yml  which can be found in src main resources

User · Answer

This is not an answer to the original question  but an alternative solution for a need to have a different configuration in a test     Instead of  PropertySource you can use -Dspring config additional-location classpath application-tests yml   Be aware  that suffix tests does not mean profile     In that one YAML file one can specify multiple profiles  that can kind of inherit from each other  read more here - Property resolving for multiple Spring profiles  yaml configuration   Then  you can specify in your test  that active profiles  using  ActiveProfiles  profile1 profile2    are profile1 profile2 where profile2 will simply override  some  one does not need to override all  properties from profile1

[spring] Spring @PropertySource using YAML

Examples related to spring

Examples related to spring-boot