wdio-mediawiki 2.4.0 → 2.6.0

package/Api.js

@@ -21,7 +21,7 @@ module.exports = {
 		const bot = new MWBot();
 
 		await bot.loginGetEditToken( {
-			apiUrl: `${baseUrl}/api.php`,
+			apiUrl: `${ baseUrl }/api.php`,
 			username: username,
 			password: password
 		} );

package/BlankPage.js

@@ -3,7 +3,9 @@
 const Page = require( './Page' );
 
 class BlankPage extends Page {
-	get heading() { return $( '#firstHeading' ); }
+	get heading() {
+		return $( '#firstHeading' );
+	}
 
 	async open() {
 		await super.openTitle( 'Special:BlankPage', { uselang: 'en' } );

package/CreateAccountPage.js

@@ -1,20 +1,64 @@
 'use strict';
 
 const Page = require( './Page' );
+const Util = require( 'wdio-mediawiki/Util' );
 
 class CreateAccountPage extends Page {
-	get username() { return $( '#wpName2' ); }
-	get password() { return $( '#wpPassword2' ); }
-	get confirmPassword() { return $( '#wpRetype' ); }
-	get create() { return $( '#wpCreateaccount' ); }
-	get heading() { return $( '#firstHeading' ); }
+	get username() {
+		return $( '#wpName2' );
+	}
+
+	get password() {
+		return $( '#wpPassword2' );
+	}
+
+	get confirmPassword() {
+		return $( '#wpRetype' );
+	}
+
+	get create() {
+		return $( '#wpCreateaccount' );
+	}
+
+	get heading() {
+		return $( '#firstHeading' );
+	}
+
+	get tempPasswordInput() {
+		return $( '#wpCreateaccountMail' );
+	}
+
+	get reasonInput() {
+		return $( '#wpReason' );
+	}
 
-	open() {
-		super.openTitle( 'Special:CreateAccount' );
+	async open() {
+		await super.openTitle( 'Special:CreateAccount' );
 	}
 
+	/**
+	 * Navigate to Special:CreateAccount, then fill out and submit the account creation form.
+	 *
+	 * @param {string} username
+	 * @param {string} password
+	 * @return {Promise<void>}
+	 */
 	async createAccount( username, password ) {
 		await this.open();
+		await this.submitForm( username, password );
+	}
+
+	/**
+	 * Fill out and submit the account creation form on Special:CreateAccount.
+	 * The browser is assumed to have already navigated to this page.
+	 *
+	 * @param {string} username
+	 * @param {string} password
+	 * @return {Promise<void>}
+	 */
+	async submitForm( username, password ) {
+		await Util.waitForModuleState( 'mediawiki.special.createaccount', 'ready', 10000 );
+
 		await this.username.setValue( username );
 		await this.password.setValue( password );
 		await this.confirmPassword.setValue( password );

package/LoginPage.js

@@ -1,15 +1,33 @@
+// This file is used at Selenium/Explanation/Page object pattern
+// https://www.mediawiki.org/wiki/Selenium/Explanation/Page_object_pattern
+
 'use strict';
 
 const Page = require( './Page' );
 
 class LoginPage extends Page {
-	get username() { return $( '#wpName1' ); }
-	get password() { return $( '#wpPassword1' ); }
-	get loginButton() { return $( '#wpLoginAttempt' ); }
-	get userPage() { return $( '#pt-userpage' ); }
+	get username() {
+		return $( '#wpName1' );
+	}
+
+	get password() {
+		return $( '#wpPassword1' );
+	}
+
+	get loginButton() {
+		return $( '#wpLoginAttempt' );
+	}
+
+	get userPage() {
+		return $( '#pt-userpage' );
+	}
+
+	async open() {
+		await super.openTitle( 'Special:UserLogin' );
+	}
 
-	open() {
-		super.openTitle( 'Special:UserLogin' );
+	async getActualUsername() {
+		return browser.execute( () => mw.config.get( 'wgUserName' ) );
 	}
 
 	async login( username, password ) {
@@ -17,6 +35,17 @@ class LoginPage extends Page {
 		await this.username.setValue( username );
 		await this.password.setValue( password );
 		await this.loginButton.click();
+		await browser.waitUntil(
+			async () => await browser.execute(
+				( expectedUsername ) => typeof mw !== 'undefined' &&
+					mw.config.get( 'wgUserName' ) === expectedUsername,
+				username
+			),
+			{
+				timeout: 15000,
+				timeoutMsg: 'Cannot submit login form'
+			}
+		);
 	}
 
 	async loginAdmin() {

package/Page.js

@@ -3,7 +3,7 @@
 const querystring = require( 'querystring' );
 
 /**
- * Based on http://webdriver.io/guide/testrunner/pageobjects.html
+ * Based on https://webdriver.io/docs/pageobjects
  */
 class Page {
 
@@ -11,20 +11,28 @@ class Page {
 	 * Navigate the browser to a given page.
 	 *
 	 * @since 1.0.0
-	 * @see <http://webdriver.io/api/protocol/url.html>
+	 * @see <https://webdriver.io/docs/api/browser/url>
 	 * @param {string} title Page title
 	 * @param {Object} [query] Query parameter
 	 * @param {string} [fragment] Fragment parameter
-	 * @return {void} This method runs a browser command.
+	 * @return {Promise<void>}
 	 */
 	async openTitle( title, query = {}, fragment = '' ) {
-		const config = Object.assign( browser.config || {}, browser.options || {} );
 		query.title = title;
 		await browser.url(
-			config.baseUrl + '/index.php?' +
+			browser.config.baseUrl + '/index.php?' +
 			querystring.stringify( query ) +
 			( fragment ? ( '#' + fragment ) : '' )
 		);
+		// Wait for the page to be fully loaded. TODO: This can be replaced by the `wait` option to
+		// browser.url in webdriverio 9 (T363704).
+		await browser.waitUntil(
+			() => browser.execute( () => document.readyState === 'complete' ),
+			{
+				timeout: 10 * 1000,
+				timeoutMsg: 'Page did not load in time'
+			}
+		);
 	}
 }
 

package/README.md

@@ -1,12 +1,12 @@
 # wdio-mediawiki
 
-A plugin for [WebdriverIO](http://webdriver.io/) providing utilities to simplify testing of MediaWiki features.
+A plugin for [WebdriverIO](https://webdriver.io) providing utilities to simplify testing of MediaWiki features.
 
 ## Getting Started
 
 ### Page
 
-The `Page` class is a base class for following the [Page Objects Pattern](http://webdriver.io/guide/testrunner/pageobjects.html).
+The `Page` class is a base class for following the [Page Objects Pattern](https://webdriver.io/docs/pageobjects).
 
 * `openTitle( title [, Object query [, string fragment ] ] )`
 
@@ -17,7 +17,7 @@ See [BlankPage](./BlankPage.js) and [specs/BlankPage](./specs/BlankPage.js) for
 
 ### Api
 
-Utilities to interact with the MediaWiki API. Uses the [mwbot](https://github.com/Fannon/mwbot) library.
+Utilities to interact with the MediaWiki API. Uses the [mwbot](https://github.com/gesinn-it-pub/mwbot) library.
 
 Actions are performed logged-in using `browser.config.mwUser` and `browser.config.mwPwd`,
 which typically come from `MEDIAWIKI_USER` and `MEDIAWIKI_PASSWORD` environment variables.
@@ -46,11 +46,12 @@ making assertions that depend on its outcome.
 `Util` is a collection of popular utility methods.
 
 * `getTestString([ string prefix ])`
+* `isTargetNotWikitext(string target)`
 * `waitForModuleState(string moduleName [, string moduleStatus [, number timeout ] ])`
 
 ## Versioning
 
-This package follows [Semantic Versioning guidelines](https://semver.org/) for its releases. In
+This package follows [Semantic Versioning guidelines](https://semver.org) for its releases. In
 particular, its major version must be bumped when compatibility is removed for a previous of
 MediaWiki.
 
@@ -65,11 +66,11 @@ co-exists with its deprecated equivalent for at least one release.
 
 ## Issue tracker
 
-Please report issues to [Phabricator](https://phabricator.wikimedia.org/tag/mediawiki-core-tests/).
+Please report issues to [Phabricator](https://phabricator.wikimedia.org/tag/mediawiki-core-tests).
 
 ## Contributing
 
 This module is maintained in the MediaWiki core repository and published from there as a
 package to npmjs.org. To simplify development and to ensure changes are verified
 automatically, MediaWiki core itself uses this module directly from the working copy
-using [npm Local Paths](https://docs.npmjs.com/files/package.json#local-paths).
+using [npm Local Paths](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#local-paths).

package/RunJobs.js

@@ -6,7 +6,7 @@ const MAINPAGE_REQUESTS_MAX_RUNS = 10; // (arbitrary) safe-guard against endless
 
 function getJobCount() {
 	const bot = new MWBot( {
-		apiUrl: `${browser.config.baseUrl}/api.php`
+		apiUrl: `${ browser.config.baseUrl }/api.php`
 	} );
 	return bot.request( {
 		action: 'query',
@@ -16,27 +16,27 @@ function getJobCount() {
 }
 
 function log( message ) {
-	process.stdout.write( `RunJobs ${message}\n` );
+	process.stdout.write( `RunJobs ${ message }\n` );
 }
 
 function runThroughMainPageRequests( runCount = 1 ) {
 	const page = new Page();
-	log( `through requests to the main page (run ${runCount}).` );
+	log( `through requests to the main page (run ${ runCount }).` );
 
-	page.openTitle( '' );
-
-	return getJobCount().then( ( jobCount ) => {
-		if ( jobCount === 0 ) {
-			log( 'found no more queued jobs.' );
-			return;
-		}
-		log( `detected ${jobCount} more queued job(s).` );
-		if ( runCount >= MAINPAGE_REQUESTS_MAX_RUNS ) {
-			log( 'stopping requests to the main page due to reached limit.' );
-			return;
-		}
-		return runThroughMainPageRequests( ++runCount );
-	} );
+	return page.openTitle( '' ).then(
+		() => getJobCount().then( ( jobCount ) => {
+			if ( jobCount === 0 ) {
+				log( 'found no more queued jobs.' );
+				return;
+			}
+			log( `detected ${ jobCount } more queued job(s).` );
+			if ( runCount >= MAINPAGE_REQUESTS_MAX_RUNS ) {
+				log( 'stopping requests to the main page due to reached limit.' );
+				return;
+			}
+			return runThroughMainPageRequests( ++runCount );
+		} )
+	);
 }
 
 /**
@@ -61,9 +61,7 @@ function runThroughMainPageRequests( runCount = 1 ) {
 class RunJobs {
 
 	static run() {
-		browser.call( () => {
-			return runThroughMainPageRequests();
-		} );
+		browser.call( () => runThroughMainPageRequests() );
 	}
 }
 

package/Util.js

@@ -1,10 +1,44 @@
 'use strict';
 
 module.exports = {
+	/**
+	 * Generate a random number string with some additional extended ASCII.
+	 *
+	 * @param {string} prefix A prefix to apply to the generated output.
+	 * @return {string}
+	 */
 	getTestString( prefix = '' ) {
 		return prefix + Math.random().toString() + '-Iñtërnâtiônàlizætiøn';
 	},
 
+	/**
+	 * Check if a page is (or, if it doesn't yet exist, would be by default) a wikitext content
+	 * object, as opposed to e.g. a JSON blob or a content model provided by an extension. This
+	 * is useful for when a target of a test requires wikitext behaviour, such as testing for
+	 * having a talk page, being subject to redirects, being editable, or similar concerns.
+	 *
+	 * @param {string} target The name of the page in question.
+	 * @return {Promise<boolean>} True if the target is not wikitext.
+	 */
+	async isTargetNotWikitext( target ) {
+		// First, make sure that the 'mw' object should exist
+		await this.waitForModuleState( 'mediawiki.base' );
+
+		// Then, ask the API for the basic 'info' data about the given page
+		return browser.executeAsync( ( target_, done ) => {
+			mw.loader.using( 'mediawiki.api' ).then( () => {
+				const api = new mw.Api();
+				api.get( {
+					action: 'query', prop: 'info', titles: target_,
+					format: 'json', formatversion: 2
+				} ).then( ( result ) => {
+					// Finally, return whether said page is wikitext (or would be, if it doesn't yet exist)
+					done( result.query.pages[ 0 ].contentmodel !== 'wikitext' );
+				} );
+			} );
+		}, target );
+	},
+
 	/**
 	 * Wait for a given module to reach a specific state
 	 *
@@ -13,14 +47,14 @@ module.exports = {
 	 * @param {number} timeout The wait time in milliseconds before the wait fails
 	 */
 	async waitForModuleState( moduleName, moduleStatus = 'ready', timeout = 5000 ) {
-		await browser.waitUntil( async () => {
-			return await browser.execute( ( arg ) => {
-				return typeof mw !== 'undefined' &&
-					mw.loader.getState( arg.name ) === arg.status;
-			}, { status: moduleStatus, name: moduleName } );
-		}, {
-			timeout: timeout,
-			timeoutMsg: 'Failed to wait for ' + moduleName + ' to be ' + moduleStatus + ' after ' + timeout + ' ms.'
-		} );
+		await browser.waitUntil(
+			() => browser.execute(
+				( arg ) => typeof mw !== 'undefined' && mw.loader.getState( arg.name ) === arg.status,
+				{ status: moduleStatus, name: moduleName }
+			), {
+				timeout: timeout,
+				timeoutMsg: 'Failed to wait for ' + moduleName + ' to be ' + moduleStatus + ' after ' + timeout + ' ms.'
+			}
+		);
 	}
 };

package/index.js

@@ -23,11 +23,10 @@ function testTitle( title ) {
  * @since 1.1.0
  * @param {string} title Test title
  * @param {string} extension png for screenshots, mp4 for videos
- * @param {string} screenshotPath Optional path
  * @return {string} Full path of screenshot/video file
  */
-function filePath( title, extension, screenshotPath = undefined ) {
-	return `${screenshotPath || browser.config.screenshotPath}/${testTitle( title )}-${makeFilenameDate()}.${extension}`;
+function filePath( title, extension ) {
+	return `${ browser.config.screenshotPath }/${ testTitle( title ) }-${ makeFilenameDate() }.${ extension }`;
 }
 
 /**
@@ -35,19 +34,18 @@ function filePath( title, extension, screenshotPath = undefined ) {
  *
  * @since 1.0.0
  * @param {string} title Description (will be sanitised and used as file name)
- * @param {string} screenshotPath Optional path
  * @return {string} File path
  */
-async function saveScreenshot( title, screenshotPath = undefined ) {
+async function saveScreenshot( title ) {
 	// Create sensible file name for current test title
-	const path = filePath( title, 'png', screenshotPath );
+	const path = filePath( title, 'png' );
 	// Ensure directory exists, based on WebDriverIO#saveScreenshotSync()
 	try {
 		// eslint-disable-next-line security/detect-non-literal-fs-filename
-		fs.statSync( screenshotPath || browser.config.screenshotPath );
+		fs.statSync( browser.config.screenshotPath );
 	} catch ( err ) {
 		// eslint-disable-next-line security/detect-non-literal-fs-filename
-		fs.mkdirSync( screenshotPath || browser.config.screenshotPath );
+		fs.mkdirSync( browser.config.screenshotPath );
 	}
 	// Create and save screenshot
 	await browser.saveScreenshot( path );
@@ -75,7 +73,7 @@ function startVideo( ffmpeg, title ) {
 		] );
 		const logBuffer = function ( buffer, prefix ) {
 			const lines = buffer.toString().trim().split( '\n' );
-			lines.forEach( function ( line ) {
+			lines.forEach( ( line ) => {
 				console.log( prefix + line );
 			} );
 		};

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "wdio-mediawiki",
-	"version": "2.4.0",
+	"version": "2.6.0",
 	"description": "WebdriverIO plugin for testing a MediaWiki site.",
-	"homepage": "https://gerrit.wikimedia.org/g/mediawiki/core/+/master/tests/selenium/wdio-mediawiki/",
+	"homepage": "https://gerrit.wikimedia.org/g/mediawiki/core/+/master/tests/selenium/wdio-mediawiki",
 	"license": "MIT",
 	"keywords": [
 		"mediawiki",
@@ -12,9 +12,6 @@
 		"*.js",
 		"specs/"
 	],
-	"engines": {
-		"node": ">=10.0"
-	},
 	"dependencies": {
 		"mwbot": "2.1.3"
 	}

package/specs/BlankPage.js

@@ -1,13 +1,12 @@
 'use strict';
 
-const assert = require( 'assert' );
 const BlankPage = require( './../BlankPage' );
 
-describe( 'BlankPage', function () {
-	it( 'should have its title @daily', async function () {
+describe( 'BlankPage', () => {
+	it( 'should have its title @daily', async () => {
 		await BlankPage.open();
 
 		// check
-		assert.strictEqual( await BlankPage.heading.getText(), 'Blank page' );
+		await expect( await BlankPage.heading ).toHaveText( 'Blank page' );
 	} );
 } );

package/wdio-defaults.conf.js

@@ -15,6 +15,8 @@ const fs = require( 'fs' );
 const path = require( 'path' );
 const logPath = process.env.LOG_DIR || path.join( process.cwd(), 'tests/selenium/log' );
 const { makeFilenameDate, saveScreenshot, startVideo, stopVideo } = require( 'wdio-mediawiki' );
+// T355556: remove when T324766 is resolved
+const dns = require( 'dns' );
 
 if ( !process.env.MW_SERVER || !process.env.MW_SCRIPT_PATH ) {
 	throw new Error( 'MW_SERVER or MW_SCRIPT_PATH not defined.\nSee https://www.mediawiki.org/wiki/Selenium/How-to/Set_environment_variables\n' );
@@ -22,8 +24,8 @@ if ( !process.env.MW_SERVER || !process.env.MW_SCRIPT_PATH ) {
 
 /**
  * For more details documentation and available options:
- * - https://webdriver.io/docs/configurationfile/
- * - https://webdriver.io/docs/options/
+ * - https://webdriver.io/docs/configurationfile
+ * - https://webdriver.io/docs/configuration
  */
 exports.config = {
 	// ======
@@ -54,7 +56,7 @@ exports.config = {
 
 	maxInstances: 1,
 	capabilities: [ {
-		// For Chrome/Chromium https://sites.google.com/a/chromium.org/chromedriver/capabilities
+		// For Chrome/Chromium https://www.w3.org/TR/webdriver
 		browserName: 'chrome',
 		'goog:chromeOptions': {
 			// If DISPLAY is set, assume developer asked non-headless or CI with Xvfb.
@@ -64,7 +66,10 @@ exports.config = {
 				'--enable-automation',
 				...( process.env.DISPLAY ? [] : [ '--headless' ] ),
 				// Chrome sandbox does not work in Docker
-				...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] )
+				...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] ),
+				// Workaround inputs not working consistently post-navigation on Chrome 90
+				// https://issuetracker.google.com/issues/42322798
+				'--allow-pre-commit-input'
 			]
 		}
 	} ],
@@ -83,9 +88,9 @@ exports.config = {
 	bail: 0,
 	// Base for browser.url() and wdio-mediawiki/Page#openTitle()
 	baseUrl: process.env.MW_SERVER + process.env.MW_SCRIPT_PATH,
-	// See also: https://webdriver.io/docs/frameworks/
+	// See also: https://webdriver.io/docs/frameworks
 	framework: 'mocha',
-	// See also: https://mochajs.org/
+	// See also: https://mochajs.org
 	// The number of times to retry the entire specfile when it fails as a whole
 	specFileRetries: 1,
 	// Delay in seconds between the spec file retry attempts
@@ -97,15 +102,16 @@ exports.config = {
 		ui: 'bdd',
 		timeout: process.env.DEBUG ? ( 60 * 60 * 1000 ) : ( 60 * 1000 )
 	},
-	// See also: https://webdriver.io/docs/dot-reporter.html
+	// See also: https://webdriver.io/docs/dot-reporter
 	reporters: [
-		// See also: https://webdriver.io/docs/spec-reporter/
+		// See also: https://webdriver.io/docs/spec-reporter
 		'spec',
-		// See also: https://webdriver.io/docs/junit-reporter/
+		// See also: https://webdriver.io/docs/junit-reporter
 		[ 'junit', {
 			outputDir: logPath,
 			outputFileFormat: function () {
-				return `WDIO.xunit-${makeFilenameDate()}.xml`;
+				const random = Math.random().toString( 16 ).slice( 2, 10 );
+				return `WDIO.xunit-${ makeFilenameDate() }-${ random }.xml`;
 			}
 		} ]
 	],
@@ -114,13 +120,27 @@ exports.config = {
 	// Hooks
 	// =====
 
+	/**
+	 * Gets executed just before initializing 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
+	 */
+	// T355556: remove when T324766 is resolved
+	beforeSession: function () {
+		// eslint-disable-next-line n/no-unsupported-features/node-builtins
+		dns.setDefaultResultOrder( 'ipv4first' );
+	},
+
 	/**
 	 * Executed before a Mocha test starts.
 	 *
 	 * @param {Object} test Mocha Test object
 	 */
 	beforeTest: function ( test ) {
-		ffmpeg = startVideo( ffmpeg, `${test.parent}-${test.title}` );
+		ffmpeg = startVideo( ffmpeg, `${ test.parent }-${ test.title }` );
 	},
 
 	/**
@@ -129,7 +149,7 @@ exports.config = {
 	 * @param {Object} test Mocha Test object
 	 */
 	afterTest: async function ( test ) {
-		await saveScreenshot( `${test.parent}-${test.title}` );
+		await saveScreenshot( `${ test.parent }-${ test.title }` );
 		stopVideo( ffmpeg );
 	}
 };