Junit Test'te varsayılan Spring-Boot uygulamasını geçersiz kılın. Özellikler ayarları

application.propertiesSınıf özellikleri (src / main / resources / application.properties) bir dosyada varsayılan özellikleri ayarlanır bir Spring-Boot uygulaması var .

Bir test.propertiesdosyada bildirilen özelliklerle (src / test / resources / test.properties) JUnit testimdeki bazı varsayılan ayarları geçersiz kılmak istiyorum

Genellikle Junit Testlerim için özel bir Config Class'ım var;

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 {

}

İlk @PropertySource("classpath:test.properties")olarak TestConfig sınıfında kullanmanın hile yapacağını düşündüm , ancak bu özellikler application.properties ayarlarının üzerine yazmayacak (bkz. Spring-Boot Reference Doc - 23. Harici Yapılandırma ).

Sonra -Dspring.config.location=classpath:test.propertiestesti başlatırken kullanmaya çalıştım . Bu başarılı oldu - ancak her test yürütmesi için bu sistem özelliğini ayarlamak istemiyorum. Böylece koda koydum

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

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

}

talihsiz bir şekilde yine başarılı olamadı.

Ben gözden kaçmış olması gerektiği application.propertiesile JUnit testlerinde ayarları geçersiz kılmak için basit bir çözüm test.propertiesolmalıdır.

@TestPropertySourceİçindeki değerleri geçersiz kılmak için kullanabilirsiniz application.properties. Javadoc'tan:

test özellik kaynakları, sistem ve uygulama özellik kaynaklarında tanımlanan özellikleri seçici olarak geçersiz kılmak için kullanılabilir

Örneğin:

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

}

src/test/resources/application.propertiesAşağıdaki ek açıklamalar kullanılırsa Spring Boot otomatik olarak yüklenir

@RunWith(SpringRunner.class)
@SpringBootTest

Bu nedenle, otomatik yapılandırmayı kullanmak test.propertiesiçin application.propertiesolarak yeniden adlandırın .

Eğer varsa sadece * * açıklandığı gibi ayrıca aşağıdakileri kullanabilirsiniz (Çevre içine) özelliklerini dosyası yüklemek için gereğini burada

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

[ Güncelleme: Test için belirli özellikleri geçersiz kılma ]

1. Ekle src/main/resources/application-test.properties.
2. Test sınıfına açıklama ekleyin @ActiveProfiles("test").

Bu , burada tanımlanan kurallara göre test durumu için uygulama bağlamını yükler application.propertiesve ardından application-test.properties özellikleri .

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

Yapılandırmayı dışlaştırmak için meta ek açıklamaları da kullanabilirsiniz . Örneğin:

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

@SpringBootTestEk açıklama kullanıyorsanız, testinizdeki birkaç özelliği geçersiz kılmak için uygun başka bir yaklaşım :

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

TLDR:

Yani ne yaptım standart src/main/resources/application.propertiesve aynı zamanda bir src/test/resources/application-default.propertiesyerde ben tüm testlerim için bazı ayarları geçersiz kılmak oldu.

Tüm hikaye

Aynı problemle karşılaştım ve şu ana kadar profil kullanmıyordum. Şimdi bunu yapmak ve profili beyan etmeyi hatırlamak zor olabilir - ki bu kolayca unutulabilir.

İşin püf noktası, belirli bir profilin application-<profile>.propertiesgenel profildeki ayarları geçersiz kılmasıdır. Bkz. Https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties .

Basit açıklama:

Eğer benim gibi olan ve aynı varsa application.propertiesiçinde src/main/resourcesve src/test/resourcesve vardır merak neden application.propertiestest klasöründe değil ağır basanapplication.properties ana kaynaklarda, okumaya ...

Eğer varsa application.propertiesaltında src/main/resourcesve aynı application.propertiesaltında src/test/resources, application.propertiesaldı alır, size testler nasıl bağlıdır . Klasör yapısı src/main/resources ve src/test/resources, sen gibi testi eğer öyleyse, bir Maven mimari kongre olduğunu mvnw testve hatta gradlew test, application.propertiesiçinde src/test/resourcesolarak, kaldırdı alacak Test sınıf yolu önce gelecek ana sınıf yolunu. Ancak, testinizi Run as JUnit TestElipse / STS'de olduğu gibi çalıştırırsanız , ana sınıf yolu test sınıfyolundan önce geldiğinde , application.propertiesgiriş src/main/resourcesalınacaktır .

Bunu açarak kontrol edebilirsiniz Run > Run Configurations > JUnit > *your_run_configuration* > Click on "Show Command Line".

Gibi bir şey göreceksiniz:

XXXbin \ javaw.exe -ea -Dfile.encoding = UTF-8-sınıfyolu XXX \ workspace-spring-tool-suite-4-4.5.1.RELEASE \ project_name \ bin \ main; XXX \ çalışma alanı-yay-araç takımını-4-4.5.1.RELEASE \ project_name \ bin \ testi;

\ Main'nin önce geldiğini ve sonra \ test ettiğini görüyor musunuz ? Doğru, hepsi sınıf yolu :-)

Şerefe

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`

Spring 5.2.5 ve Spring Boot 2.2.6 kullanıyorsanız ve tüm dosya yerine yalnızca birkaç özelliği geçersiz kılmak istiyorsanız. Yeni ek açıklamayı kullanabilirsiniz: @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);
    }
}

Aksi takdirde, varsayılan özellik yapılandırıcı adını değiştirebilir, özelliği ayarlayabilir spring.config.name=testve daha sonra src/test/test.propertiesyerel org.springframework.boot.SpringApplicationörneğimiz olan sınıf yolu kaynağına sahip olarak , uygulama özelliklerini yok sayarak bu ayrılmış test.properties öğesinden otomatik olarak yapılandırılır;

Faydası: testlerin otomatik yapılandırılması;

Dezavantajı: CI katmanında "spring.config.name" özelliğini gösterme

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

spring.config.name = uygulama # Yapılandırma dosya adı

JUnits'inizin yazıldığı src / test / resources dizininde bir application.properties dosyası da oluşturabilirsiniz.