Fork me on GitHub

attester:run

Full name:

com.ariatemplates.attester:attester-maven-plugin:2.6.2:run

Description:

Runs attester with the --server-only option. This is useful to run tests manually.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Optional Parameters

Name Type Since Description
arguments List - Arguments to pass to the node.js process.
ariaTemplatesBootstrap String - Aria Templates bootstrap file. (Passed through --config.tests.aria-templates.bootstrap to attester)
ariaTemplatesClasspath String - Aria Templates single test classpath to include. If this parameter is defined, ariaTemplatesClasspathsIncludes and ariaTemplatesClasspathsExcludes are ignored. It allows to easily run a single test from the command line. (Passed through --config.tests.aria-templates.classpaths.includes to attester)
ariaTemplatesClasspathsExcludes String[] - Aria Templates test classpaths to exclude. (Passed through --config.tests.aria-templates.classpaths.excludes to attester)
ariaTemplatesClasspathsIncludes String[] - Aria Templates test classpaths to include. (Passed through --config.tests.aria-templates.classpaths.includes to attester)
ariaTemplatesExtraScripts String[] - Aria Templates extra scripts to be included before running each test. (Passed through --config.tests.aria-templates.extraScripts to attester)
attesterExtractionParentDirectory File - Parent directory in which the directory containing the extracted attester files will be created, if it does not already exist. Files are extracted from the following maven artifact: com.ariatemplates.attester:attester:zip:project This parameter is only used if attesterPath is not defined.
attesterPath File - Path to the attester directory. If not defined, attester is extracted from the the following maven artifact: com.ariatemplates.attester:attester:zip:project
avoidRenamingAttesterExtractionDirectory boolean - When this option is set to true (which is now the default), attester will extract attester files directly in the final folder without the need to rename it. It is the recommended value when extracting attester files in a private location of the current build (such as the target directory, see the attesterExtractionParentDirectory parameter). Setting this option to false restores the previous behavior, which was to first create a temporary folder, then to extract attester files in it and finally to rename the folder to its final name. This previous behavior was designed to allow setting a shared folder in the attesterExtractionParentDirectory parameter: if multiple builds run concurrently, if they find an existing folder with the final name, they could directly use it and know that the extraction was complete (because renaming the folder happens at the end of the extraction). Otherwise, they would each try to extract attester files in their own temporary folder, and then only one build would successfully rename its temporary folder and all other builds would detect the final folder at the end of their temporary extraction and they would use the final folder and erase their temporary folder. However, in some setups, it was noticed that the renameTo function can randomly fail for non-obvious reasons (maybe because the folder is locked by an anti-virus program while checking the newly extracted files). So, to keep a safe and consistent behavior, it is recommended to keep the default values for the avoidRenamingAttesterExtractionDirectory and attesterExtractionParentDirectory parameters. This parameter is only used if attesterPath is not defined.
browsers String[] - List of browsers to test. (Passed through --config.browsers to attester)
colors boolean - Enables or disables colors. (Passes --colors or --no-colors to attester)
configFile File - Configuration file to use. More information about the format to use is documented here. Note that most options can be configured directly from the pom.xml, without the need for an external configuration file.
coverageExcludes String[] - List of file patterns to be excluded from code coverage instrumentation. See coverageRootDirectory for more information. This property is ignored if coverageRootDirectory does not exist or is not a directory. (Passed through --config.coverage.files.excludes to attester)
coverageIncludes String[] - List of file patterns to be included for code coverage instrumentation. See coverageRootDirectory for more information. This property is ignored if coverageRootDirectory does not exist or is not a directory. (Passed through --config.coverage.files.includes to attester)
coverageRootDirectory File - Root directory for code coverage instrumentation. Files inside this directory and matching one of the coverageIncludes patterns and not matching any coverageExcludes patterns will be instrumented for code coverage when requested to the web server. Note that for code coverage instrumentation to be effective, this directory or one of its parents has to be configured to be served by the web server (e.g. through testSourceDirectory, warSourceDirectory or webappDirectory). The default value for this parameter is the value of the warSourceDirectory parameter. (Passed through --config.coverage.files.rootDirectory to attester)
host String - Host for the internal web server. (Passed through --host to attester)
jsonCoverageReportFile File - JSON coverage file report. (Passed through --config.coverage-reports.json-file to attester)
jsonReportFile File - JSON file report. (Passed through --config.test-reports.json-file to attester)
lcovCoverageReportFile File - lcov coverage file report. (Passed through --config.coverage-reports.lcov-file to attester)
nodejsPath File - Path to the node.js executable. If not defined, node.js is used from the the following maven artifact: org.nodejs:node:0.10.32:exe:win32

