Sostituisci le impostazioni application.properties di Spring-Boot predefinite in Junit Test

Ho un'applicazione Spring-Boot in cui le proprietà predefinite sono impostate in un application.propertiesfile nel percorso di classe (src / main / resources / application.properties).

Vorrei sovrascrivere alcune impostazioni predefinite nel mio test JUnit con le proprietà dichiarate in un test.propertiesfile (src / test / resources / test.properties)

Di solito ho una lezione di configurazione dedicata per i miei test Junit, ad es

package foo.bar.test;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import(CoreConfig.class)
@EnableAutoConfiguration
public class TestConfig {

}

Ho pensato che usare @PropertySource("classpath:test.properties")la classe TestConfig avrebbe funzionato, ma queste proprietà non sovrascrivevano le impostazioni application.properties (vedi Documento di riferimento di Spring-Boot - 23. Configurazione esterna ).

Quindi ho provato a usare -Dspring.config.location=classpath:test.propertiesquando invoco il test. Ciò ha avuto esito positivo, ma non voglio impostare questa proprietà di sistema per ogni esecuzione del test. Quindi l'ho inserito nel codice

@Configuration
@Import(CoreConfig.class)
@EnableAutoConfiguration
public class TestConfig {

  static {
    System.setProperty("spring.config.location", "classpath:test.properties");
  }

}

che sfortunatamente non ebbe ancora successo.

Ci deve essere una soluzione semplice su come sovrascrivere le application.propertiesimpostazioni nei test JUnit con test.propertiesquella che devo aver trascurato.

È possibile utilizzare @TestPropertySourceper sovrascrivere i valori in application.properties. Dal suo javadoc:

le origini delle proprietà del test possono essere utilizzate per sovrascrivere selettivamente le proprietà definite nelle origini delle proprietà del sistema e dell'applicazione

Per esempio:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public class ExampleApplicationTests {

}

Spring Boot si carica automaticamente src/test/resources/application.properties, se vengono utilizzate le seguenti annotazioni

@RunWith(SpringRunner.class)
@SpringBootTest

Quindi, rinominare test.propertiesin application.propertiesper utilizzare la configurazione automatica.

Se * solo * devi caricare il file delle proprietà (nell'ambiente) puoi anche usare quanto segue, come spiegato qui

@RunWith(SpringRunner.class)
@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class) 

[ Aggiornamento: sovrascrivere alcune proprietà per il test ]

1. Aggiungi src/main/resources/application-test.properties.
2. Annota la classe di test con @ActiveProfiles("test").

Questo carica application.propertiese quindi le application-test.properties proprietà nel contesto dell'applicazione per il test case, come da regole qui definite .

Demo - https://github.com/mohnish82/so-spring-boot-testprops

È inoltre possibile utilizzare meta-annotazioni per esternalizzare la configurazione. Per esempio:

@RunWith(SpringJUnit4ClassRunner.class)
@DefaultTestAnnotations
public class ExampleApplicationTests { 
   ...
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public @interface DefaultTestAnnotations { }

Un altro approccio adatto per sovrascrivere alcune proprietà nel test, se si utilizza l' @SpringBootTestannotazione:

@SpringBootTest(properties = {"propA=valueA", "propB=valueB"})

TLDR:

Quindi quello che ho fatto è stato avere lo standard src/main/resources/application.propertiese anche un punto in src/test/resources/application-default.propertiescui ho ignorato alcune impostazioni per TUTTI i miei test.

L'intera storia

Ho riscontrato lo stesso problema e finora non utilizzavo i profili. Sembrava fastidioso doverlo fare ora e ricordare di aver dichiarato il profilo - che può essere facilmente dimenticato.

Il trucco è, per sfruttare il fatto che un profilo specifico ha la precedenza sulle application-<profile>.propertiesimpostazioni nel profilo generale. Vedi https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties .

Spiegazione semplice:

Se siete come me e si ha la stessa application.propertiesin src/main/resourcese src/test/resources, e si sta chiedendo il motivo per cui l' application.propertiesnella cartella test non è prioritarie nella application.propertiesnelle vostre risorse principali, continua a leggere ...

Se hai application.propertiessotto src/main/resourcese lo stesso application.propertiessotto src/test/resources, che application.propertiesviene raccolto, dipende da come stai eseguendo i test . La struttura delle cartelle src/main/resourcese src/test/resources, è una convenzione architettonica di Maven, quindi se si esegue il test in modo uguale mvnw testo uniforme gradlew test, application.propertiesin src/test/resourcesverrà acquisito, poiché il percorso di classe test precederà il percorso di classe principale . Ma, se esegui il tuo test come Run as JUnit Testin Elipse / STS, application.propertiesin src/main/resourcesverrà prelevato come principale percorso di classe precede il percorso di classe test .

Puoi verificarlo aprendo il Run > Run Configurations > JUnit > *your_run_configuration* > Click on "Show Command Line".

Vedrai qualcosa come:

XXXbin \ javaw.exe -ea -Dfile.encoding = UTF-8 -classpath XXX \ workspace-spring-tool-suite-4-4.5.1.RELEASE \ project_name \ bin \ main; XXX \ workspace-primavera-tool-suite 4-4.5.1.RELEASE \ project_name \ bin \ test;

Vedi che \ main viene prima e poi \ test ? Bene, si tratta di un percorso di classe :-)

Saluti

I just configured min as the following :

spring.h2.console.enabled=true
spring.h2.console.path=/h2-console


# changing the name of my data base for testing
spring.datasource.url= jdbc:h2:mem:mockedDB
spring.datasource.username=sa
spring.datasource.password=sa



# in testing i don`t need to know the port

#Feature that determines what happens when no accessors are found for a type
#(and there are no annotations to indicate it is meant to be serialized).
spring.jackson.serialization.FAIL_ON_EMPTY_BEANS=false`enter code here`

Se si utilizza Spring 5.2.5 e Spring Boot 2.2.6 e si desidera sovrascrivere solo alcune proprietà anziché l'intero file. È possibile utilizzare la nuova annotazione: @DynamicPropertySource

@SpringBootTest
@Testcontainers
class ExampleIntegrationTests {

    @Container
    static Neo4jContainer<?> neo4j = new Neo4jContainer<>();

    @DynamicPropertySource
    static void neo4jProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.data.neo4j.uri", neo4j::getBoltUrl);
    }
}

Altrimenti potremmo cambiare il nome del configuratore di proprietà predefinito, impostando la proprietà spring.config.name=teste quindi avendo la risorsa del percorso di classe la src/test/test.propertiesnostra istanza nativa org.springframework.boot.SpringApplicationverrà configurata automaticamente da questo test.properties separato, ignorando le proprietà dell'applicazione;

Vantaggio: autoconfigurazione dei test;

Svantaggio: esporre la proprietà "spring.config.name" al livello CI

rif: http://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html

spring.config.name = application # Nome file di configurazione

Puoi anche creare un file application.properties in src / test / resources dove sono scritte le tue JUnit.