wdio-mediawiki 2.4.0 → 2.5.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

@@ -3,11 +3,25 @@
 const Page = require( './Page' );
 
 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' );
+	}
 
 	open() {
 		super.openTitle( 'Special:CreateAccount' );

package/LoginPage.js

@@ -3,10 +3,21 @@
 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' );
+	}
 
 	open() {
 		super.openTitle( 'Special:UserLogin' );

package/Page.js

@@ -18,10 +18,9 @@ class Page {
 	 * @return {void} This method runs a browser command.
 	 */
 	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 ) : '' )
 		);

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,12 +16,12 @@ 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( '' );
 
@@ -30,7 +30,7 @@ function runThroughMainPageRequests( runCount = 1 ) {
 			log( 'found no more queued jobs.' );
 			return;
 		}
-		log( `detected ${jobCount} more queued job(s).` );
+		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;

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 );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wdio-mediawiki",
-	"version": "2.4.0",
+	"version": "2.5.0",
 	"description": "WebdriverIO plugin for testing a MediaWiki site.",
 	"homepage": "https://gerrit.wikimedia.org/g/mediawiki/core/+/master/tests/selenium/wdio-mediawiki/",
 	"license": "MIT",
@@ -13,7 +13,8 @@
 		"specs/"
 	],
 	"engines": {
-		"node": ">=10.0"
+		"node": ">=18.17.0",
+		"npm": ">=9.6.7"
 	},
 	"dependencies": {
 		"mwbot": "2.1.3"

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' );
@@ -105,7 +107,7 @@ exports.config = {
 		[ 'junit', {
 			outputDir: logPath,
 			outputFileFormat: function () {
-				return `WDIO.xunit-${makeFilenameDate()}.xml`;
+				return `WDIO.xunit-${ makeFilenameDate() }.xml`;
 			}
 		} ]
 	],
@@ -114,13 +116,25 @@ 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 () {
+		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 +143,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 );
 	}
 };