Skip to content

Commit 2e836f1

Browse files
authored
Merge pull request #273 from eXist-db/test-name
add info about %test:name to xqsuite article
2 parents 7e26af9 + 6788f13 commit 2e836f1

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

src/main/xar-resources/data/xqsuite/xqsuite.xml

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
55
<info>
66
<title>XQSuite - Annotation-based Test Framework for XQuery</title>
7-
<date>1Q18</date>
7+
<date>4Q18</date>
88
<keywordset>
99
<keyword>application-development</keyword>
1010
<keyword>xquery</keyword>
@@ -163,6 +163,12 @@
163163
external resource.</para>
164164
</listitem>
165165
</varlistentry>
166+
<varlistentry>
167+
<term><code>%test:name</code></term>
168+
<listitem>
169+
<para>Povide a more descriptive name for your test than the XQuery function name, which is the default.</para>
170+
</listitem>
171+
</varlistentry>
166172
<varlistentry>
167173
<term><code>%test:pending</code></term>
168174
<listitem>
@@ -295,14 +301,14 @@
295301
supported by many systems, for instance Jenkins. </para>
296302
<para>For every XQuery module tested, <code>test:suite</code> creates a single <tag>testsuite</tag>
297303
element. The result of each test run is output as a <tag>testcase</tag> element. It will be
298-
empty if the test passed. If the test failed (meaning that the test did not meet its assertions,
304+
empty if the test passed. If the test failed (meaning that the test did not meet its assertions,
299305
or that it raised an <literal>fn:error</literal>), there will be a <tag>failure</tag> element
300306
containing the expected result of the function, and an <tag>output</tag> element with the
301-
actual result. In the case that the test resulted in an unexpected error that is not covered by
302-
<literal>fn:error</literal>, there will be an <tag>error</tag> element with the error type and
303-
message. The <tag>testsuite</tag> element will also contain the timestamp when the tests began,
304-
the duration of the tests, and a count of the number of tests, failed tests, pending tests, and
305-
tests that raised unexpected errors not covered by <literal>fn:error</literal>. Here is a sample
307+
actual result. In the case that the test resulted in an unexpected error that is not covered by
308+
<literal>fn:error</literal>, there will be an <tag>error</tag> element with the error type and
309+
message. The <tag>testsuite</tag> element will also contain the timestamp when the tests began,
310+
the duration of the tests, and a count of the number of tests, failed tests, pending tests, and
311+
tests that raised unexpected errors not covered by <literal>fn:error</literal>. Here is a sample
306312
showing a failed test:</para>
307313
<programlisting language="xml" xlink:href="listings/listing-8.xml"/>
308314
</sect1>

0 commit comments

Comments
 (0)