Changes

=Usage=

or directory and runs all functions that are annotated with {{Code|%unit:test}}. A test report is

generated and returned, which resembles the format returned by other xUnit testing frameworks,

==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'''

|

declare %unit:test function local:void() { () };

* The following test will be successful, as the function body will raise <code>err:XPTY0004</code>:

declare %unit:test('expected', "err:XPTY0004") function local:add() {

123 + 'strings and integers cannot be added'

};

|}

{| 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'''

|

* The first function will be evaluated before the actual test:

declare %updating %unit:before("local:check") function local:before-check() {

db:create('test-db')

unit:assert(db:exists('test-db'))

};

|}

{| 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%'

| '''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%'

| '''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%'

| '''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.

==Query==

module namespace test = 'http://basex.org/modules/xqunit-tests';

()

};

By running {{Code|TEST tests.xqm}}, the following report will be generated (timings may differ):

==Result==

<testsuites time="PT0.256S">

<testsuite name="file:///C:/Users/user/Desktop/test.xqm" time="PT0.212S" tests="8" failures="4" errors="1" skipped="1">

</testsuite>

</testsuites>

=Errors=

! 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.