protractor-html-reporter-2

This package is inspired by protractor-html-reporter which developed based upon inspiration of cucumber-html-report.

You can use this package to generate HTML report for Protractor test execution with pie charts based on xml file with tests results. For generating xml file with tests results you can use [jasmine-reporters] (https://www.npmjs.com/package/jasmine-reporters).
This reporter can also display screenshots taken on test failure. To get the screenshots you can use jasmine2-protractor-utils module.

repo : https://github.com/abhishekkyd/protractor-html-reporter-2

Additional Changes from protractor-html-reporter:

• Added "100%" width for TestSuite rows in CSS

• Added report name outputFilename capability for report

outputFilename: 'ProtractorTestReport'

• Added current execution testPlatform capability for report

testPlatform: platform

• Added a new row for Environment

• Added condition statement for Failed and Skipped, it will not be displayed if the count is 0.

Sample images

Dashboard view:

Testsuite view:

Testcase view:

Screenshot view:

How to use

• Converting the xml file to html

  1 var HTMLReport = require('protractor-html-reporter-2');
  2
  3 testConfig = {
  4             reportTitle: 'Protractor Test Execution Report',
  5             outputPath: './',
  6             outputFilename: 'ProtractorTestReport',
  7             screenshotPath: './screenshots',
  8             testBrowser: browserName,
  9             browserVersion: browserVersion
  10         };
  11 new HTMLReport().from('xmlresults.xml', testConfig);

• Using with protractor conf.js file

  1//HTMLReport called once tests are finished
  2onComplete: function() {
  3     var browserName, browserVersion;
  4     var capsPromise = browser.getCapabilities();
  5
  6     capsPromise.then(function (caps) {
  7        browserName = caps.get('browserName');
  8        browserVersion = caps.get('version');
  9        platform = caps.get('platform');
  10
  11        var HTMLReport = require('protractor-html-reporter-2');
  12
  13		testConfig = {
  14            reportTitle: 'Protractor Test Execution Report',
  15            outputPath: './',
  16            outputFilename: 'ProtractorTestReport',
  17            screenshotPath: './screenshots',
  18            testBrowser: browserName,
  19            browserVersion: browserVersion,
  20            modifiedSuiteName: false,
  21            screenshotsOnlyOnFailure: true,
  22            testPlatform: platform
  23        };
  24        new HTMLReport().from('xmlresults.xml', testConfig);
  25    });
  26 }

• In order to obtain results in xml file you can use jasmine-reporters module:

  1var jasmineReporters = require('jasmine-reporters');
  2jasmine.getEnv().addReporter(new jasmineReporters.JUnitXmlReporter({
  3    consolidateAll: true,
  4    savePath: './',
  5    filePrefix: 'xmlresults'
  6}));

• In order to obtain screenshots on failure you can use this piece of code (you have to put it in onPrepare). The directory with screenshots must be in the same location as html report file (e.g. html file is in report directory so screenshots files must be in directory /report/screenshots/).

  1var fs = require('fs-extra');
  2
  3fs.emptyDir('screenshots/', function (err) {
  4        console.log(err);
  5    });
  6
  7    jasmine.getEnv().addReporter({
  8        specDone: function(result) {
  9            if (result.status == 'failed') {
  10                browser.getCapabilities().then(function (caps) {
  11                    var browserName = caps.get('browserName');
  12
  13                    browser.takeScreenshot().then(function (png) {
  14                        var stream = fs.createWriteStream('screenshots/' + browserName + '-' + result.fullName+ '.png');
  15                        stream.write(new Buffer(png, 'base64'));
  16                        stream.end();
  17                    });
  18                });
  19            }
  20        }
  21    });

• Or you can use jasmine2-protractor-utils module to get the screenshots:

  1//In exports.config put this:
  2plugins: [{
  3    package: 'jasmine2-protractor-utils',
  4    disableHTMLReport: true,
  5    disableScreenshot: false,
  6    screenshotPath:'./screenshots',
  7    screenshotOnExpectFailure:false,
  8    screenshotOnSpecFailure:true,
  9    clearFoldersBeforeTest: true
  10  }],
  11  ```

If you want to display your screenshots on report you have to pass testBrowser (it's the name of the browser) in testConfig object, because the screenshot's names are in format "browserName-.png" (e.g. "chrome-.png").

Options

• reportTitle
  The report title displayed in generated html report.
• outputPath
  The path where to write html report.
• outputFilename
  The name of html report file (without .html).
• screenshotPath
  The path where to look for screenshots (the path must be in the same location as html file report e.g. if html file report is in location /report/test-report.html the screenshots must be placed in directory /report/screenshots/.
• testBrowser
  The name of browser on which the tests were executed. It's necessary if you want to display screenshots in your report.
• browserVersion
  The version of the browser.
• modifiedSuiteName (bool) default: false
  It says if suite names were changed at conf.js level. The suite names can be changed using 'jasmine-reporters' module and using modifySuiteName option. If we change the suite names this will also affect the names of screenshots we are looking for. If modifiedSuiteName is set to true the reporter will remove from the suite name the prefix and a dot (e.g. "firefox.") in order to find correct screenshot name. Unfortunately, the reporter will handle such situation only if we change suite name to "browserName.TestSuiteName" form.
• screenshotsOnlyOnFailure (bool) default: true
  To display screenshots only in testcases that failed. Default value is "true".
• testPlatform The name of platform on which the tests were executed.

Credits

Thanks to @etxebe and all credits to developers of protractor-html-reporter for nice protractor reporting. The protractor-html-reporter-2 is liitle bit html enhancement of this one. I've just fixed few things, some thing were added from pull requests and this reporter is still based on xml file.