Testing - XWiki

There are various types of tests and everyone has its own terminology. You'll find below the XWiki terminology and best practices related to testing.

6

7

Check the [[general development flow>>dev:Community.DevelopmentPractices||anchor="HGeneralDevelopmentFlow"]] to understand better how testing fits in the larger picture.

= Testing Strategy =

Here's the general testing methodology used by the XWiki project:

12

13

* Code committed must have associated automated tests.

14

* There are [[checks in the build>>Community.Building||anchor="HAutomaticChecks"]] (in the ##quality## profile - executed automatically on the CI) to ensure that committed code:

15

** do not reduce the total test coverage for that module

16

* Developers run unit and functional tests on their machines daily and frequently.

17

* Unit and functional tests are executed by the CI, at each commit.

18

* Most automated functional tests are currently running in a single environment (HSQLDB/Jetty/Firefox). However, we've started to use Docked-based testing to test automatically using several configurations and are migrating more and more tests to that. There are jobs in XWiki's CI that execute tests in all configurations regularly (not at each commit though but as much as possible).

19

** Manual tests are also executed at each release by dedicated contributors and they manually execute tests that are not covered by the automated tests.

20

* Performance tests are executed manually several times per year (usually for LTS releases and sometimes for stable releases too).

21

* Responsiveness tests (e.g. verify that XWiki displays fine on a Mobile) are currently executed manually from time to time by dedicated contributors.

22

* Accessibility (WCAG) tests are performed automatically at each commit.

23

* HTML5 validity tests are performed automatically at each commit.

24

25

== Choosing a type of test to write ==

26

27

The strategy is the following:

28

29

* We need at least one functional test for each feature to make sure the feature really works end to end.

30

* We should limit the numer of functional tests we write because:

31

** They're costly to write

32

** They're costly to run (takes a long time to setup the XWiki instance and they're executed on various environments too).

33

** They're costly to maintain (functional tests are more subject to flickers)

34

** You get feedback about a problem much later on. A unit or integration tests will be executed when building that module, all the time, while functional tests will give you results hours later once the CI execute them.

35

* When testing variations for a use case then we must favor writing a unit test or an integration tests since they're less costly to execute and run. This can mean: a java unit test, a Javascript unit test (using Jasmine for example), a Java integration test, a ##PageTest## (to test a wiki page or a template).

36

* Ask yourself first what would be the fastest executing test to write that would prove that the change you're bringing to the code is tested. Imagine you're making a change in some JS file for example; writing a functional test for that would be bad and not ideal because of the points listed above and it would be much better to have a Jasmine-based unit test. One exception is if the general feature where the change is located doesn't currently have a fuctional test and thus writing a functional test would cover the generic use case and incidentally also cover the change (without being specific to that change).

37

38

== Testing Guidelines ==

39

40

* Don't use sensitive information in test data.

= Unit Testing =

== Java Unit Testing ==

45

46

See [[Java Unit Testing>>Community.Testing.JavaUnitTesting.WebHome]]

47

48

== JavaScript Unit Testing ==

49

50

51

The ##jasmine-maven-plugin## we use to run the Javascript test on some module might not work on some distribution, such as Debian buster. A workaround documented as part of https://jira.xwiki.org/browse/XWIKI-17287 is to use {{code}}export OPENSSL_CONF=""{{/code}} to make it work. Also note that we're considering to get rid of Jasmine Maven Plugin in the future since it seems not maintained anymore, you can find information on https://jira.xwiki.org/browse/XWIKI-19316.

52

53

54

