org.concordion.ext

Class StoryboardExtension

java.lang.Object

org.concordion.ext.StoryboardExtension

All Implemented Interfaces:

org.concordion.api.extension.ConcordionExtension

public class StoryboardExtension
extends java.lang.Object
implements org.concordion.api.extension.ConcordionExtension

The Storyboard extension provides the capability to embed a series of 'cards' containing screenshots or data (text, xml, or html) in a panel at the bottom of the specification.

Further information can be found in the Specification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoryboardExtension.AppendTo

Constructor Summary

Constructors

Constructor and Description
StoryboardExtension()

Method Summary

Modifier and Type	Method and Description
StoryboardExtension	addCard(Card card) Add custom cards to the storyboard
StoryboardExtension	addCard(ScreenshotCard card) Add screenshot card to the storyboard
void	addCardImage(java.lang.String sourcePath, java.lang.String filename) Add custom card image that will be shared by all tests, must be called before test starts otherwise this will do nothing
StoryboardExtension	addContainer(Container container) Allow custom containers to be added the storyboard.
StoryboardExtension	addNotification(java.lang.String title, java.lang.String description, CardImage image, CardResult result)
StoryboardExtension	addNotification(java.lang.String title, java.lang.String description, java.lang.String data, CardImage image, CardResult result) Adds data/information card to story board
StoryboardExtension	addNotification(java.lang.String title, java.lang.String description, java.lang.String data, java.lang.String fileExtension, CardImage image, CardResult result) Adds data/information card to story board
StoryboardExtension	addScreenshot(java.lang.String title, java.lang.String description) Adds screenshot card to story board
StoryboardExtension	addSectionContainer(java.lang.String title) Adds a section container to the storyboard.
void	addTo(org.concordion.api.extension.ConcordionExtender concordionExtender)
StoryboardExtension	closeContainer() Mark current container as completed, any cards added past this point will go to the parent container/storyboard.
CustomCardImage	getCardImage(java.lang.String filename) Get a previously added custom card image
java.lang.String	getCurrentExampleTitle() Get the title of the current example
boolean	hasScreenshotTaker() Check to see if a screenshot taker has been set
StoryboardExtension	insertContainer(Container container) Allow custom containers to be added the storyboard.
StoryboardExtension	insertSectionContainer(java.lang.String title) Adds a section container to the storyboard.
StoryboardExtension	markPriorScreenshotsForRemoval() Marks any screenshot cards added before this point to be deleted if tests completes successfully.
StoryboardExtension	removeScreenshotTaker() Removes the screenshot taker so no further screenshots will be taken.
StoryboardExtension	setAcceptCards(boolean accept) Prevent cards and containers from being added to the the storyboard.
StoryboardExtension	setAcceptsScreenshots(boolean accept) Deprecated. Has been replaced by setAcceptCards(boolean) and will be removed in the next version.
StoryboardExtension	setAppendMode(StoryboardExtension.AppendTo appendMode) Set how items are added to the storyboard Append to end of Storyboard (original behaviour) If item is added within currently executing Example Command append to example element, otherwise append to Storyboard (default) If item is added within currently executing Example Command append to new section container in Storyboard, otherwise append to Storyboard
StoryboardExtension	setScreenshotTaker(org.concordion.ext.ScreenshotTaker screenshotTaker) Set a screenshot taker.
StoryboardExtension	setSupressRepeatingFailures(boolean value) To limit the number of items added to the storyboard, the default behaviour is to ignore second or subsequent failure.
StoryboardExtension	setTakeScreenshotOnExampleCompletion(boolean value) A screenshot of the current page will be automatically added to the storyboard (as long as the screenshot taker has been set) when: an example completes a container is closed (either automatically or by calling closeContainer())
StoryboardExtension	setTitle(java.lang.String title) Set the title to display on the Storyboard and/or ExampleContainer
StoryboardExtension	skipFinalScreenshot() If configured to take final screenshot for example (see setTakeScreenshotOnExampleCompletion(boolean)), this will override that behaviour until: an example completes a container is closed (either automatically or by calling closeContainer())

