AbstractJasmineMojo (jasmine-maven-plugin 2.2 API)

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 boolean`	`coffeeScriptCompilationEnabled` Control the Coffee Script compilation.
`protected String`	`connectorClass` Type of `Connector` to use on the jetty server.
`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 List<FileSystemReporter>`	`fileSystemReporters` Specify a custom file system reporter to be used to store the test report.
`protected boolean`	`haltOnFailure` Halt the build on test failure.
`protected File`	`jasmineTargetDir` Target directory for files created by the plugin.
`protected String`	`manualSpecRunnerHtmlFileName` The name of the Manual Spec Runner.
`protected org.apache.maven.project.MavenProject`	`mavenProject`
`protected boolean`	`mvnTestSkip` Skip compilation and execution of tests.
`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 ReporterRetriever`	`reporterRetriever`
`protected List<Reporter>`	`reporters` Specify a custom reporter to be used to print the test report.
`protected ResourceRetriever`	`resourceRetriever`
`protected String`	`serverHostname` Not used by the `jasmine:bdd` goal.
`protected int`	`serverPort` Used by the `jasmine:bdd` goal to specify port to run the server under.
`protected boolean`	`skipJasmineTests` Skip only jasmine tests
`protected boolean`	`skipTests` Skip execution of 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 String`	`uriScheme` Specify the URI scheme in which to access the SpecRunner.

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

Constructor Summary

Constructors
Constructor and Description

AbstractJasmineMojo()

Constructors
Constructor and Description
`AbstractJasmineMojo()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute()`
`int`	`getAutoRefreshInterval()`
`File`	`getBasedir()`
`protected org.eclipse.jetty.server.Connector`	`getConnector()`
`List<Context>`	`getContexts()`
`File`	`getCustomRunnerConfiguration()`
`File`	`getCustomRunnerTemplate()`
`List<FileSystemReporter>`	`getFileSystemReporters()`
`File`	`getJasmineTargetDir()`
`org.apache.maven.project.MavenProject`	`getMavenProject()`
`List<String>`	`getPreloadSources()`
`ClassLoader`	`getProjectClassLoader()`
`List<Reporter>`	`getReporters()`
`String`	`getSourceEncoding()`
`ScriptSearch`	`getSources()`
`String`	`getSpecDirectoryName()`
`SpecRunnerTemplate`	`getSpecRunnerTemplate()`
`ScriptSearch`	`getSpecs()`
`String`	`getSrcDirectoryName()`
`boolean`	`isCoffeeScriptCompilationEnabled()`
`protected boolean`	`isSkipTests()`
`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
  - 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
  - reporters
```
@Parameter
protected List<Reporter> reporters
```
    Specify a custom reporter to be used to print the test report.
    
    Example usage:
```
 <reporters>
   <reporter>
     <reporterName>${project.basedir}/src/test/resources/myCustomReporter.js</reporterName>
   </reporter>
   <reporter>
     <reporterName>STANDARD</reporterName>
   </reporter>
 </reporters>
 
```
  - fileSystemReporters
```
@Parameter
protected List<FileSystemReporter> fileSystemReporters
```
    Specify a custom file system reporter to be used to store the test report.
    
    Example usage:
```
 <fileSystemReporters>
   <reporter>
     <fileName>MyFile.log</fileName>
     <reporterName>${project.basedir}/src/test/resources/myCustomReporter.js</reporterName>
   </reporter>
   <reporter>
     <fileName>Test-jasmine.xml</fileName>
     <reporterName>JUNIT_XML</reporterName>
   </reporter>
 </fileSystemReporters>
 
```
  - 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 execution of tests.
    
    Since:
    
    1.1.0
    
    See Also:
    
    http://maven.apache.org/general.html#skip-test
  - mvnTestSkip
```
@Parameter(property="maven.test.skip")
protected boolean mvnTestSkip
```
    Skip compilation and execution of tests.
    
    Since:
    
    1.3.1.3
    
    See Also:
    
    http://maven.apache.org/general.html#skip-test
  - skipJasmineTests
```
@Parameter(property="skipJasmineTests")
protected boolean skipJasmineTests
```
    Skip only jasmine tests
    
    Since:
    
    1.3.1.3
  - 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
  - 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
  - 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
  - uriScheme
```
@Parameter(property="jasmine.uriScheme",
           defaultValue="http")
