tests/selenium/wdio.conf.js

   1 const fs = require( 'fs' ),
   2         path = require( 'path' ),
   3         logPath = process.env.LOG_DIR || path.join( __dirname, '/log' );
   4
   5 let ffmpeg;
   6
   7 // get current test title and clean it, to use it as file name
   8 function fileName( title ) {
   9         return encodeURIComponent( title.replace( /\s+/g, '-' ) );
  10 }
  11
  12 // build file path
  13 function filePath( test, screenshotPath, extension ) {
  14         return path.join( screenshotPath, `${fileName( test.parent )}-${fileName( test.title )}.${extension}` );
  15 }
  16
  17 // relative path
  18 function relPath( foo ) {
  19         return path.resolve( __dirname, '../..', foo );
  20 }
  21
  22 exports.config = {
  23         // ======
  24         // Custom WDIO config specific to MediaWiki
  25         // ======
  26         // Use in a test as `browser.options.<key>`.
  27         // Defaults are for convenience with MediaWiki-Vagrant
  28
  29         // Wiki admin
  30         username: process.env.MEDIAWIKI_USER || 'Admin',
  31         password: process.env.MEDIAWIKI_PASSWORD || 'vagrant',
  32
  33         // Base for browser.url() and Page#openTitle()
  34         baseUrl: ( process.env.MW_SERVER || 'http://127.0.0.1:8080' ) + (
  35                 process.env.MW_SCRIPT_PATH || '/w'
  36         ),
  37
  38         // ======
  39         // Sauce Labs
  40         // ======
  41         // See http://webdriver.io/guide/services/sauce.html
  42         // and https://docs.saucelabs.com/reference/platforms-configurator
  43         services: [ 'sauce' ],
  44         user: process.env.SAUCE_USERNAME,
  45         key: process.env.SAUCE_ACCESS_KEY,
  46
  47         // Default timeout in milliseconds for Selenium Grid requests
  48         connectionRetryTimeout: 90 * 1000,
  49
  50         // Default request retries count
  51         connectionRetryCount: 3,
  52
  53         // ==================
  54         // Test Files
  55         // FIXME: The non-core patterns to be removed once T199116 is fixed.
  56         // ==================
  57         specs: [
  58                 relPath( './tests/selenium/wdio-mediawiki/specs/*.js' ),
  59                 relPath( './tests/selenium/specs/**/*.js' ),
  60                 relPath( './extensions/*/tests/selenium/specs/**/*.js' ),
  61                 relPath( './extensions/VisualEditor/modules/ve-mw/tests/selenium/specs/**/*.js' ),
  62                 relPath( './extensions/Wikibase/repo/tests/selenium/specs/**/*.js' ),
  63                 relPath( './skins/*/tests/selenium/specs/**/*.js' )
  64         ],
  65         // Patterns to exclude
  66         exclude: [
  67                 relPath( './extensions/CirrusSearch/tests/selenium/specs/**/*.js' ),
  68                 // Disabled per T222517
  69                 relPath( './skins/MinervaNeue/tests/selenium/specs/**/*.js' )
  70         ],
  71
  72         // ============
  73         // Capabilities
  74         // ============
  75
  76         // How many instances of the same capability (browser) may be started at the same time.
  77         maxInstances: 1,
  78
  79         capabilities: [ {
  80                 // For Chrome/Chromium https://sites.google.com/a/chromium.org/chromedriver/capabilities
  81                 browserName: 'chrome',
  82                 maxInstances: 1,
  83                 chromeOptions: {
  84                         // If DISPLAY is set, assume developer asked non-headless or CI with Xvfb.
  85                         // Otherwise, use --headless (added in Chrome 59)
  86                         // https://chromium.googlesource.com/chromium/src/+/59.0.3030.0/headless/README.md
  87                         args: [
  88                                 ...( process.env.DISPLAY ? [] : [ '--headless' ] ),
  89                                 // Chrome sandbox does not work in Docker
  90                                 ...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] )
  91                         ]
  92                 }
  93         } ],
  94
  95         // ===================
  96         // Test Configurations
  97         // ===================
  98
  99         // Enabling synchronous mode (via the wdio-sync package), means specs don't have to
 100         // use Promise#then() or await for browser commands, such as like `brower.element()`.
 101         // Instead, it will automatically pause JavaScript execution until th command finishes.
 102         //
 103         // For non-browser commands (such as MWBot and other promises), this means you
 104         // have to use `browser.call()` to make sure WDIO waits for it before the next
 105         // browser command.
 106         sync: true,
 107
 108         // Level of logging verbosity: silent | verbose | command | data | result | error
 109         logLevel: 'error',
 110
 111         // Enables colors for log output.
 112         coloredLogs: true,
 113
 114         // Warns when a deprecated command is used
 115         deprecationWarnings: true,
 116
 117         // Stop the tests once a certain number of failed tests have been recorded.
 118         // Default is 0 - don't bail, run all tests.
 119         bail: 0,
 120
 121         // Setting this enables automatic screenshots for when a browser command fails
 122         // It is also used by afterTest for capturig failed assertions.
 123         // We disable it since we have our screenshot handler in the afterTest hook.
 124         screenshotPath: null,
 125
 126         // Default timeout for each waitFor* command.
 127         waitforTimeout: 10 * 1000,
 128
 129         // Framework you want to run your specs with.
 130         // See also: http://webdriver.io/guide/testrunner/frameworks.html
 131         framework: 'mocha',
 132
 133         // Test reporter for stdout.
 134         // See also: http://webdriver.io/guide/testrunner/reporters.html
 135         reporters: [ 'spec', 'junit' ],
 136         reporterOptions: {
 137                 junit: {
 138                         outputDir: logPath
 139                 }
 140         },
 141
 142         // Options to be passed to Mocha.
 143         // See the full list at http://mochajs.org/
 144         mochaOpts: {
 145                 ui: 'bdd',
 146                 timeout: 60 * 1000
 147         },
 148
 149         // =====
 150         // Hooks
 151         // =====
 152         // See also: http://webdriver.io/guide/testrunner/configurationfile.html
 153
 154         /**
 155         * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
 156         * @param {Object} test test details
 157         */
 158         beforeTest: function ( test ) {
 159                 if ( process.env.DISPLAY && process.env.DISPLAY.startsWith( ':' ) ) {
 160                         var logBuffer;
 161                         let videoPath = filePath( test, logPath, 'mp4' );
 162                         const { spawn } = require( 'child_process' );
 163                         ffmpeg = spawn( 'ffmpeg', [
 164                                 '-f', 'x11grab', //  grab the X11 display
 165                                 '-video_size', '1280x1024', // video size
 166                                 '-i', process.env.DISPLAY, // input file url
 167                                 '-loglevel', 'error', // log only errors
 168                                 '-y', // overwrite output files without asking
 169                                 '-pix_fmt', 'yuv420p', // QuickTime Player support, "Use -pix_fmt yuv420p for compatibility with outdated media players"
 170                                 videoPath // output file
 171                         ] );
 172
 173                         logBuffer = function ( buffer, prefix ) {
 174                                 let lines = buffer.toString().trim().split( '\n' );
 175                                 lines.forEach( function ( line ) {
 176                                         console.log( prefix + line );
 177                                 } );
 178                         };
 179
 180                         ffmpeg.stdout.on( 'data', ( data ) => {
 181                                 logBuffer( data, 'ffmpeg stdout: ' );
 182                         } );
 183
 184                         ffmpeg.stderr.on( 'data', ( data ) => {
 185                                 logBuffer( data, 'ffmpeg stderr: ' );
 186                         } );
 187
 188                         ffmpeg.on( 'close', ( code, signal ) => {
 189                                 console.log( '\n\tVideo location:', videoPath, '\n' );
 190                                 if ( code !== null ) {
 191                                         console.log( `\tffmpeg exited with code ${code} ${videoPath}` );
 192                                 }
 193                                 if ( signal !== null ) {
 194                                         console.log( `\tffmpeg received signal ${signal} ${videoPath}` );
 195                                 }
 196                         } );
 197                 }
 198         },
 199
 200         /**
 201          * Save a screenshot when test fails.
 202          *
 203          * @param {Object} test Mocha Test object
 204          */
 205         afterTest: function ( test ) {
 206                 if ( ffmpeg ) {
 207                         // stop video recording
 208                         ffmpeg.kill( 'SIGINT' );
 209                 }
 210
 211                 // if test passed, ignore, else take and save screenshot
 212                 if ( test.passed ) {
 213                         return;
 214                 }
 215                 // save screenshot
 216                 let screenshotfile = filePath( test, logPath, 'png' );
 217                 browser.saveScreenshot( screenshotfile );
 218                 console.log( '\n\tScreenshot location:', screenshotfile, '\n' );
 219         }
 220 };