* These are **tests that do not rely on the DOM**, written as "behavioral specifications", using the [[Jasmine>>https://jasmine.github.io/]] test framework. You can find some information how to write such tests on [[the frontend resources>>xwiki:Documentation.DevGuide.FrontendResources.IntegratingJavaScriptLibraries||anchor="HWhatisJasmine3F"]].

55

* In development mode, you can start the test runner process by running {{code language="shell"}}mvn jasmine:bdd{{/code}} in your command line. This will start a test runner at ##http:~/~/localhost:8234##, that will run all tests in the ##src/test/javascript## directory. Write your tests there and hit refresh to see the results directly in your browser.

56

* For tests that need a DOM, see [[Functional Testing>>||anchor="HFunctionalTesting"]]

57

58

== Java Rendering Testing ==

59

60

We have a special framework for making it easy to write Rendering tests, see the [[Rendering Testing Framework>>rendering:Main.Extending||anchor="HAddingTests"]]

61

62

== View Unit Testing ==

63

64

See [[View Unit Testing>>Community.Testing.ViewUnitTesting.WebHome]]

65

66

= Functional Testing =

67

68

A functional test requires a running XWiki instance.

69

70

== Functional UI Testing ==

71

72

We now have 3 frameworks for running GUI tests:

73

74

* One based on Docker (and using Selenium 3+). This is now the recommended framework to use for new tests.

75

* One based on Selenium3/Webdriver which is now deprecated and shouldn't be used. We encourage committers to port tests written for it to Docker tests. Especially when committers bring modification to the old tests we encourage them to rewrite the tests as new Docker tests.

76

* A last one based on Selenium1 which is also deprecated and shouldn't be used. We encourage committers to port tests written for it to Docker tests. Especially when committers bring modification to the old tests we encourage them to rewrite the tests as new Docker tests.

=== Docker-based Testing ===

81

82

This is currently the official way to write UI functional tests.

83

84

See [[DockerTesting]].

85

86

=== Legacy Frameworks ===

87

88

In the history of XWiki's development we have built different frameworks to perform functionl tests and we still haven't finished migrating them to the newer frameworks. This is an ongoing process. When fully done, these instructions should be removed.

89

90

==== Selenium-based Framework ====

Using:

* Uses [[Selenium3>>https://www.selenium.dev/]]

95

* To debug a test simply start XWiki somewhere and then debug your JUnit tests as a normal JUnit test in your IDE.

96

** Note that functional test Maven modules will create an XWiki instance in ##target/xwiki## thanks to the execution of the XWiki Packager plugin, so it's simpler to start this XWiki instance when debugging.

97

* In order to debug more easily flickering tests you can simply add the {{{@Intermittent}}} annotation on your test method and it'll be executed 100 times in a row (you can also specify {{{@Intermittent(repetition=N)}}}to repeat it N times). This is achieved thanks to the [[Tempus Fugit>>http://tempusfugitlibrary.org/documentation/junit/intermittent/]] framework that we've integrated.

98

* To run a specific test, pass the ##pattern## property (it's a regex on the test class name) as in: ##mvn install -Dpattern="TestClass#testName"## (this will run the ##testName## test from ##TestClass##)

99

** More details on the usage of the ##pattern## property and examples can be found in the [[documentation of the XWikiExecutorTestMethodFilter class>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-integration/src/main/java/org/xwiki/test/integration/XWikiExecutorTestMethodFilter.java#L25]].

100

* To run the tests on your own running instance (instead of letting Maven close your instance and start a fresh one), use ##-Dxwiki.test.verifyRunningXWikiAtStart=true##. It could be useful to verify that you have not broken the tests on your instance before committing your changes.

101

* By default the Firefox browser will be used but if you wish to run with another browser just pass the ##browser## parameter as in:

102

** Firefox (default): ##-Dbrowser=*firefox##

103

** Internet Explorer: ##-Dbrowser=*iexplore##

104

** Chrome: ##-Dbrowser=*chrome##

105

** PhantomJS: ##-Dbrowser=*phantomjs##

106

* In case of compatibility problem between the version of the browser and the version of Selenium, you can specify which install of firefox to use thanks to ##-Dwebdriver.firefox.bin##. For example, we use to need Firefox 32 in the past, you could install it locally and refer to it with ##-Dwebdriver.firefox.bin="/path/to/your/firefox-32.0"##.

107

* We check for pages that require Programming Rights automatically by bundling a Listener component that listens to the ##ScriptEvaluatingEvent## event and that drops Programming Rights, in an effort to make the tests fail and so that the developer can notice he requires PR and fix that. In some cases where it's necessary, this can be disabled by setting the configuration {{code language="xml"}}< testProgrammingRights>false</testProgrammingRights>{{/code}} in the configuration of the Package Mojo, and/or by using a System Property to control where the check is performed, e.g. {{code language="xml"}}<xwikiPropertiesAdditionalProperties>test.prchecker.excludePattern=.*:XWiki\.XWikiPreferences</xwikiPropertiesAdditionalProperties>{{/code}}. {{info}}Since XWiki 9.8RC1{{/info}}

108

* If the ##xwiki.test.startXWiki## system property is set to ##true## then the test itself will start/stop XWiki. If set to ##false## then it's then the responsibility of the build to start/stop XWiki. Useful when starting.stopping XWiki inside a Docker container handled by the Maven build for example. {{info}}Since XWiki 10.0{{/info}}

109

110

===== Best practices =====

111

112

* Tests are located in ##xwiki-platform## inside the module that they are testing. Note that in the past we were putting functional tests in ##[[xwiki-platform-distribution/xwiki-platform-distribution-flavor/xwiki-platform-distribution-flavor-test>>https://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-distribution/xwiki-platform-distribution-flavor/xwiki-platform-distribution-flavor-test]]## but we have started to move them inside the specific modules they are testing.

113

* Name the tests using ##<prefix>IT.java##.

114

* Use a ##AllIT.java## test suite to ensure that XWiki is started/stopped only once for all tests in the module:(((

115

116

@RunWith(PageObjectSuite.class)

public class AllIT

{

}

)))

* Use the ##maven-failsafe-plugin## for functional UI tests:(((

123

124

125

<groupId>org.apache.maven.plugins</groupId>

126

<artifactId>maven-failsafe-plugin</artifactId>

</plugin>

)))

