mq-check

Verifies that specified messages exist in queue

Overview

e:mq-send

<e:mq-check name="someQueue">
    <e:message>{"msg" : "1"}</e:message>
    <e:message from="/data/mq/msg2.json"/>
</e:mq-check>

Usage

1. Configure a map of queue aliases to MqTester implementations via MqPlugin.

2. Use e:mq-send tag in specification:

<e:mq-check name="someQueue">
    <e:message>{"msg" : "1"}</e:message>
    <e:message from="/data/mq/msg2.json"/>
</e:mq-check>

Attributes

name="myQueue"

from="/data/file.json"

vars="var1=1, var2={{now}}, var3=' preserved spaces string '"

varsSeparator="|"

headers="type=String, contentEncoding=UTF-8"

contains="EXACT_IN_ANY_ORDER"

verifyAs="xml"

jsonUnitOptions="IGNORING_EXTRA_FIELDS"

layout="horizontally"

collapsable="true"

awaitAtMostSec="4"

awaitPollDelayMillis="1000"

awaitPollIntervalMillis="500"

Examples

Verify single message

Specifying message in tag body

To verify single message short form of the command may be used: expected message template may be specified without nested e:message tag.

<e:mq-check name="myQueue">{"date" : "{{now 'yyyy-MM-dd'}}"}</e:mq-check>

Specifying message in file

Expected message template could be specified in file via from attribute. The vars attribute could be used to conveniently provide context variables for message template.

{
  "date": "{{now 'yyyy-MM-dd'}}",
  "var1": "{{myVar1}}",
  "var2": "{{myVar2}}",
  "var3": "{{myVar3}}"
}

<e:mq-check name="myQueue" from="/specs/mq/check/msg.json" vars="myVar1={{now 'yyyy-MM-dd'}} | myVar2={{date myVar1 minus='1 d'}} | myVar3=str with commas , signs" varsSeparator="|"/>

Verify empty queue

To verify that queue is empty the e:check command with empty tag body could be used.

<e:mq-check name="myQueue"/>

Overriding verification configuration for specific check

To override global JsonUnit configuration for specific check the jsonUnitOptions attribute could be used.

<e:mq-check name="myQueue" verifyAs="jsonIgnoreExtraFields"> { "param1": "1", "arr": [{ "param3": "3" }, { "param4": "4"}] } </e:mq-check>

Verifying message list

Overview

Expected message list may be specified via nestede:message tags. Each message template may be specified either as e:message tag body or in a file via from attribute. The vars attribute could be used to conveniently provide context variables for message template.

<e:mq-check name="myQueue">
  <e:message>{"msg" : "1"}</e:message>
  <e:message from="/specs/mq/check/msg.json" vars="myVar1={{now 'yyyy-MM-dd'}} | myVar2={{date myVar1 minus='1 d'}} | myVar3=str with commas , signs" varsSeparator="|"/>
  <e:message>{"msg" : "3"}</e:message>
</e:mq-check>

Message order

contains attribute could be used to specify message order restriction.

By default e:mq-checkcommand waits until exact specified message list will appear in a queue in exact provided order. To ignore order set contains="EXACT_IN_ANY_ORDER".

<e:mq-check name="myQueue" contains="EXACT_IN_ANY_ORDER">
  <e:message>{"msg" : "3"}</e:message>
  <e:message>{"msg" : "2"}</e:message>
  <e:message>{"msg" : "1"}</e:message>
</e:mq-check>

Verifying message headers

The headers attribute could be used for message headers verification. Extracting actual headers from the message is the MqTester implementation responsibility.

<e:mq-check name="myQueue" headers="id={{id}}, contentEncoding=UTF-8">{}</e:mq-check>

In case of message list verifying the headers attribute may be applicable to e:message tag.

<e:mq-check name="myQueue">
  <e:message headers="id=1, date={{ignore}}">{}</e:message>
  <e:message headers="id=2, date={{after (today)}}">{}</e:message>
</e:mq-check>

Verifying different message formats

An implementation of io.github.adven27.concordion.extensions.exam.core.ContentVerifier interface is responsible for actual message body verifying. There are following built-in implementation:

ContentVerifier.Json

Enabled by default or by verifyAs="json"

Uses JsonAssert.assertJsonEquals for verification.

ContentVerifier.Xml

Enabled by verifyAs="xml".

Uses DiffBuilder.compare for verification.

ContentVerifier.Default

Fallback verifier. Enabled if no verifier are found for specified verifyAs attribute.

Uses jUnit Assert.assertEquals for verification.

Additional verifier implementations may be provided by addContentVerifiers parameter of MqPlugin constructor.

<e:mq-check name="myQueue" from="/data/mq/some.xml" verifyAs="xml"/>

<e:mq-check name="myQueue">
  <e:message from="/data/mq/some.txt" verifyAs="customFormat"/>
</e:mq-check>

<e:mq-check name="myQueue">
  <e:message from="/data/mq/some.xml" verifyAs="xml"/>
  <e:message from="/data/mq/some.txt" verifyAs="customFormat"/>
</e:mq-check>

Pretty-printing

Collapsable view

Big messages may be collapsed in report via the collapsable attribute.

<e:mq-check name="myQueue" from="/data/mq/big.json" collapsable="true"/>

Layout

Layout of the message list in report may be changed via the layout attribute.

<e:mq-check name="myQueue" collapsable="true" layout="horizontally">
  <e:message from="/data/mq/big.json"/>
  <e:message from="/data/mq/big.json"/>
</e:mq-check>

More

• How do check failures look like?