Skip to content

Latest commit

 

History

History
116 lines (88 loc) · 4.08 KB

README.md

File metadata and controls

116 lines (88 loc) · 4.08 KB
Raw

LocalSandbox

LocalSandbox is a local emulator for Azure cloud services. Currently, the focus is on supporting Azure Service Bus but other services are planned.

Feel free to open a GitHub issue if you have a feature request or bug report.

Quickstart

The easiest way to get started is by running in docker:

docker run --name localsandbox -d -p 7329:7329 -p 5672:5672 localsandbox/localsandbox

Note

Alternatively, you can run the emulator directly on your machine by downloading the latest binary release from the releases page and running localsandbox run (or localsandbox start to launch in the background).

A basic message can then be sent and received using the following code:

using Azure.Messaging.ServiceBus;

var subscriptionId = "default";
var resourceGroupName = "default";
var namespaceName = "default";

var sbClient = new ServiceBusClient(
    $"Endpoint=sb://{subscriptionId}.{resourceGroupName}.{namespaceName}.localhost.localsandbox.sh;SharedAccessKeyName=1234;SharedAccessKey=password;UseDevelopmentEmulator=true",
    new ServiceBusClientOptions()
    {
        TransportType = ServiceBusTransportType.AmqpTcp,
        CustomEndpointAddress = new("https://localhost.localsandbox.sh:5672")
    });

var sender = sbClient.CreateSender("default");
await sender.SendMessageAsync(new("Hello, World!"));

var receiver = sbClient.CreateReceiver("default");
var message = await receiver.ReceiveMessageAsync();

Console.WriteLine(message.Body.ToString());

Tip

LocalSandbox automatically creates a subscription, namespace, resource group and queue called default every time it starts. You can disable this behavior by setting the environment variable LOCALSANDBOX_DEFAULT_RESOURCES to false.

Creating Resources

With the Azure CLI

LocalSandbox comes bundled with a command utility azl which is a wrapper around az running everything locally against LocalSandbox. For example, to create a new queue with a docker-based installation you can run:

docker exec localsandbox \
    azl servicebus queue create \
    --name myqueue \
    --namespace-name default \
    --resource-group default

Tip

The subscription id (account id) used by the CLI can be set with the AZURE_SUBSCRIPTION_ID environment variable. Subscriptions are always created on-the-fly.

With the Azure SDK

LocalSandbox supports the SDK management clients. For example, to create a new queue in C#:

using Microsoft.Azure.Management.ServiceBus;
using Microsoft.Azure.Management.ServiceBus.Models;
using Microsoft.Rest;

var subscriptionId = "default"; // will be auto-created
var sbManagementClient = new ServiceBusManagementClient(new TokenCredentials(subscriptionId))
{
    SubscriptionId = subscriptionId,
    BaseUri = new("https://localhost.localsandbox.sh:7329/azure")
};

var queue = await sbManagementClient.Queues.CreateOrUpdateAsync(
    resourceGroupName: "default",
    namespaceName: "default",
    queueName: "myqueue",
    new SBQueue()
);

Console.WriteLine("Created Queue: " + queue.Name);

Note

As the example demonstrates, the subscription id is provided as the bearer token for authentication. The subscription will always be created automatically if one does not yet exist.

Features and Roadmap

  • Service Bus
    • Queues
    • Topics / Subscriptions
    • Sessions
    • Dead-lettering
    • Auto-forwarding
    • Management Client
    • Message defer
    • Duplicate detection
    • Message Batching
    • SBQueue properties - lockDuration, messageCount, etc
    • Scheduled messages
    • Message annotations: TTL, ID, Subject, etc
    • Subqueues
    • Transactions
    • Rules
    • Administration client
    • WebSockets
    • All CRUD REST API endpoints
  • Azure Storage (w/ Azurite)
  • Azure Event Hubs (w/ MS Emulator)
  • Let me know what you want!