Selenium/How-to/Run tests targeting Patch demo

For this example, we will target the public instance of Patch demo. To access Patch Demo you need a Wikimedia account. Using Patch Demo, you can choose which extensions and patches you need using the GUI.

Clone MediaWiki core

There are several ways to clone the MediaWiki core (anonymous http, http, ssh). In this example, we will use anonymous http since it is the simplest. You can skip this step if you already have MediaWiki core cloned.

git clone "https://gerrit.wikimedia.org/r/mediawiki/core"

Go to MediaWiki core folder

cd core

Install dependencies

Depending on your operating system, installing dependencies will be different.

Browser

• Install Google Chrome or Chromium.

Node.js

• Install Node.js and npm.
• Install required npm packages.

Warning:

Running npm ci is not safe. See How to protect yourself from npm.

npm ci

Start Patch demo

1. Go to Patch demo in your browser
2. Create a wiki with the patches/extensions you need for your test and click "Create demo"
3. Patch demo will show usernames and passwords for the users. Save those to use in your environment variables.

   

4. In the last step when you press "Open wiki" you will get the URL to your instance (it will look something like https://651d9fcf78.catalyst.wmcloud.org. Use that instead of patchdemo_url when you configure your MW_SERVER in the next step.

Environment variables

DISPLAY

Check if DISPLAY environment variable is set with echo $DISPLAY. If there's no output, that's good. (The default on macOS). If you get any output, for example :0 (the default on Ubuntu Linux), unset the variable with unset DISPLAY.

For more information see Selenium/How-to/Make the browser visible and Selenium/How-to/Record videos of test runs.

MW_* and MEDIAWIKI_*

Ensure the following environment variables are set. Either run this manually from the terminal or, to make it easier for next time, set them from shell configuration file (~/.bash_profile, ~/.zshrc...) which means the variables are always available from any terminal session:

# Target Patch Demo
export MW_SERVER=patchdemo_url
export MW_SCRIPT_PATH=/w
export MEDIAWIKI_USER="Patch Demo"
export MEDIAWIKI_PASSWORD=patchdemo1

If you prefer, you can create an .env file instead (in MediaWiki core folder), with this content.

# Target Patch Demo
MW_SERVER=patchdemo_url
MW_SCRIPT_PATH=/w
MEDIAWIKI_USER="Patch Demo"
MEDIAWIKI_PASSWORD=patchdemo1

Replace patchdemo_url with your url that you will get when you create your Patch demo instance.

Run the Selenium tests

Run all tests.

npm run selenium-test