Assertion Commands
Common Attributes
The following table lists all attributes the assertion commands have in common. However, keep in mind that particularly the syntax of the element attribute depends on the Data Source Adapter it is used with.
Apart from these common attributes each assertion command might have additional attributes that are specific for a particular Data Source Adapter. If such attributes exist they are documented with the corresponding Data Source Adapter.
| Attribute Name | Description | required/optional |
|---|---|---|
| id | A unique identifier which will also be written to the report. It can be set to any value. Its main purpose is to associate a message in the report to its originating instruction in the instruction set. That allows easy tracking which reported value belongs to which instruction command. | optional |
| label | Sometimes the element's identifier is not quite human readable. In such a case it could be useful to define the label attribute with a name that a human being can understand. The contents of the label attribute is always copied unchanged to the report. | optional |
| element |
The identifier for the element to check or report.
|
required |
| not | If this attribute is set to "true" (or "yes, "on", "1") then the result gets negated. That's a simple way to express that something is expected not to be as specified. | optional |
| optional |
If this attribute is set to "true" (or "yes, "on", "1") then
the check is optional. That is, in case that the element cannot
be found at all then this is not reported as an error or failure.
However, if the element was found the check gets executed as usual and reports a failure if it wasn't successful. |
optional |
| useSlashes |
If this attribute is set to "true" (or "yes, "on", "1") then
all backslashes in the found element's data will be translated
into forward slashes.
The default is "no". |
optional |
Commands
AssertEquals
The purpose of this command is to check whether or not the value
of the specified element is equal to the value
specified in the body this command.
If the element's value is not equal to the specified value then a
failure message (msgid="FAIL0001")
is written to the report.
Attributes
This command supports all the common attributes.
Example
<AssertEquals id="CHECK78" element="MaxConnections">25</AssertEquals>
Description: If the element MaxConnections ist not 25 then an assertion failure message will be written to the report.
<AssertEquals label="Server Name" element="//Config/server[@id='M19']/host/@fqdn">
www.testserver.com
</AssertEquals>
Description: If the element (i.e the server name) that is specified by the XPath expression is not www.testserver.com then an assertion failure message will be written to the report.
AssertLess
The purpose of this command is to check whether or not the value
of the specified element is less than the value
specified in the body of this command.
If the element's value is not less than the specified value then a
failure message (msgid="FAIL0002")
is written to the report.
Attributes
This command supports all the common attributes.
Example
<AssertLess id="L210" label="Limit LDAP search result" element="searchLimit">1000</AssertLess>
Description: If the element SearchLimit ist not less than 1000 then an assertion failure message will be written to the report.
AssertGreater
The purpose of this command is to check whether or not the value
of the specified element is greater than the value
specified in the body of this command.
If the element's value is not greater than the specified value then a
failure message (msgid="FAIL0003")
is written to the report.
Attributes
This command supports all the common attributes.
Example
<AssertGreater id="GR09" element="port">9000</AssertGreater>
Description: If the element port ist not greater than 9000 then an assertion failure message will be written to the report.
<AssertGreater element="Specification-Version">F<AssertGreater>
Description: If the element Specification-Version is not greater than F then an assertion failure message will be written to the report.
AssertLessOrEqual
The purpose of this command is to check whether or not the value
of the specified element is less or equal compared to the value
specified in the body of this command.
If the element's value is not less than or equal to the specified
value then a failure message (msgid="FAIL004")
is written to the report.
Attributes
This command supports all the common attributes.
Example
<AssertLessOrEqual element="logLevel">3</AssertLessOrEqual>
Description: If the element logLevel ist not 3 or less then an assertion failure message will be written to the report.
<AssertLessOrEqual label="Max memory usage" element="memory">1024<AssertLessOrEqual>
Description: If the element memory is not greater than 1024 then an assertion failure message will be written to the report.
AssertGreaterOrEqual
The purpose of this command is to check whether or not the value
of the specified element is greater or equal compared to the value
specified in the body of this command.
If the element's value is not greater than or equal to the specified
value then a failure message (msgid="FAIL005")
is written to the report.
Attributes
This command supports all the common attributes.
Example
<AssertGreaterOrEqual element="open.files">8</AssertGreaterOrEqual>
Description: If the element open.files ist not 8 or greater then an assertion failure message will be written to the report.
<AssertGreaterOrEqual element="//product[@name='tools']/@patch-level">
4
<AssertGreaterOrEqual>
Description: If the element //product[@name='tools']/@patch-level is not greater than 4 then an assertion failure message will be written to the report.
AssertExistence
The purpose of this command is to check whether or not
the specified element exists.
If the element does not exist then a
failure message (msgid="FAIL0006")
is written to the report.
Attributes
This command supports all the common attributes and additionally the following:
| Attribute Name | Description | required/optional |
|---|---|---|
| emptyExists | If this attribute is set to "yes", an existing setting
with an empty value is accepted as existing.
If set to "no", such an empty value will cause a
configuration failure message.
If the attribute is not explicitly set the default value is "yes". |
optional |
Example
<AssertExistence label="proxy module" element="LoadModule[@1='proxy_module']/@2"/>
Description: Asserts that the LoadModule proxy_module with a second parameter exists. If not a failure message is added to the report.
AssertMatch
With this command a value can be checked against a simple pattern.
The pattern can be any string. In such a pattern the characters
'*', '?' and '#'
have specials meanings. The '*' stands for any number and any
character. The '?' represents any single occurance of an
arbitrary character. The '#' represents a single digit (i.e. 0-9).
If the element does not match the pattern then the
failure message (msgid="FAIL0008")
is added to the report.
Attributes
This command supports all the common attributes.
Example
<AssertMatch id="D420" label="Mail address"
element="[cn=jdoe,ou=users,dc=company]/@mail">*.*@*.*</AssertMatch>
Description: If the LDAP element with the distinguished name cn=jdoe,ou=users,dc=company must have an attribute named mail with a typical eMail address value that is matching the pattern *.*@*.*. The value john.doe@company.com will be fine but the value jdoe@company.com will cause an assertion failure message being added to the report.
AssertContains
This command allows to treat the value of elements as a list
of values. It can assert that a particular value is in
such a list. The default separator for the list elements is comma (',').
If the list value does not contain the expected value then the
failure message (msgid="FAIL0009")
is added to the report.
Attributes
This command supports all the common attributes.
Example
<AssertContains id="ABC" label="Italian"
element="supported.languages" case-sensitive="no">it</AssertContains>
Description: If the property supported.languages doesn't contain the value "it" (case insensitive comparison) then a failure message gets reported.
AssertOneOf
This command allows to check if the value of an element
is equal to one of a list of allowed values.
If the element's value is not equal to any of the allowed
values then
failure message (msgid="FAIL0010")
is added to the report.
Attributes
This command supports all the common attributes.
Example
<AssertOneOf label="Language" element="current.language" case-sensitive="no">
<Value>it</Value>
<Value>fr</Value>
<Value>de</Value>
</AssertOneOf>
Description: If the property current.language is not "it" or "fr" or "de" (case insensitive comparison) then a failure message is added to the report.
AssertNewLine
This assertion command is only reasonable within a text file
data source adapter.
It can be used to check the end-of-line characters in
a text file.
If at least one line is terminated by a different one than the
expected the failure message (msgid="FAIL0011")
is added to the report.
Attributes
| Attribute Name | Description | required/optional |
|---|---|---|
| element | The element name for this assertion command must always be EOL (i.e. "End Of Line"). | required |
| value | The value attribute specifies the expected line-end
character(s). Valid values are:
|
required |
Example
<AssertNewLine label="Unix style line end" element="EOL" value="LF"/>
Description: Checks all lines in a file to end with line-feed (LF) character. If any line has different line-end character(s) then the assertion fails.
