Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/tests/selenium/README.md

74 lines
2.2 KiB
Markdown
Raw Normal View History

Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
# Selenium tests
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
## Getting started
selenium: Fix and update links in comments and documentation Bug: T324766 Change-Id: If62835494fe7dd47fc4f18b881783570340cb5a9
2024-02-15 13:46:21 +00:00
See <https://www.mediawiki.org/wiki/Selenium> for how to best
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
run these locally. Below the internal prerequisites are documented,
but you might not need to install these yourself.
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
## Prerequisites
selenium: Fix and update links in comments and documentation Bug: T324766 Change-Id: If62835494fe7dd47fc4f18b881783570340cb5a9
2024-02-15 13:46:21 +00:00
- [Chromium](https://www.chromium.org/Home) or [Chrome](https://www.google.com/chrome)
- [Node.js](https://nodejs.org)
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
## Usage
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
There are three supported modes of running the tests.
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
#### Headless
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
The Selenium tests default to headless mode, unless a `DISPLAY` environment variable is set.
This variable may be set on Linux desktop and XQuartz environments. To run headless there,
unset the `DISPLAY` environment variable first.
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
npm run selenium-test
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
Or:
Selenium: record video of every test In addition to two existing modes (headless and visible), this patch introcues another mode, headless recording. If DISPLAY environment variable is not set, Chrome will run in it's built-in headless mode. If it is set, and the value starts with colon (`:`), Chrome will run in headless mode using Xvfb and record video of every test using FFmpeg. If the value does not start with colon, Chrome will be visible. Bug: T179188 Change-Id: Ic1723c5f2d57a28201caf6ba7056cb73fb74a957
2018-03-30 16:42:04 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
DISPLAY= npm run selenium-test
Selenium: record video of every test In addition to two existing modes (headless and visible), this patch introcues another mode, headless recording. If DISPLAY environment variable is not set, Chrome will run in it's built-in headless mode. If it is set, and the value starts with colon (`:`), Chrome will run in headless mode using Xvfb and record video of every test using FFmpeg. If the value does not start with colon, Chrome will be visible. Bug: T179188 Change-Id: Ic1723c5f2d57a28201caf6ba7056cb73fb74a957
2018-03-30 16:42:04 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
### Visible browser
Selenium: record video of every test In addition to two existing modes (headless and visible), this patch introcues another mode, headless recording. If DISPLAY environment variable is not set, Chrome will run in it's built-in headless mode. If it is set, and the value starts with colon (`:`), Chrome will run in headless mode using Xvfb and record video of every test using FFmpeg. If the value does not start with colon, Chrome will be visible. Bug: T179188 Change-Id: Ic1723c5f2d57a28201caf6ba7056cb73fb74a957
2018-03-30 16:42:04 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
To see the browser window, ensure the `DISPLAY` variable is set. On Linux desktop and in XQuartz
environments this is probably set already. On macOS, set it to a dummy value like `1`.
WebdriverIO should be able to run Chrome headlessly Chrome 59 introduced an headless mode, in this mode it does not need any DISPLAY (Xorg, Xvfb...). That achieved by passing to chrome: --headless Use headless when DISPLAY is not available. One can switch to headless by simply unsetting the environment variable: unset(DISPLAY). Bug: T167507 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Id5424eafb20112fd74d472b8cef02cb15cafff89
2017-06-09 13:40:31 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
DISPLAY=1 npm run selenium-test
WebdriverIO should be able to run Chrome headlessly Chrome 59 introduced an headless mode, in this mode it does not need any DISPLAY (Xorg, Xvfb...). That achieved by passing to chrome: --headless Use headless when DISPLAY is not available. One can switch to headless by simply unsetting the environment variable: unset(DISPLAY). Bug: T167507 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Id5424eafb20112fd74d472b8cef02cb15cafff89
2017-06-09 13:40:31 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
### Video recording
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
selenium: Record videos using Xvfb+ffmpeg Unil 2020-06-15 we were using Xvfb+ffmpeg to record videos. In eed975d we have switched to wdio-video-reporter npm package. It has never worked very well. It does not really record videos. It creates screenshots and creates videos from them. It does not record modal popups. Sometimes, it doesn't create a video for a test at all. I think it's time to switch back to Xvfb+ffmpeg. It has worked well. The reason we moved to wdio-video-reporter was that it worked on all platforms. That's not really important any more, since Xvfb+ffmpeg works in a Fresh container. Bug: T253113 Change-Id: I221775208576b6496f682ceefd6e6334db488bd4
2021-05-06 17:54:28 +00:00
To capture a video, the tests have to run in the context of an X11 server, with the `DISPLAY`
environment variable set to its display name. If the shell has no X11 server or if you want
to hide the output, you can also launch a virtual X11 display using Xvfb. Recording videos
is currently supported only on Linux, and is triggered by the `DISPLAY` value starting with
a colon (as Xvfb typically would).
Example test run in [Fresh](https://gerrit.wikimedia.org/g/fresh).
fresh-node -env -net
export DISPLAY=:1
Revert "selenium: Default to larger window size" This reverts commit 6548e0b934317c815e7ddee60a5947d83a498e2d. Reason for revert: This commit breaks video recording in CI. Bug: T317879 Bug: T314115 Change-Id: I0fbd9ab9737a5c4f83c2a913aaaa60408f90c514
2022-10-25 12:50:38 +00:00
Xvfb "$DISPLAY" -screen 0 1280x1024x24 &
selenium: Record videos using Xvfb+ffmpeg Unil 2020-06-15 we were using Xvfb+ffmpeg to record videos. In eed975d we have switched to wdio-video-reporter npm package. It has never worked very well. It does not really record videos. It creates screenshots and creates videos from them. It does not record modal popups. Sometimes, it doesn't create a video for a test at all. I think it's time to switch back to Xvfb+ffmpeg. It has worked well. The reason we moved to wdio-video-reporter was that it worked on all platforms. That's not really important any more, since Xvfb+ffmpeg works in a Fresh container. Bug: T253113 Change-Id: I221775208576b6496f682ceefd6e6334db488bd4
2021-05-06 17:54:28 +00:00
npm run selenium-test
Selenium README note about --url-base on Windows For me /wd/hub doesnt work and wd/hub must be used Change-Id: Ic61d516b53c95b0d1351bcda7308870f5fc5171c
2018-01-13 11:52:26 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
## Filter
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
Run a specific spec:
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
npm run selenium-test -- --spec tests/selenium/specs/page.js
Document how to run just one Selenium test Bug: T139740 Change-Id: Ieb5f27285046c33d77b615159dc2000d80ef644a
2017-11-28 13:26:42 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
To filter by test case, e.g. with the name containing "preferences":
Document how to run just one Selenium test Bug: T139740 Change-Id: Ieb5f27285046c33d77b615159dc2000d80ef644a
2017-11-28 13:26:42 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
npm run selenium-test -- --mochaOpts.grep preferences
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Update readme file Replace `npm run selenium` with `npm run selenium-test`. Fix MD001 - Heading levels should only increment by one level at a time. https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md Bug: T324766 Change-Id: Ie3d48fdd65496385a63609eef7e228031ef90f1a
2024-02-16 12:33:43 +00:00
## Configuration
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
The following environment variables decide where to find MediaWiki and how to login:
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Improve README docs Simplify the README to only mention the bare minimum about how to use WDIO itself. The rest is deferred to the various wiki pages, which are more up to date. Also removes selenium.sh file, which is no longer used as of 1955a8aa564, I forgot to re-remove it during one of the rebases. It is now supported to pass arguments to 'npm run selenium' as well. Previously, arguments were only supported for 'npm run selenium-test', which required manual starting of a chromedriver. Bug: T214708 Change-Id: I5951af9146ac5fdce8d6506d703620049d6efe74
2019-09-20 17:37:36 +00:00
- `MW_SERVER`: The value of `$wgServer`.
- `MW_SCRIPT_PATH`: The value of `$wgScriptPath`.
- `MEDIAWIKI_USER`: Username of a wiki account with sysop rights.
- `MEDIAWIKI_PASSWORD`: Password for this user.
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Initial version of wdio-mediawiki package This is new package will be reusable by other repositories for their browser tests, without having to reference the internal selenium/pageobjects/ directory from MediaWiki core. In addition to not requiring direct imports, it will also avoid problems in the future by allowing the package to be versioned and iterated upon without forcing an atomic global upgrade (or broken master builds), everytime we change something. See wdio-mediawiki/README for details. Within MediaWiki core itself, the package is used using the 'file' specifier in its package.json, so that we always test and develop using its working copy, which makes drafting and testing changes easier. Also misc changes to make wdio.conf easier to understand. Bug: T193088 Change-Id: I547a7899e7a97693a93567dd763784e637433d55
2018-05-02 17:48:24 +00:00
## Further reading
Selenium tests in Node.js using WebdriverIO Introduce the WebdriverIO browser testing framework driven by Node.js. The overall intents are: * have MediaWiki core to provide a platform to run tests that is shared between core and the extensions. * phase out ruby driven browser tests eventually. Code is namespaced in sub directory /tests/selenium The 'pages' sub directory provides helper representing a MediaWiki page such as Special:Login and human friendly helpers to interact with the elements. Add Grunt task webdriver:test. Provide a npm script to easily spawn/dispose chromedriver and run above grunt task. wdio.conf.js provides all the configuration. It defaults to point to a MediaWiki-Vagrant installation on http://127.0.0.1:8080. Can be overriden with environment settings as needed. glob patterns (specs) are made absolute paths from MediaWiki root path that let us run the tests either from the root path (eg the npm wrapper or from the tests/selenium directory when invoking wdio directly. wdio assumes they are relative to the current working directory, hence the normalization. wdio.conf.jenkins.js extends the configuration and is used solely for Jenkins. The switch is done from the Gruntfile.js whenever JENKINS_HOME is set. Specially we want junit reports to be generated. Provide a more specific eslint configuration. References: * MALU https://phabricator.wikimedia.org/source/malu/ * T151442 Research WebdriverIO * T151443 Research Nightwatch.js Bug: T139740 Signed-off-by: Antoine Musso <hashar@free.fr> Change-Id: Ibe7a004a120e82af637ab3e31b725de743134c99
2016-12-19 16:39:29 +00:00
selenium: Fix and update links in comments and documentation Bug: T324766 Change-Id: If62835494fe7dd47fc4f18b881783570340cb5a9
2024-02-15 13:46:21 +00:00
- [Selenium](https://www.mediawiki.org/wiki/Selenium) on mediawiki.org
Reference in a new issue Copy permalink