Methods inherited from class java.lang.Object

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

Constructor Detail

StoryboardExtension

public StoryboardExtension()

Method Detail

addTo

public void addTo(org.concordion.api.extension.ConcordionExtender concordionExtender)

Specified by:

addTo in interface org.concordion.api.extension.ConcordionExtension

addCardImage

public void addCardImage(java.lang.String sourcePath,
                         java.lang.String filename)

Add custom card image that will be shared by all tests, must be called before test starts otherwise this will do nothing

Parameters:

sourcePath - Location of image

filename - Filename of image

getCardImage

public CustomCardImage getCardImage(java.lang.String filename)

Get a previously added custom card image

Parameters:

filename - Original filename of image

Returns:

CustomCardImage object

setTitle

public StoryboardExtension setTitle(java.lang.String title)

Set the title to display on the Storyboard and/or ExampleContainer

This is a token effort at multi-language support.

Parameters:

title - The title

Returns:

A self reference

setAppendMode

public StoryboardExtension setAppendMode(StoryboardExtension.AppendTo appendMode)

Set how items are added to the storyboard

• Append to end of Storyboard (original behaviour)
• If item is added within currently executing Example Command append to example element, otherwise append to Storyboard (default)
• If item is added within currently executing Example Command append to new section container in Storyboard, otherwise append to Storyboard

Parameters:

appendMode - The card append mode

Returns:

A self reference

setSupressRepeatingFailures

public StoryboardExtension setSupressRepeatingFailures(boolean value)

To limit the number of items added to the storyboard, the default behaviour is to ignore second or subsequent failure. If using the Example command then up to one failure card will be added per example.

Parameters:

value - true to not add card on second, or subsequent, failure (default behaviour), false to add a card for every failure.

Returns:

A self reference

hasScreenshotTaker

public boolean hasScreenshotTaker()

Check to see if a screenshot taker has been set

Returns:

True if screenshot taker exists

setScreenshotTaker

public StoryboardExtension setScreenshotTaker(org.concordion.ext.ScreenshotTaker screenshotTaker)

Set a screenshot taker. If not set then the storyboard extension cannot take screenshots. For a non gui application this is the most appropriate behaviour and you will not want to change this. For GUI applications you can either:

• Use RobotScreenshotTaker which will take a shot of the full visible screen
• See the demo application for an example implementation of a custom SeleniumScreenshotTaker

Parameters:

screenshotTaker - Takes screenshots of the system under test

Returns:

A self reference

removeScreenshotTaker

public StoryboardExtension removeScreenshotTaker()

Removes the screenshot taker so no further screenshots will be taken.

Returns:

A self reference

setTakeScreenshotOnExampleCompletion

public StoryboardExtension setTakeScreenshotOnExampleCompletion(boolean value)

A screenshot of the current page will be automatically added to the storyboard (as long as the screenshot taker has been set) when:

• an example completes
• a container is closed (either automatically or by calling closeContainer())

If not using the example command then final screenshots must be added manually.

This setting is also obeyed by containers that are configured to auto close such as the section container.

Parameters:

value - true to take screenshot (default), false to not take screenshot

Returns:

A self reference

skipFinalScreenshot

public StoryboardExtension skipFinalScreenshot()

If configured to take final screenshot for example (see setTakeScreenshotOnExampleCompletion(boolean)), this will override that behaviour until:

• an example completes
• a container is closed (either automatically or by calling closeContainer())

This also prevents screenshots being taken if a test fails or an exception is thrown.

Returns:

A self reference

setAcceptsScreenshots

@Deprecated
public StoryboardExtension setAcceptsScreenshots(boolean accept)

Deprecated. Has been replaced by setAcceptCards(boolean) and will be removed in the next version.

Set to false to stop screenshot cards being added, this is useful in situations where might be looping and refreshing screen constantly and don't want to show too many screenshots of same screen in storyboard.

Parameters:

accept - Accept screenshot setting

