Mengesampingkan pengaturan default Spring-Boot application.properties di Junit Test

Saya memiliki aplikasi Spring-Boot di mana properti default diatur dalam application.propertiesfile di classpath (src / main / resources / application.properties).

Saya ingin mengganti beberapa pengaturan default dalam uji JUnit saya dengan properti yang dideklarasikan dalam test.propertiesfile (src / test / resources / test.properties)

Saya biasanya memiliki Kelas Konfigurasi khusus untuk Tes Junit saya, misalnya

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 {

}

Saya pertama kali berpikir bahwa menggunakan @PropertySource("classpath:test.properties")di kelas TestConfig akan melakukan trik, tetapi properti ini tidak akan menimpa pengaturan application.properties (lihat Spring-Boot Reference Doc - 23. Konfigurasi Eksternalisasi ).

Kemudian saya mencoba menggunakan -Dspring.config.location=classpath:test.propertiesketika menjalankan tes. Itu berhasil - tetapi saya tidak ingin mengatur properti sistem ini untuk setiap eksekusi tes. Jadi saya memasukkannya ke dalam kode

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

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

}

yang sayangnya sekali lagi tidak berhasil.

Pasti ada solusi sederhana tentang cara mengesampingkan application.propertiespengaturan dalam tes JUnit dengan test.propertiesyang harus saya abaikan.

Anda dapat menggunakan @TestPropertySourceuntuk mengganti nilai di application.properties. Dari javadoc-nya:

sumber properti uji dapat digunakan untuk menimpa secara selektif properti yang didefinisikan dalam sumber properti sistem dan aplikasi

Sebagai contoh:

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

}

Spring Boot otomatis dimuat src/test/resources/application.properties, jika anotasi berikut digunakan

@RunWith(SpringRunner.class)
@SpringBootTest

Jadi, mengubah nama test.propertiesuntuk application.propertiesmemanfaatkan konfigurasi otomatis.

Jika Anda * hanya * perlu memuat file properti (ke Lingkungan) Anda juga dapat menggunakan yang berikut, seperti yang dijelaskan di sini

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

[ Pembaruan: Mengganti properti tertentu untuk pengujian ]

1. Tambah src/main/resources/application-test.properties.
2. Beri anotasi pada kelas tes dengan @ActiveProfiles("test").

Ini memuat application.propertiesdan kemudian application-test.properties properti ke dalam konteks aplikasi untuk kasus uji, sesuai aturan yang ditetapkan di sini .

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

Anda juga dapat menggunakan meta-anotasi untuk mengeksternalisasi konfigurasi. Sebagai contoh:

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

Pendekatan lain yang cocok untuk mengganti beberapa properti dalam pengujian Anda, jika Anda menggunakan @SpringBootTestanotasi:

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

TLDR:

Jadi apa yang saya lakukan adalah memiliki standar src/main/resources/application.propertiesdan juga src/test/resources/application-default.propertiestempat saya menimpa beberapa pengaturan untuk SEMUA tes saya.

Seluruh cerita

Saya mengalami masalah yang sama dan sejauh ini tidak menggunakan profil. Tampaknya merepotkan harus melakukannya sekarang dan ingat menyatakan profil - yang dapat dengan mudah dilupakan.

Kuncinya adalah, untuk meningkatkan bahwa profil tertentu application-<profile>.propertiesmenimpa pengaturan di profil umum. Lihat https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-profile-specific-properties .

Penjelasan sederhana:

Jika Anda seperti saya dan Anda memiliki yang sama application.propertiesdi src/main/resourcesdan src/test/resources, dan Anda bertanya-tanya mengapa application.propertiesdi folder tes Anda tidak mengesampingkan para application.propertiessumber daya utama Anda, baca terus ...

Jika Anda memiliki di application.propertiesbawah src/main/resourcesdan di application.propertiesbawah yang sama src/test/resources, yang application.propertiesdiambil, tergantung pada bagaimana Anda menjalankan tes Anda . Struktur folder src/main/resourcesdan src/test/resources, adalah konvensi arsitektur Maven, jadi jika Anda menjalankan tes seperti mvnw testatau bahkan gradlew test, application.propertiesin src/test/resourcesakan dijemput, karena test classpath akan mendahului classpath utama . Tetapi, jika Anda menjalankan tes Anda seperti Run as JUnit Testdi Elipse / STS, application.propertiesin src/main/resourcesakan dijemput, karena jalur utama utama mendahului jalur kelas uji .

Anda dapat memeriksanya dengan membuka Run > Run Configurations > JUnit > *your_run_configuration* > Click on "Show Command Line".

Anda akan melihat sesuatu seperti:

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-spring-tool-suite-4-4.5.1.RELEASE \ project_name \ bin \ test;

Apakah Anda melihat bahwa \ main terlebih dahulu, lalu \ test ? Benar, Ini semua tentang classpath :-)

Bersulang

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`

Jika Anda menggunakan Spring 5.2.5 dan Spring Boot 2.2.6 dan ingin mengganti hanya beberapa properti alih-alih seluruh file. Anda dapat menggunakan anotasi baru: @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);
    }
}

Kalau tidak, kita dapat mengubah nama konfigurator properti default, mengatur properti spring.config.name=testdan kemudian memiliki sumber daya kelas-jalur src/test/test.propertiesinstance asli kita org.springframework.boot.SpringApplicationakan secara otomatis dikonfigurasi dari properti test.prop terpisah ini, mengabaikan properti aplikasi;

Manfaat: konfigurasi otomatis pengujian;

Kelemahan: memperlihatkan properti "spring.config.name" di layer CI

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

spring.config.name = application # Config nama file

Anda juga dapat membuat file application.properties di src / test / resources di mana JUnits Anda ditulis.