add articles about testing #282
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lguariento
requested changes
Jan 2, 2019
| <link xlink:href="xqsuite">XQsuite</link> | ||
| </term> | ||
| <listitem> | ||
| <para>This is an annotation based framework that allows you to add unit tests to XQuery |
| <sect1 xml:id="int-test"> | ||
| <title>Introduction</title> | ||
| <para>Creating an automated mininal testsuite is possible with relatively little effort. It pays to take the need for testing into account when you start developing your | ||
| application. This enables others to extend your program with new features, by knowning that these don't break existing functions. It also allows test only contributions, to |
There was a problem hiding this comment.
Do you mean "test-only contributions", or "to test only contributions"? If it's the first one - in that case adding a "-" between 'test' and 'contributions' will clarify a bit, if it's the second, add 'to' before 'test'.
| <title>Introduction</title> | ||
| <para>Creating an automated mininal testsuite is possible with relatively little effort. It pays to take the need for testing into account when you start developing your | ||
| application. This enables others to extend your program with new features, by knowning that these don't break existing functions. It also allows test only contributions, to | ||
| help you to gradually advance your test coverage. The following section will walk you trough the three main aspects of such a minimal test setup.</para> |
There was a problem hiding this comment.
Replacing 'to help' with 'helping' would make things clearer.
| <para>Before you start designing tests, you should start to automate your build process. This ensures that things don't only work on your system, and it can catch some common | ||
| errors.</para> | ||
| <para>The examples in this article will use <link condition="_blank" xlink:href="https://travis-ci.com">travis-ci</link> as it is the most popular continual integration (ci) | ||
| provider in the exist-db organization on Github, other popuar choices include <link condition="_blank" xlink:href="https://www.appveyor.com">appveyor</link>, <link condition="_blank" xlink:href="https://jenkins.io">jenkins</link>, <link condition="_blank" xlink:href="https://circleci.com">circl-ci</link>, … .</para> |
| <para>The services typically require a small configuration file, so you can build your code on a clean virtual machine, without the risk of local files interfering. For | ||
| travis the required name of such a file is <literal>.travis.yml</literal> and in its simplest form it would look like this:</para> | ||
| <programlisting language="yaml" xlink:href="listings/travis-1.txt"/> | ||
| <para>For the correct way to create such a configuration file for other CI providers please consult their documentation. In all cases, since exist-db is written in Java, your |
There was a problem hiding this comment.
Sometimes 'ci' is upper-case, sometimes lower-case.
| <title>Picking a Type</title> | ||
| <para>Generally speaking, you should follow the sequence provided above. Whatever can be tested as part of your validation tests, is best tested there. When validation testing | ||
| isn't a good fit, go for unit tests, followed by integration and lastly performance tests. The reasons for this are twofold: On the one hand, validation tests tend to be | ||
| faster than unit tests, which in turn are slower then integration tests and performance tests. On the other hand, each type tends to be more easy to configure, with a higher |
| chance of providing you with the information that you need when a test fails.</para> | ||
| <sect2 xml:id="ex-select"> | ||
| <title>Selection Example</title> | ||
| <para>To illustrate this, lets take a theoretical example: imagine your code includes an online form where users submit a date that needs to be stored in the database. For |
| <title>Using native types</title> | ||
| <programlisting language="xquery" xlink:href="listings/valid.txt"/> | ||
| </example> | ||
| <para>To check that your <literal>local:check-input</literal> function is working as expected, you can define a few <emphasis>unit test</emphasis> Typically, such a test |
There was a problem hiding this comment.
unit test. <- add full stop
| <para>To check that your <literal>local:check-input</literal> function is working as expected, you can define a few <emphasis>unit test</emphasis> Typically, such a test | ||
| would include some corner cases like BCE dates, leap years, or dates in foreign date formats, as well as a basic test date that should simply store in the db.</para> | ||
| <example> | ||
| <title>testing corner cases</title> |
| <sect1 xml:id="coverage"> | ||
| <title>Test Coverage</title> | ||
| <para>Ideally, we would always achieve full test coverage for our code. So that every meaningful unit of code has a corresponding set of tests. While other programming | ||
| languages offer automated means of analysing your code to indentify areas that aren't tested, such tools are unfortunately not very common for Xquery. How much testing is necessary for you to ship with confidence, rests on each developer. For apps published under the exist-db namespace, we have outlined a set of minimum requirementes (more is obviously desirable) which are featured in the section on <link condition="_blank" xlink:href="integration-testing">integration testing</link>.</para> |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this is a first draft for a more general article about testing strategies, and a more detailed article about integration testing. All feedback and corrections are welcome.
I'm fully expecting the need for further refinement, hence WIP