Returns:

A self reference

setAcceptCards

public StoryboardExtension setAcceptCards(boolean accept)

Prevent cards and containers from being added to the the storyboard. This is useful in situations where might be repeating an action several times and only want to record the first pass through, or performing cleanup steps and don't want the actions recorded.

Setting this to false will disable prevent cards and containers being added until either it is set to true, or the current example or specification completes.

Parameters:

accept - True to allow cards to be added, false to prevent them from being added

Returns:

A self reference

addScreenshot

public StoryboardExtension addScreenshot(java.lang.String title,
                                         java.lang.String description)

Adds screenshot card to story board

Parameters:

title - Card title

description - Card description

Returns:

A self reference

markPriorScreenshotsForRemoval

public StoryboardExtension markPriorScreenshotsForRemoval()

Marks any screenshot cards added before this point to be deleted if tests completes successfully. If added within a section break then it will only apply to the screenshots in the section break.

Returns:

A self reference

addNotification

public StoryboardExtension addNotification(java.lang.String title,
                                           java.lang.String description,
                                           CardImage image,
                                           CardResult result)

Parameters:

title - short description

description - card summary

image - StockCardImage or custom CardImage to display

result - Success/failure status

Returns:

A self reference

addNotification

public StoryboardExtension addNotification(java.lang.String title,
                                           java.lang.String description,
                                           java.lang.String data,
                                           CardImage image,
                                           CardResult result)

Adds data/information card to story board

Parameters:

title - short description

description - card summary

data - any data that may want to present to user when they click on it, can be empty, xml, json, etc

image - StockCardImage or custom CardImage to display

result - Success/failure status

Returns:

A self reference

addNotification

public StoryboardExtension addNotification(java.lang.String title,
                                           java.lang.String description,
                                           java.lang.String data,
                                           java.lang.String fileExtension,
                                           CardImage image,
                                           CardResult result)

Adds data/information card to story board

Parameters:

title - short description

description - card summary

data - any data that may want to present to user when they click on it, can be empty, xml, json, etc

fileExtension - file extension of file to write data to, defaults to txt

image - StockCardImage or custom CardImage to display

result - Success/failure status

Returns:

A self reference

addSectionContainer

public StoryboardExtension addSectionContainer(java.lang.String title)

Adds a section container to the storyboard. If there is already a section container open it will be closed before adding the new section container.

See also insertSectionContainer(String).

Parameters:

title - Title of the section break

Returns:

A self reference

insertSectionContainer

public StoryboardExtension insertSectionContainer(java.lang.String title)

Adds a section container to the storyboard. If there is already a section container open then append the new container to it ignoring any "auto close" setting.

See also addSectionContainer(String).

Parameters:

title - Title of the section break

Returns:

A self reference

closeContainer

public StoryboardExtension closeContainer()

Mark current container as completed, any cards added past this point will go to the parent container/storyboard.

Unlike containers that are auto closed automatically (such as the section container when auto close is on) a final screenshot will NOT be taken.

Returns:

A self reference

addCard

public StoryboardExtension addCard(Card card)

Add custom cards to the storyboard

Parameters:

card - Custom card

Returns:

A self reference

addCard

public StoryboardExtension addCard(ScreenshotCard card)

Add screenshot card to the storyboard

Parameters:

card - Custom card

Returns:

A self reference

addContainer

public StoryboardExtension addContainer(Container container)

Allow custom containers to be added the storyboard. If there is already a container open that is configured to be auto closed, it will be closed before adding the new section container.

See also insertContainer(Container).

Parameters:

container - Custom container

Returns:

A self reference

insertContainer

public StoryboardExtension insertContainer(Container container)

Allow custom containers to be added the storyboard. If there is already a container open then append the new container to it ignoring any "auto close" setting.

See also addContainer(Container).

Parameters:

container - Custom container

Returns:

A self reference

getCurrentExampleTitle

public java.lang.String getCurrentExampleTitle()

Get the title of the current example

Returns:

Title if executing an example, otherwise an empty string