Spring Cloud Azure-Unterstützung für Testcontainer

Dieser Artikel gilt für:✅ Version 5.19.0

In diesem Artikel wird beschrieben, wie Sie Spring Cloud Azure in Testcontainer integrieren, um effektive Integrationstests für Ihre Anwendungen zu schreiben.

Testcontainers ist ein Open-Source-Framework zum Bereitstellen von Ausschütten, einfachen Instanzen von Datenbanken, Nachrichtenbrokern, Webbrowsern oder alles, was in einem Docker-Container ausgeführt werden kann. Es ist in JUnit integriert, sodass Sie eine Testklasse schreiben können, die einen Container starten kann, bevor eine der Tests ausgeführt wird. Testcontainers ist besonders nützlich für das Schreiben von Integrationstests, die mit einem echten Back-End-Dienst sprechen.

Die spring-cloud-azure-testcontainers-Bibliothek unterstützt jetzt Integrationstests für die folgenden Azure-Dienste:

• Azure Cosmos DB-
• Azure Blob Storage-
• Azure Queue Storage

Dienstverbindungen

Eine Dienstverbindung ist eine Verbindung mit einem beliebigen Remotedienst. Die Autokonfiguration von Spring Boot kann die Details einer Dienstverbindung nutzen und diese verwenden, um eine Verbindung mit einem Remotedienst herzustellen. Dabei haben die Verbindungsdetails Vorrang vor verbindungsbezogenen Konfigurationseigenschaften.

Wenn Sie Testcontainer verwenden, können Sie automatisch Verbindungsdetails für einen Dienst erstellen, der in einem Container ausgeführt wird, indem Sie das Containerfeld in der Testklasse kommentieren.

Die @ServiceConnection Anmerkung wird von xxxContainerConnectionDetailsFactory Klassen verarbeitet, die mit spring.factoriesregistriert sind. Diese Fabriken erstellen eine ConnectionDetails Bean basierend auf einer bestimmten Container Unterklasse oder dem Docker-Imagenamen.

Die folgende Tabelle enthält Informationen zu den in der spring-cloud-azure-testcontainers JAR unterstützten Verbindungsdetails-Factoryklassen:

Verbindungsdetails Factoryklasse	Verbindungsdetailsanker
CosmosContainerConnectionDetailsFactory	AzureCosmosConnectionDetails
StorageBlobContainerConnectionDetailsFactory	AzureStorageBlobConnectionDetails
StorageQueueContainerConnectionDetailsFactory	AzureStorageQueueConnectionDetails

Einrichten von Abhängigkeiten

Die folgende Konfiguration richtet die erforderlichen Abhängigkeiten ein:

Cosmos

<dependency>
  <groupId>org.testcontainers</groupId>
  <artifactId>azure</artifactId>
</dependency>
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-testcontainers</artifactId>
</dependency>
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-cosmos</artifactId>
</dependency>

Blob Storage-

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-testcontainers</artifactId>
</dependency>
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-storage-blob</artifactId>
</dependency>

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-testcontainers</artifactId>
</dependency>
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-storage-queue</artifactId>
</dependency>

Verwenden von Testcontainern

Im folgenden Codebeispiel wird die grundlegende Verwendung von Testcontainern veranschaulicht:

Cosmos

@SpringBootTest
@Testcontainers
@ImportAutoConfiguration(classes = { AzureGlobalPropertiesAutoConfiguration.class, AzureCosmosAutoConfiguration.class})
public class CosmosTestcontainersTest {

    @TempDir
    private static File tempFolder;

    @Autowired
    private CosmosClient client;

    @Container
    @ServiceConnection
    static CosmosDBEmulatorContainer cosmos = new CosmosDBEmulatorContainer(
    DockerImageName.parse("mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest"));