port Integer - Port for the internal web server. (Passed through --port to attester)
systemNodejs boolean - Whether to use the node.js executable from the PATH instead of the one from the maven repository in case the nodejsPath parameter is not defined. On non-Windows operating systems, as there is no executable in the maven repository, this parameter is considered as true.
testSourceDirectory File - First directory to serve as the root of the web server. This directory is usually the one containing Javascript tests. (Passed through --config.resources./ to attester)
warSourceDirectory File - Second directory to serve as the root of the web server. In case a file is requested and not present in testSourceDirectory, it is looked for in this directory. This directory is usually the one containing the main Javascript files of the application. If it exists, it is also used as the default value for the coverageRootDirectory option. (Passed through --config.resources./ to attester)
webappDirectory File - Third directory to serve as the root of the web server. In case a file is requested and not present in either warSourceDirectory or testSourceDirectory, it is looked for in this directory. This directory usually contains any external library needed by the application. (Passed through --config.resources./ to attester)
xmlReportFile File - Single JUnit-style file report. (Passed through --config.test-reports.xml-file to attester)
xmlReportsDirectory File - Directory for the set of JUnit-style report files. (Passed through --config.test-reports.xml-directory to attester)

Parameter Details

arguments:

Arguments to pass to the node.js process.
  • Type: java.util.List
  • Required: No

ariaTemplatesBootstrap:

Aria Templates bootstrap file. (Passed through --config.tests.aria-templates.bootstrap to attester)
  • Type: java.lang.String
  • Required: No
  • Expression: /aria/aria-templates-${at.version}.js

ariaTemplatesClasspath:

Aria Templates single test classpath to include. If this parameter is defined, ariaTemplatesClasspathsIncludes and ariaTemplatesClasspathsExcludes are ignored. It allows to easily run a single test from the command line. (Passed through --config.tests.aria-templates.classpaths.includes to attester)
  • Type: java.lang.String
  • Required: No
  • Expression: ${attester.ariaTemplatesClasspath}

ariaTemplatesClasspathsExcludes:

Aria Templates test classpaths to exclude. (Passed through --config.tests.aria-templates.classpaths.excludes to attester)
  • Type: java.lang.String[]
  • Required: No

ariaTemplatesClasspathsIncludes:

Aria Templates test classpaths to include. (Passed through --config.tests.aria-templates.classpaths.includes to attester)
  • Type: java.lang.String[]
  • Required: No

ariaTemplatesExtraScripts:

Aria Templates extra scripts to be included before running each test. (Passed through --config.tests.aria-templates.extraScripts to attester)
  • Type: java.lang.String[]
  • Required: No

attesterExtractionParentDirectory:

Parent directory in which the directory containing the extracted attester files will be created, if it does not already exist. Files are extracted from the following maven artifact: com.ariatemplates.attester:attester:zip:project This parameter is only used if attesterPath is not defined.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}

attesterPath:

Path to the attester directory. If not defined, attester is extracted from the the following maven artifact: com.ariatemplates.attester:attester:zip:project
  • Type: java.io.File
  • Required: No
  • Expression: ${com.ariatemplates.attester.path}

avoidRenamingAttesterExtractionDirectory:

When this option is set to true (which is now the default), attester will extract attester files directly in the final folder without the need to rename it. It is the recommended value when extracting attester files in a private location of the current build (such as the target directory, see the attesterExtractionParentDirectory parameter). Setting this option to false restores the previous behavior, which was to first create a temporary folder, then to extract attester files in it and finally to rename the folder to its final name. This previous behavior was designed to allow setting a shared folder in the attesterExtractionParentDirectory parameter: if multiple builds run concurrently, if they find an existing folder with the final name, they could directly use it and know that the extraction was complete (because renaming the folder happens at the end of the extraction). Otherwise, they would each try to extract attester files in their own temporary folder, and then only one build would successfully rename its temporary folder and all other builds would detect the final folder at the end of their temporary extraction and they would use the final folder and erase their temporary folder. However, in some setups, it was noticed that the renameTo function can randomly fail for non-obvious reasons (maybe because the folder is locked by an anti-virus program while checking the newly extracted files). So, to keep a safe and consistent behavior, it is recommended to keep the default values for the avoidRenamingAttesterExtractionDirectory and attesterExtractionParentDirectory parameters. This parameter is only used if attesterPath is not defined.
  • Type: boolean
  • Required: No
  • Expression: ${attester.avoidRenamingAttesterExtractionDirectory}

