wdio-mediawiki 2.7.0 → 3.0.0

package/Api.js

@@ -14,9 +14,9 @@ module.exports = {
 	 * @return {Promise<MWBot>}
 	 */
 	async bot(
-		username = browser.config.mwUser,
-		password = browser.config.mwPwd,
-		baseUrl = browser.config.baseUrl
+		username = browser.options.capabilities[ 'mw:user' ],
+		password = browser.options.capabilities[ 'mw:pwd' ],
+		baseUrl = browser.options.baseUrl
 	) {
 		const bot = new MWBot();
 
@@ -44,7 +44,7 @@ module.exports = {
 		// Create the new account
 		return await adminBot.request( {
 			action: 'createaccount',
-			createreturnurl: browser.config.baseUrl,
+			createreturnurl: browser.options.baseUrl,
 			createtoken: adminBot.createaccountToken,
 			username: username,
 			password: password,
@@ -65,7 +65,7 @@ module.exports = {
 	async blockUser( adminBot, username, expiry ) {
 		return await adminBot.request( {
 			action: 'block',
-			user: username || browser.config.mwUser,
+			user: username || browser.options.capabilities[ 'mw:user' ],
 			reason: 'browser test',
 			token: adminBot.editToken,
 			expiry
@@ -84,7 +84,7 @@ module.exports = {
 	async unblockUser( adminBot, username ) {
 		return await adminBot.request( {
 			action: 'unblock',
-			user: username || browser.config.mwUser,
+			user: username || browser.options.capabilities[ 'mw:user' ],
 			reason: 'browser test done',
 			token: adminBot.editToken
 		} );

package/LoginPage.js

@@ -49,7 +49,7 @@ class LoginPage extends Page {
 	}
 
 	async loginAdmin() {
-		await this.login( browser.config.mwUser, browser.config.mwPwd );
+		await this.login( browser.options.capabilities[ 'mw:user' ], browser.options.capabilities[ 'mw:pwd' ] );
 	}
 }
 

package/Page.js

@@ -20,14 +20,14 @@ class Page {
 	async openTitle( title, query = {}, fragment = '' ) {
 		query.title = title;
 		await browser.url(
-			browser.config.baseUrl + '/index.php?' +
+			browser.options.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' ),
+			async () => ( await browser.execute( () => document.readyState ) ) === 'complete',
 			{
 				timeout: 10 * 1000,
 				timeoutMsg: 'Page did not load in time'

package/README.md

@@ -19,7 +19,7 @@ See [BlankPage](./BlankPage.js) and [specs/BlankPage](./specs/BlankPage.js) for
 
 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`,
+Actions are performed logged-in using `browser.options.capabilities[ 'mw:user' ]` and `browser.options.capabilities[ 'mw:pwd' ]`,
 which typically come from `MEDIAWIKI_USER` and `MEDIAWIKI_PASSWORD` environment variables.
 
 * `bot([string username [, string password [, string baseUrl ] ] ])`

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.options.baseUrl }/api.php`
 	} );
 	return bot.request( {
 		action: 'query',

package/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const fs = require( 'fs' );
+const { mkdir } = require( 'fs/promises' );
 
 /**
  * @since 1.1.0
@@ -26,7 +26,7 @@ function testTitle( title ) {
  * @return {string} Full path of screenshot/video file
  */
 function filePath( title, extension ) {
-	return `${ browser.config.screenshotPath }/${ testTitle( title ) }-${ makeFilenameDate() }.${ extension }`;
+	return `${ browser.options.capabilities[ 'mw:screenshotPath' ] }/${ testTitle( title ) }-${ makeFilenameDate() }.${ extension }`;
 }
 
 /**
@@ -34,19 +34,14 @@ function filePath( title, extension ) {
  *
  * @since 1.0.0
  * @param {string} title Description (will be sanitised and used as file name)
- * @return {string} File path
+ * @return {Promise<string>} File path
  */
 async function saveScreenshot( title ) {
 	// Create sensible file name for current test title
 	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( browser.config.screenshotPath );
-	} catch ( err ) {
-		// eslint-disable-next-line security/detect-non-literal-fs-filename
-		fs.mkdirSync( browser.config.screenshotPath );
-	}
+
+	// eslint-disable-next-line security/detect-non-literal-fs-filename
+	await mkdir( browser.options.capabilities[ 'mw:screenshotPath' ], { recursive: true } );
 	// Create and save screenshot
 	await browser.saveScreenshot( path );
 	return path;
@@ -71,6 +66,9 @@ function startVideo( ffmpeg, title ) {
 			'-pix_fmt', 'yuv420p', // QuickTime Player support, "Use -pix_fmt yuv420p for compatibility with outdated media players"
 			videoPath // output file
 		] );
+		ffmpeg.on( 'error', ( e ) => {
+			console.error( `Could not start ffmpeg or could not kill it, check the error ${ e }` );
+		} );
 		const logBuffer = function ( buffer, prefix ) {
 			const lines = buffer.toString().trim().split( '\n' );
 			lines.forEach( ( line ) => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wdio-mediawiki",
-	"version": "2.7.0",
+	"version": "3.0.0",
 	"description": "WebdriverIO plugin for testing a MediaWiki site.",
 	"homepage": "https://gerrit.wikimedia.org/g/mediawiki/core/+/master/tests/selenium/wdio-mediawiki",
 	"license": "MIT",

package/specs/BlankPage.js

@@ -7,6 +7,6 @@ describe( 'BlankPage', () => {
 		await BlankPage.open();
 
 		// check
-		await expect( await BlankPage.heading ).toHaveText( 'Blank page' );
+		await expect( BlankPage.heading ).toHaveText( 'Blank page' );
 	} );
 } );

package/wdio-defaults.conf.js

@@ -22,21 +22,28 @@ 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' );
 }
 
+process.on( 'uncaughtException', ( error ) => {
+	console.error( 'Caught uncaughtException: ', error );
+	// eslint-disable-next-line n/no-process-exit
+	process.exit( 1 );
+} );
+
+process.on( 'unhandledRejection', ( reason, promise ) => {
+	console.log( 'Unhandled Rejection at:', promise, 'reason:', reason );
+} );
+
+[ 'SIGINT', 'SIGTERM' ].forEach( ( signal ) => process.on( signal, () => {
+	// eslint-disable-next-line no-underscore-dangle
+	console.log( `Received ${ signal }. Active handles:`, process._getActiveHandles() );
+} )
+);
+
 /**
  * For more details documentation and available options:
  * - https://webdriver.io/docs/configurationfile
  * - https://webdriver.io/docs/configuration
  */
 exports.config = {
-	// ======
-	// Custom conf keys for MediaWiki
-	//
-	// Access via `browser.config.<key>`.
-	// Defaults are for MediaWiki-Docker
-	// ======
-	mwUser: process.env.MEDIAWIKI_USER,
-	mwPwd: process.env.MEDIAWIKI_PASSWORD,
-
 	// ==================
 	// Runner Configuration
 	// ==================
@@ -48,7 +55,9 @@ exports.config = {
 	specs: [
 		'./tests/selenium/specs/**/*.js'
 	],
-
+	// Set the waitForTimeout for all wait for commands
+	// https://v8.webdriver.io/docs/timeouts/#waitfor-timeout
+	waitforTimeout: 10000,
 	// ============
 	// Capabilities
 	// Define the different browser configurations to use ("capabilities") here.
@@ -56,17 +65,39 @@ exports.config = {
 
 	maxInstances: 1,
 	capabilities: [ {
+		// ======
+		// Custom conf keys for MediaWiki
+		//
+		// Access via `browser.options.<key>`.
+		// Defaults are for MediaWiki-Docker
+		// ======
+		'mw:user': process.env.MEDIAWIKI_USER,
+		'mw:pwd': process.env.MEDIAWIKI_PASSWORD,
+
+		// Setting this enables automatic screenshots for when a browser command fails
+		// It is also used by afterTest for capturing screenshots.
+		'mw:screenshotPath': logPath,
+
 		// For Chrome/Chromium https://www.w3.org/TR/webdriver
 		browserName: 'chrome',
+		// Use correct browser and driver in CI
+		...( process.env.CI && {
+			'wdio:chromedriverOptions': {
+				binary: '/usr/bin/chromedriver'
+			}
+		} ),
 		'goog:chromeOptions': {
+			...( process.env.CI && {
+				binary: '/usr/bin/chromium'
+			} ),
 			// If DISPLAY is set, assume developer asked non-headless or CI with Xvfb.
 			// Otherwise, use --headless.
 			args: [
 				// Dismissed Chrome's `Save password?` popup
 				'--enable-automation',
 				...( process.env.DISPLAY ? [] : [ '--headless' ] ),
-				// Chrome sandbox does not work in Docker
-				...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] ),
+				// Chrome sandbox does not work in Docker. Disable GPU to prevent crashes (T389536#10677201)
+				...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox', '--disable-gpu', '--disable-dev-shm-usage' ] : [] ),
 				// Workaround inputs not working consistently post-navigation on Chrome 90
 				// https://issuetracker.google.com/issues/42322798
 				'--allow-pre-commit-input'
@@ -81,9 +112,6 @@ exports.config = {
 
 	// Level of logging verbosity: trace | debug | info | warn | error | silent
 	logLevel: 'error',
-	// Setting this enables automatic screenshots for when a browser command fails
-	// It is also used by afterTest for capturing screenshots.
-	screenshotPath: logPath,
 	// Stop after this many failures, or 0 to run all tests before reporting failures.
 	bail: 0,
 	// Base for browser.url() and wdio-mediawiki/Page#openTitle()
@@ -147,9 +175,14 @@ exports.config = {
 	 * Executed after a Mocha test ends.
 	 *
 	 * @param {Object} test Mocha Test object
+	 * @param {Object} context scope object the test was executed with
+	 * @param {Object} result hook result
 	 */
-	afterTest: async function ( test ) {
-		await saveScreenshot( `${ test.parent }-${ test.title }` );
-		stopVideo( ffmpeg );
+	afterTest: async function ( test, context, result ) {
+		try {
+			await saveScreenshot( `${ test.parent }-${ test.title }${ result.passed ? '' : '-failed' }` );
+		} finally {
+			stopVideo( ffmpeg );
+		}
 	}
 };