forked from webdriverio-community/wdio-video-reporter
-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.js
238 lines (200 loc) · 7.46 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
import WdioReporter from '@wdio/reporter';
import allureReporter from '@wdio/allure-reporter';
import fs from 'fs-extra';
import path from 'path';
import helpers from './helpers.js';
import config from './config.js';
import notAvailableImage from './assets/not-available.png';
import defaultFramework from './frameworks/default.js';
import cucumberFramework from './frameworks/cucumber.js';
export default class Video extends WdioReporter {
/**
* Set reporter options
*/
constructor (options) {
if (options.logLevel === 'silent') {
options.logFile = undefined;
}
super(options);
this.isDone = false;
// User options
if(options.outputDir) {
config.outputDir = options.outputDir;
} else {
// Wdio doesn't pass outputDir, but logFile which includes outputDir
config.outputDir = options.logFile ? path.dirname(options.logFile) : config.outputDir;
}
if(config.outputDir.length > 1) {
config.outputDir = config.outputDir.replace(/[\/|\\]$/, '');
}
config.saveAllVideos = options.saveAllVideos || config.saveAllVideos;
config.videoSlowdownMultiplier = options.videoSlowdownMultiplier || config.videoSlowdownMultiplier;
config.videoRenderTimeout = options.videoRenderTimeout || config.videoRenderTimeout;
config.excludedActions.push(...(options.addExcludedActions || []));
config.jsonWireActions.push(...(options.addJsonWireActions || []));
config.recordAllActions = options.recordAllActions || false;
config.maxTestNameCharacters = options.maxTestNameCharacters || config.maxTestNameCharacters;
this.screenshotPromises = [];
this.videos = [];
this.videoPromises = [];
this.testnameStructure = [];
this.testname = '';
this.frameNr = 0;
this.videos = [];
this.config = config;
helpers.setLogger(msg => this.write(msg));
}
/**
* overwrite isSynchronised method
*/
get isSynchronised () {
return this.isDone;
}
/**
* Set wdio config options
*/
onRunnerStart (browser) {
const allureConfig = browser.config.reporters.filter(r => r === 'allure' || r[0] === 'allure').pop();
if (allureConfig && allureConfig[1] && allureConfig[1].outputDir) {
config.allureOutputDir = path.resolve(allureConfig[1].outputDir);
}
config.usingAllure = !!allureConfig;
const logLevel = browser.config.logLevel;
config.debugMode = logLevel.toLowerCase() === 'trace' || logLevel.toLowerCase() === 'debug';
helpers.debugLog('Using reporter config:' + JSON.stringify(browser.config.reporters, undefined, 2) + '\n\n');
helpers.debugLog('Using config:' + JSON.stringify(config, undefined, 2) + '\n\n\n');
// Jasmine and Mocha ought to behave the same regarding test-structure
this.framework = browser.config.framework === 'cucumber' ? cucumberFramework : defaultFramework;
this.framework.frameworkInit.call(this, browser);
if(config.usingAllure) {
process.on('exit', () => this.onExit.call(this));
}
}
/**
* Save screenshot or add not available image movie stills
*/
onAfterCommand (jsonWireMsg) {
const command = jsonWireMsg.endpoint && jsonWireMsg.endpoint.match(/[^\/]+$/);
const commandName = command ? command[0] : 'undefined';
helpers.debugLog('Incoming command: ' + jsonWireMsg.endpoint + ' => [' + commandName + ']\n');
// Filter out non-action commands and keep only last action command
if ((!config.recordAllActions && (config.excludedActions.includes(commandName) || !config.jsonWireActions.includes(commandName)))
|| !this.recordingPath) {
return;
}
const filename = this.frameNr.toString().padStart(4, '0') + '.png';
const filePath = path.resolve(this.recordingPath, filename);
try {
this.screenshotPromises.push(
browser.saveScreenshot(filePath).then(() => {
helpers.debugLog('- Screenshot!!\n');
})
);
} catch (e) {
fs.writeFile(filePath, notAvailableImage, 'base64');
helpers.debugLog('- Screenshot not available...\n');
}
this.frameNr++;
}
/**
* Add suite name to naming structure
*/
onSuiteStart (suite) {
helpers.debugLog(`\n\n\n--- New suite: ${suite.title} ---\n`);
this.framework.onSuiteStart.call(this, suite);
}
/**
* Cleare suite name from naming structure
*/
onSuiteEnd (suite) {
this.testnameStructure.pop();
this.framework.onSuiteEnd.call(this, suite);
}
/**
* Setup filename based on test name and prepare storage directory
*/
onTestStart (test) {
this.framework.onTestStart.call(this, test);
}
/**
* Remove empty directories
*/
onTestSkip (test) {
this.framework.onTestSkip.call(this, test);
}
/**
* Add attachment to Allue if applicable and start to generate the video (Not applicable to Cucumber)
*/
onTestEnd (test) {
this.testnameStructure.pop();
if(config.usingAllure) {
if (browser.capabilities.deviceType) {
allureReporter.addArgument('deviceType', browser.capabilities.deviceType);
}
if (browser.capabilities.browserVersion) {
allureReporter.addArgument('browserVersion', browser.capabilities.browserVersion);
}
}
if (test.state === 'failed' || (test.state === 'passed' && config.saveAllVideos)) {
const filePath = path.resolve(this.recordingPath, this.frameNr.toString().padStart(4, '0') + '.png');
try {
this.screenshotPromises.push(
browser.saveScreenshot(filePath).then(() => {
helpers.debugLog('- Screenshot!!\n');
})
);
} catch (e) {
fs.writeFile(filePath, notAvailableImage, 'base64');
helpers.debugLog('- Screenshot not available...\n');
}
helpers.generateVideo.call(this);
}
}
/**
* Wait for all ffmpeg-processes to finish
*/
onRunnerEnd () {
let abortTimer;
let started = false;
const wrapItUp = () => {
if (!started) {
clearTimeout(abortTimer);
started = true;
helpers.debugLog(`\n--- FFMPEG is done ---\n\n`);
this.write('\nGenerated:' + JSON.stringify(this.videos, undefined, 2) + '\n\n');
this.write(`\n\nVideo reporter Done!\n`);
this.isDone = true;
}
};
Promise.all(this.videoPromises)
.then(wrapItUp)
.catch(wrapItUp);
abortTimer = setTimeout(() => {
this.write(`videoRenderTimeout triggered before ffmpeg had a chance to wrap up`);
wrapItUp();
}, config.videoRenderTimeout*1000);
}
/**
* Finalize allure report
*/
onExit () {
const abortTime = new Date().getTime() + config.videoRenderTimeout*1000;
helpers.waitForVideosToExist(this.videos, abortTime);
helpers.waitForVideosToBeWritten(this.videos, abortTime);
if (new Date().getTime() > abortTime) {
console.log(`videoRenderTimeout triggered, not all videos finished writing to disk before patching Allure`);
}
fs
.readdirSync(config.allureOutputDir)
.filter(line => line.includes('.mp4'))
.map(filename => path.resolve(config.allureOutputDir, filename))
.filter(allureFile => fs.statSync(allureFile).size < 1024)
.filter(allureFile => this.videos.includes(fs.readFileSync(allureFile).toString())) // Dont parse other browsers videos since they may not be ready
.forEach((filePath) => {
const videoFilePath = fs.readFileSync(filePath).toString(); // The contents of the placeholder file is the video path
if (fs.existsSync(videoFilePath)) {
fs.copySync(videoFilePath, filePath);
}
});
}
}