Ausführen lokaler Tests mithilfe des Azure Event Hubs-Emulators

In diesem Artikel werden die Schritte zum lokalen Entwickeln und Testen mithilfe des Azure Event Hubs-Emulators zusammengefasst.

Voraussetzungen

• Docker Desktop
• Mindestanforderungen für Hardware:
  • 2 GB RAM
  • 5 GB Speicherplatz auf dem Datenträger
• Windows-Subsystem für Linux (WSL) (nur für Windows):
  • Installieren von WSL
  • Konfigurieren von Docker zur Verwendung von WSL

Hinweis

Stellen Sie sicher, dass Docker Desktop im Hintergrund ausgeführt wird, bevor Sie mit den Schritten in diesem Artikel fortfahren.

Ausführen des Emulators

Zum Ausführen des Event Hubs-Emulators können Sie ein automatisiertes Skript oder einen Linux-Container verwenden:

Automatisiertes Skript

Klonen Sie vor dem Ausführen eines automatisierten Skripts das GitHub-Installer-Repository des Emulators lokal.

Windows

Führen Sie die folgenden Schritte aus, um den Event Hubs-Emulator lokal unter Windows auszuführen:

1. Führen Sie den folgenden Befehl im PowerShell-Fenster aus, um die Ausführung nicht signierter Skripts zuzulassen:

   $>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser'

2. Führen Sie das Setupskript LaunchEmulator.ps1 aus. Wenn Sie das Skript ausführen, werden zwei Container angezeigt: der Event Hubs-Emulator und Azurite (eine Abhängigkeit für den Emulator).

Linux und macOS

So führen Sie den Event Hubs-Emulator lokal unter Linux oder macOS aus

• Führen Sie das Setupskript LaunchEmulator.sh aus. Wenn Sie das Skript ausführen, werden zwei Container angezeigt: der Event Hubs-Emulator und Azurite (eine Abhängigkeit für den Emulator).

Docker (Linux-Container)

1. Stellen Sie zum Starten des Emulators eine Konfiguration für die Entitäten bereit, die Sie verwenden möchten. Speichern Sie die folgende JSON-Datei lokal als config.json:

   {
       "UserConfig": {
           "NamespaceConfig": [
           {
               "Type": "EventHub",
               "Name": "emulatorNs1",
               "Entities": [
               {
                   "Name": "eh1",
                   "PartitionCount": "2",
                   "ConsumerGroups": [
                   {
                       "Name": "cg1"
                   }
                   ]
               }
               ]
           }
           ], 
           "LoggingConfig": {
               "Type": "File"
           }
       }
   }
   
   

2. Speichern Sie die folgende YAML-Datei als docker-compose.yaml, um Container für den Event Hubs-Emulator einzurichten.

   name: microsoft-azure-eventhubs
   services:
     emulator:
       container_name: "eventhubs-emulator"
       image: "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest"
       volumes:
         - "${CONFIG_PATH}:/Eventhubs_Emulator/ConfigFiles/Config.json"
       ports:
         - "5672:5672"
         - "9092:9092"
       environment:
         BLOB_SERVER: azurite
         METADATA_SERVER: azurite
         ACCEPT_EULA: ${ACCEPT_EULA}
       depends_on:
         - azurite
       networks:
         eh-emulator:
           aliases:
             - "eventhubs-emulator"
     azurite:
       container_name: "azurite"
       image: "mcr.microsoft.com/azure-storage/azurite:latest"
       ports:
         - "10000:10000"
         - "10001:10001"
         - "10002:10002"
       networks:
         eh-emulator:
           aliases:
             - "azurite"
   networks:
     eh-emulator:
   

3. Erstellen Sie eine ENV-Datei, um die Umgebungsvariablen für den Event Hubs-Emulator zu deklarieren:

   # Centralized environment variables store for docker-compose
   
   # 1. CONFIG_PATH: Path to config.json file
   CONFIG_PATH="<Replace with path to config.json file>" 
   
   # 2. ACCEPT_EULA: Pass 'Y' to accept license terms. 
   ACCEPT_EULA="N"
   
   

   Das Argument ACCEPT_EULA bestätigt die Microsoft-Software-Lizenzbedingungen. Achten Sie darauf, die ENV-Datei in dem Verzeichnis zu platzieren, in dem sich auch die Datei docker-compose.yaml befindet.

   Wichtig

   Verwenden Sie beim Angeben von Dateipfaden unter Windows doppelte umgekehrte Schrägstriche (\\) anstelle von einzelnen umgekehrten Schrägstrichen (\), um eine Verwechslung mit Escapezeichen zu vermeiden.

4. Führen Sie den folgenden Befehl aus, um den Emulator auszuführen:

    docker compose -f <PathToDockerComposeFile> up -d
   

Nach erfolgreicher Ausführung der Schritte werden die Container in Docker ausgeführt.

Interagieren mit dem Emulator

Standardmäßig verwendet der Emulator die Konfigurationsdatei config.json. Sie können Entitäten (Event Hubs/Kafka-Themen) konfigurieren, indem Sie Änderungen an der Konfigurationsdatei vornehmen. Weitere Informationen finden Sie unter Vornehmen von Konfigurationsänderungen

Sie können die folgende Verbindungszeichenfolge verwenden, um eine Verbindung mit dem Event Hubs-Emulator herzustellen:

• Wenn der Emulatorcontainer und die interagierende Anwendung nativ auf dem lokalen Computer ausgeführt werden, verwenden Sie die folgende Verbindungszeichenfolge:

"Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Anwendungen (containerisiert/nicht containerisiert) auf dem anderen Computer und dem gleichen lokalen Netzwerk können mit dem Emulator interagieren, indem die IPv4-Adresse des Computers verwendet wird. Verwenden Sie die folgende Verbindungszeichenfolge:

"Endpoint=sb://192.168.y.z;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Anwendungscontainer im selben Brückennetzwerk können mit dem Emulator mithilfe des Alias oder der IP interagieren. Die folgende Verbindungszeichenfolge setzt voraus, dass der Name des Emulators den Standardwert „eventhubs-emulator“ aufweist:

"Endpoint=sb://eventhubs-emulator;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Anwendungscontainer im anderen Brückennetzwerk können mit dem Emulator interagieren, indem „host.docker.internal“ als Host verwendet wird. Verwenden Sie die folgende Verbindungszeichenfolge:

"Endpoint=sb://host.docker.internal;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Verwenden von Kafka

Stellen Sie bei der Interaktion mit Kafka sicher, dass die Producer- und Consumerkonfiguration wie folgt festgelegt wird:

        {
            BootstrapServers =  //Value of bootstrap servers would depend on kind of connection string being used
            SecurityProtocol = SecurityProtocol.SaslPlaintext,
            SaslMechanism = SaslMechanism.Plain,
            SaslUsername = "$ConnectionString",
            SaslPassword = //Value of connection string would depend on topology
        };

Der Wert von BootstrapServers und SaslPassword hängt von der Topologie Ihres Setup ab. Ausführliche Informationen finden Sie im Abschnitt Interaktion mit dem Emulator.

Wichtig

Bei Verwendung von Kafka sind nur Producer- und Consumer-APIs mit dem Event Hubs-Emulator kompatibel.

Verwenden von AMQP

Mit den aktuellen Client-SDK-Releases können Sie in verschiedenen Programmiersprachen mit dem Emulator interagieren. Ausführliche Informationen finden Sie unter Client-SDKs.

Informationen zu den ersten Schritten finden Sie in den Event Hubs-Emulatorbeispielen auf GitHub.

Zugehöriger Inhalt

Übersicht über den Azure Event Hubs-Emulator