net.masterthought.cucumber.reports.Reportable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cucumber-reporting Show documentation

Provides pretty html reports for Cucumber (Behaviour-Driven Development). It works by generating html from the cucumber json report formatter. So can be used anywhere a json report is generated. Current use is in the cucumber jenkins plugin and a maven mojo to generate the same report from mvn command line when running locally.

There is a newer version: 5.8.4

Show newest version

package net.masterthought.cucumber.reports;

import net.masterthought.cucumber.json.support.Status;

/**
 * Defines methods required to generate single report. Implementations of this interface are used by Velocity template.
 * 
 * @author Damian Szczepanik (damianszczepanik@github)
 */
public interface Reportable {

    /** Returns name of the element that will be displayed to user. */
    String getName();

    /** In case of running the same tests on many devices it displays name of the device. */
    String getDeviceName();

    /** Returns number of scenarios related to this element. */
    int getScenarios();

    /** Returns number of passed scenarios for this element. */
    int getPassedScenarios();

    /** Returns number of failed scenarios for this element. */
    int getFailedScenarios();

    /** Returns number of all steps for this element. */
    int getSteps();

    /** Returns number of passed steps for this element. */
    int getPassedSteps();

    /** Returns number of failed steps for this element. */
    int getFailedSteps();

    /** Returns number of skipped steps for this element. */
    int getSkippedSteps();

    /** Returns number of undefined steps for this element. */
    int getUndefinedSteps();

    /** Returns number of missing steps for this element. */
    int getMissingSteps();

    /** Returns number of pending steps for this element. */
    int getPendingSteps();

    /** Returns formatted duration for this element. */
    String getDurations();

    /** Returns status for this element. */
    Status getStatus();
}