Spring @PropertySource usando YAML

Spring Boot nos permite reemplazar nuestros archivos application.properties con equivalentes YAML. Sin embargo, parece que tengo un problema con mis pruebas. Si anoto mi TestConfiguration(una configuración simple de Java), se espera un archivo de propiedades.

Por ejemplo, esto no funciona: @PropertySource(value = "classpath:application-test.yml")

Si tengo esto en mi archivo YAML:

db:
  url: jdbc:oracle:thin:@pathToMyDb
  username: someUser
  password: fakePassword

Y estaría aprovechando esos valores con algo como esto:

@Value("${db.username}") String username

Sin embargo, termino con un error así:

Could not resolve placeholder 'db.username' in string value "${db.username}"

¿Cómo puedo aprovechar la bondad de YAML en mis pruebas también?

Spring-boot tiene un ayudante para esto, solo agregue

@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class)

en la parte superior de sus clases de prueba o en una superclase de prueba abstracta.

Editar: escribí esta respuesta hace cinco años. No funciona con versiones recientes de Spring Boot. Esto es lo que hago ahora (traduzca Kotlin a Java si es necesario):

@TestPropertySource(locations=["classpath:application.yml"])
@ContextConfiguration(
        initializers=[ConfigFileApplicationContextInitializer::class]
)

se agrega a la parte superior, luego

    @Configuration
    open class TestConfig {

        @Bean
        open fun propertiesResolver(): PropertySourcesPlaceholderConfigurer {
            return PropertySourcesPlaceholderConfigurer()
        }
    }

al contexto.

Como se mencionó @PropertySource, no carga el archivo yaml. Como solución, cargue el archivo por su cuenta y agregue las propiedades cargadas a Environment.

Implementar ApplicationContextInitializer:

public class YamlFileApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
  @Override
  public void initialize(ConfigurableApplicationContext applicationContext) {
    try {
        Resource resource = applicationContext.getResource("classpath:file.yml");
        YamlPropertySourceLoader sourceLoader = new YamlPropertySourceLoader();
        PropertySource<?> yamlTestProperties = sourceLoader.load("yamlTestProperties", resource, null);
        applicationContext.getEnvironment().getPropertySources().addFirst(yamlTestProperties);
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
  }
}

Agregue su inicializador a su prueba:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class, initializers = YamlFileApplicationContextInitializer.class)
public class SimpleTest {
  @Test
  public test(){
    // test your properties
  }
}

@PropertySourcese puede configurar por factoryargumento. Entonces puedes hacer algo como:

@PropertySource(value = "classpath:application-test.yml", factory = YamlPropertyLoaderFactory.class)

¿Dónde YamlPropertyLoaderFactoryestá su cargador de propiedades personalizadas?

public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory {
    @Override
    public PropertySource<?> 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);
    }
}

Inspirado en https://stackoverflow.com/a/45882447/4527110

@PropertySourcesolo admite archivos de propiedades (es una limitación de Spring, no de Boot en sí). No dude en abrir un ticket de solicitud de función en JIRA .

Otra opción es configurar el spring.config.locationpaso @TestPropertySource:

