Behaviour changes from ament_tools (#16)

* Document retest-until-fail change * Include change of ament_python test results * fix junit case * add junit to wordlist * add rational as well as advantage of different behavior * clarify that buildspace is the package specific build directory * wording fixup
colcon · May 31, 2018 · 67dcadf · 67dcadf
1 parent 455b739
commit 67dcadf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/migration/ament_tools.rst b/migration/ament_tools.rst
@@ -86,3 +86,12 @@ ament test_results
 
 ``--verbose``
   ``--all``
+
+Behavioral changes
+------------------
+
+``--retest-until-fail`` with ``colcon`` uses `pytest-repeat <https://github.com/pytest-dev/pytest-repeat>`_ which runs individual tests of a package N times each (the first test N times, then the second test N times, etc).
+With ``ament_tools`` the entire test suite of a package was run up to N times.
+As a consequence ``colcon`` provides a more accurate result since each test that passed has actually run N times.
+
+The location of JUnit test results file for ``ament_python`` packages tested with ``colcon`` is in ``<pkg-build>/pytest.xml``, whereas with ``ament_tools`` it is in ``<pkg-build>/test_results/<pkgname>/pytest.xunit.xml``.
diff --git a/spelling_wordlist.txt b/spelling_wordlist.txt
@@ -7,6 +7,7 @@ CTest
 devel
 discoverability
 internet
+JUnit
 linters
 macOS
 metadata