standard-for-tests

When converting existing tests (JUnit4/JMock → JUnit5/Mockito), use the convert-tests skill in addition to this one.

When writing a test:

• Follow the test strategy at https://dev.xwiki.org/xwiki/bin/view/Community/Testing/#HTestingStrategy
• When writing unit tests for Java code, follow https://dev.xwiki.org/xwiki/bin/view/Community/Testing/#HJavaUnitTesting
• When writing unit tests for code using XWiki Rendering (like rendering macros), follow https://rendering.xwiki.org/xwiki/bin/view/Main/Extending#HAddingTests
• When writing unit tests for XWiki templates (.vm files) or XWiki pages (.xml files representing a wiki page), follow https://dev.xwiki.org/xwiki/bin/view/Community/Testing/ViewUnitTesting/
• When writing a functional test, follow https://dev.xwiki.org/xwiki/bin/view/Community/Testing/DockerTesting/
• For functional tests, follow the best practices defined at https://dev.xwiki.org/xwiki/bin/view/Community/Testing/#HBestPractices but also at https://dev.xwiki.org/xwiki/bin/view/Community/Testing/DockerTesting/
• For other types of tests, see https://dev.xwiki.org/xwiki/bin/view/Community/Testing/ which has sections for other types
• After writing a test, use Maven to verify that any test written works fine. However, if the test is a functional test, ask before executing Maven since there could be an already running XWiki instance locally on the developer's machine, and the test is supposed to start one too.
• Apply XWiki's general code best practices and code style when writing tests.
• Don't use @OldcoreTest when @ComponentTest is enough.
• Verify if the jacoco coverage threshold cannot be increased after tests have been added, by running maven with -Pquality -Dxwiki.jacoco.instructionRatio=1.00 which should fail but provide the current threshold value that can then be used to replace the current value.

Location of XWiki test frameworks (relative to each repo's checkout):

• Simple and component-based test framework: in the xwiki-commons repo at xwiki-commons-tools/xwiki-commons-tool-test
• Rendering test framework: in the xwiki-rendering repo at xwiki-rendering-test
• Oldcore test framework + docker test framework + page test framework and more: in the xwiki-platform repo at xwiki-platform-core/xwiki-platform-test