Teste localmente usando o emulador do Barramento de Serviço do Microsoft Azure

Este artigo resume as etapas para desenvolver e testar localmente usando o emulador do Barramento de Serviço do Microsoft Azure.

Pré-requisitos

• Docker Desktop
• Requisitos mínimos de hardware:
  • 2 GB de RAM
  • 5 GB de espaço em disco
• Configuração do Subsistema do Windows para Linux (WSL) (somente para Windows):
  • Instalar o WSL
  • Configurar o Docker para usar o WSL

Observação

Antes de prosseguir com as etapas incluídas nesse artigo, certifique-se de que o Docker Desktop esteja operacional em segundo plano.

Executar o emulador

Para executar o emulador do Barramento de Serviço, você pode usar um script automatizado ou um contêiner Linux:

Script automatizado

Antes de executar um script automatizado, clone o Repositório do instalador do GitHub do emulador localmente.

Windows

Use as etapas a seguir para executar o emulador do Barramento de Serviço localmente no Windows:

1. Permitir a execução de scripts não assinados executando esse comando na janela do PowerShell:

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

2. Execute o script de instalação LaunchEmulator.ps1. Executar o script traz dois contêineres: o emulador do Barramento de Serviço e o Sql Edge (uma dependência para o emulador).

Linux e macOS

Para executar o emulador do Barramento de Serviço localmente no Linux ou macOS:

• Execute o script de instalação LaunchEmulator.sh. Executar o script traz dois contêineres: o emulador do Barramento de Serviço e o Sql Edge (uma dependência para o emulador).

Docker (contêiner do Linux)

1. Para iniciar o emulador, forneça uma configuração para as entidades que você quer usar. Salve o arquivo JSON a seguir 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.Para iniciar contêineres para o emulador do Barramento de Serviço, salve o seguinte arquivo .yaml como docker-compose.yaml

Observação

O Emulador do Barramento de Serviço usa a porta 5672 por padrão. Se você personalizou a configuração para usar uma porta diferente, atualize a configuração de portas no arquivo 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. Crie o arquivo .env para declarar as variáveis de ambiente para o emulador do Barramento de Serviço e garanta que todas as seguintes variáveis de ambiente estejam definidas.

# 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

• Ao passar o valor "Y" para a variável de ambiente "ACCEPT_EULA", você estará reconhecendo e aceitando os termos e condições do Contrato de Licença de Usuário Final (EULA) para ambos emulador do Barramento de Serviço do Azure e SQL do Azure no Edge.

• Certifique-se de colocar o arquivo .env no mesmo diretório para o arquivo docker-compose.yaml.

• Defina a variável de ambiente MSSQL_SA_PASSWORD para uma senha forte de pelo menos oito caracteres que atenda aos requisitos de senha.

• Ao especificar caminhos de arquivo no Windows, use barras invertidas duplas (\\) em vez de barras invertidas simples (\) para evitar problemas com caracteres de escape.

4. Para executar o emulador, execute o seguinte comando:

    docker compose -f <PathToDockerComposeFile> up -d

Após concluir as etapas com sucesso, você poderá encontrar os contêineres em execução no Docker.

Interagir com o emulador

Por padrão, o emulador usa o arquivo de configuração config.json. Você pode configurar entidades fazendo alterações no arquivo de configuração. Para saber mais, visite fazer alterações na configuração

Você pode usar a seguinte cadeia de conexão para se conectar ao emulador do Barramento de Serviço:

• Quando o contêiner do emulador e o aplicativo em execução nativa estão no mesmo computador, use a seguinte cadeia de conexão:

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

• Aplicativos (Conteinerizados/Não conteinerizados) em computadores diferentes e na mesma rede local podem interagir com o emulador usando o endereço IPv4 do computador. Use a seguinte cadeia de conexão:

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

• Contêineres de aplicativos na mesma ponte de rede podem interagir com o Emulador usando seu alias ou IP. A seguinte cadeia de conexão assume que o nome do contêiner do Emulador é "servicebus-emulator":

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

• Contêineres de aplicativos em pontes de rede diferentes podem interagir com o Emulador usando "host.docker.internal" como host. Use a seguinte cadeia de conexão:

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

Você pode usar os SDKs de cliente mais recentes para interagir com o emulador do Barramento de Serviço em várias linguagens de programação. Para começar, consulte os exemplos do emulador do Barramento de Serviço no GitHub.

Conteúdo relacionado

Visão geral do emulador do Barramento de Serviço do Microsoft Azure