https://github.com/godogx/allure

Allure result formatter for godog
https://github.com/godogx/allure

allure-report bdd cucumber go godog godog-extension golang report testing

Last synced: 3 months ago
JSON representation

Allure result formatter for godog

• Host: GitHub
• URL: https://github.com/godogx/allure
• Owner: godogx
• License: mit
• Created: 2021-09-07T07:12:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T17:25:21.000Z (3 months ago)
• Last Synced: 2024-10-29T18:32:13.909Z (3 months ago)
• Topics: allure-report, bdd, cucumber, go, godog, godog-extension, golang, report, testing
• Language: Go
• Homepage:
• Size: 389 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Allure Formatter

[![Build Status](https://github.com/godogx/allure/workflows/test-unit/badge.svg)](https://github.com/godogx/allure/actions?query=branch%3Amaster+workflow%3Atest-unit)

[![Coverage Status](https://codecov.io/gh/godogx/allure/branch/master/graph/badge.svg)](https://codecov.io/gh/godogx/allure)

[![GoDevDoc](https://img.shields.io/badge/dev-doc-00ADD8?logo=go)](https://pkg.go.dev/github.com/godogx/allure)

[![Time Tracker](https://wakatime.com/badge/github/godogx/allure.svg)](https://wakatime.com/badge/github/godogx/allure)

![Code lines](https://sloc.xyz/github/godogx/allure/?category=code)

![Comments](https://sloc.xyz/github/godogx/allure/?category=comments)

Stores [`godog`](https://github.com/cucumber/godog) test results in `allure 2` format.

## Usage

[Allure](https://github.com/allure-framework/allure2) is convenient UI to expose test results.

You can enable it by calling `allure.RegisterFormatter()`.

Additional configuration can be added with env vars before test run.

`ALLURE_ENV_*` are added to allure environment report.

`ALLURE_EXECUTOR_*` configure `Executor` info.

`ALLURE_RESULTS_PATH` can change default `./allure-results` destination.

Example:

```bash

export ALLURE_ENV_TICKET=JIRA-1234

export ALLURE_ENV_APP=todo-list

export ALLURE_EXECUTOR_NAME=IntegrationTest

export ALLURE_EXECUTOR_TYPE=github

export ALLURE_EXECUTOR_URL=https://github.com/

```

Then you can run test with

```bash

# Optionally clean up current result (if you have it).

rm -rf ./allure-results/*

# Optionally copy history from previous report.

cp -r ./allure-report/history ./allure-results/history

# Run suite with godog CLI tool or with go test.

godog -f allure

# Generate report with allure CLI tool.

allure generate --clean

```

[Example instrumentation](https://github.com/vearutop/cache-story/blob/v1.1.0/.github/workflows/test-integration.yml#L139-L162) and [sample report](https://vearutop.github.io/cache-story/).

## Sample report

![Screenshot](_testdata/screenshot.png)