azservicebus

xk6-azservicebus

This is a k6 extension using the xk6 system, that allows to connect with Azure ServiceBus.

• xk6-azservicebus
  • Build
  • API
    • ServiceBus
    • Sender
    • Receiver
  • License

Build

To build a k6 binary with this extension, first ensure you have the prerequisites:

• Go toolchain
• Git

1. Install xk6 framework for extending k6:

go install go.k6.io/xk6/cmd/xk6@latest

1. Build the binary:

xk6 build --with github.com/fernandoescolar/xk6-azservicebus@latest

1. Run a test

k6 run -e CONNECTION_STRING=your_azure_service_bus_connection_string your_tests.js

You can find some example javascript files in the examples folder.

API

ServiceBus

A ServiceBus instance represents the connection with the Azure ServiceBus service and it is created with new ServiceBus(configuration), where configuration attributes are:

Example:

import { ServiceBus } from 'k6/x/azservicebus';

const config = {
    connectionString: __ENV.CONNECTION_STRING,
    timeout: 30000,
};

const servicebus = new ServiceBus(config);

When you finish using the ServiceBus instance, you should close it using the close() method:

export function teardown() {
    servicebus.close();
}

Sender

To send messages to Azure ServiceBus you have to create a new sender using the createSender(topicOrQueue) method of the ServiceBus instance. The topicOrQueue parameter is the name of the topic or the queue where the messages will be sent:

const sender = servicebus.createSender('test-topic');
// or
const sender = servicebus.createSender('test-queue');

Then, you can send messages to a topic or a queue using the following functions:

Example:

const sender = servicebus.createSender('test-topic');

sender.send('hello azure service bus!');
sender.sendBatch(['hello azure service bus!', 'hello again!']);
sender.sendMessage({
  subject: 'my subject',
  bodyAsString: 'hello azure service bus!'
});
sender.sendBatchMessages([
  {
    subject: 'my subject',
    bodyAsString: 'hello azure service bus!'
  },
  {
    subject: 'my subject',
    bodyAsString: 'hello again!'
  }
]);

sender.close();

Once you have finished using the sender, you should close it using the close() method:

sender.close();

And the Message object has the following attributes:

Receiver

To receive messages from Azure ServiceBus you have to create a new queue receiver using the createQueueReceiver(queue) method of the ServiceBus instance, or createSubscriptionReceiver(topic, subscription) method to create a subscription receiver. The queue parameter is the name of the queue where the messages will be received, and the topic and subscription parameters are the name of the topic and the subscription where the messages will be received:

const receiver = servicebus.createQueueReceiver('test-queue');
// or
const receiver = servicebus.createSubscriptionReceiver('test-topic', 'test-subscription');

Then, you can receive messages from a queue or a subscription using the following functions:

const receiver = servicebus.createQueueReceiver('test-queue');

const message = receiver.getMessage();
check(message, {
  'Is expected message': (m) => m.bodyAsString === expectedMessage,
})

receiver.close();

Once you have finished using the receiver, you should close it using the close() method:

receiver.close();

And the ReceivedMessage object has the following attributes:

License

The source code of this project is released under the MIT License.