View Source

About the Extensions

The MQTT Extensions are custom extensions for Parasoft SOAtest and Virtualize. You can use the extensions on the client side to perform many tasks:

Publish to a topic.
Subscribe to a topic filter until the desired number of messages are received or a specified duration elapses.
Monitor a topic filter during test execution to perform validations on the events that occur.

On the server side, you can use the listener extension to subscribe to a topic filter then publish to a topic based on the incoming subscription messages.
The following custom extensions are provided for MQTT integration:

MQTT Transport: A transport protocol for publishing MQTT messages.
MQTT Subscriber: Use to subscribe to a topic filter until the specified duration elapses.
MQTT Message Listener: A message listener used to subscribe to a topic filter and publish virtualized messages.
MQTT Event Monitor: An entry point to the event monitoring interface, subscribes to a topic to report message events received during testing.
MQTT Configure Tool: A simple tool that configures different MQTT properties so they do not have to be configured in every MQTT extension within a test.

Using Variables

If you intend to run the MQTT extensions in Load Test, note that the test_suite_loc variable is the only variable that can be used in input fields. Load Test does not support the project_loc and workspace_loc variables for Parasoft Marketplace extensions used in .tst projects. The test_suite_loc variable enables you to specify an external file path relative to the location of the .tst project file.

Installation

This tool can be installed from the UI or command line. Download and unzip the compressed folder in a convenient location prior to starting the installation process.

UI Installation

Go to Parasoft > Preferences and click System Properties.
Click Add JARs and select the mqtt.jar file.
Click Apply.
Restart SOAtest.

Command Line Installation

Add the mqtt.jar file to the system.properties.classpath property in your local settings properties file. For example:

system.properties.classpath=<PATH_TO_JAR>/mqtt.jar

MQTT Transport

Add a Message Client to a test and switch the transport to Custom Extension.
Choose MQTT from the Select Implementation menu.

Configuration

You can configure the following settings.

Connection Settings

Click the Connection tab to configure the connection settings.

Broker URL	Defines the URL of the MQTT broker in the following format: `protocol://host:port` protocol is the connection protocol. The transport can communicate with MQTT brokers over TCP or WebSocket protocols. Acceptable values for the protocol are `tcp`, `ssl`, `ws`, or `wss`. host is the broker's host. port is the broker's port. This field is required. If the defined protocol is `ssl` or `wss`, the Transport Layer Security (TLS) settings must also be configured.
Client ID	Defines the client ID to use when connecting to the broker. If left blank, the client ID will be generated by the MQTT broker.
Username	Defines the username to use when connecting to the broker.
Password	Defines the password to use when connecting to the broker.
Connection Timeout	Defines the maximum seconds allowed to establish a connection to the MQTT broker. The default is `30`.
Keep Alive Interval	Defines the maximum interval before disconnecting an idle MQTT client. The default is `60`.
Clean Session	Enables/disables clean sessions. `True`: Establish a clean session. Any messages that have been persisted by the broker will not be solicited to the client. `False`: Don't establish a clean session. Any messages that have been persisted by the broker will be solicited to the client. The default is `true`.
Client Persistence Directory	Defines a directory to store client persistence files. Client persistence is useful if Clean Session is set to `false`. This is because persistence is used by the client to help the broker determine which messages were missed by the client in case the connection is lost with the broker. The default is `Memory Persistence`. Messages will not persist if you restart SOAtest/Virtualize. You should define a directory for the data if it must persist across restarts.

Publish Settings

Click the Publish tab to configure the publish settings:

Topic

Defines to which topic to publish the message.

Quality of Service

Defines the quality-of-service metric that's tied to the published message.

Possible values are 0, 1, and 2. The default is 1.

Retain Message on Server

Enables/disables retaining the message on the server. Setting to true retains the message.

Retained messages are solicited to clients upon subscription to a topic regardless of their Clean Session settings. The default is false.

Last Will and Testament (LWT) Settings

The Last Will and Testament (LWT) is defined when a client connects to a broker. If the client loses connection from the broker for any reason other than a clean disconnect, then the broker will publish the clients LWT automatically.

Topic	Defines to which topic to publish the LWT.
Will Payload	Defines the payload of the LWT. The default is `none`. If this field is not set, the client will not establish a LWT with the broker.
Quality of Service	Defines the quality-of-service metric that's tied to the LWT. Possible values are `0`, `1`, and `2`. The default is `1`.
Retain Message on Server	Enables/disables retaining the LWT on the server. Setting to true retains the LWT. Retained messages are solicited to clients upon subscription to a topic regardless of their Clean Session settings. The default is `false`.

Transport Layer Security (TLS) Settings

The TLS settings must be configured when the protocol is set to ssl or wss in the Broker URL field so that secure connections can be established properly.

TLS Protocol	Defines the Transport Layer Protocol to use when establishing a secure connection. The default is `TLSv1.2`.
Key Manager Factory	Defines the Key Manager Factory used to manage the keys provided in the Key Store File. Different Key Managers are available depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available factory names. The default is `SunX509`.
Key Store File Location	Defines an absolute or relative path to the asset (.tst, .pva, .pvn) key store file.
Key Store Type	Defines the type of Key Store File provided. Different Key Store Types can be handled depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available Key Store Type names.
Key Store Password	Defines the password to be used to extract the keys/certificates from the Key Store File. If left blank, an attempt will be made to extract the keys without a password.
Trust Manager Factory	Defines the Trust Manager Factory used to manage the keys provided in the Trust Store File. Different Trust Managers are available depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available factory names. The default is `SunX509`.
Trust Store File Location	Defines an absolute or relative path to the asset (.tst, .pva, .pvn) Trust Store file. The default is `Trust All Certificates`.
Trust Store Type	Defines the type of Trust Store File provided. Different Trust Store Types can be handled depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available Trust Store Type names.
Trust Store Password	Defines the password to be used to extract the keys/certificates from the Trust Store File. If left blank, an attempt will be made to extract the keys without a password.

Connection Management Settings

Click the Connection Management tab to configure the connection management settings.

Keep connection alive	Enable this option to keep the client connection alive and reused for subsequent publishing.
Close connection after test execution	Enable this option to close the client connection directly after publishing.

MQTT Subscriber

The MQTT Subscriber listens on the topic until the specified duration is reached, the maximum number of messages is reached, or the connection is terminated. If the maximum number of messages is zero (unlimited) then the Subscriber will attempt to listen for the full subscription duration.