add Open Connection TestStep

Author: Holger Balow-Schott

README.md

@@ -3,10 +3,11 @@
 
 ## Ready! API Websocket Plugin
 
-This plugin adds three TestSteps to the functional testing in Ready! API
+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
-* and one for dropping connections
+* 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.
 
@@ -17,9 +18,9 @@ Thanks to the original authors.
 
 This plugin is compatible and works with:
 * SoapUI 5.2.x
-* Ready! API 1.4.x
+* Ready! API 1.4.x and 1.5.x
 
-If you like to run an unsigned version in SoapUI OS >= 5.2.1 you have to install [SoapUI PluginLoader Jailbreak](https://github.com/hschott/soapui-pluginloader-jailbreak).
+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](https://github.com/hschott/soapui-pluginloader-jailbreak).
 
 
 ### Install in SoapUI
@@ -33,11 +34,12 @@ Install the plugin via the Plugin Manager inside Ready! API. Please read [Ready!
 
 ## Websocket Test Steps
 
-This plugin allows publish messages to websocket servers and receive messages from them. It adds 3 new test steps:
+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
 
 ### Lifetime of Websocket connections
 
@@ -103,7 +105,7 @@ This dialog allows you to manage all connections used for the current project.
 
 ### Publish using Websockets
 
-This test step publishes a message on the selected server. 
+This test step publishes a message on the selected server.
 
 <img width="573" alt="publish message" src="https://cloud.githubusercontent.com/assets/4548589/10111462/813c2c42-63d4-11e5-8b11-104800eb8274.png">
 
@@ -211,4 +213,20 @@ You can choose one of these methods:
 * 'Send Protocol Error message' - Send status code `1002` and status reason `drop connection test step` message to the websocket server
 
 
+### Open Websocket Connection
+
+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.
+
 

artwork/html5-connectivity.xcf

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<con:soapui-project id="5e871d76-59b2-469f-8b50-884412b8247e" activeEnvironment="Default" name="ready-websocket-plugin" resourceRoot="" soapui-version="5.2.0" abortOnError="false" runType="SEQUENTIAL" xmlns:con="http://eviware.com/soapui/config"><con:settings><con:setting id="WebSocketConnections"><![CDATA[<xml-fragment>
+<con:soapui-project id="5e871d76-59b2-469f-8b50-884412b8247e" activeEnvironment="Default environment" name="ready-websocket-plugin" resourceRoot="" soapui-version="6.0.0" abortOnError="false" runType="SEQUENTIAL" xmlns:con="http://eviware.com/soapui/config"><con:settings><con:setting id="WebSocketConnections"><![CDATA[<xml-fragment>
   <Connection>
     <Name>sample echo</Name>
     <ServerURI>ws://websocket-hschott.rhcloud.com:8000/echo/websocket</ServerURI>
@@ -60,12 +60,12 @@
   </con:configuration>
 </assertion></con:config></con:testStep><con:testStep type="WebsocketDropConnectionTestStep" name="Drop Websocket Connection" id="b1b78f5a-45e1-4ffe-b3a2-87cfa3bbf858"><con:settings/><con:config><ConnectionName>echo.websocket.org</ConnectionName><Timeout>30000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><DropMethod>SendDisconnect</DropMethod></con:config></con:testStep><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>c627ec6b-68fa-4ea5-a00a-f797a9394029</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>544deb0f-4897-42d0-b1d6-eb1e3373956c</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>b1b78f5a-45e1-4ffe-b3a2-87cfa3bbf858</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="e5456773-8f37-40f1-ac52-26666c03e77c" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample echo" searchProperties="true"><con:settings/><con:testStep type="websocketPublishTestStep" name="Publish using Websocket" id="63fc5f29-f33a-46de-869c-53a3b91e85b8"><con:settings/><con:config><ConnectionName>sample echo</ConnectionName><Timeout>10000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><MessageKind>Text</MessageKind><Message>${=UUID.randomUUID().toString()}</Message></con:config></con:testStep><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="7fe1de57-583b-4a35-8512-82f809bfa87c"><con:settings/><con:config><ConnectionName>sample echo</ConnectionName><Timeout>10000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>Text</ExpectedMessageType><MaxMessageCount>0</MaxMessageCount><assertion type="Simple Contains" id="86361834-f58b-40da-af2f-9ea6b3ba1f9b" name="Contains">
   <con:configuration><token>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</token><ignoreCase>false</ignoreCase><useRegEx>true</useRegEx></con:configuration>
-</assertion></con:config></con:testStep><con:testStep type="WebsocketDropConnectionTestStep" name="Drop Websocket Connection" id="8a9ac491-000d-4f7c-9a5e-8f8d84bc8564"><con:settings/><con:config><ConnectionName>sample echo</ConnectionName><Timeout>30000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><DropMethod>SendDisconnect</DropMethod></con:config></con:testStep><con:loadTest id="ee97b7cc-bd56-4b76-a0a6-722ab8d64c94" name="LoadTest 1"><con:settings><con:setting id="HttpSettings@close-connections">false</con:setting></con:settings><con:threadCount>5</con:threadCount><con:startDelay>0</con:startDelay><con:sampleInterval>250</con:sampleInterval><con:calculateTPSOnTimePassed>true</con:calculateTPSOnTimePassed><con:resetStatisticsOnThreadCountChange>true</con:resetStatisticsOnThreadCountChange><con:historyLimit>0</con:historyLimit><con:testLimit>30</con:testLimit><con:limitType>TIME</con:limitType><con:loadStrategy><con:type>Simple</con:type><con:config><testDelay>100</testDelay><randomFactor>1.0</randomFactor></con:config></con:loadStrategy><con:assertion type="Step Status" name="Step Status"/><con:maxAssertionErrors>100</con:maxAssertionErrors><con:statisticsLogFolder/><con:statisticsLogInterval>0</con:statisticsLogInterval><con:logStatisticsOnThreadChange>false</con:logStatisticsOnThreadChange><con:cancelOnReachedLimit>false</con:cancelOnReachedLimit><con:cancelExcessiveThreads>true</con:cancelExcessiveThreads><con:strategyInterval>500</con:strategyInterval><con:updateStatisticsPerTestStep>false</con:updateStatisticsPerTestStep></con:loadTest><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>8d6b38b9-7a09-43d4-8d17-04e6e4e62333</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>5e20ce24-91ec-4af1-b3be-5b881fd2debb</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="e5bf9b66-fccb-43bd-a901-ca09ba8f865e" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample stream" searchProperties="true"><con:settings/><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="b683e840-e961-4ee6-9915-beb5c7d06a80"><con:settings/><con:config><ConnectionName>sample stream</ConnectionName><Timeout>0</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>BinaryData</ExpectedMessageType><MaxMessageCount>0</MaxMessageCount><assertion type="Simple Contains" id="bd55144b-a7e6-4918-9cc7-0abbc858bc59" name="Contains">
+</assertion></con:config></con:testStep><con:testStep type="WebsocketDropConnectionTestStep" name="Drop Websocket Connection" id="8a9ac491-000d-4f7c-9a5e-8f8d84bc8564"><con:settings/><con:config><ConnectionName>sample echo</ConnectionName><Timeout>30000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><DropMethod>SendDisconnect</DropMethod></con:config></con:testStep><con:loadTest id="ee97b7cc-bd56-4b76-a0a6-722ab8d64c94" name="LoadTest 1"><con:settings><con:setting id="HttpSettings@close-connections">false</con:setting></con:settings><con:threadCount>5</con:threadCount><con:startDelay>0</con:startDelay><con:sampleInterval>250</con:sampleInterval><con:calculateTPSOnTimePassed>true</con:calculateTPSOnTimePassed><con:resetStatisticsOnThreadCountChange>true</con:resetStatisticsOnThreadCountChange><con:historyLimit>0</con:historyLimit><con:testLimit>30</con:testLimit><con:limitType>TIME</con:limitType><con:loadStrategy><con:type>Simple</con:type><con:config><testDelay>100</testDelay><randomFactor>1.0</randomFactor></con:config></con:loadStrategy><con:assertion type="Step Status" name="Step Status"/><con:maxAssertionErrors>100</con:maxAssertionErrors><con:statisticsLogFolder/><con:statisticsLogInterval>0</con:statisticsLogInterval><con:logStatisticsOnThreadChange>false</con:logStatisticsOnThreadChange><con:cancelOnReachedLimit>false</con:cancelOnReachedLimit><con:cancelExcessiveThreads>true</con:cancelExcessiveThreads><con:strategyInterval>500</con:strategyInterval><con:updateStatisticsPerTestStep>false</con:updateStatisticsPerTestStep><con:reportParameters/></con:loadTest><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>8d6b38b9-7a09-43d4-8d17-04e6e4e62333</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>5e20ce24-91ec-4af1-b3be-5b881fd2debb</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="e5bf9b66-fccb-43bd-a901-ca09ba8f865e" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample stream" searchProperties="true"><con:settings/><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="b683e840-e961-4ee6-9915-beb5c7d06a80"><con:settings/><con:config><ConnectionName>sample stream</ConnectionName><Timeout>0</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>BinaryData</ExpectedMessageType><MaxMessageCount>0</MaxMessageCount><assertion type="Simple Contains" id="bd55144b-a7e6-4918-9cc7-0abbc858bc59" name="Contains">
   <con:configuration><token>4301</token><ignoreCase>false</ignoreCase><useRegEx>false</useRegEx></con:configuration>
 </assertion></con:config></con:testStep><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>8d6b38b9-7a09-43d4-8d17-04e6e4e62333</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>5e20ce24-91ec-4af1-b3be-5b881fd2debb</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="d1c89c6d-99a6-4dbd-8142-c65870fe1bad" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample hello" searchProperties="true"><con:settings/><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="92143b19-63f7-4a7a-a3e9-928cc10b5009"><con:settings/><con:config><ConnectionName>sample hello</ConnectionName><Timeout>1000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>Text</ExpectedMessageType><assertion type="Simple Contains" id="d84495ec-89ba-482b-a87e-7335a9b8279c" name="Contains">
   <con:configuration>
     <token>Hello world!</token>
     <ignoreCase>false</ignoreCase>
     <useRegEx>false</useRegEx>
   </con:configuration>
-</assertion></con:config></con:testStep><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>8d6b38b9-7a09-43d4-8d17-04e6e4e62333</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>5e20ce24-91ec-4af1-b3be-5b881fd2debb</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="7ace7571-b1c5-40a0-b94e-1d2b0188e032" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample code" searchProperties="true"><con:settings/><con:testStep type="websocketPublishTestStep" name="Publish using Websocket" id="e805a2bc-e7db-4adc-9884-6d3f02adb11c"><con:settings/><con:config><ConnectionName>sample code</ConnectionName><Timeout>1000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><MessageKind>IntegerValue</MessageKind><Message>1006</Message></con:config></con:testStep><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="2eecdb9f-4808-4409-a4c2-c53e434cb98a"><con:settings/><con:config><ConnectionName>sample code</ConnectionName><Timeout>1000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>BinaryData</ExpectedMessageType></con:config></con:testStep><con:properties/></con:testCase><con:properties/></con:testSuite><con:properties/><con:wssContainer/><con:oAuth2ProfileContainer/><con:sensitiveInformation/></con:soapui-project>
+</assertion></con:config></con:testStep><con:properties/><con:reportParameters/><con:breakPoints><con:testStepId>8d6b38b9-7a09-43d4-8d17-04e6e4e62333</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints><con:breakPoints><con:testStepId>5e20ce24-91ec-4af1-b3be-5b881fd2debb</con:testStepId><con:status>NONE</con:status><con:properties/></con:breakPoints></con:testCase><con:testCase id="7ace7571-b1c5-40a0-b94e-1d2b0188e032" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="sample code" searchProperties="true"><con:settings/><con:testStep type="websocketPublishTestStep" name="Publish using Websocket" id="e805a2bc-e7db-4adc-9884-6d3f02adb11c"><con:settings/><con:config><ConnectionName>sample code</ConnectionName><Timeout>1000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><MessageKind>IntegerValue</MessageKind><Message>1006</Message></con:config></con:testStep><con:testStep type="WebsocketReceiveTestStep" name="Receive Websocket Message" id="2eecdb9f-4808-4409-a4c2-c53e434cb98a"><con:settings/><con:config><ConnectionName>sample code</ConnectionName><Timeout>1000</Timeout><TimeoutMeasure>Seconds</TimeoutMeasure><ExpectedMessageType>BinaryData</ExpectedMessageType></con:config></con:testStep><con:properties/><con:reportParameters/></con:testCase><con:properties/><con:reportParameters/></con:testSuite><con:properties/><con:wssContainer/><con:databaseConnectionContainer/><con:oAuth2ProfileContainer/><con:reporting><con:xmlTemplates/><con:parameters/></con:reporting><con:sensitiveInformation/><con:authRepository/></con:soapui-project>

ready-websocket-plugin-soapui-project.xml

@@ -16,7 +16,7 @@
 import com.eviware.soapui.support.xml.XmlObjectConfigurationReader;
 
 @PluginTestStep(typeName = "WebsocketDropConnectionTestStep", name = "Drop Websocket Connection",
-        description = "Disconnects from the websocket server", iconPath = "com/smartbear/assets/drop_step.png")
+        description = "Disconnects from the websocket server", iconPath = "com/tsystems/readyapi/plugin/websocket/drop_step.png")
 public class DropConnectionTestStep extends ConnectedTestStep {
     private static final String DROP_METHOD_SETTING_NAME = "DropMethod";
 
@@ -120,11 +120,11 @@ public DropMethod getDropMethod() {
     }
 
     protected void initIcons() {
-        unknownStepIcon = UISupport.createImageIcon("com/smartbear/assets/unknown_drop_step.png");
-        disabledStepIcon = UISupport.createImageIcon("com/smartbear/assets/disabled_drop_step.png");
+        unknownStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/unknown_drop_step.png");
+        disabledStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/disabled_drop_step.png");
 
-        iconAnimator = new IconAnimator<DropConnectionTestStep>(this, "com/smartbear/assets/unknown_drop_step.png",
-                "com/smartbear/assets/drop_step.png", 5);
+        iconAnimator = new IconAnimator<DropConnectionTestStep>(this, "com/tsystems/readyapi/plugin/websocket/unknown_drop_step.png",
+                "com/tsystems/readyapi/plugin/websocket/drop_step.png", 5);
     }
 
     @Override

src/main/java/com/tsystems/readyapi/plugin/websocket/DropConnectionTestStep.java

@@ -21,7 +21,7 @@
 
 @PluginTestStep(typeName = "websocketPublishTestStep", name = "Publish using Websocket",
         description = "Publishes a specified message through websocket protocol.",
-        iconPath = "com/smartbear/assets/publish_step.png")
+        iconPath = "com/tsystems/readyapi/plugin/websocket/publish_step.png")
 public class PublishTestStep extends ConnectedTestStep {
 
     private final static String MESSAGE_KIND_SETTING_NAME = "MessageKind";
@@ -191,11 +191,11 @@ public PublishedMessageType getMessageKind() {
     }
 
     protected void initIcons() {
-        unknownStepIcon = UISupport.createImageIcon("com/smartbear/assets/unknown_publish_step.png");
-        disabledStepIcon = UISupport.createImageIcon("com/smartbear/assets/disabled_publish_step.png");
+        unknownStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/unknown_publish_step.png");
+        disabledStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/disabled_publish_step.png");
 
-        iconAnimator = new IconAnimator<PublishTestStep>(this, "com/smartbear/assets/unknown_publish_step.png",
-                "com/smartbear/assets/publish_step.png", 5);
+        iconAnimator = new IconAnimator<PublishTestStep>(this, "com/tsystems/readyapi/plugin/websocket/unknown_publish_step.png",
+                "com/tsystems/readyapi/plugin/websocket/publish_step.png", 5);
     }
 
     @Override

src/main/java/com/tsystems/readyapi/plugin/websocket/PublishTestStep.java

@@ -54,7 +54,7 @@
 
 @PluginTestStep(typeName = "WebsocketReceiveTestStep", name = "Receive Websocket Message",
         description = "Waits for a Websocket message of a specific topic.",
-        iconPath = "com/smartbear/assets/receive_step.png")
+        iconPath = "com/tsystems/readyapi/plugin/websocket/receive_step.png")
 public class ReceiveTestStep extends ConnectedTestStep implements Assertable {
     private final static Logger LOGGER = Logger.getLogger(PluginConfig.LOGGER_NAME);
 
@@ -408,13 +408,13 @@ private void initAssertions(TestStepConfig testStepData) {
     }
 
     protected void initIcons() {
-        validStepIcon = UISupport.createImageIcon("com/smartbear/assets/valid_receive_step.png");
-        failedStepIcon = UISupport.createImageIcon("com/smartbear/assets/invalid_receive_step.png");
-        unknownStepIcon = UISupport.createImageIcon("com/smartbear/assets/unknown_receive_step.png");
-        disabledStepIcon = UISupport.createImageIcon("com/smartbear/assets/disabled_receive_step.png");
+        validStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/valid_receive_step.png");
+        failedStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/invalid_receive_step.png");
+        unknownStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/unknown_receive_step.png");
+        disabledStepIcon = UISupport.createImageIcon("com/tsystems/readyapi/plugin/websocket/disabled_receive_step.png");
 
-        iconAnimator = new IconAnimator<ReceiveTestStep>(this, "com/smartbear/assets/receive_step_base.png",
-                "com/smartbear/assets/receive_step.png", 5);
+        iconAnimator = new IconAnimator<ReceiveTestStep>(this, "com/tsystems/readyapi/plugin/websocket/receive_step_base.png",
+                "com/tsystems/readyapi/plugin/websocket/receive_step.png", 5);
     }
 
     @Override