* Locate tests in ##src/test/java## (i.e the default maven location for tests)

131

* Tests should be written using the Page Objects Pattern:

132

** [[Original article from Simon Steward>>https://code.google.com/p/selenium/wiki/PageObjects]]

133

** [[Article from Martin Fowler>>http://martinfowler.com/bliki/PageObject.html]]

134

* (((

135

Since functional tests take a long time to execute (XWiki to start, Browser to start, navigation, etc) it's important to write tests that execute as fast as possible. Here are some tips:

136

137

* Write scenarios (i.e. write only a few test methods, even only one if you can so that you can have a single fixture) instead of a lot of individual tests as you'd do for unit tests.

138

* (((

139

Use ##getUtil()## to perform quick actions that are not part of what you wish to test (i.e that are part of the test fixture). For example to create a page you need in your fixture, write:

(((

getUtil().createPage(...);

)))

instead of

(((

WikiEditPage wep = new WikiEditPage();

152

wep.switchToEdit(SPACE_NAME, DOC_NAME);

153

wep.setTitle(DOC_TITLE);

154

wep.setContent(CONTENT);

155

ViewPage vp = wep.clickSaveAndView();

)))

)))

* Your Maven module for test may depend on a specific profile (as a best practice, you can use ##integration-tests##). Doing this, it will be built only when specifically asked with ##-Pintegration-tests## (see below for an example of the ##pom.xml##)(((

<id>integration-tests</id>

164

165

<module>application-task-test</module>

</modules>

</profile>

</profiles>

)))

)))

* {{warning}}Never, ever, wait on a timer!{{/warning}} Instead wait on elements.

173

* If you need to create, update or delete a page during your tests, use a space name specific to your test scenario with ##getTestClassName()##. For example:(((

174

175

getUtil().createPage(getTestClassName(), "Page", "Content", "Title");

176

177

)))

178

* Tests must not depend on one another. In other words, it should be possible to execute tests in any order and running only one test class should work fine.

179

* Tests that need to change existing configuration (e.g. change the default language, set specific rights, etc) must put back the configuration as it was. This is true only in flavor tests or when several functional tests of different domains are executed one after another. However functional tests located in xwiki-platform specific modules are only running the tests for their module and thus it's not important, and saves times, if they don't clean up.

180

* Tests are allowed to create new documents and don't need to remove them at the end of the test.

181

* Stdout/stderr validation errors(((

182

We have a [[check>>Community.Building.WebHome||anchor="HAutomaticChecks"]] that verifies if functional tests output some invalid content to stdout/stderr. If your test contains such errors it'll fail and then you have 3 options:

183

184

* It's a normal and expected output from the test (for ex the test verifies an error condition and it's expected it will raise a stack trace in the console). In this case add an expectation in the test. For example:(((

185

186

public class TemplateTest extends AbstractTest

187

{

188

public void wrongTemplate()

189

{

190

...

191

this.validateConsole.getLogCaptureConfiguration().registerExpected( "Possible break-in attempt!",

192

"Error getting resource [null]");

}

...

)))

* It's a non-expected error. You then have 2 sub-choices:

198

** Fix the problem (the best and recommended solution!)

199

** Increase the technical debt by adding an exclude. For example:(((

200

201

this.validateConsole.getLogCaptureConfiguration().registerExcludes(

202

"java.lang.IllegalStateException: Response is committed");

)))

)))

