Tester localement à l’aide de l’émulateur Azure Service Bus

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

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 Service Bus, 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

Suivez ces étapes pour exécuter l’émulateur Service Bus 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 Service Bus et SQL Edge (une dépendance pour l’émulateur).

Linux et macOS

Pour exécuter l’émulateur Service Bus localement sur Linux ou macOS :

• Exécutez le script d’installation LaunchEmulator.sh. L’exécution du script affiche deux conteneurs : l’émulateur Service Bus et SQL Edge (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": {
    "Namespaces": [
      {
        "Name": "sbemulatorns",
        "Queues": [
          {
            "Name": "queue.1",
            "Properties": {
              "DeadLetteringOnMessageExpiration": false,
              "DefaultMessageTimeToLive": "PT1H",
              "DuplicateDetectionHistoryTimeWindow": "PT20S",
              "ForwardDeadLetteredMessagesTo": "",
              "ForwardTo": "",
              "LockDuration": "PT1M",
              "MaxDeliveryCount": 10,
              "RequiresDuplicateDetection": false,
              "RequiresSession": false
            }
          }
        ],
   
        "Topics": [
          {
            "Name": "topic.1",
            "Properties": {
              "DefaultMessageTimeToLive": "PT1H",
              "DuplicateDetectionHistoryTimeWindow": "PT20S",
              "RequiresDuplicateDetection": false
            },
            "Subscriptions": [
              {
                "Name": "subscription.1",
                "Properties": {
                  "DeadLetteringOnMessageExpiration": false,
                  "DefaultMessageTimeToLive": "PT1H",
                  "LockDuration": "PT1M",
                  "MaxDeliveryCount": 10,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "",
                  "RequiresSession": false
                },
                "Rules": [
                  {
                    "Name": "app-prop-filter-1",
                    "Properties": {
                      "FilterType": "Correlation",
                      "CorrelationFilter": {
                        "ContentType": "application/text",
                        "CorrelationId": "id1",
                        "Label": "subject1",
                        "MessageId": "msgid1",
                        "ReplyTo": "someQueue",
                        "ReplyToSessionId": "sessionId",
                        "SessionId": "session1",
                        "To": "xyz"
                      }
                    }
                  }
                ]
              },
              {
                "Name": "subscription.2",
                "Properties": {
                  "DeadLetteringOnMessageExpiration": false,
                  "DefaultMessageTimeToLive": "PT1H",
                  "LockDuration": "PT1M",
                  "MaxDeliveryCount": 10,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "",
                  "RequiresSession": false
                },
                "Rules": [
                  {
                    "Name": "user-prop-filter-1",
                    "Properties": {
                      "FilterType": "Correlation",
                      "CorrelationFilter": {
                        "Properties": {
                          "prop3": "value3"
                        }
                      }
                    }
                  }
                ]
              },
              {
                "Name": "subscription.3",
                "Properties": {
                  "DeadLetteringOnMessageExpiration": false,
                  "DefaultMessageTimeToLive": "PT1H",
                  "LockDuration": "PT1M",
                  "MaxDeliveryCount": 10,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "",
                  "RequiresSession": false
                }
              }
            ]
          }
        ]
      }
    ],
    "Logging": {
      "Type": "File"
    }
   }
   }
   
   

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

Remarque

L’émulateur Service Bus utilise le port 5672 par défaut. Si vous avez personnalisé la configuration pour utiliser un port différent, mettez à jour le paramètre des ports dans le fichier YAML.

name: microsoft-azure-servicebus-emulator
services:
  emulator:
    container_name: "servicebus-emulator"
    image: mcr.microsoft.com/azure-messaging/servicebus-emulator:latest
    volumes:
      - "${CONFIG_PATH}:/ServiceBus_Emulator/ConfigFiles/Config.json"
    ports:
      - "5672:5672"
    environment:
      SQL_SERVER: sqledge  
      MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
      ACCEPT_EULA: ${ACCEPT_EULA}
    depends_on:
      - sqledge
    networks:
      sb-emulator:
        aliases:
          - "sb-emulator"
  sqledge:
        container_name: "sqledge"
        image: "mcr.microsoft.com/azure-sql-edge:latest"
        networks:
          sb-emulator:
            aliases:
              - "sqledge"
        environment:
          ACCEPT_EULA: ${ACCEPT_EULA}
          MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
networks:
  sb-emulator:

3. Créez un fichier .env visant à déclarer les variables d’environnement pour l’émulateur Service Bus et vérifiez que toutes les variables d’environnement suivantes sont définies.

# Environment file for user defined variables in docker-compose.yml

# 1. CONFIG_PATH: Path to Config.json file
# Ex: CONFIG_PATH="C:\\Config\\Config.json"
CONFIG_PATH="<Replace with path to Config.json file>"

# 2. ACCEPT_EULA: Pass 'Y' to accept license terms for Azure SQL Edge and Azure Service Bus emulator.
# Service Bus emulator EULA : https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt
# SQL Edge EULA : https://go.microsoft.com/fwlink/?linkid=2139274
ACCEPT_EULA="N"

# 3. MSSQL_SA_PASSWORD to be filled by user as per policy
MSSQL_SA_PASSWORD=""

Important

• En passant la valeur « Y » à la variable d’environnement « ACCEPT_EULA », vous acceptez les conditions générales du Contrat de licence utilisateur final (CLUF) pour l’émulateur Azure Service Bus et Azure SQL Edge.

• Veillez à placer le fichier .env dans le même répertoire que le fichier docker-compose.yaml.

• Définissez la variable d’environnement MSSQL_SA_PASSWORD avec un mot de passe fort d’au moins huit caractères répondant aux critères de mot de passe.

• Lorsque vous spécifiez des chemins de fichier dans Windows, utilisez des barres obliques inverses doubles (\\) au lieu de barres obliques inverses simples (\) pour éviter les problèmes liés aux 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 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 Service Bus :

• Lorsque le conteneur de l’émulateur et l’application interagissante s’exécutent en mode natif sur l’ordinateur local, 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 du conteneur de l’émulateur est « servicebus-emulator » :

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

• Les conteneurs d’applications sur l’autre réseau de pont 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;"

Vous pouvez utiliser les derniers kits SDK client pour interagir avec l’émulateur Service Bus dans différents langages de programmation. Pour commencer, reportez-vous aux Exemples d’émulateur Service Bus sur GitHub.

Contenu connexe

Vue d’ensemble de l’émulateur Azure Service Bus