com.github.searls.jasmine.mojo

Class AbstractJasmineMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.searls.jasmine.mojo.AbstractJasmineMojo

All Implemented Interfaces:

JasmineConfiguration, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ServerMojo, TestMojo

public abstract class AbstractJasmineMojo
extends org.apache.maven.plugin.AbstractMojo
implements JasmineConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected int	autoRefreshInterval Automatically refresh the test runner at the given interval (specified in seconds) when using the jasmine:bdd goal.
protected String	browserVersion Determines the browser and version profile that HtmlUnit will simulate.
protected String	customRunnerConfiguration Sometimes you want to have full control over how scriptloaders are configured.
protected String	customRunnerTemplate It may be the case that the jasmine-maven-plugin doesn't currently suit all of your needs, and as a result the generated SpecRunner HTML files are set up in a way that you can't run your specs.
protected boolean	debug True to increase HtmlUnit output and attempt reporting on specs even if a timeout occurred.
protected String	format Determines the format that jasmine:test will print to console.
protected boolean	haltOnFailure Halt the build on test failure.
protected File	jasmineTargetDir Target directory for files created by the plugin.
protected String	junitXmlReportFileName The name of the generated JUnit XML report.
protected boolean	keepServerAlive Keep the server alive after the jasmine:test goal exists.
protected org.codehaus.plexus.resource.ResourceManager	locator
protected String	manualSpecRunnerHtmlFileName The name of the Manual Spec Runner.
protected org.apache.maven.project.MavenProject	mavenProject
protected List<String>	preloadSources JavaScript sources (typically vendor/lib dependencies) that need to be loaded before other sources (and specs) in a particular order.
protected String	scriptLoaderPath Deprecated. Specify script loader path using the preloadSources parameter instead.
protected int	serverPort Used by the jasmine:bdd goal to specify port to run the server under.
protected boolean	skipTests Skip the tests.
protected String	sourceEncoding The source encoding.
protected ScriptSearch	sources
protected String	specDirectoryName The name of the directory the specs will be deployed to on the server.
protected String	specRunnerHtmlFileName The name of the Spec Runner file.
protected SpecRunnerTemplate	specRunnerTemplate Determines the strategy to use when generation the JasmineSpecRunner.
protected ScriptSearch	specs
protected String	srcDirectoryName The name of the directory the sources will be deployed to on the server.
protected StringifiesStackTraces	stringifiesStackTraces
protected int	timeout Timeout for spec execution in seconds.
protected Map<String,String>	webDriverCapabilities Web driver capabilities used to initialize a DesiredCapabilities instance when creating a web driver.
protected String	webDriverClassName Determines the Selenium WebDriver class we'll use to execute the tests.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJasmineMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
int	getAutoRefreshInterval()
File	getBasedir()
File	getCustomRunnerConfiguration()
File	getCustomRunnerTemplate()
File	getJasmineTargetDir()
org.apache.maven.project.MavenProject	getMavenProject()
List<String>	getPreloadSources()
String	getScriptLoaderPath() Deprecated.
String	getSourceEncoding()
ScriptSearch	getSources()
String	getSpecDirectoryName()
SpecRunnerTemplate	getSpecRunnerTemplate()
ScriptSearch	getSpecs()
String	getSrcDirectoryName()
abstract void	run()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.searls.jasmine.config.JasmineConfiguration

getLog

Field Detail

webDriverClassName

@Parameter(defaultValue="org.openqa.selenium.htmlunit.HtmlUnitDriver")
protected String webDriverClassName

Determines the Selenium WebDriver class we'll use to execute the tests. See the Selenium documentation for more details. The plugin uses HtmlUnit by default.

Some valid examples:

• org.openqa.selenium.htmlunit.HtmlUnitDriver
• org.openqa.selenium.phantomjs.PhantomJSDriver
• org.openqa.selenium.firefox.FirefoxDriver
• org.openqa.selenium.ie.InternetExplorerDriver

For org.openqa.selenium.phantomjs.PhantomJSDriver, see the webDriverCapabilities property.

Since:

1.1.0

webDriverCapabilities

@Parameter
protected Map<String,String> webDriverCapabilities

Web driver capabilities used to initialize a DesiredCapabilities instance when creating a web driver.

