In ReadyAPI, you can create virtual services that emulate behavior of real JMS clients that act like both subscribers and publishers. For detailed information on how to perform this or that action, see topics of the APIs (Virtual) section. This section highlights specifics of creating and using JMS virtual clients in ReadyAPI.
Create JMS virtual services
In ReadyAPI, you create an empty JMS virtual service and then add JMS routes to it manually. A JMS route specifies:
-
the JMS server,
-
the JMS topic or queue.
Recording of JMS virtual services is not supported.
Configure Connection
After you add a virtual service, configure the service as it is described in one of the topics below. ReadyAPI can work with virtual services by using the classes from the JMS provider.
Configuring Direct ConnectionSend requests
To send requests, you can use a JMS publisher application, or you can use the JMS Request test step.
1. Configure the test step
Let’s see how you can do this with the JMS Request test step:
-
Create a test suite and a test case (or open an existing test case for editing) and click JMS Request on the toolbar. ReadyAPI will ask you to enter the test step name and then will ask what interface type to use for the JMS request being created. This information is needed for selecting the request editor UI. Select any value you want:
Click the image to enlarge it.
-
Go through the subsequent dialogs that ReadyAPI uses for adding REST or SOAP requests. You can leave default settings in them. For instance, if you selected the REST interface, ReadyAPI will ask you about selecting the REST request. You can choose any value in that dialog.
-
On the next step, ReadyAPI asks you to specify the endpoint for the request. For JMS virtual services, the endpoint means the JMS server (or JMS session) and topic or queue that the request will use for communication:
Click the image to enlarge it.
Parameter Description JMS Server Specifies the JMS server the test step will use. You can select the JMS server specified in the JMS dialog or create a new one.
Send Destination JNDI Name The JMS topic or queue, where the JMS Request test step will post a message.
Receive Destination JNDI Name The JMS topic or queue, where the JMS Request test step will wait for a response to the posted message.
Note: We recommend using a different queue or topic than that you specified in the “Send Destination JNDI Name” field. Click OK to create the endpoint.
You will see it in the JMS Request editor:
Click the image to enlarge it.
Note that only the endpoint matters. Other values like the resource path or method type are ignored.
If needed, you can keep the “Send...” or “Receive...” edit box empty to create “send-only” or “receive-only” endpoints. See Setting Endpoints.
-
Tip: After the test step sends a request, it will wait for a response message to appear in the JMS topic or queue set by the “Receive Destination JNDI Name” parameter. We recommend setting the maximum waiting time in the Timeout property of the JMS Request. This is needed to prevent endless request execution in case when the virtual service does not post a response. The timeout is set in milliseconds.
2. Start the JMS broker
Before sending requests to a JMS virtual service, you need to start the JMS broker on your computer. In this example, we are using ActiveMQ. You can start it from the command line:
<ActiveMQ folder>/bin/activemq.bat start
You can also configure and run ActiveMQ as a service every time the operating system starts. See Running ActiveMQ as a Service or ActiveMQ documentation.
3. Send a JMS request and check the results
-
Start the virtual service. You can do this for example, by clicking Run on the service editor toolbar. Also, see Running Virtual Services.
If the service found the broker running, and if it detected the needed JMS sessions, topics and queue, the “connection” icons are black, otherwise, they are red:
-
Run the JMS Request test step or the test case. After the virtual service responds, you will see the response contents in the editor:
Click the image to enlarge it.
Request and response dispatching
When a JMS virtual service receives a request, it starts searching for the matching virtual operation by comparing the JMS session and message destination with the session and destination set in the virtual operation properties. If the operation is found, the service uses dispatch settings to select a response for the reply. If the service has two operations that match the JMS session and destination, it will use the first found operation.
If the service fails to find an operation, it does not return anything. That is why we recommend setting a timeout for the JMS request (see above).
Tip: To simulate absence of responses from your JMS virtual service, select either the Query Match, XPath or the Script dispatch strategy, configure the strategy properties so that they do not return any response name, and select <None> in the Default Response box:
Click the image to enlarge it.
Run JMS virtual services
You can run JMS virtual services both on local and remote machines:
-
On local computers, you can run them from within ReadyAPI and from the command-line runner.
-
To run virtual services on remote machines, you need VirtServer there.
For complete information, see Running Virtual Services.
Important: To run a JMS virtual service on some computer, you need to install and configure a JMS provider (like ActiveMQ). For example, if you are going to run a JMS virtual service on VirtServer, you need to install ActiveMQ on the VirtServer computer.
View bytes messages
In the Transaction Log, you can view the contents of JMS bytes messages.
Click the image to enlarge it.
To open the editor, click Show hex viewer.
You can configure the editor, using the following options:
| Option | Description |
|---|---|
| View mode |
Specifies the view mode of the editor. Possible options:
|
| Encoding | The encoding is used to view request and response messages. |
| Code Type |
How ReadyAPI should represent the message in the Code view.
|
See Also
JMS Virtual Services
JMS Support
Creating the Connector Plugin