org.unitils.jbehave.core.reporters

Class UnitilsHtmlReporter

java.lang.Object

org.unitils.jbehave.core.reporters.UnitilsHtmlReporter

All Implemented Interfaces:

org.jbehave.core.reporters.StoryReporter

public class UnitilsHtmlReporter
extends Object
implements org.jbehave.core.reporters.StoryReporter

Since:

04/11/2014

Author:

Suzan Rogge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitilsHtmlReporter.OutputKeywords OutputKeywords.
static class	UnitilsHtmlReporter.OutputLifecycle OutputLifecycle.
static class	UnitilsHtmlReporter.OutputMeta OutputMeta.
static class	UnitilsHtmlReporter.OutputNarrative OutputNarrative.
static class	UnitilsHtmlReporter.OutputParameter OutputParameter.
static class	UnitilsHtmlReporter.OutputRestart OutputRestart.
static class	UnitilsHtmlReporter.OutputScenario Outputscenario.
static class	UnitilsHtmlReporter.OutputStep OutputStep.
static class	UnitilsHtmlReporter.OutputStory OutputStory.

Field Summary

Fields

Modifier and Type	Field and Description
protected UnitilsHtmlReporter.OutputScenario	outputScenario
protected UnitilsHtmlReporter.OutputStory	outputStory

Constructor Summary

Constructors

