Open rafalf opened 2 years ago
That is true. Set the option in the reporter, not the aggregator / But you cant use that and the video reporter at the same time. they interfere with each other. You can set a breakpoint on ine 187 of HtmlReporter at the start of onAfterCommand to see if it is working properly for you.
Rich
On Mon, Jun 6, 2022 at 2:10 AM Rafal Fusik @.***> wrote:
framework: 'jasmine', useOnAfterCommandForScreenshot: true,
Here the config: (NOTE: wdio-video-reporter is commented out)
const { ReportAggregator } = require("wdio-html-nice-reporter"); // const video = require('wdio-video-reporter'); const log = require('log4js'); log.configure({ appenders: { fileLog: { type: 'file', filename: "logs/html-reporter.log", maxLogSize: 5000000, level: 'debug' }, debugLog: { type: 'file', filename: "logs/debug-html-reporter.log", maxLogSize: 5000000, level: 'debug' }, 'out': { type: 'stdout', layout: { type: "colored" } }, 'filterOut': { type: 'stdout', layout: { type: "colored" }, level: 'info' } }, categories: { file: {appenders: ['fileLog'], level: 'info'}, default: {appenders: ['out', 'fileLog'], level: 'info'}, console: {appenders: ['out'], level: 'info'}, debug: {appenders: ['debugLog'], level: 'debug'} } });
//pick the category above to match the output you want. let logger = log.getLogger("default");
exports.config = {
// // ==================== // Runner Configuration // ==================== // // // ================== // Specify Test Files // ================== // Define which test specs should run. The pattern is relative to the directory // from which `wdio` was called. // // The specs are defined as an array of spec files (optionally using wildcards // that will be expanded). The test for each spec file will be run in a separate // worker process. In order to have a group of spec files run in the same worker // process simply enclose them in an array within the specs array. // // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script), // then the current working directory is where your `package.json` resides, so `wdio` // will be called from there. // specs: [ './test/specs/**/*.js' ], suites: { suite_1: [ './test/specs/a1.spec.js', ], suite_2: [ './test/specs/a2.cap.spec.js', ], }, // Patterns to exclude. exclude: [ // 'path/to/excluded/files' ], // // ============ // Capabilities // ============ // Define your capabilities here. WebdriverIO can run multiple capabilities at the same // time. Depending on the number of capabilities, WebdriverIO launches several test // sessions. Within your capabilities you can overwrite the spec and exclude options in // order to group specific specs to a specific capability. // // First, you can define how many instances should be started at the same time. Let's // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec // files and you set maxInstances to 10, all spec files will get tested at the same time // and 30 processes will get spawned. The property handles how many capabilities // from the same test should run tests. // maxInstances: 1, // // If you have trouble getting all important capabilities together, check out the // Sauce Labs platform configurator - a great tool to configure your capabilities: // https://saucelabs.com/platform/platform-configurator // capabilities: [{ // maxInstances can get overwritten per capability. So if you have an in-house Selenium // grid with only 5 firefox instances available you can make sure that not more than // 5 instances get started at a time. maxInstances: 1, // chrome options and capabilities // https://webdriver.io/docs/options/#capabilities browserName: 'chrome', "goog:chromeOptions": { "excludeSwitches": [ "enable-automation" ], args: [ '--window-size=1440,900', '--no-sandbox', ], prefs: { download: { 'prompt_for_download': false, 'directory_upgrade': true, 'default_directory': require('path').resolve(__dirname, 'download') }, credentials_enable_service: false, profile: { 'password_manager_enabled': false } }, }, acceptInsecureCerts: true // If outputDir is provided WebdriverIO can capture driver session logs // it is possible to configure which logTypes to include/exclude. // excludeDriverLogs: ['*'], // pass '*' to exclude all driver session logs // excludeDriverLogs: ['bugreport', 'server'], }], // // =================== // Test Configurations // =================== // Define all options that are relevant for the WebdriverIO instance here // // Level of logging verbosity: trace | debug | info | warn | error | silent logLevel: 'debug', // // Set specific log levels per logger // loggers: // - webdriver, webdriverio // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service // - @wdio/mocha-framework, @wdio/jasmine-framework // - @wdio/local-runner // - @wdio/sumologic-reporter // - @wdio/cli, @wdio/config, @wdio/utils // Level of logging verbosity: trace | debug | info | warn | error | silent // logLevels: { // webdriver: 'info', // ***@***.***/appium-service': 'info' // }, // // If you only want to run your tests until a specific amount of tests have failed use // bail (default is 0 - don't bail, run all tests). bail: 1, // // Set a base URL in order to shorten url command calls. If your `url` parameter starts // with `/`, the base url gets prepended, not including the path portion of your baseUrl. // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url // gets prepended directly. baseUrl: 'http://localhost', // // Default timeout for all waitFor* commands. waitforTimeout: 10000, // // Default timeout in milliseconds for request // if browser driver or grid doesn't send response connectionRetryTimeout: 120000, // // Default request retries count connectionRetryCount: 3, // // Test runner services // Services take over a specific job you don't want to take care of. They enhance // your test setup with almost no effort. Unlike plugins, they don't add new // commands. Instead, they hook themselves up into the test process. services: ['chromedriver'], // Framework you want to run your specs with. // The following are supported: Mocha, Jasmine, and Cucumber // see also: https://webdriver.io/docs/frameworks // // Make sure you have the wdio adapter package for the specific framework installed // before running any tests. framework: 'jasmine', // // The number of times to retry the entire specfile when it fails as a whole specFileRetries: 1, // Delay in seconds between the spec file retry attempts specFileRetriesDelay: 0, // // Whether or not retried specfiles should be retried immediately or deferred to the end of the queue specFileRetriesDeferred: false, // // Test reporter for stdout. // The only one supported by default is 'dot' // see also: https://webdriver.io/docs/dot-reporter // https://github.com/presidenten/wdio-video-reporter // https://github.com/rpii/wdio-html-reporter reporters: [ 'spec', // [video, { // saveAllVideos: false, // If true, also saves videos for successful test cases // videoSlowdownMultiplier: 3, // Higher to get slower videos, lower for faster videos [Value 1-100] // videoRenderTimeout: 5, // Max seconds to wait for a video to finish rendering\ // outputDir: 'reports/html-reports/screenshots', // }], ["html-nice", { debug: true, outputDir: './reports/html-reports/', filename: 'report.html', reportTitle: 'HTML Report', linkScreenshots: true, //to show the report in a browser when done showInBrowser: false, collapseTests: false, //to turn on screenshots after every test useOnAfterCommandForScreenshot: true, LOG: logger }] ], // // Options to be passed to Jasmine. jasmineOpts: { // Jasmine default timeout defaultTimeoutInterval: 60000, // // The Jasmine framework allows interception of each assertion in order to log the state of the application // or website depending on the result. For example, it is pretty handy to take a screenshot every time // an assertion fails. expectationResultHandler: function(passed, assertion) { // do something } }, // // ===== // Hooks // ===== // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance // it and to build services around it. You can either apply a single function or an array of // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got // resolved to continue. /** * Gets executed once before all workers get launched. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details */ // onPrepare: function (config, capabilities) { // }, /** * Gets executed before a worker process is spawned and can be used to initialise specific service * for that worker as well as modify runtime environments in an async fashion. * @param {String} cid capability id (e.g 0-0) * @param {[type]} caps object containing capabilities for session that will be spawn in the worker * @param {[type]} specs specs to be run in the worker process * @param {[type]} args object that will be merged with the main configuration once worker is initialized * @param {[type]} execArgv list of string arguments passed to the worker process */ // onWorkerStart: function (cid, caps, specs, args, execArgv) { // }, /** * Gets executed just after a worker process has exited. * @param {String} cid capability id (e.g 0-0) * @param {Number} exitCode 0 - success, 1 - fail * @param {[type]} specs specs to be run in the worker process * @param {Number} retries number of retries used */ // onWorkerEnd: function (cid, exitCode, specs, retries) { // }, /** * Gets executed just before initialising the webdriver session and test framework. It allows you * to manipulate configurations depending on the capability or spec. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that are to be run * @param {String} cid worker id (e.g. 0-0) */ // beforeSession: function (config, capabilities, specs, cid) { // }, /** * Gets executed before test execution begins. At this point you can access to all global * variables like `browser`. It is the perfect place to define custom commands. * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that are to be run * @param {Object} browser instance of created browser/device session */ // before: function (capabilities, specs) { // }, /** * Runs before a WebdriverIO command gets executed. * @param {String} commandName hook command name * @param {Array} args arguments that command would receive */ // beforeCommand: function (commandName, args) { // }, /** * Hook that gets executed before the suite starts * @param {Object} suite suite details */ // beforeSuite: function (suite) { // }, /** * Function to be executed before a test (in Mocha/Jasmine) starts. */ // beforeTest: function (test, context) { // }, /** * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling * beforeEach in Mocha) */ // beforeHook: function (test, context) { // }, /** * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling * afterEach in Mocha) */ // afterHook: function (test, context, { error, result, duration, passed, retries }) { // }, /** * Function to be executed after a test (in Mocha/Jasmine only) * @param {Object} test test object * @param {Object} context scope object the test was executed with * @param {Error} result.error error object in case the test fails, otherwise `undefined` * @param {Any} result.result return object of test function * @param {Number} result.duration duration of test * @param {Boolean} result.passed true if test has passed, otherwise false * @param {Object} result.retries information to spec related retries, e.g. `{ attempts: 0, limit: 0 }` */ // afterTest: function(test, context, { error, result, duration, passed, retries }) { // }, // afterTest: function ( // test, // context, // { error, result, duration, passed, retries } // ) { // // take a screenshot anytime a test fails and throws an error // if (error) { // browser.takeScreenshot(); // } // }, /** * Hook that gets executed after the suite has ended * @param {Object} suite suite details */ // afterSuite: function (suite) { // }, /** * Runs after a WebdriverIO command gets executed * @param {String} commandName hook command name * @param {Array} args arguments that command would receive * @param {Number} result 0 - command success, 1 - command error * @param {Object} error error object if any */ // afterCommand: function (commandName, args, result, error) { // }, /** * Gets executed after all tests are done. You still have access to all global variables from * the test. * @param {Number} result 0 - test pass, 1 - test fail * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that ran */ // after: function (result, capabilities, specs) { // }, /** * Gets executed right after terminating the webdriver session. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that ran */ // afterSession: function (config, capabilities, specs) { // }, /** * Gets executed after all workers got shut down and the process is about to exit. An error * thrown in the onComplete hook will result in the test run failing. * @param {Object} exitCode 0 - success, 1 - fail * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {<Object>} results object containing test results */ // onComplete: function(exitCode, config, capabilities, results) { // }, /** * Gets executed when a refresh happens. * @param {String} oldSessionId session ID of the old session * @param {String} newSessionId session ID of the new session */ // onReload: function(oldSessionId, newSessionId) { // } onPrepare: function (config, capabilities) { let reportAggregator = new ReportAggregator({ outputDir: './reports/html-reports/', filename: 'master-report.html', reportTitle: 'Master Report', browserName : 'chrome', LOG: logger, collapseTests: true }); reportAggregator.clean() ; global.reportAggregator = reportAggregator; }, onComplete: function(exitCode, config, capabilities, results) { (async () => { await global.reportAggregator.createReport(); })(); },
}
my understanding is that the following setting should make the reporter to take a screenshot and attach to the report when aggregated:
useOnAfterCommandForScreenshot: true,
— Reply to this email directly, view it on GitHub https://github.com/rpii/wdio-html-reporter/issues/87, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEABIENFVEOD2FH7OG6K3B3VNW553ANCNFSM5X6XXMYA . You are receiving this because you are subscribed to this thread.Message ID: @.***>
@rpii It is set in the reporter and the video is out so they don't mess up each other
["html-nice", {
debug: true,
outputDir: './reports/html-reports/',
filename: 'report.html',
reportTitle: 'HTML Report',
linkScreenshots: true,
//to show the report in a browser when done
showInBrowser: false,
collapseTests: false,
//to turn on screenshots after every test
useOnAfterCommandForScreenshot: true,
LOG: logger
}]
],
I ran this in cucumber and got a screenshot for each test:
On Tue, Jun 7, 2022 at 2:58 AM Rafal Fusik @.***> wrote:
@rpii https://github.com/rpii It is set in the reporter and the video is out so they don't mess up each other
["html-nice", { debug: true, outputDir: './reports/html-reports/', filename: 'report.html', reportTitle: 'HTML Report', linkScreenshots: true, //to show the report in a browser when done showInBrowser: false, collapseTests: false, //to turn on screenshots after every test useOnAfterCommandForScreenshot: true, LOG: logger }] ],
— Reply to this email directly, view it on GitHub https://github.com/rpii/wdio-html-reporter/issues/87#issuecomment-1148455379, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEABIEMPKHCP6564LGBBXNTVN4MH7ANCNFSM5X6XXMYA . You are receiving this because you were mentioned.Message ID: @.***>
@rpii I DONT use cucumber, its a plain webdriverio with the html reporter and jasmine as a framework
@rpii
I checked it put with mocha
as well, no joy no screenshots taken
My config:
const { ReportAggregator } = require("wdio-html-nice-reporter");
const LOG = require('log4js');
LOG.configure({
appenders: {
fileLog: {
type: 'file',
filename: "logs/html-reporter.log",
maxLogSize: 5000000,
level: 'debug'
},
debugLog: {
type: 'file',
filename: "logs/debug-html-reporter.log",
maxLogSize: 5000000,
level: 'debug'
},
'out': {
type: 'stdout',
layout: {
type: "colored"
}
},
'filterOut': {
type: 'stdout',
layout: {
type: "colored"
},
level: 'info'
}
},
categories: {
file: {appenders: ['fileLog'], level: 'info'},
default: {appenders: ['out', 'fileLog'], level: 'info'},
console: {appenders: ['out'], level: 'info'},
debug: {appenders: ['debugLog'], level: 'debug'}
}
});
//pick the category above to match the output you want.
let logger = LOG.getLogger("default");
exports.config = {
//
// ====================
// Runner Configuration
// ====================
//
//
// ==================
// Specify Test Files
// ==================
// Define which test specs should run. The pattern is relative to the directory
// from which `wdio` was called.
//
// The specs are defined as an array of spec files (optionally using wildcards
// that will be expanded). The test for each spec file will be run in a separate
// worker process. In order to have a group of spec files run in the same worker
// process simply enclose them in an array within the specs array.
//
// If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script),
// then the current working directory is where your `package.json` resides, so `wdio`
// will be called from there.
//
specs: [
'./test/specs/**/*.js'
],
suites: {
cid_dev: [
'./test/specs/template.cid.spec.js',
],
cid: [
'./test/specs/.spec.js',
],
},
// Patterns to exclude.
exclude: [
// 'path/to/excluded/files'
],
//
// ============
// Capabilities
// ============
// Define your capabilities here. WebdriverIO can run multiple capabilities at the same
// time. Depending on the number of capabilities, WebdriverIO launches several test
// sessions. Within your capabilities you can overwrite the spec and exclude options in
// order to group specific specs to a specific capability.
//
// First, you can define how many instances should be started at the same time. Let's
// say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
// set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
// files and you set maxInstances to 10, all spec files will get tested at the same time
// and 30 processes will get spawned. The property handles how many capabilities
// from the same test should run tests.
//
maxInstances: 1,
//
// If you have trouble getting all important capabilities together, check out the
// Sauce Labs platform configurator - a great tool to configure your capabilities:
// https://saucelabs.com/platform/platform-configurator
//
capabilities: [{
// maxInstances can get overwritten per capability. So if you have an in-house Selenium
// grid with only 5 firefox instances available you can make sure that not more than
// 5 instances get started at a time.
maxInstances: 1,
// chrome options and capabilities
// https://webdriver.io/docs/options/#capabilities
browserName: 'chrome',
"goog:chromeOptions": {
"excludeSwitches": [ "enable-automation" ],
args: [
'--window-size=1440,900',
],
prefs: {
download: {
'prompt_for_download': false,
'directory_upgrade': true,
'default_directory': require('path').resolve(__dirname, 'download')
},
credentials_enable_service: false,
profile: {
'password_manager_enabled': false
}
},
},
acceptInsecureCerts: true
// If outputDir is provided WebdriverIO can capture driver session logs
// it is possible to configure which logTypes to include/exclude.
// excludeDriverLogs: ['*'], // pass '*' to exclude all driver session logs
// excludeDriverLogs: ['bugreport', 'server'],
}],
//
// ===================
// Test Configurations
// ===================
// Define all options that are relevant for the WebdriverIO instance here
//
// Level of logging verbosity: trace | debug | info | warn | error | silent
logLevel: 'debug',
//
// Set specific log levels per logger
// loggers:
// - webdriver, webdriverio
// - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
// - @wdio/mocha-framework, @wdio/jasmine-framework
// - @wdio/local-runner
// - @wdio/sumologic-reporter
// - @wdio/cli, @wdio/config, @wdio/utils
// Level of logging verbosity: trace | debug | info | warn | error | silent
// logLevels: {
// webdriver: 'info',
// '@wdio/appium-service': 'info'
// },
//
// If you only want to run your tests until a specific amount of tests have failed use
// bail (default is 0 - don't bail, run all tests).
bail: 0,
//
// Set a base URL in order to shorten url command calls. If your `url` parameter starts
// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
// gets prepended directly.
baseUrl: 'http://localhost',
//
// Default timeout for all waitFor* commands.
waitforTimeout: 10000,
//
// Default timeout in milliseconds for request
// if browser driver or grid doesn't send response
connectionRetryTimeout: 120000,
//
// Default request retries count
connectionRetryCount: 3,
//
// Test runner services
// Services take over a specific job you don't want to take care of. They enhance
// your test setup with almost no effort. Unlike plugins, they don't add new
// commands. Instead, they hook themselves up into the test process.
services: ['chromedriver'],
// Framework you want to run your specs with.
// The following are supported: Mocha, Jasmine, and Cucumber
// see also: https://webdriver.io/docs/frameworks
//
// Make sure you have the wdio adapter package for the specific framework installed
// before running any tests.
framework: 'mocha',
//
// The number of times to retry the entire specfile when it fails as a whole
// specFileRetries: 1,
//
// Delay in seconds between the spec file retry attempts
// specFileRetriesDelay: 0,
//
// Whether or not retried specfiles should be retried immediately or deferred to the end of the queue
// specFileRetriesDeferred: false,
//
// Test reporter for stdout.
// The only one supported by default is 'dot'
// see also: https://webdriver.io/docs/dot-reporter
// https://github.com/rpii/wdio-html-reporter
reporters: [
'spec',
["html-nice", {
debug: true,
outputDir: './reports/html-reports/',
filename: 'report.html',
reportTitle: 'HTML Report',
linkScreenshots: true,
//to show the report in a browser when done
showInBrowser: false,
collapseTests: false,
//to turn on screenshots after every test
useOnAfterCommandForScreenshot: true,
LOG: logger
}]
],
//
// Options to be passed to Mocha.
// See the full list at http://mochajs.org/
mochaOpts: {
ui: 'bdd',
timeout: 60000
},
//
// =====
// Hooks
// =====
// WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
// it and to build services around it. You can either apply a single function or an array of
// methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
// resolved to continue.
/**
* Gets executed once before all workers get launched.
* @param {Object} config wdio configuration object
* @param {Array.<Object>} capabilities list of capabilities details
*/
// onPrepare: function (config, capabilities) {
// },
/**
* Gets executed before a worker process is spawned and can be used to initialise specific service
* for that worker as well as modify runtime environments in an async fashion.
* @param {String} cid capability id (e.g 0-0)
* @param {[type]} caps object containing capabilities for session that will be spawn in the worker
* @param {[type]} specs specs to be run in the worker process
* @param {[type]} args object that will be merged with the main configuration once worker is initialized
* @param {[type]} execArgv list of string arguments passed to the worker process
*/
// onWorkerStart: function (cid, caps, specs, args, execArgv) {
// },
/**
* Gets executed just after a worker process has exited.
* @param {String} cid capability id (e.g 0-0)
* @param {Number} exitCode 0 - success, 1 - fail
* @param {[type]} specs specs to be run in the worker process
* @param {Number} retries number of retries used
*/
// onWorkerEnd: function (cid, exitCode, specs, retries) {
// },
/**
* Gets executed just before initialising the webdriver session and test framework. It allows you
* to manipulate configurations depending on the capability or spec.
* @param {Object} config wdio configuration object
* @param {Array.<Object>} capabilities list of capabilities details
* @param {Array.<String>} specs List of spec file paths that are to be run
* @param {String} cid worker id (e.g. 0-0)
*/
// beforeSession: function (config, capabilities, specs, cid) {
// },
/**
* Gets executed before test execution begins. At this point you can access to all global
* variables like `browser`. It is the perfect place to define custom commands.
* @param {Array.<Object>} capabilities list of capabilities details
* @param {Array.<String>} specs List of spec file paths that are to be run
* @param {Object} browser instance of created browser/device session
*/
// before: function (capabilities, specs) {
// },
/**
* Runs before a WebdriverIO command gets executed.
* @param {String} commandName hook command name
* @param {Array} args arguments that command would receive
*/
// beforeCommand: function (commandName, args) {
// },
/**
* Hook that gets executed before the suite starts
* @param {Object} suite suite details
*/
// beforeSuite: function (suite) {
// },
/**
* Function to be executed before a test (in Mocha/Jasmine) starts.
*/
// beforeTest: function (test, context) {
// },
/**
* Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
* beforeEach in Mocha)
*/
// beforeHook: function (test, context) {
// },
/**
* Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
* afterEach in Mocha)
*/
// afterHook: function (test, context, { error, result, duration, passed, retries }) {
// },
/**
* Function to be executed after a test (in Mocha/Jasmine only)
* @param {Object} test test object
* @param {Object} context scope object the test was executed with
* @param {Error} result.error error object in case the test fails, otherwise `undefined`
* @param {Any} result.result return object of test function
* @param {Number} result.duration duration of test
* @param {Boolean} result.passed true if test has passed, otherwise false
* @param {Object} result.retries informations to spec related retries, e.g. `{ attempts: 0, limit: 0 }`
*/
// afterTest: function(test, context, { error, result, duration, passed, retries }) {
// },
/**
* Hook that gets executed after the suite has ended
* @param {Object} suite suite details
*/
// afterSuite: function (suite) {
// },
/**
* Runs after a WebdriverIO command gets executed
* @param {String} commandName hook command name
* @param {Array} args arguments that command would receive
* @param {Number} result 0 - command success, 1 - command error
* @param {Object} error error object if any
*/
// afterCommand: function (commandName, args, result, error) {
// },
/**
* Gets executed after all tests are done. You still have access to all global variables from
* the test.
* @param {Number} result 0 - test pass, 1 - test fail
* @param {Array.<Object>} capabilities list of capabilities details
* @param {Array.<String>} specs List of spec file paths that ran
*/
// after: function (result, capabilities, specs) {
// },
/**
* Gets executed right after terminating the webdriver session.
* @param {Object} config wdio configuration object
* @param {Array.<Object>} capabilities list of capabilities details
* @param {Array.<String>} specs List of spec file paths that ran
*/
// afterSession: function (config, capabilities, specs) {
// },
/**
* Gets executed after all workers got shut down and the process is about to exit. An error
* thrown in the onComplete hook will result in the test run failing.
* @param {Object} exitCode 0 - success, 1 - fail
* @param {Object} config wdio configuration object
* @param {Array.<Object>} capabilities list of capabilities details
* @param {<Object>} results object containing test results
*/
// onComplete: function(exitCode, config, capabilities, results) {
// },
/**
* Gets executed when a refresh happens.
* @param {String} oldSessionId session ID of the old session
* @param {String} newSessionId session ID of the new session
*/
// onReload: function(oldSessionId, newSessionId) {
// }
onPrepare: function (config, capabilities) {
let reportAggregator = new ReportAggregator({
outputDir: './reports/html-reports/',
filename: 'master-report.html',
reportTitle: 'Master Report',
browserName : 'chrome',
LOG: logger,
collapseTests: true
});
reportAggregator.clean() ;
global.reportAggregator = reportAggregator;
},
onComplete: function(exitCode, config, capabilities, results) {
(async () => {
await global.reportAggregator.createReport();
})();
},
}
config
{
"name": "webdriverio-tests",
"version": "0.1.0",
"private": true,
"devDependencies": {
"@wdio/cli": "^7.20.2",
"@wdio/local-runner": "^7.20.2",
"@wdio/logger": "^7.19.0",
"@wdio/mocha-framework": "^7.20.0",
"@wdio/spec-reporter": "^7.20.0",
"chai": "^4.3.6",
"chromedriver": "^102.0.0",
"googleapis": "^105.0.0",
"got": "^11.8.3",
"linkifyjs": "^3.0.5",
"log4js": "^6.5.2",
"wdio-chromedriver-service": "^7.3.2",
"wdio-html-nice-reporter": "^7.9.1",
"wdio-wait-for": "^2.2.6"
},
"dependencies": {
"webdriverio": "^7.19.5"
},
"scripts": {
"wdio": "wdio run wdio.conf.js"
}
}
Hi,
I will look into this when I get a chance. That functionality doesn't work if you are using the video reporter in conjunction with the html reporter. I will remove it completely next time. You would be better off adding something like this to your base page, and calling it as needed in test code: or, use the video reporter to take a movie of the test
Rich
import ReportEvents from @.***/wdio-report-events" ; let eventReporter = new ReportEvents() ;
...
public logMessage(message:string) {
eventReporter.logMessage( message)
}
public takeScreenshot(message:string) {
const timestamp = dayjs().format('YYYYMMDD-HHmmss.SSS');
fs.ensureDirSync('reports/html-reports/screenshots/');
const filepath = path.join('reports/html-reports/screenshots/',
timestamp + '.png'); browser.saveScreenshot(filepath); this.logMessage(message); return this; }
On Mon, Jun 6, 2022 at 2:10 AM Rafal Fusik @.***> wrote:
framework: 'jasmine', useOnAfterCommandForScreenshot: true,
Here the config: (NOTE: wdio-video-reporter is commented out)
const { ReportAggregator } = require("wdio-html-nice-reporter"); // const video = require('wdio-video-reporter'); const log = require('log4js'); log.configure({ appenders: { fileLog: { type: 'file', filename: "logs/html-reporter.log", maxLogSize: 5000000, level: 'debug' }, debugLog: { type: 'file', filename: "logs/debug-html-reporter.log", maxLogSize: 5000000, level: 'debug' }, 'out': { type: 'stdout', layout: { type: "colored" } }, 'filterOut': { type: 'stdout', layout: { type: "colored" }, level: 'info' } }, categories: { file: {appenders: ['fileLog'], level: 'info'}, default: {appenders: ['out', 'fileLog'], level: 'info'}, console: {appenders: ['out'], level: 'info'}, debug: {appenders: ['debugLog'], level: 'debug'} } });
//pick the category above to match the output you want. let logger = log.getLogger("default");
exports.config = {
// // ==================== // Runner Configuration // ==================== // // // ================== // Specify Test Files // ================== // Define which test specs should run. The pattern is relative to the directory // from which `wdio` was called. // // The specs are defined as an array of spec files (optionally using wildcards // that will be expanded). The test for each spec file will be run in a separate // worker process. In order to have a group of spec files run in the same worker // process simply enclose them in an array within the specs array. // // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script), // then the current working directory is where your `package.json` resides, so `wdio` // will be called from there. // specs: [ './test/specs/**/*.js' ], suites: { suite_1: [ './test/specs/a1.spec.js', ], suite_2: [ './test/specs/a2.cap.spec.js', ], }, // Patterns to exclude. exclude: [ // 'path/to/excluded/files' ], // // ============ // Capabilities // ============ // Define your capabilities here. WebdriverIO can run multiple capabilities at the same // time. Depending on the number of capabilities, WebdriverIO launches several test // sessions. Within your capabilities you can overwrite the spec and exclude options in // order to group specific specs to a specific capability. // // First, you can define how many instances should be started at the same time. Let's // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec // files and you set maxInstances to 10, all spec files will get tested at the same time // and 30 processes will get spawned. The property handles how many capabilities // from the same test should run tests. // maxInstances: 1, // // If you have trouble getting all important capabilities together, check out the // Sauce Labs platform configurator - a great tool to configure your capabilities: // https://saucelabs.com/platform/platform-configurator // capabilities: [{ // maxInstances can get overwritten per capability. So if you have an in-house Selenium // grid with only 5 firefox instances available you can make sure that not more than // 5 instances get started at a time. maxInstances: 1, // chrome options and capabilities // https://webdriver.io/docs/options/#capabilities browserName: 'chrome', "goog:chromeOptions": { "excludeSwitches": [ "enable-automation" ], args: [ '--window-size=1440,900', '--no-sandbox', ], prefs: { download: { 'prompt_for_download': false, 'directory_upgrade': true, 'default_directory': require('path').resolve(__dirname, 'download') }, credentials_enable_service: false, profile: { 'password_manager_enabled': false } }, }, acceptInsecureCerts: true // If outputDir is provided WebdriverIO can capture driver session logs // it is possible to configure which logTypes to include/exclude. // excludeDriverLogs: ['*'], // pass '*' to exclude all driver session logs // excludeDriverLogs: ['bugreport', 'server'], }], // // =================== // Test Configurations // =================== // Define all options that are relevant for the WebdriverIO instance here // // Level of logging verbosity: trace | debug | info | warn | error | silent logLevel: 'debug', // // Set specific log levels per logger // loggers: // - webdriver, webdriverio // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service // - @wdio/mocha-framework, @wdio/jasmine-framework // - @wdio/local-runner // - @wdio/sumologic-reporter // - @wdio/cli, @wdio/config, @wdio/utils // Level of logging verbosity: trace | debug | info | warn | error | silent // logLevels: { // webdriver: 'info', // ***@***.***/appium-service': 'info' // }, // // If you only want to run your tests until a specific amount of tests have failed use // bail (default is 0 - don't bail, run all tests). bail: 1, // // Set a base URL in order to shorten url command calls. If your `url` parameter starts // with `/`, the base url gets prepended, not including the path portion of your baseUrl. // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url // gets prepended directly. baseUrl: 'http://localhost', // // Default timeout for all waitFor* commands. waitforTimeout: 10000, // // Default timeout in milliseconds for request // if browser driver or grid doesn't send response connectionRetryTimeout: 120000, // // Default request retries count connectionRetryCount: 3, // // Test runner services // Services take over a specific job you don't want to take care of. They enhance // your test setup with almost no effort. Unlike plugins, they don't add new // commands. Instead, they hook themselves up into the test process. services: ['chromedriver'], // Framework you want to run your specs with. // The following are supported: Mocha, Jasmine, and Cucumber // see also: https://webdriver.io/docs/frameworks // // Make sure you have the wdio adapter package for the specific framework installed // before running any tests. framework: 'jasmine', // // The number of times to retry the entire specfile when it fails as a whole specFileRetries: 1, // Delay in seconds between the spec file retry attempts specFileRetriesDelay: 0, // // Whether or not retried specfiles should be retried immediately or deferred to the end of the queue specFileRetriesDeferred: false, // // Test reporter for stdout. // The only one supported by default is 'dot' // see also: https://webdriver.io/docs/dot-reporter // https://github.com/presidenten/wdio-video-reporter // https://github.com/rpii/wdio-html-reporter reporters: [ 'spec', // [video, { // saveAllVideos: false, // If true, also saves videos for successful test cases // videoSlowdownMultiplier: 3, // Higher to get slower videos, lower for faster videos [Value 1-100] // videoRenderTimeout: 5, // Max seconds to wait for a video to finish rendering\ // outputDir: 'reports/html-reports/screenshots', // }], ["html-nice", { debug: true, outputDir: './reports/html-reports/', filename: 'report.html', reportTitle: 'HTML Report', linkScreenshots: true, //to show the report in a browser when done showInBrowser: false, collapseTests: false, //to turn on screenshots after every test useOnAfterCommandForScreenshot: true, LOG: logger }] ], // // Options to be passed to Jasmine. jasmineOpts: { // Jasmine default timeout defaultTimeoutInterval: 60000, // // The Jasmine framework allows interception of each assertion in order to log the state of the application // or website depending on the result. For example, it is pretty handy to take a screenshot every time // an assertion fails. expectationResultHandler: function(passed, assertion) { // do something } }, // // ===== // Hooks // ===== // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance // it and to build services around it. You can either apply a single function or an array of // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got // resolved to continue. /** * Gets executed once before all workers get launched. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details */ // onPrepare: function (config, capabilities) { // }, /** * Gets executed before a worker process is spawned and can be used to initialise specific service * for that worker as well as modify runtime environments in an async fashion. * @param {String} cid capability id (e.g 0-0) * @param {[type]} caps object containing capabilities for session that will be spawn in the worker * @param {[type]} specs specs to be run in the worker process * @param {[type]} args object that will be merged with the main configuration once worker is initialized * @param {[type]} execArgv list of string arguments passed to the worker process */ // onWorkerStart: function (cid, caps, specs, args, execArgv) { // }, /** * Gets executed just after a worker process has exited. * @param {String} cid capability id (e.g 0-0) * @param {Number} exitCode 0 - success, 1 - fail * @param {[type]} specs specs to be run in the worker process * @param {Number} retries number of retries used */ // onWorkerEnd: function (cid, exitCode, specs, retries) { // }, /** * Gets executed just before initialising the webdriver session and test framework. It allows you * to manipulate configurations depending on the capability or spec. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that are to be run * @param {String} cid worker id (e.g. 0-0) */ // beforeSession: function (config, capabilities, specs, cid) { // }, /** * Gets executed before test execution begins. At this point you can access to all global * variables like `browser`. It is the perfect place to define custom commands. * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that are to be run * @param {Object} browser instance of created browser/device session */ // before: function (capabilities, specs) { // }, /** * Runs before a WebdriverIO command gets executed. * @param {String} commandName hook command name * @param {Array} args arguments that command would receive */ // beforeCommand: function (commandName, args) { // }, /** * Hook that gets executed before the suite starts * @param {Object} suite suite details */ // beforeSuite: function (suite) { // }, /** * Function to be executed before a test (in Mocha/Jasmine) starts. */ // beforeTest: function (test, context) { // }, /** * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling * beforeEach in Mocha) */ // beforeHook: function (test, context) { // }, /** * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling * afterEach in Mocha) */ // afterHook: function (test, context, { error, result, duration, passed, retries }) { // }, /** * Function to be executed after a test (in Mocha/Jasmine only) * @param {Object} test test object * @param {Object} context scope object the test was executed with * @param {Error} result.error error object in case the test fails, otherwise `undefined` * @param {Any} result.result return object of test function * @param {Number} result.duration duration of test * @param {Boolean} result.passed true if test has passed, otherwise false * @param {Object} result.retries information to spec related retries, e.g. `{ attempts: 0, limit: 0 }` */ // afterTest: function(test, context, { error, result, duration, passed, retries }) { // }, // afterTest: function ( // test, // context, // { error, result, duration, passed, retries } // ) { // // take a screenshot anytime a test fails and throws an error // if (error) { // browser.takeScreenshot(); // } // }, /** * Hook that gets executed after the suite has ended * @param {Object} suite suite details */ // afterSuite: function (suite) { // }, /** * Runs after a WebdriverIO command gets executed * @param {String} commandName hook command name * @param {Array} args arguments that command would receive * @param {Number} result 0 - command success, 1 - command error * @param {Object} error error object if any */ // afterCommand: function (commandName, args, result, error) { // }, /** * Gets executed after all tests are done. You still have access to all global variables from * the test. * @param {Number} result 0 - test pass, 1 - test fail * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that ran */ // after: function (result, capabilities, specs) { // }, /** * Gets executed right after terminating the webdriver session. * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {Array.<String>} specs List of spec file paths that ran */ // afterSession: function (config, capabilities, specs) { // }, /** * Gets executed after all workers got shut down and the process is about to exit. An error * thrown in the onComplete hook will result in the test run failing. * @param {Object} exitCode 0 - success, 1 - fail * @param {Object} config wdio configuration object * @param {Array.<Object>} capabilities list of capabilities details * @param {<Object>} results object containing test results */ // onComplete: function(exitCode, config, capabilities, results) { // }, /** * Gets executed when a refresh happens. * @param {String} oldSessionId session ID of the old session * @param {String} newSessionId session ID of the new session */ // onReload: function(oldSessionId, newSessionId) { // } onPrepare: function (config, capabilities) { let reportAggregator = new ReportAggregator({ outputDir: './reports/html-reports/', filename: 'master-report.html', reportTitle: 'Master Report', browserName : 'chrome', LOG: logger, collapseTests: true }); reportAggregator.clean() ; global.reportAggregator = reportAggregator; }, onComplete: function(exitCode, config, capabilities, results) { (async () => { await global.reportAggregator.createReport(); })(); },
}
my understanding is that the following setting should make the reporter to take a screenshot and attach to the report when aggregated:
useOnAfterCommandForScreenshot: true,
— Reply to this email directly, view it on GitHub https://github.com/rpii/wdio-html-reporter/issues/87, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEABIENFVEOD2FH7OG6K3B3VNW553ANCNFSM5X6XXMYA . You are receiving this because you are subscribed to this thread.Message ID: @.***>
what is this for?
framework: 'jasmine', useOnAfterCommandForScreenshot: true,
that may be interfering with the one inside html reporter. Set that in the reporter and elsewhere. I will try to get your project setup to test but wont get to it for a while.
Rich
On Tue, Jun 7, 2022 at 11:53 PM Rafal Fusik @.***> wrote:
@rpii https://github.com/rpii I DONT use cucumber, its a plain webdriverio with the html reporter and jasmine as a framework
— Reply to this email directly, view it on GitHub https://github.com/rpii/wdio-html-reporter/issues/87#issuecomment-1149532488, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEABIEJUVA75YMR25DIFNFDVOA7KLANCNFSM5X6XXMYA . You are receiving this because you were mentioned.Message ID: @.***>
@rpii framework: 'jasmine', - it's the framework, similar to mocha
as for useOnAfterCommandForScreenshot its coming from the reporter itself
//to turn on screenshots after every test useOnAfterCommandForScreenshot: true,
Here the config: (NOTE: wdio-video-reporter is commented out)
my understanding is that the following setting should make the reporter to take a screenshot and attach to the report when aggregated:
package