HTML report generation plugin for Gauge
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Updating issue template Apr 7, 2016
build fix templates directory name Mar 30, 2017
env Making generation of symlink configurable., #195 Oct 10, 2018
gauge-proto @ d16ae1a allow support for streaming chunks to html-report, #1239 Nov 19, 2018
gauge_messages allow support for streaming chunks to html-report, #1239 Nov 19, 2018
generator revert spec throttling, it causes race conditions Nov 28, 2018
images Added sample html-report screenshot. May 14, 2018
listener allow support for streaming chunks to html-report, #1239 Nov 19, 2018
logger add missed new logger package Mar 30, 2018
regenerate allow support for streaming chunks to html-report, #1239 Nov 19, 2018
test_helper Change []error to []buildError Apr 20, 2017
theme resolving path resolution issues. Apr 19, 2017
themes/default Merge branch 'master' into 164_screenshot Dec 7, 2018
.gitignore allow support for streaming chunks to html-report, #1239 Nov 19, 2018
.gitmodules adding gauge-proto as submodule Jan 20, 2015
.travis.yml run travis build against golang 1.8 Mar 30, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Dec 1, 2015
COPYING Create COPYING Feb 6, 2015
README.md Added sample html-report screenshot. May 14, 2018
genproto.sh Update proto and autogenerated relevant code #90 Oct 18, 2016
htmlReport.go write report when suiteFailure occurs Dec 7, 2018
htmlReport_test.go fixed tests for creating html-report symlink Dec 5, 2018
main.go introduced debug logging for html-report Mar 30, 2018
plugin.json allow support for streaming chunks to html-report, #1239 Nov 19, 2018
schema.json Changed the schema Apr 20, 2017

README.md

html-report

Download Nightly Build Status

This is the html-report plugin for Gauge.

Features

  • A comprehensive test results report template prepared in a html format providing the overall summary with drill down of the test cases executed and effort spent during the testing for each stage and feature.
  • It provides the details for the defects found during the run.
  • It indicates the tests by color code - failed(red), passed(green) and skipped(grey).
  • The failure can be analyzed with the stacktrace and screenshot(captures unless overwritten not to).
  • The skipped tests can be analyzed with the given reason.
  • Custom Messages allows users to add messages at runtime.

Sample HTML Report documemt

Create New Project preview

Installation

gauge install html-report
  • Installing specific version
gauge install html-report --version 2.1.0

Offline installation

gauge install html-report --file html-report-2.1.0-linux.x86_64.zip

Build from Source

Requirements
Compiling

Download dependencies

go get -t ./...

Compilation


go run build/make.go

For cross-platform compilation

go run build/make.go --all-platforms
Installing

After compilation

go run build/make.go --install

Installing to a CUSTOM_LOCATION

go run build/make.go --install --plugin-prefix CUSTOM_LOCATION

Creating distributable

Note: Run after compiling

go run build/make.go --distro

For distributable across platforms: Windows and Linux for both x86 and x86_64

go run build/make.go --distro --all-platforms

New distribution details need to be updated in the html-report-install.json file in the gauge plugin repository for a new version update.

Configuration

The HTML report plugin can be configured by the properties set in the env/default.properties file in the project.

The configurable properties are:

gauge_reports_dir

  • Specifies the path to the directory where the execution reports will be generated.

  • Should be either relative to the project directory or an absolute path. By default it is set to reports directory in the project

overwrite_reports

  • Set to true if the reports must be overwritten on each execution maintaining only the latest execution report.

  • If set to false then a new report will be generated on each execution in the reports directory in a nested time-stamped directory. By sdefault it is set to true.

GAUGE_HTML_REPORT_THEME_PATH

  • Specifies the path to the custom theme directory.

  • Should be either relative to the project directory or an absolute path. By default, default theme shipped with gauge is used.

Report re-generation

If report generation fails due to some reason, we don't have to re-run the tests again.

The html-report plugin now generates a last_run_result.json file in the root of the reports directory. There is also a symlink to the html-report executable in the same location.

To regenerate the report

  • Navigate to the reports directory
  • run ./html-report --input=last_run_result.json --output="/some/path"

Note: The output directory is created. Take care not to overwrite an existing directory

While regenerating a report, the default theme is used. A custom can be used if --theme flag is specified with the path to the custom theme.

License

GNU Public License version 3.0 html-report is released under GNU Public License version 3.0

Copyright

Copyright 2015 ThoughtWorks, Inc.