    @BeforeAll
    static void setup() {
        cosmos.start();
        Path keyStoreFile = new File(tempFolder, "azure-cosmos-emulator.keystore").toPath();
        KeyStore keyStore = cosmos.buildNewKeyStore();
        try {
            keyStore.store(Files.newOutputStream(keyStoreFile.toFile().toPath()), cosmos.getEmulatorKey().toCharArray());
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    
        System.setProperty("javax.net.ssl.trustStore", keyStoreFile.toString());
        System.setProperty("javax.net.ssl.trustStorePassword", cosmos.getEmulatorKey());
        System.setProperty("javax.net.ssl.trustStoreType", "PKCS12");
    }

    @Test
    void test() {
        // ...
    }
}

Um CosmosDBEmulatorContainerzu verwenden, müssen wir eine KeyStore für TLS/SSL vorbereiten. Weitere Informationen finden Sie unter Cosmos DB Azure Module in der Testcontainers-Dokumentation. Mit @ServiceConnectionermöglicht diese Konfiguration Cosmos DB-bezogenen Bohnen in der App, mit Cosmos DB zu kommunizieren, die im Testcontainers-verwalteten Docker-Container ausgeführt wird. Diese Aktion erfolgt durch die automatische Definition einer AzureCosmosConnectionDetails Bean, die dann von der Autokonfiguration von Cosmos DB verwendet wird und alle verbindungsbezogenen Konfigurationseigenschaften außer Kraft gesetzt wird.

Blob Storage-

@SpringBootTest
@Testcontainers
@ImportAutoConfiguration(classes = { AzureGlobalPropertiesAutoConfiguration.class, AzureStorageBlobAutoConfiguration.class, AzureStorageBlobResourceAutoConfiguration.class})
public class StorageBlobTestcontainersTest {

    @Container
    @ServiceConnection
    private static final GenericContainer<?> AZURITE_CONTAINER = new GenericContainer<>(
        "mcr.microsoft.com/azure-storage/azurite:latest")
        .withExposedPorts(10000);

    @Value("azure-blob://testcontainers/message.txt")
    private Resource blobFile;

    @BeforeAll
    static void setup() {
        AZURITE_CONTAINER.start();
    }

    @Test
    void test() {
        // ...
    }
}

Mit @ServiceConnectionermöglicht diese Konfiguration blobbezogene Bohnen in der App, mit Blob Storage zu kommunizieren, die im Testcontainers-verwalteten Docker-Container ausgeführt wird. Diese Aktion erfolgt durch die automatische Definition einer AzureStorageBlobConnectionDetails Bean, die dann von der autokonfigurierten Blob Storage-Konfiguration verwendet wird und alle verbindungsbezogenen Konfigurationseigenschaften außer Kraft gesetzt wird.

@SpringBootTest
@Testcontainers
@TestPropertySource(properties = "spring.cloud.azure.storage.queue.queue-name=devstoreaccount1/tc-queue")
@ImportAutoConfiguration(classes = { AzureGlobalPropertiesAutoConfiguration.class, AzureStorageQueueAutoConfiguration.class})
public class StorageQueueTestcontainersTest {

    @Container
    @ServiceConnection
    private static final GenericContainer<?> AZURITE_CONTAINER = new GenericContainer<>(
        "mcr.microsoft.com/azure-storage/azurite:latest")
        .withExposedPorts(10001);

    @Autowired
    private QueueClient queueClient;

    @BeforeAll
    static void setup() {
        AZURITE_CONTAINER.start();
    }

    @Test
    void test() {
        // ...
    }
}

Mit @ServiceConnectionermöglicht diese Konfiguration warteschlangenbezogene Bohnen in der App die Kommunikation mit warteschlangenbasiertem Speicher, der im Testcontainers-verwalteten Docker-Container ausgeführt wird. Diese Aktion erfolgt durch die automatische Definition einer AzureStorageQueueConnectionDetails Bean, die dann von der Autokonfiguration des Warteschlangenspeichers verwendet wird und alle verbindungsbezogenen Konfigurationseigenschaften außer Kraft gesetzt wird.

Proben

Weitere Informationen finden Sie in den Azure-spring-boot-samples Repository auf GitHub.