Examples of functional tests:

208

209

* {{scm path="xwiki-platform-core/xwiki-platform-activeinstalls/xwiki-platform-activeinstalls-test"}}Active Installs Application Functional Tests{{/scm}}

210

* {{scm path="xwiki-platform-core/xwiki-platform-administration/xwiki-platform-administration-test"}}Administration Application Functional Tests{{/scm}}

211

* {{scm user="xwiki-contrib" project="application-faq"}}FAQ Application Functional Tests{{/scm}}

212

* {{scm path="xwiki-platform-core/xwiki-platform-ircbot/xwiki-platform-ircbot-test"}}IRCBot Application Functional Tests{{/scm}}

213

* {{scm path="xwiki-platform-core/xwiki-platform-linkchecker/xwiki-platform-linkchecker-test"}}Link Checker Application Functional Tests{{/scm}}

214

* {{scm path="xwiki-platform-core/xwiki-platform-panels/xwiki-platform-panels-test"}}Panels Application Functional Tests{{/scm}}

215

216

===== Troubleshooting =====

217

218

* If you get an error of the type ###java.net.ConnectException: Failed to connect to localhost/0:0:0:0:0:0:0:1:21684#, try removing the ##WebDriverManager## cache directory at ##/.cache/selenium## and retry.##

219

220

==== Selenium1-based Framework ====

221

222

* We were using Selenium RC to perform functional tests for GUI. We had created some JUnit extension to easily write Selenium tests in Java.

223

** Existing tests can be found in ##[[xwiki-enteprise/xwiki-enterprise-test/xwiki-enterprise-test-selenium>>https://github.com/xwiki/xwiki-enterprise/tree/master/xwiki-enterprise-test/xwiki-enterprise-test-selenium]]##

224

* To run these tests on your local machine go to ##xwiki-enteprise/xwiki-enterprise-test/xwiki-enterprise-test-selenium## and type ##mvn install##.

225

* To run a specific test, pass the ##pattern## property as in: ##mvn install -Dpattern=DeletePageTest## (this will run the ##DeletePageTest## - Note that you don't have to specify the extension). In addition if you wish to execute only a specific method from a Test Case class, you can pass the ##patternMethod## property as in: ##mvn install -Dpattern=DeletePageTest -DpatternMethod=testDeletePageCanDoRedirect##.

226

* To enable debug output from the selenium server start maven with the ##-Ddebug=true## switch and then all messages from the selenium server are saved to: ##xwiki-enteprise/xwiki-enterprise-test/xwiki-enterprise-test-selenium/target/selenium/server.log##.

227

* To debug a functional Selenium test in your favourite Java IDE go in ##xwiki-enteprise/xwiki-enterprise-test/xwiki-enterprise-test-selenium## and run maven with ##-Dmaven.surefire.debug##. Maven will wait till you connect your IDE to the running JVM on port 5005. You can put a breakpoint in your IDE and debug the test.

228

229

==== Browser version ====

230

231

The legacy frameworks only supported testing with one version of the ##Firefox## browser.

232

233

* The ##Selenium 2## version used is ##2.44.0##

234

