diff options
Diffstat (limited to 'www/wiki/tests/selenium')
-rw-r--r-- | www/wiki/tests/selenium/README.md | 61 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/createaccount.page.js | 49 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/delete.page.js | 39 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/edit.page.js | 39 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/history.page.js | 13 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/page.js | 8 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/preferences.page.js | 20 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/restore.page.js | 21 | ||||
-rw-r--r-- | www/wiki/tests/selenium/pageobjects/userlogin.page.js | 27 | ||||
-rwxr-xr-x | www/wiki/tests/selenium/selenium.sh | 9 | ||||
-rw-r--r-- | www/wiki/tests/selenium/specs/page.js | 136 | ||||
-rw-r--r-- | www/wiki/tests/selenium/specs/user.js | 69 | ||||
-rw-r--r-- | www/wiki/tests/selenium/wdio.conf.js | 328 |
13 files changed, 819 insertions, 0 deletions
diff --git a/www/wiki/tests/selenium/README.md b/www/wiki/tests/selenium/README.md new file mode 100644 index 00000000..b15d4073 --- /dev/null +++ b/www/wiki/tests/selenium/README.md @@ -0,0 +1,61 @@ +# Selenium tests + +## Prerequisites + +- [Chrome](https://www.google.com/chrome/) +- [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/) +- [Node.js](https://nodejs.org/en/) +- [MediaWiki-Vagrant](https://www.mediawiki.org/wiki/MediaWiki-Vagrant) + +Set up MediaWiki-Vagrant: + + cd mediawiki/vagrant + vagrant up + +## Installation + + cd mediawiki + npm install + +## Usage + + npm run selenium + +By default, Chrome will run in headless mode. If you want to see Chrome, set DISPLAY +environment variable to any value: + + DISPLAY=:1 npm run selenium + +To run only one file (for example page.js), you first need to spawn the chromedriver: + + chromedriver --url-base=wd/hub --port=4444 + +Then in another terminal: + + cd tests/selenium + ../../node_modules/.bin/wdio --spec specs/page.js + +To run only one test (name contains string 'preferences'): + + ../../node_modules/.bin/wdio --spec specs/user.js --mochaOpts.grep preferences + +The runner reads the config file `wdio.conf.js` and runs the spec listed in +`page.js`. + +The defaults in the configuration files aim are targeting a MediaWiki-Vagrant +installation on http://127.0.0.1:8080 with a user Admin and +password 'vagrant'. Those settings can be overridden using environment +variables: + +`MW_SERVER`: to be set to the value of your $wgServer +`MW_SCRIPT_PATH`: ditto with $wgScriptPath +`MEDIAWIKI_USER`: username of an account that can create users on the wiki +`MEDIAWIKI_PASSWORD`: password for above user + +Example: + + MW_SERVER=http://example.org MW_SCRIPT_PATH=/dev/w npm run selenium + +## Links + +- [Selenium/Node.js](https://www.mediawiki.org/wiki/Selenium/Node.js) diff --git a/www/wiki/tests/selenium/pageobjects/createaccount.page.js b/www/wiki/tests/selenium/pageobjects/createaccount.page.js new file mode 100644 index 00000000..105f4092 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/createaccount.page.js @@ -0,0 +1,49 @@ +'use strict'; +const Page = require( './page' ); + +class CreateAccountPage extends Page { + + get username() { return browser.element( '#wpName2' ); } + get password() { return browser.element( '#wpPassword2' ); } + get confirmPassword() { return browser.element( '#wpRetype' ); } + get create() { return browser.element( '#wpCreateaccount' ); } + get heading() { return browser.element( '#firstHeading' ); } + + open() { + super.open( 'Special:CreateAccount' ); + } + + createAccount( username, password ) { + this.open(); + this.username.setValue( username ); + this.password.setValue( password ); + this.confirmPassword.setValue( password ); + this.create.click(); + } + + apiCreateAccount( username, password ) { + + const MWBot = require( 'mwbot' ), // https://github.com/Fannon/mwbot + Promise = require( 'bluebird' ); + let bot = new MWBot(); + + return Promise.coroutine( function* () { + yield bot.loginGetCreateaccountToken( { + apiUrl: `${browser.options.baseUrl}/api.php`, + username: browser.options.username, + password: browser.options.password + } ); + yield bot.request( { + action: 'createaccount', + createreturnurl: browser.options.baseUrl, + createtoken: bot.createaccountToken, + username: username, + password: password, + retype: password + } ); + } ).call( this ); + + } + +} +module.exports = new CreateAccountPage(); diff --git a/www/wiki/tests/selenium/pageobjects/delete.page.js b/www/wiki/tests/selenium/pageobjects/delete.page.js new file mode 100644 index 00000000..d43cb9f6 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/delete.page.js @@ -0,0 +1,39 @@ +'use strict'; +const Page = require( './page' ); + +class DeletePage extends Page { + + get reason() { return browser.element( '#wpReason' ); } + get watch() { return browser.element( '#wpWatch' ); } + get submit() { return browser.element( '#wpConfirmB' ); } + get displayedContent() { return browser.element( '#mw-content-text' ); } + + open( name ) { + super.open( name + '&action=delete' ); + } + + delete( name, reason ) { + this.open( name ); + this.reason.setValue( reason ); + this.submit.click(); + } + + apiDelete( name, reason ) { + + const MWBot = require( 'mwbot' ), // https://github.com/Fannon/mwbot + Promise = require( 'bluebird' ); + let bot = new MWBot(); + + return Promise.coroutine( function* () { + yield bot.loginGetEditToken( { + apiUrl: `${browser.options.baseUrl}/api.php`, + username: browser.options.username, + password: browser.options.password + } ); + yield bot.delete( name, reason ); + } ).call( this ); + + } + +} +module.exports = new DeletePage(); diff --git a/www/wiki/tests/selenium/pageobjects/edit.page.js b/www/wiki/tests/selenium/pageobjects/edit.page.js new file mode 100644 index 00000000..33a27f0f --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/edit.page.js @@ -0,0 +1,39 @@ +'use strict'; +const Page = require( './page' ); + +class EditPage extends Page { + + get content() { return browser.element( '#wpTextbox1' ); } + get displayedContent() { return browser.element( '#mw-content-text' ); } + get heading() { return browser.element( '#firstHeading' ); } + get save() { return browser.element( '#wpSave' ); } + + openForEditing( name ) { + super.open( name + '&action=edit' ); + } + + edit( name, content ) { + this.openForEditing( name ); + this.content.setValue( content ); + this.save.click(); + } + + apiEdit( name, content ) { + + const MWBot = require( 'mwbot' ), // https://github.com/Fannon/mwbot + Promise = require( 'bluebird' ); + let bot = new MWBot(); + + return Promise.coroutine( function* () { + yield bot.loginGetEditToken( { + apiUrl: `${browser.options.baseUrl}/api.php`, + username: browser.options.username, + password: browser.options.password + } ); + yield bot.edit( name, content, `Created page with "${content}"` ); + } ).call( this ); + + } + +} +module.exports = new EditPage(); diff --git a/www/wiki/tests/selenium/pageobjects/history.page.js b/www/wiki/tests/selenium/pageobjects/history.page.js new file mode 100644 index 00000000..869484e6 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/history.page.js @@ -0,0 +1,13 @@ +'use strict'; +const Page = require( './page' ); + +class HistoryPage extends Page { + + get comment() { return browser.element( '#pagehistory .comment' ); } + + open( name ) { + super.open( name + '&action=history' ); + } + +} +module.exports = new HistoryPage(); diff --git a/www/wiki/tests/selenium/pageobjects/page.js b/www/wiki/tests/selenium/pageobjects/page.js new file mode 100644 index 00000000..77bb1f4e --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/page.js @@ -0,0 +1,8 @@ +// From http://webdriver.io/guide/testrunner/pageobjects.html +'use strict'; +class Page { + open( path ) { + browser.url( browser.options.baseUrl + '/index.php?title=' + path ); + } +} +module.exports = Page; diff --git a/www/wiki/tests/selenium/pageobjects/preferences.page.js b/www/wiki/tests/selenium/pageobjects/preferences.page.js new file mode 100644 index 00000000..98b87fe9 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/preferences.page.js @@ -0,0 +1,20 @@ +'use strict'; +const Page = require( './page' ); + +class PreferencesPage extends Page { + + get realName() { return browser.element( '#mw-input-wprealname' ); } + get save() { return browser.element( '#prefcontrol' ); } + + open() { + super.open( 'Special:Preferences' ); + } + + changeRealName( realName ) { + this.open(); + this.realName.setValue( realName ); + this.save.click(); + } + +} +module.exports = new PreferencesPage(); diff --git a/www/wiki/tests/selenium/pageobjects/restore.page.js b/www/wiki/tests/selenium/pageobjects/restore.page.js new file mode 100644 index 00000000..071f7f98 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/restore.page.js @@ -0,0 +1,21 @@ +'use strict'; +const Page = require( './page' ); + +class RestorePage extends Page { + + get reason() { return browser.element( '#wpComment' ); } + get submit() { return browser.element( '#mw-undelete-submit' ); } + get displayedContent() { return browser.element( '#mw-content-text' ); } + + open( name ) { + super.open( 'Special:Undelete/' + name ); + } + + restore( name, reason ) { + this.open( name ); + this.reason.setValue( reason ); + this.submit.click(); + } + +} +module.exports = new RestorePage(); diff --git a/www/wiki/tests/selenium/pageobjects/userlogin.page.js b/www/wiki/tests/selenium/pageobjects/userlogin.page.js new file mode 100644 index 00000000..0061d0c2 --- /dev/null +++ b/www/wiki/tests/selenium/pageobjects/userlogin.page.js @@ -0,0 +1,27 @@ +'use strict'; +const Page = require( './page' ); + +class UserLoginPage extends Page { + + get username() { return browser.element( '#wpName1' ); } + get password() { return browser.element( '#wpPassword1' ); } + get loginButton() { return browser.element( '#wpLoginAttempt' ); } + get userPage() { return browser.element( '#pt-userpage' ); } + + open() { + super.open( 'Special:UserLogin' ); + } + + login( username, password ) { + this.open(); + this.username.setValue( username ); + this.password.setValue( password ); + this.loginButton.click(); + } + + loginAdmin() { + this.login( browser.options.username, browser.options.password ); + } + +} +module.exports = new UserLoginPage(); diff --git a/www/wiki/tests/selenium/selenium.sh b/www/wiki/tests/selenium/selenium.sh new file mode 100755 index 00000000..6b71019b --- /dev/null +++ b/www/wiki/tests/selenium/selenium.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +set -euo pipefail +chromedriver --url-base=/wd/hub --port=4444 & +# Make sure it is killed to prevent file descriptors leak +function kill_chromedriver() { + killall chromedriver > /dev/null +} +trap kill_chromedriver EXIT +npm run selenium-test diff --git a/www/wiki/tests/selenium/specs/page.js b/www/wiki/tests/selenium/specs/page.js new file mode 100644 index 00000000..376dce59 --- /dev/null +++ b/www/wiki/tests/selenium/specs/page.js @@ -0,0 +1,136 @@ +'use strict'; +const assert = require( 'assert' ), + DeletePage = require( '../pageobjects/delete.page' ), + RestorePage = require( '../pageobjects/restore.page' ), + EditPage = require( '../pageobjects/edit.page' ), + HistoryPage = require( '../pageobjects/history.page' ), + UserLoginPage = require( '../pageobjects/userlogin.page' ); + +describe( 'Page', function () { + + var content, + name; + + function getTestString() { + return Math.random().toString() + '-öäü-♠♣♥♦'; + } + + before( function () { + // disable VisualEditor welcome dialog + UserLoginPage.open(); + browser.localStorage( 'POST', { key: 've-beta-welcome-dialog', value: '1' } ); + } ); + + beforeEach( function () { + browser.deleteCookie(); + content = getTestString(); + name = getTestString(); + } ); + + it( 'should be creatable', function () { + + // create + EditPage.edit( name, content ); + + // check + assert.equal( EditPage.heading.getText(), name ); + assert.equal( EditPage.displayedContent.getText(), content ); + + } ); + + it( 'should be re-creatable', function () { + let initialContent = getTestString(); + + // create + browser.call( function () { + return EditPage.apiEdit( name, initialContent ); + } ); + + // delete + browser.call( function () { + return DeletePage.apiDelete( name, 'delete prior to recreate' ); + } ); + + // create + EditPage.edit( name, content ); + + // check + assert.equal( EditPage.heading.getText(), name ); + assert.equal( EditPage.displayedContent.getText(), content ); + + } ); + + it( 'should be editable', function () { + + // create + browser.call( function () { + return EditPage.apiEdit( name, content ); + } ); + + // edit + EditPage.edit( name, content ); + + // check + assert.equal( EditPage.heading.getText(), name ); + assert.equal( EditPage.displayedContent.getText(), content ); + + } ); + + it( 'should have history', function () { + + // create + browser.call( function () { + return EditPage.apiEdit( name, content ); + } ); + + // check + HistoryPage.open( name ); + assert.equal( HistoryPage.comment.getText(), `(Created page with "${content}")` ); + + } ); + + it( 'should be deletable', function () { + + // login + UserLoginPage.loginAdmin(); + + // create + browser.call( function () { + return EditPage.apiEdit( name, content ); + } ); + + // delete + DeletePage.delete( name, content + '-deletereason' ); + + // check + assert.equal( + DeletePage.displayedContent.getText(), + '"' + name + '" has been deleted. See deletion log for a record of recent deletions.\nReturn to Main Page.' + ); + + } ); + + it( 'should be restorable', function () { + + // login + UserLoginPage.loginAdmin(); + + // create + browser.call( function () { + return EditPage.apiEdit( name, content ); + } ); + + // delete + browser.call( function () { + return DeletePage.apiDelete( name, content + '-deletereason' ); + } ); + + // restore + RestorePage.restore( name, content + '-restorereason' ); + + // check + assert.equal( RestorePage.displayedContent.getText(), name + ' has been restored\nConsult the deletion log for a record of recent deletions and restorations.' ); + + } ); + +} ); diff --git a/www/wiki/tests/selenium/specs/user.js b/www/wiki/tests/selenium/specs/user.js new file mode 100644 index 00000000..3f3872dc --- /dev/null +++ b/www/wiki/tests/selenium/specs/user.js @@ -0,0 +1,69 @@ +'use strict'; +const assert = require( 'assert' ), + CreateAccountPage = require( '../pageobjects/createaccount.page' ), + PreferencesPage = require( '../pageobjects/preferences.page' ), + UserLoginPage = require( '../pageobjects/userlogin.page' ); + +describe( 'User', function () { + + var password, + username; + + before( function () { + // disable VisualEditor welcome dialog + UserLoginPage.open(); + browser.localStorage( 'POST', { key: 've-beta-welcome-dialog', value: '1' } ); + } ); + + beforeEach( function () { + browser.deleteCookie(); + username = `User-${Math.random().toString()}`; + password = Math.random().toString(); + } ); + + it( 'should be able to create account', function () { + + // create + CreateAccountPage.createAccount( username, password ); + + // check + assert.equal( CreateAccountPage.heading.getText(), `Welcome, ${username}!` ); + + } ); + + it( 'should be able to log in', function () { + + // create + browser.call( function () { + return CreateAccountPage.apiCreateAccount( username, password ); + } ); + + // log in + UserLoginPage.login( username, password ); + + // check + assert.equal( UserLoginPage.userPage.getText(), username ); + + } ); + + it( 'should be able to change preferences', function () { + + var realName = Math.random().toString(); + + // create + browser.call( function () { + return CreateAccountPage.apiCreateAccount( username, password ); + } ); + + // log in + UserLoginPage.login( username, password ); + + // change + PreferencesPage.changeRealName( realName ); + + // check + assert.equal( PreferencesPage.realName.getValue(), realName ); + + } ); + +} ); diff --git a/www/wiki/tests/selenium/wdio.conf.js b/www/wiki/tests/selenium/wdio.conf.js new file mode 100644 index 00000000..0930a0f1 --- /dev/null +++ b/www/wiki/tests/selenium/wdio.conf.js @@ -0,0 +1,328 @@ +'use strict'; + +const fs = require( 'fs' ), + path = require( 'path' ); + +let logPath, password, username; + +// username and password will be used only if +// MEDIAWIKI_USER or MEDIAWIKI_PASSWORD environment variables are not set +if ( process.env.JENKINS_HOME ) { + logPath = '../log/'; + password = 'testpass'; + username = 'WikiAdmin'; +} else { + logPath = './log/'; + password = 'vagrant'; + username = 'Admin'; +} + +function relPath( foo ) { + return path.resolve( __dirname, '../..', foo ); +} + +exports.config = { + // ====== + // Custom + // ====== + // Define any custom variables. + // Example: + // username: 'Admin', + // Use if from tests with: + // browser.options.username + username: process.env.MEDIAWIKI_USER === undefined ? + username : + process.env.MEDIAWIKI_USER, + password: process.env.MEDIAWIKI_PASSWORD === undefined ? + password : + process.env.MEDIAWIKI_PASSWORD, + // + // ====== + // Sauce Labs + // ====== + // + services: [ 'sauce' ], + user: process.env.SAUCE_USERNAME, + key: process.env.SAUCE_ACCESS_KEY, + // + // ================== + // Specify Test Files + // ================== + // Define which test specs should run. The pattern is relative to the directory + // from which `wdio` was called. Notice that, if you are calling `wdio` from an + // NPM script (see https://docs.npmjs.com/cli/run-script) then the current working + // directory is where your package.json resides, so `wdio` will be called from there. + // + specs: [ + relPath( './tests/selenium/specs/**/*.js' ), + relPath( './extensions/*/tests/selenium/specs/**/*.js' ), + relPath( './extensions/VisualEditor/modules/ve-mw/tests/selenium/specs/**/*.js' ), + relPath( './skins/*/tests/selenium/specs/**/*.js' ) + ], + // Patterns to exclude. + exclude: [ + './extensions/CirrusSearch/tests/selenium/specs/**/*.js' + ], + // + // ============ + // Capabilities + // ============ + // Define your capabilities here. WebdriverIO can run multiple capabilities at the same + // time. Depending on the number of capabilities, WebdriverIO launches several test + // sessions. Within your capabilities you can overwrite the spec and exclude options in + // order to group specific specs to a specific capability. + // + // First, you can define how many instances should be started at the same time. Let's + // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have + // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec + // files and you set maxInstances to 10, all spec files will get tested at the same time + // and 30 processes will get spawned. The property handles how many capabilities + // from the same test should run tests. + // + maxInstances: 1, + // + // If you have trouble getting all important capabilities together, check out the + // Sauce Labs platform configurator - a great tool to configure your capabilities: + // https://docs.saucelabs.com/reference/platforms-configurator + // + // For Chrome/Chromium https://sites.google.com/a/chromium.org/chromedriver/capabilities + capabilities: [ { + // maxInstances can get overwritten per capability. So if you have an in-house Selenium + // grid with only 5 firefox instances available you can make sure that not more than + // 5 instances get started at a time. + maxInstances: 1, + // + browserName: 'chrome', + chromeOptions: { + // Run headless when there is no DISPLAY + // --headless: since Chrome 59 https://chromium.googlesource.com/chromium/src/+/59.0.3030.0/headless/README.md + args: ( + process.env.DISPLAY ? [] : [ '--headless' ] + ).concat( + // Disable Chrome sandbox when running in Docker + fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] + ) + } + } ], + // + // =================== + // Test Configurations + // =================== + // Define all options that are relevant for the WebdriverIO instance here + // + // By default WebdriverIO commands are executed in a synchronous way using + // the wdio-sync package. If you still want to run your tests in an async way + // e.g. using promises you can set the sync option to false. + sync: true, + // + // Level of logging verbosity: silent | verbose | command | data | result | error + logLevel: 'error', + // + // Enables colors for log output. + coloredLogs: true, + // + // Warns when a deprecated command is used + deprecationWarnings: true, + // + // If you only want to run your tests until a specific amount of tests have failed use + // bail (default is 0 - don't bail, run all tests). + bail: 0, + // + // Saves a screenshot to a given path if a command fails. + screenshotPath: logPath, + // + // Set a base URL in order to shorten url command calls. If your `url` parameter starts + // with `/`, the base url gets prepended, not including the path portion of your baseUrl. + // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url + // gets prepended directly. + baseUrl: ( + process.env.MW_SERVER === undefined ? + 'http://127.0.0.1:8080' : + process.env.MW_SERVER + ) + ( + process.env.MW_SCRIPT_PATH === undefined ? + '/w' : + process.env.MW_SCRIPT_PATH + ), + // + // Default timeout for all waitFor* commands. + waitforTimeout: 10000, + // + // Default timeout in milliseconds for request + // if Selenium Grid doesn't send response + connectionRetryTimeout: 90000, + // + // Default request retries count + connectionRetryCount: 3, + // + // Initialize the browser instance with a WebdriverIO plugin. The object should have the + // plugin name as key and the desired plugin options as properties. Make sure you have + // the plugin installed before running any tests. The following plugins are currently + // available: + // WebdriverCSS: https://github.com/webdriverio/webdrivercss + // WebdriverRTC: https://github.com/webdriverio/webdriverrtc + // Browserevent: https://github.com/webdriverio/browserevent + // plugins: { + // webdrivercss: { + // screenshotRoot: 'my-shots', + // failedComparisonsRoot: 'diffs', + // misMatchTolerance: 0.05, + // screenWidth: [320,480,640,1024] + // }, + // webdriverrtc: {}, + // browserevent: {} + // }, + // + // Test runner services + // Services take over a specific job you don't want to take care of. They enhance + // your test setup with almost no effort. Unlike plugins, they don't add new + // commands. Instead, they hook themselves up into the test process. + // services: [],// + // Framework you want to run your specs with. + // The following are supported: Mocha, Jasmine, and Cucumber + // see also: http://webdriver.io/guide/testrunner/frameworks.html + // + // Make sure you have the wdio adapter package for the specific framework installed + // before running any tests. + framework: 'mocha', + // + // Test reporter for stdout. + // The only one supported by default is 'dot' + // see also: http://webdriver.io/guide/testrunner/reporters.html + reporters: [ 'spec', 'junit' ], + reporterOptions: { + junit: { + outputDir: logPath + } + }, + // + // Options to be passed to Mocha. + // See the full list at http://mochajs.org/ + mochaOpts: { + ui: 'bdd', + timeout: 20000 + }, + // + // ===== + // Hooks + // ===== + // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance + // it and to build services around it. You can either apply a single function or an array of + // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got + // resolved to continue. + /** + * Gets executed once before all workers get launched. + * @param {Object} config wdio configuration object + * @param {Array.<Object>} capabilities list of capabilities details + */ + // onPrepare: function (config, capabilities) { + // }, + /** + * Gets executed just before initialising the webdriver session and test framework. It allows you + * to manipulate configurations depending on the capability or spec. + * @param {Object} config wdio configuration object + * @param {Array.<Object>} capabilities list of capabilities details + * @param {Array.<String>} specs List of spec file paths that are to be run + */ + // beforeSession: function (config, capabilities, specs) { + // }, + /** + * Gets executed before test execution begins. At this point you can access to all global + * variables like `browser`. It is the perfect place to define custom commands. + * @param {Array.<Object>} capabilities list of capabilities details + * @param {Array.<String>} specs List of spec file paths that are to be run + */ + // before: function (capabilities, specs) { + // }, + /** + * Runs before a WebdriverIO command gets executed. + * @param {String} commandName hook command name + * @param {Array} args arguments that command would receive + */ + // beforeCommand: function (commandName, args) { + // }, + /** + * Hook that gets executed before the suite starts + * @param {Object} suite suite details + */ + // beforeSuite: function (suite) { + // }, + /** + * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts. + * @param {Object} test test details + */ + // beforeTest: function (test) { + // }, + /** + * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling + * beforeEach in Mocha) + */ + // beforeHook: function () { + // }, + /** + * Hook that gets executed _after_ a hook within the suite ends (e.g. runs after calling + * afterEach in Mocha) + */ + // afterHook: function () { + // }, + /** + * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) ends. + * @param {Object} test test details + */ + // from https://github.com/webdriverio/webdriverio/issues/269#issuecomment-306342170 + afterTest: function ( test ) { + var filename, filePath; + // if test passed, ignore, else take and save screenshot + if ( test.passed ) { + return; + } + // get current test title and clean it, to use it as file name + filename = encodeURIComponent( test.title.replace( /\s+/g, '-' ) ); + // build file path + filePath = this.screenshotPath + filename + '.png'; + // save screenshot + browser.saveScreenshot( filePath ); + console.log( '\n\tScreenshot location:', filePath, '\n' ); + } + // + /** + * Hook that gets executed after the suite has ended + * @param {Object} suite suite details + */ + // afterSuite: function (suite) { + // }, + /** + * Runs after a WebdriverIO command gets executed + * @param {String} commandName hook command name + * @param {Array} args arguments that command would receive + * @param {Number} result 0 - command success, 1 - command error + * @param {Object} error error object if any + */ + // afterCommand: function (commandName, args, result, error) { + // }, + /** + * Gets executed after all tests are done. You still have access to all global variables from + * the test. + * @param {Number} result 0 - test pass, 1 - test fail + * @param {Array.<Object>} capabilities list of capabilities details + * @param {Array.<String>} specs List of spec file paths that ran + */ + // after: function (result, capabilities, specs) { + // }, + /** + * Gets executed right after terminating the webdriver session. + * @param {Object} config wdio configuration object + * @param {Array.<Object>} capabilities list of capabilities details + * @param {Array.<String>} specs List of spec file paths that ran + */ + // afterSession: function (config, capabilities, specs) { + // }, + /** + * Gets executed after all workers got shut down and the process is about to exit. + * @param {Object} exitCode 0 - success, 1 - fail + * @param {Object} config wdio configuration object + * @param {Array.<Object>} capabilities list of capabilities details + */ + // onComplete: function(exitCode, config, capabilities) { + // } +}; |