org.concordion.cubano.driver.concordion

Class EnvironmentExtension

java.lang.Object

org.concordion.cubano.driver.concordion.EnvironmentExtension

All Implemented Interfaces:

java.util.EventListener, org.concordion.api.extension.ConcordionExtension, org.concordion.api.listener.SpecificationProcessingListener

public class EnvironmentExtension
extends java.lang.Object
implements org.concordion.api.extension.ConcordionExtension, org.concordion.api.listener.SpecificationProcessingListener

Displays the environment details to the left hand side of the standard Concordion footer.

Sample usage:

 @Extension private final EnvironmentExtension footer = new EnvironmentExtension()  .withRerunTest(“MyMSD-RunSelectedTest”)  .withRerunParameter(“token”, “ALLOW”)  .withRerunParameter(“TEST_CLASSNAME”, this.getClass().getName().replace(ConcordionBase.class.getPackage().getName() + “.”, "“))  .withEnvironment(AppConfig.getEnvironment().toUpperCase())  .withURL(AppConfig.getUrl()); 

Note:

• The only required parameter for rerunning tests is ”token" which must be configured in the Jenkins job
• Requires custom css that must be added manually
• Job will need to pass -DJENKINS_URL=${JENKINS_URL} -DSVN_URL=${SVN_URL} (if using subversion) so that we can pick up those values

Constructor Summary

Constructors

Constructor and Description
EnvironmentExtension()

Method Summary

Modifier and Type	Method and Description
void	addTo(org.concordion.api.extension.ConcordionExtender concordionExtender)
void	afterProcessingSpecification(org.concordion.api.listener.SpecificationProcessingEvent event)
void	beforeProcessingSpecification(org.concordion.api.listener.SpecificationProcessingEvent event)
static java.lang.String	getSubversionUrl()
EnvironmentExtension	withEnvironment(java.lang.String environment) Set the name of the environment to display in the footer of each specification.
EnvironmentExtension	withRerunParameter(java.lang.String name, java.lang.String value) Set the name and value of a Jenkins rerun test job parameter to append to the “rerun” link.
EnvironmentExtension	withRerunTest(java.lang.String jobName) Set the name of the test to append a “rerun” link in the footer of each specification for.
EnvironmentExtension	withURL(java.lang.String url) Set the URL of the environment to display in the footer of each specification.
EnvironmentExtension	withURL(java.lang.String url, java.lang.String label) Set the URL of the environment to display in the footer of each specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentExtension

public EnvironmentExtension()

Method Detail

addTo

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

Specified by:

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

withRerunTest

public EnvironmentExtension withRerunTest(java.lang.String jobName)

Set the name of the test to append a “rerun” link in the footer of each specification for.

Parameters:

jobName - Name of the Jenkins job used to rerun a test

Returns:

A self reference

withRerunParameter

public EnvironmentExtension withRerunParameter(java.lang.String name,
                                               java.lang.String value)

Set the name and value of a Jenkins rerun test job parameter to append to the “rerun” link. withRerunTest(String) must also be called.

Parameters:

name - Jenkins job parameter name

value - If rerun Jenkins job accepts a subversion tag parameter then supply the name

Returns:

A self reference

withEnvironment

public EnvironmentExtension withEnvironment(java.lang.String environment)

Set the name of the environment to display in the footer of each specification.

Parameters:

environment - Envrionment name

Returns:

A self reference

withURL

public EnvironmentExtension withURL(java.lang.String url)

Set the URL of the environment to display in the footer of each specification.

Parameters:

url - Environment URL

Returns:

A self reference

withURL

public EnvironmentExtension withURL(java.lang.String url,
                                    java.lang.String label)

Set the URL of the environment to display in the footer of each specification.

Parameters:

url - Environment URL

label - Label to show in place of the URL

Returns:

A self reference

beforeProcessingSpecification

public void beforeProcessingSpecification(org.concordion.api.listener.SpecificationProcessingEvent event)

Specified by:

beforeProcessingSpecification in interface org.concordion.api.listener.SpecificationProcessingListener

afterProcessingSpecification

public void afterProcessingSpecification(org.concordion.api.listener.SpecificationProcessingEvent event)

Specified by:

afterProcessingSpecification in interface org.concordion.api.listener.SpecificationProcessingListener

getSubversionUrl

public static java.lang.String getSubversionUrl()

Returns:

Subversion URL to pass when using a Subverion Tag parameter.