Testowanie lokalne przy użyciu emulatora usługi Azure Service Bus

W tym artykule podsumowano kroki tworzenia i testowania lokalnego przy użyciu emulatora usługi Azure Service Bus.

Wymagania wstępne

• Docker Desktop
• Minimalne wymagania sprzętowe:
  • 2 GB pamięci RAM
  • 5 GB miejsca na dysku
• konfiguracja Podsystem Windows dla systemu Linux (tylko dla systemu Windows):
  • Instalowanie programu WSL
  • Konfigurowanie platformy Docker do korzystania z usługi WSL

Uwaga

Przed kontynuowaniem kroków opisanych w tym artykule upewnij się, że program Docker Desktop działa w tle.

Uruchamianie emulatora

Aby uruchomić emulator usługi Service Bus, możesz użyć zautomatyzowanego skryptu lub kontenera systemu Linux:

Skrypt zautomatyzowany

Przed uruchomieniem zautomatyzowanego skryptu sklonuj repozytorium instalatora GitHub emulatora lokalnie.

Windows

Wykonaj następujące kroki, aby uruchomić emulator usługi Service Bus lokalnie w systemie Windows:

1. Zezwól na wykonywanie niepodpisanych skryptów, uruchamiając to polecenie w oknie programu PowerShell:

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

2. Uruchom skrypt instalacyjny LaunchEmulator.ps1. Uruchomienie skryptu powoduje wyświetlenie dwóch kontenerów: emulator usługi Service Bus i program Sql Edge (zależność dla emulatora).

Linux i macOS

Aby uruchomić emulator usługi Service Bus lokalnie w systemie Linux lub macOS:

• Uruchom skrypt konfiguracji LaunchEmulator.sh. Uruchomienie skryptu powoduje wyświetlenie dwóch kontenerów: emulator usługi Service Bus i program Sql Edge (zależność dla emulatora).

Docker (kontener systemu Linux)

1. Aby uruchomić emulator, podaj konfigurację jednostek, których chcesz użyć. Zapisz następujący plik JSON lokalnie jako 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.To uruchom kontenery dla emulatora usługi Service Bus, zapisz następujący plik yaml jako plik docker-compose.yaml

Uwaga

Emulator usługi Service Bus domyślnie używa portu 5672. Jeśli konfiguracja została dostosowana do używania innego portu, zaktualizuj ustawienie portów w pliku 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. Utwórz plik env, aby zadeklarować zmienne środowiskowe emulatora usługi Service Bus i upewnij się, że ustawiono wszystkie poniższe zmienne środowiskowe.

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

Ważne

• Przekazując wartość "Y" do zmiennej środowiskowej "ACCEPT_EULA", potwierdzasz i akceptujesz warunki umowy licencyjnej użytkownika końcowego (EULA) dla emulatora usługi Azure Service Bus i usługi Azure SQL Edge.

• Upewnij się, że w tym samym katalogu umieść plik env w pliku docker-compose.yaml.

• Ustaw zmienną środowiskową MSSQL_SA_PASSWORD na silne hasło zawierające co najmniej osiem znaków spełniających wymagania dotyczące hasła.

• Podczas określania ścieżek plików w systemie Windows użyj podwójnych ukośników odwrotnych (\\) zamiast pojedynczych ukośników odwrotnych (\), aby uniknąć problemów z znakami ucieczki.

4. Aby uruchomić emulator, wykonaj następujące polecenie:

    docker compose -f <PathToDockerComposeFile> up -d

Po pomyślnym wykonaniu tych kroków można znaleźć kontenery uruchomione na platformie Docker.

Interakcja z emulatorem

Domyślnie emulator używa config.json pliku konfiguracji. Jednostki można skonfigurować, wprowadzając zmiany w pliku konfiguracji. Aby dowiedzieć się więcej, odwiedź stronę wprowadzanie zmian konfiguracji

Aby nawiązać połączenie z emulatorem usługi Service Bus, możesz użyć następujących parametry połączenia:

• Gdy kontener emulatora i aplikacja współdziałają natywnie na komputerze lokalnym, użyj następujących parametry połączenia:

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

• Aplikacje (konteneryzowane/niekontenerowane) na różnych maszynach i tej samej sieci lokalnej mogą wchodzić w interakcję z emulatorem przy użyciu adresu IPv4 maszyny. Użyj następujących parametry połączenia:

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

• Kontenery aplikacji w tej samej sieci mostka mogą wchodzić w interakcje z emulatorem przy użyciu aliasu lub adresu IP. Po parametry połączenia przyjęto założenie, że nazwa kontenera emulatora to "servicebus-emulator":

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

• Kontenery aplikacji w innej sieci mostka mogą współdziałać z emulatorem przy użyciu hosta "host.docker.internal". Użyj następujących parametry połączenia:

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

Najnowsze zestawy SDK klienta umożliwiają interakcję z emulatorem usługi Service Bus w różnych językach programowania. Aby rozpocząć, zapoznaj się z przykładami emulatora usługi Service Bus w witrynie GitHub.

Powiązana zawartość

Omówienie emulatora usługi Azure Service Bus