wdio-mediawiki 6.3.2 → 6.4.0

package/Api.js

@@ -18,7 +18,8 @@ class Api {
 			baseUrl,
 			username,
 			password,
-			verbose
+			verbose,
+			cookies
 		} = options;
 
 		this.session = {
@@ -27,7 +28,7 @@ class Api {
 			createAccountToken: null
 		};
 
-		this.cookies = new Cookies();
+		this.cookies = new Cookies( cookies );
 		this.httpClient = new MwApiHttpClient( {
 			cookies: this.cookies,
 			options: {
@@ -62,7 +63,7 @@ class Api {
 	 * Do a request with custom parameters to the API. If you
 	 * use this function maybe something is missing in core?
 	 *
-	 * @param params
+	 * @param {Object} params
 	 * @return {Promise<Object>} The JSON response from the API
 	 * @throws {Error} If the request fails
 	 */
@@ -211,6 +212,7 @@ class Api {
  * - options.baseUrl -  browser.options.baseUrl
  * - options.username - browser.options.capabilities['mw:user']
  * - options.password - browser.options.capabilities['mw:pwd']
+ * - options.cookies - extra cookies to send with every API request (name -> value map)
  * - options.verbose set to true logs every response from MediaWiki
  *
  * @param {Object} [options={}] Optional api configuration.
@@ -223,7 +225,8 @@ class Api {
  *   baseUrl: 'https://mw.example.org',
  *   username: 'Admin',
  *   password: process.env.MW_PWD,
- *   verbose: true
+ *   verbose: true,
+ *   cookies: { cookie1: 'value1', cookie2: 'value2' }
  * });
  */
 export const createApiClient = async function ( options = {} ) {
@@ -234,6 +237,7 @@ export const createApiClient = async function ( options = {} ) {
 		baseUrl,
 		username,
 		password,
+		cookies: options.cookies,
 		verbose: options.verbose ?? false
 	} );
 	await api.loginGetEditToken( username, password );

package/PrometheusFileReporter.js

@@ -111,7 +111,9 @@ class PrometheusFileReporter extends WDIOReporter {
 		const testDurationInSeconds = ( test.end - test.start ) / 1000;
 		const myTest = this.testMetrics[ test.uid ];
 		myTest.passed++;
-		myTest.testDurationSecondsMax = Math.max( myTest.testDurationSecondsMax, testDurationInSeconds );
+		myTest.testDurationSecondsMax = Math.max(
+			myTest.testDurationSecondsMax, testDurationInSeconds
+		);
 		myTest.testDurationSecondsSum += testDurationInSeconds;
 		myTest.testDurationSecondsCount += 1;
 		this.spec.passed++;
@@ -121,7 +123,9 @@ class PrometheusFileReporter extends WDIOReporter {
 		const testDurationInSeconds = ( test.end - test.start ) / 1000;
 		const myTest = this.testMetrics[ test.uid ];
 		myTest.failed++;
-		myTest.testDurationSecondsMax = Math.max( myTest.testDurationSecondsMax, testDurationInSeconds );
+		myTest.testDurationSecondsMax = Math.max(
+			myTest.testDurationSecondsMax, testDurationInSeconds
+		);
 		myTest.testDurationSecondsSum += testDurationInSeconds;
 		myTest.testDurationSecondsCount += 1;
 		this.spec.failed++;
@@ -164,6 +168,7 @@ class PrometheusFileReporter extends WDIOReporter {
 		specMetrics.labels = labels;
 		specMetrics.tests = Object.values( this.testMetrics );
 		const outputPath = path.join( this.outputDir, 'specs-' + workerId + '.json' );
+		// eslint-disable-next-line security/detect-non-literal-fs-filename
 		writeFileSync( outputPath, JSON.stringify( specMetrics ), { encoding: 'utf-8' } );
 	}
 }
@@ -181,11 +186,13 @@ function writeAllProjectMetrics( metricsDir, fileName ) {
 	};
 	const tests = [];
 
+	// eslint-disable-next-line security/detect-non-literal-fs-filename
 	for ( const file of readdirSync( metricsDir ) ) {
 		if ( !file.startsWith( 'specs-' ) || !file.endsWith( '.json' ) ) {
 			continue;
 		}
 		const filePath = path.join( metricsDir, file );
+		// eslint-disable-next-line security/detect-non-literal-fs-filename
 		const data = JSON.parse( readFileSync( filePath, 'utf-8' ) );
 
 		// We have read the raw data, renmove it since we only need the .prom
@@ -298,6 +305,7 @@ function writeAllProjectMetrics( metricsDir, fileName ) {
 	// Only write the file if we have any tests https://phabricator.wikimedia.org/T407831
 	if ( projectMetrics.totalTests > 0 ) {
 		const projectName = projectMetrics.labels.project;
+		// eslint-disable-next-line security/detect-non-literal-fs-filename
 		writeFileSync( path.join( metricsDir, `${ projectName }-${ fileName }.prom` ), `${ lines.join( '\n' ) }\n`, 'utf-8' );
 	}
 }

package/Util.js

@@ -42,7 +42,7 @@ export async function isTargetNotWikitext( target ) {
 				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)
+				// Finally, check if the page is wikitext (or would be, if it doesn't yet exist)
 				done( result.query.pages[ 0 ].contentmodel !== 'wikitext' );
 			} );
 		} );

package/api/Cookies.js

@@ -3,14 +3,14 @@
  */
 export class Cookies {
 
-	constructor() {
-		this.pairs = {};
+	constructor( defaultCookies = {} ) {
+		this.pairs = { ...defaultCookies };
 	}
 
 	/**
 	 * Add cookies from Set-Cookie header lines.
 	 *
-	 * @param {Iterable<string>} setCookies - Iterable of `Set-Cookie` header lines.
+	 * @param {string[]} setCookies `Set-Cookie` header lines.
 	 */
 	getCookiesFromHeaders( setCookies ) {
 		for ( const line of setCookies ) {

package/index.js

@@ -1,10 +1,23 @@
 import { mkdir } from 'fs/promises';
+import { readFileSync } from 'fs';
 import os from 'node:os';
 import process from 'node:process';
+import { resolve } from 'path';
 import { spawn } from 'child_process';
 
 const DISPLAY_BASE = 100;
 
+// eslint-disable-next-line security/detect-non-literal-fs-filename
+export const version = JSON.parse( readFileSync( new URL( './package.json', import.meta.url ), 'utf8' ) ).version;
+
+function getPackageVersion( packageName ) {
+	try {
+		// eslint-disable-next-line security/detect-non-literal-fs-filename
+		return JSON.parse( readFileSync( resolve( process.cwd(), 'node_modules', packageName, 'package.json' ), 'utf8' ) ).version;
+	} catch {}
+	return 'unknown';
+}
+
 /**
  * @since 1.1.0
  * @return {string} File name friendly version of ISO 8601 date and time
@@ -160,6 +173,8 @@ export function logSystemInformation() {
 	console.log( `[System information] Memory (host): ${ formatMegabytesAndGigabytes( freeBytes ) } free` );
 	console.log( `[System information] RAM used by NodeJS ${ formatMegabytesAndGigabytes( rss ) }` );
 	console.log( `[System information] CPU: ${ cores } cores` );
+	console.log( `[Package information] WebdriverIO: ${ getPackageVersion( 'webdriverio' ) }` );
+	console.log( `[Package information] wdio-mediawiki: ${ version }` );
 }
 
 /**
@@ -190,8 +205,8 @@ export function setDisplay( instances ) {
  * NodeJS instances.
  *
  * @param {number} instances The number of parallel Xvfb servers to launch.
- * @param width The screen width
- * @param height The screen height
+ * @param {number} width The screen width
+ * @param {number} height The screen height
  * @return {object[]} An array of Xvfb child processes.
  */
 export function startXvfb( instances, width, height ) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wdio-mediawiki",
-	"version": "6.3.2",
+	"version": "6.4.0",
 	"type": "module",
 	"main": "index.js",
 	"description": "WebdriverIO plugin for testing a MediaWiki site.",

package/wdio-defaults.conf.js

@@ -51,6 +51,8 @@ export const config = {
 	// ============
 
 	maxInstances: process.env.CI ? 6 : 1,
+	// Make sure wdio do not try to start XVFB (we do that ourselves when needed)
+	autoXvfb: false,
 	capabilities: [ {
 		// ======
 		// Custom conf keys for MediaWiki
@@ -110,9 +112,11 @@ export const config = {
 	// By default we do not record videos and you can turn it on in CI
 	// Make sure to add it to true and change useBrowserHeadless to false
 	recordVideo: false,
-	// If you do not want to use browser headless, you need to export DISPLAY
-	// and have a display for the tests to work
-	useBrowserHeadless: Boolean( process.env.CI ),
+	// Always use headless in CI (if you do not override it),
+	// DISPLAY= forces headless and DISPLAY=<anything> forces non headless.
+	// When DISPLAY is not set locally, defaults to headless.
+	useBrowserHeadless: Boolean( process.env.CI ) ||
+		!process.env.DISPLAY,
 	// Only take screenshots on test failures. Setting this to false will take screenshots
 	// independently if a test works or fail
 	screenshotsOnFailureOnly: true,
@@ -150,7 +154,7 @@ export const config = {
 	 * Gets executed once before all workers get launched.
 	 *
 	 * @param {Object} wdioConfig wdio configuration object
-	 * @param capabilities
+	 * @param {Object[]} capabilities
 	 */
 	onPrepare: function ( wdioConfig, capabilities ) {
 		console.log( `Run test targeting ${ wdioConfig.baseUrl }` );