Überschreiben Sie die Standardeinstellungen für Spring-Boot application.properties in Junit Test

Ich habe eine Spring-Boot-Anwendung, in der die Standardeigenschaften in einer application.propertiesDatei im Klassenpfad festgelegt sind (src / main / resources / application.properties).

Ich möchte einige Standardeinstellungen in meinem JUnit-Test mit Eigenschaften überschreiben, die in einer test.propertiesDatei deklariert sind (src / test / resources / test.properties).

Normalerweise habe ich eine spezielle Konfigurationsklasse für meine Junit-Tests, z

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 {

}

Ich dachte zuerst, dass die Verwendung @PropertySource("classpath:test.properties")in der TestConfig-Klasse den Trick machen würde, aber diese Eigenschaften überschreiben die Einstellungen von application.properties nicht (siehe Spring-Boot-Referenzdokument - 23. Externalisierte Konfiguration ).

Dann habe ich versucht, -Dspring.config.location=classpath:test.propertiesbeim Aufrufen des Tests zu verwenden. Das war erfolgreich - aber ich möchte diese Systemeigenschaft nicht für jede Testausführung festlegen. Also habe ich es in den Code eingefügt

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

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

}

was leider wieder nicht erfolgreich war.

Es muss eine einfache Lösung geben, wie application.propertiesEinstellungen in JUnit-Tests überschrieben werden können test.properties, die ich übersehen haben muss.

Sie können @TestPropertySourceWerte in überschreiben application.properties. Aus seinem Javadoc:

Testeigenschaftsquellen können verwendet werden, um Eigenschaften, die in System- und Anwendungseigenschaftsquellen definiert sind, selektiv zu überschreiben

Beispielsweise:

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

}

Spring Boot wird automatisch geladen src/test/resources/application.properties, wenn die folgenden Anmerkungen verwendet werden

@RunWith(SpringRunner.class)
@SpringBootTest

Benennen Sie also test.propertiesum application.properties, um die automatische Konfiguration zu verwenden.

Wenn Sie * nur * die Eigenschaftendatei (in die Umgebung) laden müssen, können Sie auch Folgendes verwenden, wie hier erläutert

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

[ Update: Überschreiben bestimmter Eigenschaften zum Testen ]

1. Hinzufügen src/main/resources/application-test.properties.
2. Testklasse mit kommentieren @ActiveProfiles("test").

Dadurch werden die Eigenschaften für den Testfall gemäß den hier definierten Regeln geladen application.propertiesund anschließend application-test.properties in den Anwendungskontext übernommen .

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

Sie können auch Meta-Annotationen verwenden, um die Konfiguration zu externalisieren. Beispielsweise:

@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 { }

Ein weiterer Ansatz, der zum Überschreiben einiger Eigenschaften in Ihrem Test geeignet ist, wenn Sie @SpringBootTestAnmerkungen verwenden:

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

TLDR:

Also habe ich den Standard src/main/resources/application.propertiesund auch einen, src/test/resources/application-default.propertiesbei dem ich einige Einstellungen für ALLE meine Tests überschreibe.

Ganze Geschichte

Ich bin auf dasselbe Problem gestoßen und habe bisher auch keine Profile verwendet. Es schien lästig zu sein, es jetzt tun zu müssen und sich daran zu erinnern, das Profil deklariert zu haben - was leicht vergessen werden kann.

Der Trick besteht darin, zu nutzen, dass ein Profil bestimmte application-<profile>.propertiesEinstellungen im allgemeinen Profil überschreibt. Siehe https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties .

Einfache Erklärung:

Wenn Sie wie ich sind und dasselbe application.propertiesin src/main/resourcesund src/test/resourceshaben und sich fragen, warum das application.propertiesin Ihrem Testordner das application.propertiesin Ihren Hauptressourcen nicht überschreibt , lesen Sie weiter ...

Ob Sie application.propertiesunter src/main/resourcesund dasselbe application.propertiesunter haben src/test/resources, was application.propertiesabgeholt wird, hängt davon ab, wie Sie Ihre Tests durchführen . Die Ordnerstruktur src/main/resources und src/test/resourcesist ein Maven architektonische Konvention, also wenn Sie wie Ihr Test ausführen mvnw testoder sogar gradlew test, die application.propertiesin src/test/resourceswird abgeholt, als Test Classpath vorangehen Haupt Classpath. Aber, wenn Sie Ihren Test wie laufen Run as JUnit Testin Elipse / STS, die application.propertiesin src/main/resourceswird abgeholt, als Haupt- Classpath vorangeht Test Classpath.

Sie können es überprüfen, indem Sie das öffnen Run > Run Configurations > JUnit > *your_run_configuration* > Click on "Show Command Line".

Sie werden so etwas sehen wie:

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

Sehen Sie, dass \ main zuerst kommt und dann \ test ? Richtig, es geht nur um Klassenpfad :-)

Prost

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`

Wenn Sie Spring 5.2.5 und Spring Boot 2.2.6 verwenden und nur einige Eigenschaften anstelle der gesamten Datei überschreiben möchten. Sie können die neue Anmerkung verwenden: @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);
    }
}

Andernfalls ändern wir möglicherweise den Standardnamen des Eigenschaftenkonfigurators, legen die Eigenschaft fest spring.config.name=testund verfügen dann über eine Klassenpfadressource, deren src/test/test.propertiesnative Instanz org.springframework.boot.SpringApplicationautomatisch aus dieser getrennten test.properties konfiguriert wird, wobei Anwendungseigenschaften ignoriert werden.

Vorteil: automatische Konfiguration von Tests;

Nachteil: Offenlegen der Eigenschaft "spring.config.name" auf der CI-Ebene

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

spring.config.name = application # Name der Konfigurationsdatei

Sie können auch eine application.properties-Datei in src / test / resources erstellen, in die Ihre JUnits geschrieben sind.