This plugin adds four TestSteps to the functional testing in Ready! API
- one for publishing messages to an websocket server
- one for receiving (and asserting) messages
- one for dropping connections
- and one for only opening connections
It integrates fully with all other Ready! API features like property expansion, property transfers, data-driven testing, etc.
This plugin was inspired by SmartBear/ready-mqtt-plugin and lots of code has been taken from it. Thanks to the original authors.
This plugin is compatible and works with:
- SoapUI 5.2.x and 5.4.x
- Ready! API 1.4.x and 1.5.x
- Ready! API 2.4.x and 2.5.x
If you like to run an unsigned plugin in SoapUI OS equal to or higher than 5.2.1 you have to install SoapUI PluginLoader Jailbreak.
Download the latest release JAR file and copy it to <user home>/.soapuios/plugins/ .
For further question please read SoapUI Plugin Installation
Install the plugin via the Plugin Manager inside Ready! API. Please read Ready! API Plugin Manager for additional informations.
This plugin allows publish messages to websocket servers and receive messages from them. It adds 4 different test steps:
- Publish using Websockets – to publish a message
- Receive Websockets Message – to receive a message
- Drop Websocket connection – to close or terminate a connection with websocket server
- Open Websocket connection – to only open a connection with websocket server
Websockets are full-duplex (both directions at the same time) single tcp socket connections. Publishing and receiving messages can be done on one connection.
A TestCase bundles TestSteps and for Websocket TestSteps it is the place where open websocket connections are cached.
Each Websocket TestStep looks into the cache for a named connection. If an open websocket connection could be found it will be used for communication. If no open websocket connection could be found, a new one will be opend and cached. Once the TestCase has ended all open websocket connections will be closed.
Caching and re-using of open websocket connections only happens when you run a TestCase. When running a single Websocket TestStep it's websocket connection will not be cached for re-use.
When running a LoadTest, connections will be re-used over all threads unless Close Connection: ☑ ︎between each request is selected in the 'LoadTest Options' dialog.
Before you start, you have to specify the websocket server which you want to use and configure the connection settings.
Every websocket test step has the 'Connection' combo-box. Choose <New Connection…> item to create a new connection.
The 'Create Connection' dialog will appear:
You have to specify the following settings for the connection (note that the connection may be used in any test case in the project, so only project level property expansions will work correctly for connection settings):
Name
The unique name to identify a connection within test steps (this name will appear in the Connection combo-box of the test steps later).
Server URI
This is the URI of the websocket server. Server URI should contain the protocol being used:
ws:// to connect using a plain TCP socket.
wss:// to connect using a secure SSL/TLS socket.
Server URI may also contain a port number. If the port is not specified, it will default to 80 for ws:// server URIs, and 443 for wss:// server URIs.
Example of URI: ws://localhost:80
Subprotocols
The optional subprotocols to use in the websocket upgrade request as comma-separated list.
Authentication
Check this option if the websocket server requires authentication.
Login and Password
These fields are required if the websocket server requires authentication.
Hide
If this checkbox is unchecked, the password value will be visible in the Password text edit box. If you want to keep the password hidden, check this box.
After you close the 'Create Connection' dialog by clicking Ok, this connection will be assigned to the current test step. To use this connection with another test step, choose it from the 'Connection' combo-box in the test step editor.
If you want to browse all connections related to the project or remove some needless connections, open any Publish or Receive test step editor and click on the Configure Websocket Connections of the Project toolbar button:
The 'Configure Connections to Websocket Servers' dialog will appear:
This dialog allows you to manage all connections used for the current project.
This test step publishes a message on the selected server.
Connection
Choose the websocket server or select <New Connection…> to create a new connection for this test step.
Configure
Click this button if you wish to customize the connection selected for this test step. The 'Configure Connection' dialog will appear.
Message type
Type of message to publish. The following values are available:
Send as websocket text message
- JSON
- XML
- Text
Send as websocket binary message
- Content of file
- Integer (4 bytes)
- Long (8 bytes)
- Float
- Double
Message
This is the actual payload of the message you want to publish.
Timeout
The test step will fail if a connection to websocket server is not established and that message could not be send to the server within a specified period.
This test step waits until a message is received from the websocket server and optionaly asserts the message.
Connection
Choose the websocket server or select <New Connection…> to create a new connection for this test step.
Configure
Click this button if you wish to customize the connection selected for this test step. The 'Configure Connection' dialog will appear.
Expected message type
This field specifies how to interpret a received message payload. If a message cannot be treated as a specified type, the test step will fail. The following options are available:
- Text (UTF-8)
- Raw binary data (shown as a hexadecimal digits sequence)
- Integer number
- Float number
Timeout
The test step will fail if a valid message isn't received within a specified period.
Stop after
The test step will fail if a valid message isn't received after the specified number of messages.
Count
The count of all processed messages. The websocket client may consume some more messages before it is stopped.
Received message
The payload of a message which was received as a result of the test step execution.
Assertions
When present, assertions will continuously applied against the received stream of messages. Only if all given assertions match then this test step succeeds.
If no assertion is present then the first received message will be set as valid message.
This test step disconnects from the websocket server which is useful if you are testing scenarios in which dropped connections are a factor.
Drop Websocket Connection has no effect when running inside a LoadTest.
Connection
Choose the websocket server or select <New Connection…> to create a new connection for this test step.
Configure
Click this button if you wish to customize the connection selected for this test step. The 'Configure Connection' dialog will appear.
Drop method
You can choose one of these methods:
-
'Send Normal Close message' - Send status code
1000and status reasondrop connection test stepmessage to the websocket server -
'Send Protocol Error message' - Send status code
1002and status reasondrop connection test stepmessage to the websocket server
This test step only connects to the websocket server which is useful if you are testing scenarios in which connections should be created before any other none websocket test step.
Connection
Choose the websocket server or select <New Connection…> to create a new connection for this test step.
Configure
Click this button if you wish to customize the connection selected for this test step. The 'Configure Connection' dialog will appear.
Timeout
The test step will fail if a connection could not be established within a specified period.