Use the screenshot reporter to capture screenshots from your Selenium nodes after each executed Protractor test case.
Use meta data stored as JSON along with the screenshots to create extensive and human readable test reports.
protractor-screenshot-reporter is available via npm:
$ npm install protractor-screenshot-reporter --save-dev
In your Protractor configuration file, register
protractor-screenshot-reporter in Jasmine:
var ScreenShotReporter = require'protractor-screenshot-reporter';exportsconfig =// your config here ...// Add a screenshot reporter and store screenshots to `/tmp/screnshots`:jasminegetEnvaddReporterbaseDirectory: '/tmp/screenshots';
You have to pass a directory path as parameter when creating a new instance of the screenshot reporter:
var reporter =baseDirectory: '/tmp/screenshots';
If the given directory does not exists, it is created automatically as soon as a screenshot needs to be stored.
The function passed as second argument to the constructor is used to build up paths for screenshot files:
var path = require'path';baseDirectory: '/tmp/screenshots'pathBuilder:// Return '<browser>/<specname>' as path for screenshots:// Example: 'firefox/list-should work'.return pathjoincapabilitiescaps_browser descriptionsjoin'-';;
If you omit the path builder, a GUID is used by default instead.
You can modify the contents of the JSON meta data file by passing a function
metaDataBuilder function as third constructor parameter:
baseDirectory: '/tmp/screenshots'metaDataBuilder:// Return the description of the spec and if it has passed or not:returndescription: descriptionsjoin' 'passed: resultspassed;;
If you omit the meta data builder, the default implementation is used (see https://github.com/swissmanu/protractor-screenshot-reporter/blob/master/index.js#L42).
Since version 0.0.3, you can define if you want capture screenshots from skipped test cases using the
baseDirectory: '/tmp/screenshots'takeScreenShotsForSkippedSpecs: true;
Also you can define if you want capture screenshots only from failed test cases using the
baseDirectory: '/tmp/screenshots'takeScreenShotsOnlyForFailedSpecs: true;
A screenshot is saved as PNG image. Along with it, a JSON file with a matching filename is created.
By default, the JSON file contains the test outcome and further information about the Selenium machine which executed the test case:
By parsing these JSON files in a preprocessing step, you can generate a human readable test report.
Postprocessing is not a functionality of
protractor-screenshot-reporter. Use Grunt or similar tools to integrate it into your test process.
Copyright (c) 2014 Manuel Alabor email@example.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.