This property will be ignored if org.openqa.selenium.htmlunit.HtmlUnitDriver is used; use the browserVersion property instead.

For org.openqa.selenium.phantomjs.PhantomJSDriver, include "phantomjs.binary.path" if phantomJS is not in the system command path of the build machine.

Since:

1.3.1.1

browserVersion

@Parameter(defaultValue="FIREFOX_3_6")
protected String browserVersion

Determines the browser and version profile that HtmlUnit will simulate. This setting does nothing if the plugin is configured not to use HtmlUnit. This maps 1-to-1 with the public static instances found in BrowserVersion.

Some valid examples: CHROME, FIREFOX_3_6, INTERNET_EXPLORER_7, INTERNET_EXPLORER_8, INTERNET_EXPLORER_9

Since:

1.1.0

format

@Parameter(defaultValue="documentation")
protected String format

Determines the format that jasmine:test will print to console.

Valid options:

• "documentation" - (default) - print specs in a nested format
• "progress" - more terse, with a period for a passed specs and an 'F' for failures (e.g. '...F...')

Since:

1.1.0

preloadSources

@Parameter
protected List<String> preloadSources

JavaScript sources (typically vendor/lib dependencies) that need to be loaded before other sources (and specs) in a particular order. Each source will first be searched for relative to ${jsSrcDir}, then ${jsTestSrcDir}, then (if it's not found in either) it will be included exactly as it appears in your POM.

Therefore, if jquery.js is in ${jsSrcDir}/vendor, you would configure:

 <preloadSources>
   <source>vendor/jquery.js</source>
 </preloadSources>
 

And jquery.js would load before all the other sources and specs.

Since:

1.1.0

customRunnerTemplate

@Parameter
protected String customRunnerTemplate

It may be the case that the jasmine-maven-plugin doesn't currently suit all of your needs, and as a result the generated SpecRunner HTML files are set up in a way that you can't run your specs. Have no fear! Simply specify a custom spec runner template in the plugin configuration and make the changes you need.

Potential values are a filesystem path, a URL, or a classpath resource. The default template is stored in src/main/resources/jasmine-templates/SpecRunner.htmltemplate, and the required template strings are tokenized in "$*$" patterns.

Example usage:

 <customRunnerTemplate>${project.basedir}/src/test/resources/myCustomRunner.template</customRunnerTemplate>
 

Since:

1.1.0

customRunnerConfiguration

@Parameter
protected String customRunnerConfiguration

Sometimes you want to have full control over how scriptloaders are configured. In order to interpolate custom configuration into the generated runnerTemplate, specify a file containing the additional config. Potential values are a filesystem path, a URL, or a classpath resource.

Example usage:

 <customRunnerConfiguration>${project.basedir}/src/test/resources/myCustomConfig.txt</customRunnerConfiguration>
 

Since:

1.1.0

jasmineTargetDir

@Parameter(defaultValue="${project.build.directory}${file.separator}jasmine")
protected File jasmineTargetDir

Target directory for files created by the plugin.

Since:

1.1.0

skipTests

@Parameter(property="skipTests")
protected boolean skipTests

Skip the tests.

Since:

1.1.0

haltOnFailure

@Parameter(property="haltOnFailure",
           defaultValue="true")
protected boolean haltOnFailure

Halt the build on test failure.

Since:

1.1.0

timeout

@Parameter(defaultValue="300")
protected int timeout

Timeout for spec execution in seconds.

Since:

1.1.0

debug

@Parameter(defaultValue="false")
protected boolean debug

True to increase HtmlUnit output and attempt reporting on specs even if a timeout occurred.

Since:

1.1.0

specRunnerHtmlFileName

@Parameter(defaultValue="SpecRunner.html")
protected String specRunnerHtmlFileName

The name of the Spec Runner file.

Since:

1.1.0

manualSpecRunnerHtmlFileName

@Parameter(defaultValue="ManualSpecRunner.html")
protected String manualSpecRunnerHtmlFileName

The name of the Manual Spec Runner.

Since:

1.1.0

junitXmlReportFileName

@Parameter(defaultValue="TEST-jasmine.xml")
protected String junitXmlReportFileName

The name of the generated JUnit XML report.

Since:

1.1.0

specDirectoryName

@Parameter(defaultValue="spec")
protected String specDirectoryName

The name of the directory the specs will be deployed to on the server.

Since:

1.1.0

srcDirectoryName

@Parameter(defaultValue="src")
protected String srcDirectoryName

The name of the directory the sources will be deployed to on the server.

Since:

1.1.0

sourceEncoding

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String sourceEncoding

The source encoding.

Since:

1.1.0

keepServerAlive

@Parameter(property="keepServerAlive",
           defaultValue="false")
protected boolean keepServerAlive

Keep the server alive after the jasmine:test goal exists. Useful if you need to run further analysis on your tests, like collecting code coverage.

Since:

1.3.1.0

serverPort

@Parameter(property="jasmine.serverPort",
           defaultValue="8234")
protected int serverPort

Used by the jasmine:bdd goal to specify port to run the server under.

The jasmine:test goal always uses a random available port so this property is ignored.

Since:

1.1.0

specRunnerTemplate

@Parameter(property="jasmine.specRunnerTemplate",
           defaultValue="DEFAULT")
protected SpecRunnerTemplate specRunnerTemplate

Determines the strategy to use when generation the JasmineSpecRunner. This feature allows for custom implementation of the runner generator. Typically this is used when using different script runners.

Some valid examples: DEFAULT, REQUIRE_JS

Since:

1.1.0

scriptLoaderPath

@Parameter
@Deprecated
protected String scriptLoaderPath

Deprecated. Specify script loader path using the preloadSources parameter instead.

Path to loader script, relative to jsSrcDir. Defaults to jsSrcDir/nameOfScript.js. Which script to look for is determined by the selected spcRunnerTemplate. I.e require.js is used when REQUIRE_JS is selected as specRunnerTemplate.

Since:

1.1.0

autoRefreshInterval

@Parameter(property="jasmine.autoRefreshInterval",
           defaultValue="0")
protected int autoRefreshInterval

Automatically refresh the test runner at the given interval (specified in seconds) when using the jasmine:bdd goal.

A value of 0 disables the automatic refresh (which is the default).

Since:

1.3.1.1

mavenProject

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject mavenProject

locator

@Component
protected org.codehaus.plexus.resource.ResourceManager locator

sources

protected ScriptSearch sources

specs

protected ScriptSearch specs

stringifiesStackTraces

protected StringifiesStackTraces stringifiesStackTraces

Constructor Detail

AbstractJasmineMojo

public AbstractJasmineMojo()

Method Detail

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

run

public abstract void run()
                  throws Exception

Throws:

Exception

getSourceEncoding

public String getSourceEncoding()

Specified by:

getSourceEncoding in interface JasmineConfiguration

getCustomRunnerTemplate

public File getCustomRunnerTemplate()

Specified by:

getCustomRunnerTemplate in interface JasmineConfiguration

getSpecRunnerTemplate

public SpecRunnerTemplate getSpecRunnerTemplate()

Specified by:

getSpecRunnerTemplate in interface JasmineConfiguration

getJasmineTargetDir

public File getJasmineTargetDir()

Specified by:

getJasmineTargetDir in interface JasmineConfiguration

getSrcDirectoryName

public String getSrcDirectoryName()

Specified by:

getSrcDirectoryName in interface JasmineConfiguration

getSources

public ScriptSearch getSources()

Specified by:

getSources in interface JasmineConfiguration

getSpecs

public ScriptSearch getSpecs()

Specified by:

getSpecs in interface JasmineConfiguration

getSpecDirectoryName

public String getSpecDirectoryName()

Specified by:

getSpecDirectoryName in interface JasmineConfiguration

getPreloadSources

public List<String> getPreloadSources()

Specified by:

getPreloadSources in interface JasmineConfiguration

getAutoRefreshInterval

public int getAutoRefreshInterval()

Specified by:

getAutoRefreshInterval in interface JasmineConfiguration

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

getCustomRunnerConfiguration

public File getCustomRunnerConfiguration()

Specified by:

getCustomRunnerConfiguration in interface JasmineConfiguration

getScriptLoaderPath

@Deprecated
public String getScriptLoaderPath()

Deprecated.

Specified by:

getScriptLoaderPath in interface JasmineConfiguration

getBasedir

public File getBasedir()

Specified by:

getBasedir in interface JasmineConfiguration