Lokaal testen met behulp van de Azure Event Hubs-emulator

In dit artikel vindt u een overzicht van de stappen voor het lokaal ontwikkelen en testen met behulp van de Azure Event Hubs-emulator.

Vereisten

• Docker-bureaublad
• Minimale hardwarevereisten:
  • 2 GB RAM-geheugen
  • 5 GB schijfruimte
• configuratie van Windows-subsysteem voor Linux (WSL) (alleen voor Windows):
  • WSL installeren
  • Docker configureren voor het gebruik van WSL

Notitie

Voordat u doorgaat met de stappen in dit artikel, moet u ervoor zorgen dat Docker Desktop op de achtergrond operationeel is.

De emulator uitvoeren

Als u de Event Hubs-emulator wilt uitvoeren, kunt u een geautomatiseerd script of een Linux-container gebruiken:

Geautomatiseerd script

Voordat u een geautomatiseerd script uitvoert, kloont u de GitHub-installatieopslagplaats van de emulator lokaal.

Windows

Gebruik de volgende stappen om de Event Hubs-emulator lokaal uit te voeren in Windows:

1. Sta de uitvoering van niet-ondertekende scripts toe door deze opdracht uit te voeren in het PowerShell-venster:

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

2. Voer het installatiescript LaunchEmulator.ps1 uit. Het uitvoeren van het script brengt twee containers met zich mee: de Event Hubs-emulator en De Azure-emulator (een afhankelijkheid voor de emulator).

Linux en macOS

De Event Hubs-emulator lokaal uitvoeren op Linux of macOS:

• Voer het installatiescript uit LaunchEmulator.sh. Het uitvoeren van het script brengt twee containers met zich mee: de Event Hubs-emulator en De Azure-emulator (een afhankelijkheid voor de emulator).

Docker (Linux-container)

1. Als u de emulator wilt starten, geeft u een configuratie op voor de entiteiten die u wilt gebruiken. Sla het volgende JSON-bestand lokaal op als config.json:

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

2. Sla het volgende YAML-bestand op als docker-compose.yaml om containers voor Event Hubs emulator op te slaan.

   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. Maak een .env-bestand om de omgevingsvariabelen voor de Event Hubs-emulator te declareren:

   # 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"
   
   

   Het argument ACCEPT_EULA bevestigt de licentievoorwaarden voor Microsoft-software. Zorg ervoor dat u het .env-bestand in dezelfde map plaatst als het docker-compose.yaml-bestand .

   Belangrijk

   Wanneer u bestandspaden opgeeft in Windows, gebruikt u dubbele backslashes (\\) in plaats van enkele backslashes (\) om verwarring met escape-tekens te voorkomen.

4. Voer de volgende opdracht uit om de emulator uit te voeren:

    docker compose -f <PathToDockerComposeFile> up -d
   

Nadat de stappen zijn voltooid, kunt u de containers vinden die worden uitgevoerd in Docker.

Interactie met de emulator

De emulator gebruikt standaard config.json configuratiebestand. U kunt entiteiten (Event Hubs/Kafka-onderwerpen) configureren door wijzigingen aan te brengen in het configuratiebestand. Als u meer wilt weten, gaat u naar Configuratiewijzigingen aanbrengen

U kunt de volgende verbindingsreeks gebruiken om verbinding te maken met de Event Hubs-emulator:

• Gebruik de volgende verbindingsreeks wanneer de emulatorcontainer en interactietoepassing systeemeigen worden uitgevoerd op de lokale computer:

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

• Toepassingen (Containerized/Niet-containerized) op de verschillende computer en hetzelfde lokale netwerk kunnen communiceren met emulator met behulp van het IPv4-adres van de machine. Gebruik de volgende verbindingsreeks:

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

• Toepassingscontainers in hetzelfde brugnetwerk kunnen communiceren met Emulator met behulp van de alias of het IP-adres. In het volgende verbindingsreeks wordt ervan uitgegaan dat de naam van de emulator de standaardwaarde heeft die 'eventhubs-emulator' is:

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

• Toepassingscontainers in het verschillende brugnetwerk kunnen communiceren met Emulator met behulp van de host.docker.internal. Gebruik de volgende verbindingsreeks:

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

Kafka gebruiken

Zorg er tijdens interactie met Kafka voor dat u de producer- en consumentenconfiguratie als volgt instelt:

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

De waarde van BootstrapServers en SaslPassword is afhankelijk van uw installatietopologie. Raadpleeg de sectie Interactie met emulator voor meer informatie.

Belangrijk

Wanneer u Kafka gebruikt, zijn alleen Producer- en Consumer-API's compatibel met de Event Hubs-emulator.

AMQP gebruiken

Met de nieuwste client-SDK-releases kunt u communiceren met de emulator in verschillende programmeertalen. Zie Client-SDK's voor meer informatie.

Raadpleeg de Event Hubs-emulatorvoorbeelden op GitHub om aan de slag te gaan.

Gerelateerde inhoud

Overzicht van de Azure Event Hubs-emulator