protected String uriScheme
```
    Specify the URI scheme in which to access the SpecRunner.
    
    Since:
    
    1.3.1.4
  - serverHostname
```
@Parameter(property="jasmine.serverHostname",
           defaultValue="localhost")
protected String serverHostname
```
    Not used by the jasmine:bdd goal.
    
    The jasmine:test goal to specify hostname where the server is running. Useful when using the RemoteWebDriver.
    
    Since:
    
    1.3.1.4
  - 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
  - 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
  - coffeeScriptCompilationEnabled
```
@Parameter(property="coffeeScriptCompilationEnabled",
           defaultValue="true")
protected boolean coffeeScriptCompilationEnabled
```
    Control the Coffee Script compilation. e.g. When using RequireJS the compilation happens within the Coffee Script AMD loader plugin; we therefore need to disable the compilation here.
    
    Since:
    
    1.3.1.4
  - connectorClass
```
@Parameter(property="jasmine.connectorClass",
           defaultValue="org.eclipse.jetty.server.nio.SelectChannelConnector")
protected String connectorClass
```
    Type of Connector to use on the jetty server.
    
    Most users won't need to change this from the default value. It should only be used by advanced users.
    
    Since:
    
    1.3.1.4
  - mavenProject
```
@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject mavenProject
```
  - resourceRetriever
```
protected ResourceRetriever resourceRetriever
```
  - reporterRetriever
```
protected ReporterRetriever reporterRetriever
```
  - stringifiesStackTraces
```
protected StringifiesStackTraces stringifiesStackTraces
```
  - sources
```
protected ScriptSearch sources
```
  - specs
```
protected ScriptSearch specs
```
- Constructor Detail
  - AbstractJasmineMojo
```
public AbstractJasmineMojo()
```
- Method Detail
  - execute
```
public 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
  - isCoffeeScriptCompilationEnabled
```
public boolean isCoffeeScriptCompilationEnabled()
```
    Specified by:
    
    isCoffeeScriptCompilationEnabled in interface JasmineConfiguration
  - getMavenProject
```
public org.apache.maven.project.MavenProject getMavenProject()
```
  - getCustomRunnerConfiguration
```
public File getCustomRunnerConfiguration()
```
    Specified by:
    
    getCustomRunnerConfiguration in interface JasmineConfiguration
  - getReporters
```
public List<Reporter> getReporters()
```
    Specified by:
    
    getReporters in interface JasmineConfiguration
  - getFileSystemReporters
```
public List<FileSystemReporter> getFileSystemReporters()
```
    Specified by:
    
    getFileSystemReporters in interface JasmineConfiguration
  - getBasedir
```
public File getBasedir()
```
    Specified by:
    
    getBasedir in interface JasmineConfiguration
  - getProjectClassLoader
```
public ClassLoader getProjectClassLoader()
```
    Specified by:
    
    getProjectClassLoader in interface JasmineConfiguration
  - getContexts
```
public List<Context> getContexts()
```
    Specified by:
    
    getContexts in interface JasmineConfiguration
  - getConnector
```
protected org.eclipse.jetty.server.Connector getConnector()
                                                   throws org.apache.maven.plugin.MojoExecutionException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - isSkipTests
```
protected boolean isSkipTests()
```

Class AbstractJasmineMojo

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

preloadSources

customRunnerTemplate

customRunnerConfiguration

reporters

fileSystemReporters

jasmineTargetDir

skipTests

mvnTestSkip

skipJasmineTests

haltOnFailure

timeout

debug

specRunnerHtmlFileName

manualSpecRunnerHtmlFileName

specDirectoryName

srcDirectoryName

sourceEncoding

serverPort

uriScheme

serverHostname

specRunnerTemplate

autoRefreshInterval

coffeeScriptCompilationEnabled

connectorClass

mavenProject

resourceRetriever

reporterRetriever

stringifiesStackTraces

sources

specs

Constructor Detail

AbstractJasmineMojo

Method Detail

execute

run

getSourceEncoding

getCustomRunnerTemplate

getSpecRunnerTemplate

getJasmineTargetDir

getSrcDirectoryName

getSources

getSpecs

getSpecDirectoryName

getPreloadSources

getAutoRefreshInterval

isCoffeeScriptCompilationEnabled

getMavenProject

getCustomRunnerConfiguration

getReporters

getFileSystemReporters

getBasedir

getProjectClassLoader

getContexts

getConnector

isSkipTests