Constructor and Description
UnitilsHtmlReporter(File file, org.jbehave.core.configuration.Keywords keywords)
UnitilsHtmlReporter(File file, org.jbehave.core.configuration.Keywords keywords, String templatePath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterExamples() sets the currentExample to null.
void	afterScenario()
void	afterStory(boolean givenStory) Do some rapportation after the story.
void	beforeExamples(List<String> steps, org.jbehave.core.model.ExamplesTable table) Sets the steps and the examplestable.
void	beforeScenario(String title) sets the title of the outputscenario.
void	beforeStep(String step)
void	beforeStory(org.jbehave.core.model.Story story, boolean givenStory) Do all the things that need to be done before the story is reported.
protected FileWriter	createFileWriter(File file) Create a FileWriter for a specific file.
void	dryRun()
void	example(Map<String,String> parameters) sets the example & currentexample.
void	failed(String step, Throwable storyFailure) adds a new failed outputstep to the outputscenario.
void	failedOutcomes(String step, org.jbehave.core.model.OutcomesTable table) adds a new failed outputstep to the outputscenario.
protected freemarker.template.TemplateHashModel	getEnumModels() Get the enumModels from the BeansWrapper.
protected UnitilsHtmlReporter.OutputScenario	getOutputScenario() getter outputScenario
protected UnitilsHtmlReporter.OutputStory	getOutputStory() getter outputStory.
void	givenStories(org.jbehave.core.model.GivenStories givenStories) setter givenStories.
void	givenStories(List<String> storyPaths) Creates a new GivenStories for each path.
void	ignorable(String step) adds a new ignorable outputstep to the outputscenario.
void	lifecyle(org.jbehave.core.model.Lifecycle lifecycle) setter for the lifecycle.
void	narrative(org.jbehave.core.model.Narrative narrative) set the narrative.
protected Map<String,Object>	newDataModel() Create a new data model.
void	notPerformed(String step) adds a new not performed outputstep to the outputscenario.
void	pending(String step) adds a new pending step to the outputscenario.
void	pendingMethods(List<String> methods) setter pendingMethods
void	restarted(String step, Throwable cause) adds a new UnitilsHtmlReporter.OutputRestart step.
void	scenarioMeta(org.jbehave.core.model.Meta meta) Sets the Meta value.
void	scenarioNotAllowed(org.jbehave.core.model.Scenario scenario, String filter) sets the scenario as not allowed.
protected void	setOutputScenario(UnitilsHtmlReporter.OutputScenario outputScenario) outputScenario setter.
void	storyCancelled(org.jbehave.core.model.Story story, org.jbehave.core.model.StoryDuration storyDuration) sets the story as cancelled.
void	storyNotAllowed(org.jbehave.core.model.Story story, String filter) The story is not allowed.
void	successful(String step) Creates a new successful outputstep and adds it to the scenario.
protected void	write(File file, String resource, Map<String,Object> dataModel) Write the output to the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputStory

protected UnitilsHtmlReporter.OutputStory outputStory

outputScenario

protected UnitilsHtmlReporter.OutputScenario outputScenario

Constructor Detail

UnitilsHtmlReporter

public UnitilsHtmlReporter(File file,
                   org.jbehave.core.configuration.Keywords keywords)

UnitilsHtmlReporter

public UnitilsHtmlReporter(File file,
                   org.jbehave.core.configuration.Keywords keywords,
                   String templatePath)

Constructor.

Parameters:

file - : the report file

keywords - : the keywords used by JBehave

templatePath - : the path of the template

Method Detail

storyNotAllowed

public void storyNotAllowed(org.jbehave.core.model.Story story,
                   String filter)

The story is not allowed.

Specified by:

storyNotAllowed in interface org.jbehave.core.reporters.StoryReporter

Parameters:

story - : the story

filter - : filter

See Also:

StoryReporter.storyNotAllowed(org.jbehave.core.model.Story, java.lang.String)

beforeStory

public void beforeStory(org.jbehave.core.model.Story story,
               boolean givenStory)

Do all the things that need to be done before the story is reported.

Specified by:

beforeStory in interface org.jbehave.core.reporters.StoryReporter

Parameters:

story - : the story

givenStory - : is it the given story?

See Also:

StoryReporter.beforeStory(org.jbehave.core.model.Story, boolean)

narrative

public void narrative(org.jbehave.core.model.Narrative narrative)

set the narrative.

Specified by:

narrative in interface org.jbehave.core.reporters.StoryReporter

Parameters:

narrative - : the narrative that needs to be set

See Also:

StoryReporter.narrative(org.jbehave.core.model.Narrative)

lifecyle

public void lifecyle(org.jbehave.core.model.Lifecycle lifecycle)

setter for the lifecycle.

Specified by:

lifecyle in interface org.jbehave.core.reporters.StoryReporter

Parameters:

lifecycle - : the lifecycle that needs to be set

See Also:

StoryReporter.lifecyle(org.jbehave.core.model.Lifecycle)

scenarioNotAllowed

public void scenarioNotAllowed(org.jbehave.core.model.Scenario scenario,
                      String filter)

sets the scenario as not allowed.

Specified by:

scenarioNotAllowed in interface org.jbehave.core.reporters.StoryReporter

Parameters:

scenario - : the scenario

filter - : the filter for the outputscenario

See Also:

StoryReporter.scenarioNotAllowed(org.jbehave.core.model.Scenario, java.lang.String)

beforeScenario

public void beforeScenario(String title)

sets the title of the outputscenario.

Specified by:

beforeScenario in interface org.jbehave.core.reporters.StoryReporter

Parameters:

title - : the title of the outputscenario.

See Also:

StoryReporter.beforeScenario(java.lang.String)

beforeStep

public void beforeStep(String step)

Specified by:

beforeStep in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step

See Also:

StoryReporter.beforeStep(java.lang.String)

successful

public void successful(String step)

Creates a new successful outputstep and adds it to the scenario.

Specified by:

successful in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step

See Also:

StoryReporter.successful(java.lang.String)

ignorable

public void ignorable(String step)

adds a new ignorable outputstep to the outputscenario.

Specified by:

ignorable in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step.

See Also:

StoryReporter.ignorable(java.lang.String)

pending

public void pending(String step)

adds a new pending step to the outputscenario.

Specified by:

pending in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step

See Also:

StoryReporter.pending(java.lang.String)

notPerformed

public void notPerformed(String step)

adds a new not performed outputstep to the outputscenario.

Specified by:

notPerformed in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step.

See Also:

StoryReporter.notPerformed(java.lang.String)

failed

public void failed(String step,
          Throwable storyFailure)

adds a new failed outputstep to the outputscenario.

Specified by:

failed in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step.

storyFailure - : the story failure.

See Also:

StoryReporter.failed(java.lang.String, java.lang.Throwable)

failedOutcomes

public void failedOutcomes(String step,
                  org.jbehave.core.model.OutcomesTable table)

adds a new failed outputstep to the outputscenario.

Specified by:

failedOutcomes in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step.

table - : the OutcomesTable.

See Also:

StoryReporter.failedOutcomes(java.lang.String, org.jbehave.core.model.OutcomesTable)

givenStories

public void givenStories(org.jbehave.core.model.GivenStories givenStories)

setter givenStories.

Specified by:

givenStories in interface org.jbehave.core.reporters.StoryReporter

Parameters:

givenStories - : the stories defined in the test.

See Also:

StoryReporter.givenStories(org.jbehave.core.model.GivenStories)

givenStories

public void givenStories(List<String> storyPaths)

Creates a new GivenStories for each path.

Specified by:

givenStories in interface org.jbehave.core.reporters.StoryReporter

Parameters:

storyPaths - : list with all the stories defined in the test.

See Also:

StoryReporter.givenStories(java.util.List)

scenarioMeta

public void scenarioMeta(org.jbehave.core.model.Meta meta)

Sets the Meta value.

Specified by:

scenarioMeta in interface org.jbehave.core.reporters.StoryReporter

Parameters:

meta - : The meta data defined in the story.

See Also:

StoryReporter.scenarioMeta(org.jbehave.core.model.Meta)

beforeExamples

public void beforeExamples(List<String> steps,
                  org.jbehave.core.model.ExamplesTable table)

Sets the steps and the examplestable.

Specified by:

beforeExamples in interface org.jbehave.core.reporters.StoryReporter

Parameters:

steps - : a list with steps.

table - : the examplestable.

See Also:

StoryReporter.beforeExamples(java.util.List, org.jbehave.core.model.ExamplesTable)

example

public void example(Map<String,String> parameters)

sets the example & currentexample.

Specified by:

example in interface org.jbehave.core.reporters.StoryReporter

Parameters:

parameters - : examples

See Also:

StoryReporter.example(java.util.Map)

afterExamples

public void afterExamples()

sets the currentExample to null.

Specified by:

afterExamples in interface org.jbehave.core.reporters.StoryReporter

See Also:

StoryReporter.afterExamples()

dryRun

public void dryRun()

Specified by:

dryRun in interface org.jbehave.core.reporters.StoryReporter

See Also:

StoryReporter.dryRun()

afterScenario

public void afterScenario()

Specified by:

afterScenario in interface org.jbehave.core.reporters.StoryReporter

See Also:

StoryReporter.afterScenario()

pendingMethods

public void pendingMethods(List<String> methods)

setter pendingMethods

Specified by:

pendingMethods in interface org.jbehave.core.reporters.StoryReporter

Parameters:

methods - : list of methods.

See Also:

StoryReporter.pendingMethods(java.util.List)

restarted

public void restarted(String step,
             Throwable cause)

adds a new UnitilsHtmlReporter.OutputRestart step.

Specified by:

restarted in interface org.jbehave.core.reporters.StoryReporter

Parameters:

step - : the name of the step.

cause - : the reason why the step failed.

See Also:

StoryReporter.restarted(java.lang.String, java.lang.Throwable)

storyCancelled

public void storyCancelled(org.jbehave.core.model.Story story,
                  org.jbehave.core.model.StoryDuration storyDuration)

sets the story as cancelled.

Specified by:

storyCancelled in interface org.jbehave.core.reporters.StoryReporter

Parameters:

story - : the story defined in your test.

storyDuration - : the duration of the story.

See Also:

StoryReporter.storyCancelled(org.jbehave.core.model.Story, org.jbehave.core.model.StoryDuration)

afterStory

public void afterStory(boolean givenStory)

Do some rapportation after the story.

Specified by:

afterStory in interface org.jbehave.core.reporters.StoryReporter

Parameters:

givenStory - : is this the given story?

See Also:

StoryReporter.afterStory(boolean)

getEnumModels

protected freemarker.template.TemplateHashModel getEnumModels()

Get the enumModels from the BeansWrapper.

Returns:

TemplateHashModel

write

protected void write(File file,
         String resource,
         Map<String,Object> dataModel)

Write the output to the file.

Parameters:

file - : the file where everything should be written to.

resource - : the path of the resource

dataModel - : the datamodel

newDataModel

protected Map<String,Object> newDataModel()

Create a new data model.

Returns:

Map

createFileWriter

protected FileWriter createFileWriter(File file)
                               throws IOException

Create a FileWriter for a specific file.

Parameters:

file - : the file for the filewriter.

Returns:

FileWriter

Throws:

IOException

setOutputScenario

protected void setOutputScenario(UnitilsHtmlReporter.OutputScenario outputScenario)

outputScenario setter.

Parameters:

outputScenario - the outputScenario to set

getOutputStory

protected UnitilsHtmlReporter.OutputStory getOutputStory()

getter outputStory.

Returns:

UnitilsHtmlReporter.OutputStory

getOutputScenario

protected UnitilsHtmlReporter.OutputScenario getOutputScenario()

getter outputScenario

Returns:

UnitilsHtmlReporter.OutputScenario