Tester localement à l’aide de l’émulateur Azure Event Hubs

Cet article récapitule les étapes à suivre pour développer et tester localement à l’aide de l’émulateur Event Hubs Azure.

Prérequis

• Docker desktop
• Exigences minimales du matériel :
  • 2 Go de RAM
  • 5 Go d’espace disque
• Configuration du sous-système Windows pour Linux (WSL) (uniquement pour Windows) :
  • Installer WSL
  • Configurer Docker pour utiliser WSL

Remarque

Avant de poursuivre les étapes de cet article, vérifiez que Docker Desktop est opérationnel en arrière-plan.

Exécuter l’émulateur

Pour exécuter l’émulateur Event Hubs, vous pouvez utiliser un script automatisé ou un conteneur Linux :

Script automatisé

Avant d’exécuter un script automatisé, clonez le référentiel du programme d’installation GitHub de l’émulateur localement.

Windows

Procédez comme suit pour exécuter l’émulateur Event Hubs localement sur Windows :

1. Autorisez l’exécution de scripts non signés en exécutant cette commande dans la fenêtre PowerShell :

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

2. Exécutez le script d’installation LaunchEmulator.ps1. L’exécution du script affiche deux conteneurs : l’émulateur Event Hubs et Azurite (une dépendance pour l’émulateur).

Linux et macOS

Pour exécuter l’émulateur Event Hubs localement sur Linux ou macOS :

• Exécutez le script d’installation LaunchEmulator.sh. L’exécution du script affiche deux conteneurs : l’émulateur Event Hubs et Azurite (une dépendance pour l’émulateur).

Docker (conteneur Linux)

1. Pour démarrer l’émulateur, fournissez une configuration des entités que vous souhaitez utiliser. Enregistrez le fichier JSON suivant localement en tant que config.json :

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

2. Pour faire tourner des conteneurs pour l’émulateur Event Hubs, enregistrez le fichier .yaml suivant en tant que docker-compose.yaml.

   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. Créez un fichier .env pour déclarer les variables d’environnement pour l’émulateur Event Hubs :

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

   L’argument ACCEPT_EULA confirme les termes du contrat de licence logiciel Microsoft. Veillez à placer le fichier .env dans le même répertoire que le fichier docker-compose.yaml.

   Important

   Lorsque vous spécifiez des chemins d’accès au fichier dans Windows, utilisez des barres obliques inverses doubles (\\) au lieu de barres obliques inverses simples (\) pour éviter toute confusion avec les caractères d’échappement.

4. Pour exécuter l’émulateur, exécutez la commande suivante :

    docker compose -f <PathToDockerComposeFile> up -d
   

Lorsque les étapes sont réussies, vous trouverez des conteneurs s’exécutant dans Docker.

Interagir avec l’émulateur

Par défaut, l’émulateur utilise le fichier de configuration config.json. Vous pouvez configurer des entités (rubriques Event Hubs/Kafka) en apportant des modifications au fichier de configuration. Pour en savoir plus, consultez Apporter des modifications de configuration.

Vous pouvez utiliser la chaîne de connexion suivante pour vous connecter à l’émulateur Event Hubs :

• Lorsque le conteneur de l’émulateur et l’application d’interaction s’exécutent en mode natif sur la machine locale, utilisez la chaîne de connexion suivante :

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

• Les applications (conteneurisées/non conteneurisées) sur l’autre ordinateur et le même réseau local peuvent interagir avec l’émulateur en utilisant l’adresse IPv4 de l’ordinateur. Utilisez la chaîne de connexion suivante :

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

• Les conteneurs d’applications sur le même réseau de pont peuvent interagir avec l’émulateur à l’aide de son alias ou de son adresse IP. La chaîne de connexion suivante part du principe que le nom de l’émulateur a la valeur par défaut « eventhubs-emulator » :

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

• Les conteneurs d’applications sur le réseau de pont différent peuvent interagir avec l’émulateur à l’aide de « host.docker.internal » en tant qu’hôte. Utilisez la chaîne de connexion suivante :

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

Utilisation de Kafka

Lors de l’interaction avec Kafka, veillez à définir la configuration du producteur et du consommateur comme suit :

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

La valeur de BootstrapServers et SaslPassword dépend de votre topologie de configuration. Pour plus d’informations, consultez la section Interagir avec l’émulateur.

Important

Lorsque vous utilisez Kafka, seules les API producteur et consommateur sont compatibles avec l’émulateur Event Hubs.

Utilisation d’AMQP

Avec les dernières versions du kit de développement logiciel (SDK) client, vous pouvez interagir avec l’émulateur dans différents langages de programmation. Pour plus d’informations, consultez sdk clients.

Pour commencer, reportez-vous aux exemples d’émulateur Event Hubs sur GitHub.

Contenu connexe

Vue d’ensemble de l’émulateur Azure Event Hubs