Changes

==unit:test==

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:test}}<br/>{{Code|%unit:test("expected", CODE)}}

| '''Summary'''

|With this annotation, a function can be marked as unit test. It will be evaluated if a test report is created for the module in which this function is located.<br/><code>error</code> can be supplied as additional string argument. It is followed by <code>CODE</code>, which must be a valid [[XQuery 3.0#Expanded QNames|EQName]] string. If the function expression does not raise that error, the test will fail.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:before}}<br/>{{Code|%unit:before(FUNCTION)}}

| '''Summary'''

|A function decorated with this annotation will be evaluated '''before each''' unit test as a separate transaction.<br/><code>FUNCTION</code> can be supplied as additional argument. It must be a valid [[XQuery 3.0#Expanded QNames|EQName]] string. If specified, the function will only be evaluated before a function with the given name is tested. This extension is e. g. helpful if the results of updates need to be tested.

| '''Examples'''

|

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:after}}<br/>{{Code|%unit:after(FUNCTION)}}

| '''Summary'''

|A function decorated with this annotation will be evaluated '''after each''' unit test as a separate transaction.<br/><code>FUNCTION</code> can be supplied as additional argument. It must be a valid [[XQuery 3.0#Expanded QNames|EQName]] string. If specified, the function will only be evaluated after a function with the given name is tested.

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:before-module}}

| '''Summary'''

|If a function is decorated with this annotation, it will be evaluated '''before all''' unit tests in the current module as a separate transaction.

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:after-module}}

| '''Summary'''

|If a function is decorated with this annotation, it will be evaluated '''after all''' unit tests in the current module as a separate transaction.

{| width='100%'

| width='120' | '''Syntax'''

|{{Code|%unit:ignore}}<br/>{{Code|%unit:ignore(MESSAGE)}}

| '''Summary'''

|If a function is decorated with this annotation, it will temporarily be ignored by the test suite runner.

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|unit:assert|$test as item()*|empty-sequence()}}<br />{{Func|unit:assert|$test as item()*, $info as item()|empty-sequence()}}<br />

| '''Summary'''

|Asserts that the effective boolean value of the specified {{Code|$test}} is true and returns an empty sequence. Otherwise, raises an error. The ''effective boolean value'' of an expression can be explicitly computed by using the {{Code|fn:boolean}} function.<br/>The default failure message can be overridden with the {{Code|$info}} argument.

| '''Errors'''

|{{Error|fail|#Errors}} the assertion failed, or an error was raised.

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|unit:assert-equals|$returned as item()*, $expected as item()*|empty-sequence()}}<br />{{Func|unit:assert-equals|$returned as item()*, $expected as item()*, $info as item()|empty-sequence()}}<br />

| '''Summary'''

|Asserts that the specified arguments are equal according to the rules of the [https://www.w3.org/TR/xpath-functions-31/#func-deep-equal {{Code|fn:deep-equal}} function]. Otherwise, raises an error.<br/>The default failure message can be overridden with the {{Code|$info}} argument.

| '''Errors'''

|{{Error|fail|#Errors}} the assertion failed, or an error was raised.

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|unit:fail||empty-sequence()}}<br />{{Func|unit:fail|$info as item()|empty-sequence()}}<br />

| '''Summary'''

|Raises a unit error. The default failure message can be overridden with the {{Code|$info}} argument.

| '''Errors'''

|{{Error|fail|#Errors}} default error raised by this function.

! width="110"|Code

|Description

|{{Code|fail}}

|An assertion failed, or an error was raised.

|{{Code|no-args}}

|A test function must have no arguments.

|{{Code|private}}

|A test function must not be private.