Merge "Type hint against LinkTarget in WatchedItemStore"
[lhc/web/wiklou.git] / 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 because these tests modify LocalSettings.php, see T199116 for the long-term fix.
69 relPath( './extensions/FileImporter/tests/selenium/specs/**/*.js' ),
70 // Disabled per T222517
71 relPath( './skins/MinervaNeue/tests/selenium/specs/**/*.js' )
72 ],
73
74 // ============
75 // Capabilities
76 // ============
77
78 // How many instances of the same capability (browser) may be started at the same time.
79 maxInstances: 1,
80
81 capabilities: [ {
82 // For Chrome/Chromium https://sites.google.com/a/chromium.org/chromedriver/capabilities
83 browserName: 'chrome',
84 maxInstances: 1,
85 chromeOptions: {
86 // If DISPLAY is set, assume developer asked non-headless or CI with Xvfb.
87 // Otherwise, use --headless (added in Chrome 59)
88 // https://chromium.googlesource.com/chromium/src/+/59.0.3030.0/headless/README.md
89 args: [
90 ...( process.env.DISPLAY ? [] : [ '--headless' ] ),
91 // Chrome sandbox does not work in Docker
92 ...( fs.existsSync( '/.dockerenv' ) ? [ '--no-sandbox' ] : [] )
93 ]
94 }
95 } ],
96
97 // ===================
98 // Test Configurations
99 // ===================
100
101 // Enabling synchronous mode (via the wdio-sync package), means specs don't have to
102 // use Promise#then() or await for browser commands, such as like `brower.element()`.
103 // Instead, it will automatically pause JavaScript execution until th command finishes.
104 //
105 // For non-browser commands (such as MWBot and other promises), this means you
106 // have to use `browser.call()` to make sure WDIO waits for it before the next
107 // browser command.
108 sync: true,
109
110 // Level of logging verbosity: silent | verbose | command | data | result | error
111 logLevel: 'error',
112
113 // Enables colors for log output.
114 coloredLogs: true,
115
116 // Warns when a deprecated command is used
117 deprecationWarnings: true,
118
119 // Stop the tests once a certain number of failed tests have been recorded.
120 // Default is 0 - don't bail, run all tests.
121 bail: 0,
122
123 // Setting this enables automatic screenshots for when a browser command fails
124 // It is also used by afterTest for capturig failed assertions.
125 // We disable it since we have our screenshot handler in the afterTest hook.
126 screenshotPath: null,
127
128 // Default timeout for each waitFor* command.
129 waitforTimeout: 10 * 1000,
130
131 // Framework you want to run your specs with.
132 // See also: http://webdriver.io/guide/testrunner/frameworks.html
133 framework: 'mocha',
134
135 // Test reporter for stdout.
136 // See also: http://webdriver.io/guide/testrunner/reporters.html
137 reporters: [ 'spec', 'junit' ],
138 reporterOptions: {
139 junit: {
140 outputDir: logPath
141 }
142 },
143
144 // Options to be passed to Mocha.
145 // See the full list at http://mochajs.org/
146 mochaOpts: {
147 ui: 'bdd',
148 timeout: 60 * 1000
149 },
150
151 // =====
152 // Hooks
153 // =====
154 // See also: http://webdriver.io/guide/testrunner/configurationfile.html
155
156 /**
157 * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
158 * @param {Object} test test details
159 */
160 beforeTest: function ( test ) {
161 if ( process.env.DISPLAY && process.env.DISPLAY.startsWith( ':' ) ) {
162 var logBuffer;
163 const videoPath = filePath( test, logPath, 'mp4' );
164 const { spawn } = require( 'child_process' );
165 ffmpeg = spawn( 'ffmpeg', [
166 '-f', 'x11grab', // grab the X11 display
167 '-video_size', '1280x1024', // video size
168 '-i', process.env.DISPLAY, // input file url
169 '-loglevel', 'error', // log only errors
170 '-y', // overwrite output files without asking
171 '-pix_fmt', 'yuv420p', // QuickTime Player support, "Use -pix_fmt yuv420p for compatibility with outdated media players"
172 videoPath // output file
173 ] );
174
175 logBuffer = function ( buffer, prefix ) {
176 const lines = buffer.toString().trim().split( '\n' );
177 lines.forEach( function ( line ) {
178 console.log( prefix + line );
179 } );
180 };
181
182 ffmpeg.stdout.on( 'data', ( data ) => {
183 logBuffer( data, 'ffmpeg stdout: ' );
184 } );
185
186 ffmpeg.stderr.on( 'data', ( data ) => {
187 logBuffer( data, 'ffmpeg stderr: ' );
188 } );
189
190 ffmpeg.on( 'close', ( code, signal ) => {
191 console.log( '\n\tVideo location:', videoPath, '\n' );
192 if ( code !== null ) {
193 console.log( `\tffmpeg exited with code ${code} ${videoPath}` );
194 }
195 if ( signal !== null ) {
196 console.log( `\tffmpeg received signal ${signal} ${videoPath}` );
197 }
198 } );
199 }
200 },
201
202 /**
203 * Save a screenshot when test fails.
204 *
205 * @param {Object} test Mocha Test object
206 */
207 afterTest: function ( test ) {
208 if ( ffmpeg ) {
209 // stop video recording
210 ffmpeg.kill( 'SIGINT' );
211 }
212
213 // if test passed, ignore, else take and save screenshot
214 if ( test.passed ) {
215 return;
216 }
217 // save screenshot
218 const screenshotfile = filePath( test, logPath, 'png' );
219 browser.saveScreenshot( screenshotfile );
220 console.log( '\n\tScreenshot location:', screenshotfile, '\n' );
221 }
222 };