** (valid for 18.March.2015. Actual version used can be verified [[here>>https://github.com/xwiki/xwiki-commons/blob/master/pom.xml]] under the ##selenium.version## property)

235

* The ##Firefox## version we use in you continuous integration agents can be [[found in our docker build image>>https://github.com/xwiki/xwiki-docker-build/blob/master/build/Dockerfile#L55]].

236

** To determine browser compatibility with the Selenium version used, scan [[Selenium's changelog>>https://code.google.com/p/selenium/source/browse/java/CHANGELOG]] and look for entries like "* Updating Native events to support Firefox 24, 31, 32 and 33". That shows the supported browser version for the particular Selenium version.

237

238

If you wish to run tests with the exact configuration as XWiki's [[Continous Integration server>>http://ci.xwiki.org]] uses, you should use the [[XWiki Build Docker Image>>Community.Building.WebHome||anchor="HBuildingwithDocker"]]. This will get you the correct Firefox version pre-installed.

239

240

If you wish to do that manually without Docker then you have to:

241

242

1. [[Download>>https://ftp.mozilla.org/pub/mozilla.org/firefox/releases/]] the corresponding Firefox release

243

1. Unzip it locally

244

1. Use the ##webdriver.firefox.bin## java system property to specify the location of your firefox version

245

11. Depending on how you are starting the functional tests, you`d have to either add the system property in your maven build (surefire plugin configuration) or in your IDE (run configuration)

246

11. Read [[Selenium's FirefoxDriver documentation>>https://code.google.com/p/selenium/wiki/FirefoxDriver]] for more information and options

247

248

==== Adding a new maven dependency for minimal war ====

249

250

All our functional testing are linked to the build of a custom instance of XWiki based on the dependencies contained in the pom.xml of the test.

251

However, those dependencies are added to a minimal war that is built using dependencies located on different places dependending if it is a docker test, or an older functional test.

252

253

So when a new Maven dependency is added for all distributions, it should be declared in three places:

254

255

* in ##xwiki-platform-minimaldependencies/pom.xml##: this will allow the dependency to be retrieved for both docker tests, and for the standard distribution

256

* in ##xwiki-tools-packager-plugin##, in both ##pom.xml## and ##PackageMojo.java##: those are used for older functional tests.

== IDE Support ==

Functional tests are JUnit tests like unit tests. Thus you can execute them from within your IDE. However we usually have them enabled only when the [[##integration-tests## and ##docker## Maven profiles>>Community.Building.WebHome||anchor="HUsingProfiles"]] are enabled so make sure to enable these profiles in your IDE.

261

262

For example with IntelliJ IDEA:

263

264

{{image reference="intellijideafunctionaltest.png" width="650px"/}}

== Maven ==

* You can automatically start the XWiki instances in debug mode (i.e. the XWiki JVM will be configured to wait for a client to connect to the debugging port), by passing the ##-Ddebug=true## system property ,as in:(((

269

270

mvn clean verify -Ddebug=true

271

272

273

See the [[Remote Debugging page>>Community.Debugging||anchor="HRemoteDebugging"]] for more details.

274

)))

275

* You can control the XWiki start timeout from the command line with the ##xwikiExecutionStartTimeout## system property, for example:(((

276

277

mvn clean verify -Ddebug=true -Dpattern=.*documentModifiedCacheSync.* -DxwikiExecutionStartTimeout=1200

)))

= XHTML, CSS & WCAG Validations =

282

283

* We are using JUnit to validate that all XWiki pages produce valid XHTML 5 content.

284

https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-distribution/xwiki-platform-distribution-flavor/xwiki-platform-distribution-flavor-test/xwiki-platform-distribution-flavor-test-webstandards/src/test/it/org/xwiki/test/webstandards/AllTests.java

285

** Existing tests can be found in {{scm path="xwiki-platform-distribution/xwiki-platform-distribution-flavor/xwiki-platform-distribution-flavor-test/xwiki-platform-distribution-flavor-test-webstandards"}}##xwiki-platform-distribution-flavor-test-webstandards##{{/scm}}

286

* [[WCAG Testing Strategy>>WCAGTesting]]

287

* RSS validation is also done in {{scm path="xwiki-platform-distribution/xwiki-platform-distribution-flavor/xwiki-platform-distribution-flavor-test/xwiki-platform-distribution-flavor-test-webstandards"}}##xwiki-platform-distribution-flavor-test-webstandards##{{/scm}}

288

* CSS validation must be verified manually using the [[W3C validator>>http://jigsaw.w3.org/css-validator/]]. See [[XHTML & CSS Coding Style>>XhtmlCssCodeStyle]].

289

290

= Performance Testing =

291

292

* These are memory leakage tests, load tests and speed of execution tests.

293

* They are performed manually and in an ad hoc fashion for now. They are executed for some stable versions and for all super stable versions.

294

* See [[Methodology and reports>>test:Performances.WebHome]].

295

296

See the [[Profiling topic>>Profiling]] for details on how to use a profiler for detecting performance issues.

= Manual testing =

Here's the spirit we'd like to have from the XWiki Manual Testing Team: [[The Black Team>>http://www.t3.org/tangledwebs/07/tw0706.html]].

302

303

304

Besides automated testing, ensuring software quality requires that features be tested by actual users (see [[Manual testing>>http://en.wikipedia.org/wiki/Manual_testing]]). In order to manage manual testing, a [[test plan>>http://en.wikipedia.org/wiki/Test_plan]] is required.

305

306

* [[Manual test reports>>test:Main.WebHome]]

307

* [[Manual Test Strategy>>ManualTestStrategy]]

308

* [[Manual Test Reports>>xwiki:TestReports.WebHome]]

= Tools Reference =