Prueba local mediante el emulador de Azure Service Bus

En este artículo se resumen los pasos para desarrollar y probar localmente mediante el emulador de Azure Service Bus.

Requisitos previos

• Escritorio de Docker
• Requisitos mínimos de hardware:
  • 2 GB de RAM
  • 5 GB de espacio en disco
• Configuración del Subsistema de Windows para Linux (WSL) (solo para Windows):
  • Instalación de WSL
  • Configuración de Docker para usar WSL

Nota:

Antes de continuar con los pasos de este artículo, asegúrese de que Docker Desktop está operativo en segundo plano.

Ejecución del emulador

Para ejecutar el emulador de Service Bus, puede usar un script automatizado o un contenedor de Linux:

Script automatizado

Antes de ejecutar un script automatizado, clone el repositorio del instalador de GitHub del emulador localmente.

Windows

Siga estos pasos para ejecutar el emulador de Service Bus localmente en Windows:

1. Permita la ejecución de scripts sin firmar ejecutando este comando en la ventana de PowerShell:

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

2. Ejecute el script de instalación LaunchEmulator.ps1. Al ejecutar el script se muestran dos contenedores: el emulador de Service Bus y SQL Edge (una dependencia para el emulador).

Linux y macOS

Para ejecutar el emulador de Service Bus localmente en Linux o macOS:

• Ejecute el script de instalación LaunchEmulator.sh. Al ejecutar el script se muestran dos contenedores: el emulador de Service Bus y SQL Edge (una dependencia para el emulador).

Docker (contenedor de Linux)

1. Para iniciar el emulador, proporcione una configuración para las entidades que desea usar. Guarde el siguiente archivo JSON localmente como 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. Guarde el siguiente archivo .yaml como docker-compose.yaml para poner en marcha contenedores para el emulador de Service Bus

Nota:

El emulador de Service Bus usa el puerto 5672 de forma predeterminada. Si personalizó la configuración para usar un puerto diferente, actualice la configuración de puertos en el archivo 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. Cree un archivo .env para declarar las variables de entorno para el emulador de Service Bus y asegúrese de que se establecen todas las siguientes variables de entorno.

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

Importante

• Al pasar el valor "Y" a la variable de entorno "ACCEPT_EULA", reconoce y acepta los términos y condiciones del Contrato de licencia de usuario final (CLUF) para el emulador de Azure Service Bus y Azure SQL Edge.

• Asegúrese de colocar el archivo .env en el mismo directorio que el archivo docker-compose.yaml.

• Establezca la variable de entorno MSSQL_SA_PASSWORD en una contraseña segura de al menos ocho caracteres que cumpla los requisitos de contraseña.

• Cuando especifique rutas de archivos en Windows, utilice barras invertidas dobles (\\) en lugar de simples (\) para evitar problemas con los caracteres de escape.

4. Para ejecutar el emulador, ejecute el siguiente comando:

    docker compose -f <PathToDockerComposeFile> up -d

Una vez que los pasos se realicen correctamente, puede encontrar los contenedores que se ejecutan en Docker.

Interacción con el emulador

De forma predeterminada, el emulador usa el archivo de configuración config.json. Puede configurar entidades realizando cambios en el archivo de configuración. Para más información, visite realizar cambios de configuración

Puede usar la siguiente cadena de conexión para conectarse al emulador de Service Bus:

• Cuando el contenedor emulador y la aplicación que interactúa se ejecutan de forma nativa en la máquina local, utilice la siguiente cadena de conexión:

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

• Las aplicaciones (en contenedores o no en contenedores) en la máquina diferente y la misma red local pueden interactuar con emulador mediante la dirección IPv4 de la máquina. Use la siguiente cadena de conexión:

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

• Los contenedores de aplicaciones de la misma red de puente pueden interactuar con Emulator mediante su alias o IP. La cadena de conexión siguiente supone que el nombre del contenedor Emulator es "servicebus-emulator":

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

• Los contenedores de aplicaciones de la red de puentes diferentes pueden interactuar con el emulador mediante "host.docker.internal" como host. Use la siguiente cadena de conexión:

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

Puede usar los SDK de cliente más recientes para interactuar con el emulador de Service Bus en varios lenguajes de programación. Para empezar, consulte los ejemplos del emulador de Service Bus de en GitHub.

Contenido relacionado

Introducción al emulador de Azure Service Bus