Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2024.1

...

  1. Go to Parasoft > Preferences and click System Properties.
  2. Click Add JARs and choose the com.parasoft.soavirt.transport.asynchronous.socket-1.01.0.jar file. Once this jar file is added to the SOAtest classpath, all of the required dependencies will be loaded.
  3. Click Apply.
  4. Restart SOAtest.

...

Add the com.parasoft.soavirt.transport.asynchronous.socket-1.01.0.jar file to the system.properties.classpath property in your settings properties file. For example:

system.properties.classpath=<path to jar>/com.parasoft.soavirt.transport.asynchronous.socket-1.01.0.jar 

Once the classpath is modified, all of the required dependencies will be loaded.

...

The asynchronous socket transport is primarily used in Messaging Client tools. The transport is configured in the Messaging Clientmessaging client's Transport tab. Choose it in Asynchronous Socket from the Transport menu , then and configure the available options.

Image RemovedImage Added

Configuration

You can configure the following options.

...

Scroll Table Layout
widths30%,70%

Protocol

Specifies the protocol used to transmit messages. Options are TCP or UDP.

Default: TCP

Host

Specifies the host where the application is running. You can specify a fixed value or programmatically specify the host by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default is localhost 

PortSpecifies the port on the host where the client will send messages. You can specify a fixed value or programmatically specify the port number by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.
Character Set

Specifies the character set used for encoding messages. You can specify a fixed value or programmatically specify the character set by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default is UTF-8 

Read Mode

Specifies how the Specifies the mode for reading messages.

  • Specify fixed for fixed length messages that are always the same size.
  • Specify prefixed for messages that have an int (4 bytes) length prefix at the beginning of the message.
  • Specify prefixed-string for messages with a series of string digits prefixing the message.
  • Specify token for messages that are delimited by an end character or uni code sequence.
  • Specify none to configure the tool to continue immediately without waiting to read the next message from the server.

You can specify a fixed value or programmatically specify the read mode by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default is prefixed 

Fixed Length

Specify the size of the fixed message in the Fixed Length [default: 1024] field field.

For example, if the size of messages is always four bytes, a client might send the following request:

[0, 0, 0, 0] 

The transport would send back a response of the same size, for example:

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Token Delimiter [default: byte "23", End-Of-Transmission-Block]

Specifies the token that delimits messages.

Default is byte "23", End-Of-Transmission-Block 

Token Type [string, hex, byte] [default: hex]

Specifies the type of conversion used to get bytes from the token.

  • Specify string and the transport will use getBytes with the configured character set to convert to bytes.
  • Specify hex and the string will be parsed as a sequence of hexadecimal values. For example, 0a 0d would be the bytes 10 13.
  • Specify byte and the transport will parse the string as a sequence of bytes in decimal values separated by spaces, e.g., 10 13.

Default is hex 

Prefixed Variable-Length (Number)

...

Length of the Length Field

Determines the length of the length field. The desired number of bytes will be read and converted to a number to determine the length of the message. You can specify the following values: 1 , 2 , 3 , 4 , or 8 .

The default is to read 4 bytes and convert it to an integer.

Include Length Field Size in Length 

Indicates if the length read should also include the length field size.

For example, if the option is enabled, a 4-byte message would send a length value of 8. This is because the default length of the length field is 4 bytes and will be added to the message body length. 

Default is true

Format of Static Prefix/Suffix 

Specifies the type of conversion used to convert the static prefix/suffix into bytes.

  • Specify string and the socket will use getBytes with with the configured character set to convert to bytes.
  • Specify hex and the string will be parsed as a sequence of hexadecimal values. For example, 0a 0d would be the bytes 10 13 .
  • Specify byte and the socket will parse the string as a sequence of bytes in decimal values separated by spaces, for example, 10 13 .

Default is : hex 

Static Prefix

Specifies a prefix segment to be added to the message that may be required. If specified, the message format will be <PREFIX_BYTES><LENGTH_FIELD_BYTES><MESSAGE_DATA_BYTES>.

Static Suffix

Specifies a suffix segment to be added to the message that may be required. If specified, the message format will be <LENGTH_FIELD_BYTES><MESSAGE_DATA_BYTES><SUFFIX_BYTES>.

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

String Prefix Length [the number of string digits to read in] [default: 4]Specifies the size of the message length prefix. The number of bytes to read is calculated based on the number of digits converted into bytes. The transport encodes 0 into bytes and multiplies the number by the number provided in this field.
Include Prefix in Length [true, false] [default: true]

Indicates if the length read from the prefix should also include the length of the prefix.

Default is true

SSL

Set SSL Enabled [ default:false ] Enabled to true to listen over SSL. 

...

You can enable the Keep connection alive in order to not miss any messages sent by the server in between tests or Close connection after test execution option so the next test does not pick up old messages.

Testing Asynchronous Messages

Typically, this transport is used in a SOAtest messaging client to send one message as configured in the request tab and then wait to receive one message in response. However, sometimes a server may reply with multiple messages or even none at all. In these asynchronous cases use one or more of the following configurations (as applicable):

  • Send one message without waiting to receive a message from the server in reply by setting the Read Mode to none.
  • Skip sending a message and simply wait to receive the next message from the server by setting the Request tab to Literal, enabling Text, and leaving the text field empty.
  • Enable Keep connection alive in Connection Management to avoid missing any messages sent by the server in between tests.
  • Use Test Suite Flow Logic to loop through reading a dynamic number of messages from the server.

Change Log

1.1

  • Added support for UDP.

1.0

  • Initial release.