@TestPropertySource(properties = { "spring.config.location = classpath:<path-to-your-yml-file>" }

Desde Spring Boot 1.4, puede usar la nueva @SpringBootTestanotación para lograr esto más fácilmente (y para simplificar la configuración de la prueba de integración en general) iniciando sus pruebas de integración con el soporte de Spring Boot.

Detalles en el blog de primavera .

Por lo que puedo decir, esto significa que obtiene todos los beneficios de la bondad de configuración externalizada de Spring Boot al igual que en su código de producción, incluida la recogida automática de la configuración YAML de la ruta de clase.

De forma predeterminada, esta anotación

... primer intento de cargar @Configurationdesde cualquier clase interna, y si eso falla, buscará su @SpringBootApplicationclase primaria .

pero puede especificar otras clases de configuración si es necesario.

Para este caso particular, puede combinar @SpringBootTestcon @ActiveProfiles( "test" )y Spring recogerá su configuración YAML, siempre que siga los estándares de nomenclatura de arranque normales (es decir, application-test.yml).

@RunWith( SpringRunner.class )
@SpringBootTest
@ActiveProfiles( "test" )
public class SpringBootITest {

    @Value("${db.username}")
    private String username;

    @Autowired
    private MyBean myBean;

    ...

}

Nota: SpringRunner.classes el nuevo nombre deSpringJUnit4ClassRunner.class

El enfoque para cargar las propiedades de yaml, en mi humilde opinión, se puede hacer de dos maneras:

a. Puede colocar la configuración en una ubicación estándar, application.ymlen la raíz de la ruta de src/main/resourcesclase, normalmente y esta propiedad yaml debería cargarse automáticamente mediante Spring boot con el nombre de ruta plano que ha mencionado.

si. El segundo enfoque es un poco más extenso, básicamente define una clase para mantener tus propiedades de esta manera:

@ConfigurationProperties(path="classpath:/appprops.yml", name="db")
public class DbProperties {
    private String url;
    private String username;
    private String password;
...
}

Básicamente, esto está diciendo que cargue el archivo yaml y complete la clase DbProperties basándose en el elemento raíz de "db".

Ahora, para usarlo en cualquier clase, tendrá que hacer esto:

@EnableConfigurationProperties(DbProperties.class)
public class PropertiesUsingService {

    @Autowired private DbProperties dbProperties;

}

Cualquiera de estos enfoques debería funcionar correctamente con Spring-boot.

Encontré una solución al usar @ActiveProfiles("test")y agregar un archivo application-test.yml a src / test / resources.

Terminó luciendo así:

@SpringApplicationConfiguration(classes = Application.class, initializers = ConfigFileApplicationContextInitializer.class)
@ActiveProfiles("test")
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {

}

El archivo application-test.yml solo contiene las propiedades que quiero anular de application.yml (que se pueden encontrar en src / main / resources).

es porque no ha configurado snakeyml. Spring Boot viene con la función @EnableAutoConfiguration. También hay una configuración de snakeyml cuando llama a esta anotación.

Esta es mi manera:

@Configuration
@EnableAutoConfiguration
public class AppContextTest {
}

aquí está mi prueba:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(
        classes = {
                AppContextTest.class,
                JaxbConfiguration.class,
        }
)

public class JaxbTest {
//tests are ommited
}

Necesitaba leer algunas propiedades en mi código y esto funciona con 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);
}

Cargando archivo yml personalizado con configuración de perfil múltiple en Spring Boot.

1) Agregue el bean de propiedad con SpringBootApplication iniciando de la siguiente manera

@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) Configure el objeto pojo de Java de la siguiente manera

@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) Cree el yml personalizado (y colóquelo en la ruta del recurso de la siguiente manera, Nombre de archivo YML: test-service-config.yml

Por ejemplo, Config en el archivo yml.

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

Estaba en una situación particular en la que no podía cargar una clase @ConfigurationProperties debido a la denominación de propiedades de archivo personalizado. Al final lo único que funcionó fue (gracias @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<PropertySource<?>> loadedSources = sourceLoader.load("yamlTestProperties", resource);
            PropertySource<?> 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();

    }

}

<dependency>
  <groupId>com.github.yingzhuo</groupId>
  <artifactId>spring-boot-stater-env</artifactId>
  <version>0.0.3</version>
</dependency>

Bienvenido a usar mi biblioteca. Ahora se admite yaml , toml , hocon .

Fuente: github.com

Esta no es una respuesta a la pregunta original, sino una solución alternativa para la necesidad de tener una configuración diferente en una prueba ...

En lugar de @PropertySourcepuedes usar -Dspring.config.additional-location=classpath:application-tests.yml.

Tenga en cuenta que ese sufijo testsno significa perfil ...

En ese archivo YAML se pueden especificar múltiples perfiles, que pueden heredarse entre sí, lea más aquí - Resolución de propiedades para múltiples perfiles de Spring (configuración yaml)

A continuación, se puede especificar en su prueba, que los perfiles activos (utilizando @ActiveProfiles("profile1,profile2")) son profile1,profile2donde profile2simplemente anulará (algunos, no se necesita para anular todos) de propiedades profile1.

Probé todas las preguntas enumeradas, pero todas no funcionan para mi tarea: usar un archivo yaml específico para alguna prueba unitaria. En mi caso, funciona así:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(initializers = {ConfigFileApplicationContextInitializer.class})
@TestPropertySource(properties = {"spring.config.location=file:../path/to/specific/config/application.yml"})
public class SomeTest {


    @Value("${my.property.value:#{null}}")
    private String value;

    @Test
    public void test() {
        System.out.println("value = " + value);
    }

}

No es necesario agregar como YamlPropertyLoaderFactory o YamlFileApplicationContextInitializer. Deberías convertir tu idea. al igual que el proyecto de primavera común. Ya sabes, no usando la configuración de Java. Solo * .xml

Sigue estos pasos:

Simplemente agregue applicationContext.xml como

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="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"
       default-autowire="byName">

    <context:property-placeholder location="classpath*:*.yml"/>
</beans>

Luego añade

@ImportResource({"classpath:applicationContext.xml"})

a tu ApplicationMainClass.

Esto puede ayudar a escanear su aplicación-test.yml

db:
  url: jdbc:oracle:thin:@pathToMyDb
  username: someUser
  password: fakePassword