net.masterthought.cucumber.reducers

Enum ReducingMethod

java.lang.Object

java.lang.Enum<ReducingMethod>

net.masterthought.cucumber.reducers.ReducingMethod

All Implemented Interfaces:

Serializable, Comparable<ReducingMethod>

public enum ReducingMethod
extends Enum<ReducingMethod>

Supported reducing methods. This list contains supported methods that allow to modify the way how reports are displayed.

Author:

Damian Szczepanik (damianszczepanik@github)

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIDE_EMPTY_HOOKS Does not display hooks (@Before and @After) which do not have attachment or error message.
MERGE_FEATURES_BY_ID Merge features with different JSON files that have same ID so scenarios are be stored in single feature.
MERGE_FEATURES_WITH_RETEST Merge features and scenarios from different JSON files of different runs into a single report by features' and scenarios' ids.
SKIP_EMPTY_JSON_FILES Skip empty JSON reports.

Method Summary

Modifier and Type	Method and Description
static ReducingMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReducingMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MERGE_FEATURES_BY_ID

public static final ReducingMethod MERGE_FEATURES_BY_ID

Merge features with different JSON files that have same ID so scenarios are be stored in single feature.

MERGE_FEATURES_WITH_RETEST

public static final ReducingMethod MERGE_FEATURES_WITH_RETEST

Merge features and scenarios from different JSON files of different runs into a single report by features' and scenarios' ids. Merging rules: - Every new feature which is not in the result list is appended to the end. - When the results list already has a feature with such Id then we go down and apply the rules below to the scenarios: 1. if there is no scenario with a given Id in the feature's elements list then add the scenario to the end of the list. 2. if there are no scenario with a background (which is a previous element in the elements list) then both elements are added to the end of the current feature's elements list. As the feature file has a structure like: { elements: [ { name: ... type: "background"; }, { name: ... type: "scenario"; }, { name: ... type: "background"; }, { name: ... type: "scenario"; } .... ] } 3. if there is a scenario with a given Id then: scenario + background case: replace both elements (existing element with Id and its background with new ones) scenario only: replace only given scenario by index in the array. Example: Original cucumber report is "cucumber.json". Let's look a situation when couple of tests failed there. Cucumber runner generates a new report, for example, cucumber-rerun.json as a result of rerun the failed tests. In that case you will have a merged report where all failed tests from the original cucumber.json file are overridden with the results from the cucumber-rerun.json.

SKIP_EMPTY_JSON_FILES

public static final ReducingMethod SKIP_EMPTY_JSON_FILES

Skip empty JSON reports. If this flag is not selected then report generation fails on empty file.

HIDE_EMPTY_HOOKS

public static final ReducingMethod HIDE_EMPTY_HOOKS

Does not display hooks (@Before and @After) which do not have attachment or error message.

Method Detail

values

public static ReducingMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReducingMethod c : ReducingMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReducingMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null