browsers:

List of browsers to test. (Passed through --config.browsers to attester)
  • Type: java.lang.String[]
  • Required: No

colors:

Enables or disables colors. (Passes --colors or --no-colors to attester)
  • Type: boolean
  • Required: No
  • Expression: ${attester.colors}

configFile:

Configuration file to use. More information about the format to use is documented here. Note that most options can be configured directly from the pom.xml, without the need for an external configuration file.
  • Type: java.io.File
  • Required: No

coverageExcludes:

List of file patterns to be excluded from code coverage instrumentation. See coverageRootDirectory for more information. This property is ignored if coverageRootDirectory does not exist or is not a directory. (Passed through --config.coverage.files.excludes to attester)
  • Type: java.lang.String[]
  • Required: No

coverageIncludes:

List of file patterns to be included for code coverage instrumentation. See coverageRootDirectory for more information. This property is ignored if coverageRootDirectory does not exist or is not a directory. (Passed through --config.coverage.files.includes to attester)
  • Type: java.lang.String[]
  • Required: No

coverageRootDirectory:

Root directory for code coverage instrumentation. Files inside this directory and matching one of the coverageIncludes patterns and not matching any coverageExcludes patterns will be instrumented for code coverage when requested to the web server. Note that for code coverage instrumentation to be effective, this directory or one of its parents has to be configured to be served by the web server (e.g. through testSourceDirectory, warSourceDirectory or webappDirectory). The default value for this parameter is the value of the warSourceDirectory parameter. (Passed through --config.coverage.files.rootDirectory to attester)
  • Type: java.io.File
  • Required: No

host:

Host for the internal web server. (Passed through --host to attester)
  • Type: java.lang.String
  • Required: No
  • Expression: ${attester.host}

jsonCoverageReportFile:

JSON coverage file report. (Passed through --config.coverage-reports.json-file to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/atjstestsCoverageReport.json

jsonReportFile:

JSON file report. (Passed through --config.test-reports.json-file to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/atjstestsReport.json

lcovCoverageReportFile:

lcov coverage file report. (Passed through --config.coverage-reports.lcov-file to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/jstestdriver/jsTestDriver.conf-coverage.dat

nodejsPath:

Path to the node.js executable. If not defined, node.js is used from the the following maven artifact: org.nodejs:node:0.10.32:exe:win32
  • Type: java.io.File
  • Required: No
  • Expression: ${org.nodejs.node.path}

port:

Port for the internal web server. (Passed through --port to attester)
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${attester.port}

systemNodejs:

Whether to use the node.js executable from the PATH instead of the one from the maven repository in case the nodejsPath parameter is not defined. On non-Windows operating systems, as there is no executable in the maven repository, this parameter is considered as true.
  • Type: boolean
  • Required: No

testSourceDirectory:

First directory to serve as the root of the web server. This directory is usually the one containing Javascript tests. (Passed through --config.resources./ to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/test/webapp

warSourceDirectory:

Second directory to serve as the root of the web server. In case a file is requested and not present in testSourceDirectory, it is looked for in this directory. This directory is usually the one containing the main Javascript files of the application. If it exists, it is also used as the default value for the coverageRootDirectory option. (Passed through --config.resources./ to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/webapp

webappDirectory:

Third directory to serve as the root of the web server. In case a file is requested and not present in either warSourceDirectory or testSourceDirectory, it is looked for in this directory. This directory usually contains any external library needed by the application. (Passed through --config.resources./ to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/${project.build.finalName}

xmlReportFile:

Single JUnit-style file report. (Passed through --config.test-reports.xml-file to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/atjstestsReport.xml

xmlReportsDirectory:

Directory for the set of JUnit-style report files. (Passed through --config.test-reports.xml-directory to attester)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/jstestdriver