3 A plugin for [WebdriverIO](http://webdriver.io/) providing utilities to simplify testing of MediaWiki features.
9 The `Page` class is a base class for following the [Page Objects Pattern](http://webdriver.io/guide/testrunner/pageobjects.html).
11 * `openTitle( title [, Object query [, string fragment ] ] )`
13 The convention is for implementations to extend this class and provide an `open()` method
14 that calls `super.openTitle()`, as well as add various getters for elements on the page.
16 See [BlankPage](./BlankPage.js) and [specs/BlankPage](./specs/BlankPage.js) for an example.
20 Utilities to interact with the MediaWiki API. Uses the [mwbot](https://github.com/Fannon/mwbot) library.
22 Actions are performed logged-in using `browser.options.username` and `browser.options.password`,
23 which typically come from `MEDIAWIKI_USER` and `MEDIAWIKI_PASSWORD` environment variables.
25 * `edit(title, content [, string username [, string password [, string baseUrl ] ] ])`
26 * `delete(title, reason)`
27 * `createAccount(username, password)`
28 * `blockUser(username, expiry)`
29 * `unblockUser(username)`
33 Use the static `RunJobs.run()` method to ensure that any queued jobs are executed before
34 making assertions that depend on its outcome.
38 `Util` is a collection of popular utility methods.
40 * `getTestString([ string prefix ])`
41 * `waitForModuleState(string moduleName [, string moduleStatus [, number timeout ] ])`
45 This package follows [Semantic Versioning guidelines](https://semver.org/) for its releases. In
46 particular, its major version must be bumped when compatibility is removed for a previous of
49 It is the expectation that this module will only support a single version of MediaWiki at any
50 given time, and that tests in older branches of MediaWiki-related projects naturally use the older
51 release line of this package.
53 In order to allow for smooth and decentralised upgrades, it is recommended that the only type of
54 breaking change made to this package is a change that removes something. Thus, in order to change
55 something, it must either be backwards-compatible, or must be introduced as a new method that
56 co-exists with its deprecated equivalent for at least one release.
60 Please report issues to [Phabricator](https://phabricator.wikimedia.org/tag/mediawiki-core-tests/).
64 This module is maintained in the MediaWiki core repository and published from there as a
65 package to npmjs.org. To simplify development and to ensure changes are verified
66 automatically, MediaWiki core itself uses this module directly from the working copy
67 using [npm Local Paths](https://docs.npmjs.com/files/package.json#local-paths).