Fork me on GitHub

scalor:scala-js-env-conf-nodejs

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:scala-js-env-conf-nodejs

Description:

Configure Scala.js JavaScript VM environment for testing: provide scala-js-junit-tools settings for Node.js.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: process-test-resources.

Optional Parameters

Name Type Since Description
<commonMappingPattern> String - Regular expression for plugin configuration map values provided in pom.xml. Extractor for pattern: key=value. Must define exactly two regex capture groups. Mapping regular expression is used as follows:
  case commonMappingPattern.r( key, value ) => ( key, value )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml.
Default value is: \s*([^=\s]+)\s*=\s*([^\s]+)\s*.
User property is: scalor.commonMappingPattern.
<commonSequenceSeparator> String - Separator for plugin configuration list values provided in pom.xml. Separator regular expression is used as follows:
  string.split( commonSequenceSeparator ).map( _.trim ).filterNot( _.isEmpty )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml. Note: to insert unicode symbol in Eclipse/GTK, type CTRL+SHIFT+U, then XXXX - a 4-hex-digit unicode value. For example, for star ★, use hex code 2605.
Default value is: [★\n]+.
User property is: scalor.commonSequenceSeparator.
<envconfLogConfig> boolean - Enable to log provided JS-VM environment configuration. Use to review actual settings used to create tesing JS-VM instance:
  - full path to the executable
  - process launch arguments
  - process environment variables
  - webjars scripts settings
  - runtime.js module settings 
  - etc.

Default value is: false.
User property is: scalor.envconfLogConfig.
<envconfModulePath> File - Scala.js testing module script used to run tests inside JavaScript VM environment. Normally testing module script path should point to the result of Scala.js linker invocation.
Default value is: ${project.build.testOutputDirectory}/META-INF/resources/webjars/${project.artifactId}/${project.version}/runtime-test.js.
User property is: scalor.envconfModulePath.
<envconfNodejsArgs> String - Arguments for the Node.js JavaScript VM executable. Separator parameter: commonSequenceSeparator.
Default value is: .
User property is: scalor.envconfNodejsArgs.
<envconfNodejsExec> File - Absolute path to the Node.js JavaScript VM executable. Normally should point to the provisioning extraction result.
Default value is: ${project.basedir}/test-tool/node/node.
User property is: scalor.envconfNodejsExec.
<envconfNodejsType> String - Select JS-VM type. Available Node.js JavaScript VM environment types:
nodejs-basic - basic Node.js, for non-UI testing, does not expect any node modules
nodejs-jsdom - Node.js with JSdom.js, for broswer-UI testing, must provision 'jsdom' module

Default value is: nodejs-jsdom.
User property is: scalor.envconfNodejsType.
<envconfNodejsVars> String - Environment variables for the Node.js JavaScript VM executable. Normally should define NODE_PATH to point to the Node.js modules provisioning result. Separator parameter: commonSequenceSeparator. Mapping parameter: commonMappingPattern. Some Node.js environment variables:
NODE_MODULE_CONTEXTS - set to 0 to disable inter-module isolation via sandboxing
NODE_DEBUG - set to comma-separated list of module names to enable logging
NODE_PATH - set to absolute path to the provisioned node_modules folder

Default value is: NODE_MODULE_CONTEXTS=0 ★ NODE_PATH=${project.basedir}/test-tool/node/node_modules ★ .
User property is: scalor.envconfNodejsVars.
<envconfSystemProperties> String - System properties injected during environment configuration invocation. Normally includes settings for scala-js-junit-tools. Separator parameter: commonSequenceSeparator. Mapping parameter: commonMappingPattern.
Default value is: basedir = ${project.basedir} ★ .
User property is: scalor.envconfSystemProperties.
<envconfWebjarsFolder> File - Folder with extracted webjars resources. Specific scripts should be activated in JavaScript VM via parameter: envconfWebjarsScriptList Normally webjars folder should point to the extraction result of the webjars provisioning invocation. Absolute path.
Default value is: ${project.basedir}/test-tool/webjars.
User property is: scalor.envconfWebjarsFolder.
<envconfWebjarsScriptList> String - List of scripts which should be activated inside JavaScript VM during tests. These scripts must be provided inside the provisioning folder: envconfWebjarsFolder. Separator parameter: commonSequenceSeparator. Relative path.
Default value is: .
User property is: scalor.envconfWebjarsScriptList.
<skip> boolean - Force to skip all executions of this plugin.
Default value is: false.
User property is: scalor.skip.
<skipEnvConf> boolean - Flag to skip environment configuration.
Default value is: false.
User property is: scalor.skipEnvConf.
<skipLogReason> boolean - Enable logging of reason for skipping an execution.
Default value is: true.
User property is: scalor.skipLogReason.
<skipPackagingList> String[] - List of packaging types, which are skipped by this plugin.
Default value is: pom.
User property is: scalor.skipPackagingList.

Parameter Details

<commonMappingPattern>

Regular expression for plugin configuration map values provided in pom.xml. Extractor for pattern: key=value. Must define exactly two regex capture groups. Mapping regular expression is used as follows:
  case commonMappingPattern.r( key, value ) => ( key, value )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.commonMappingPattern
  • Default: \s*([^=\s]+)\s*=\s*([^\s]+)\s*

<commonSequenceSeparator>

Separator for plugin configuration list values provided in pom.xml. Separator regular expression is used as follows:
  string.split( commonSequenceSeparator ).map( _.trim ).filterNot( _.isEmpty )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml. Note: to insert unicode symbol in Eclipse/GTK, type CTRL+SHIFT+U, then XXXX - a 4-hex-digit unicode value. For example, for star ★, use hex code 2605.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.commonSequenceSeparator
  • Default: [★\n]+

<envconfLogConfig>

Enable to log provided JS-VM environment configuration. Use to review actual settings used to create tesing JS-VM instance:
  - full path to the executable
  - process launch arguments
  - process environment variables
  - webjars scripts settings
  - runtime.js module settings 
  - etc.
  • Type: boolean
  • Required: No
  • User Property: scalor.envconfLogConfig
  • Default: false

<envconfModulePath>

Scala.js testing module script used to run tests inside JavaScript VM environment. Normally testing module script path should point to the result of Scala.js linker invocation.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.envconfModulePath
  • Default: ${project.build.testOutputDirectory}/META-INF/resources/webjars/${project.artifactId}/${project.version}/runtime-test.js

<envconfNodejsArgs>

Arguments for the Node.js JavaScript VM executable. Separator parameter: commonSequenceSeparator.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envconfNodejsArgs
  • Default:

<envconfNodejsExec>

Absolute path to the Node.js JavaScript VM executable. Normally should point to the provisioning extraction result.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.envconfNodejsExec
  • Default: ${project.basedir}/test-tool/node/node

<envconfNodejsType>

Select JS-VM type. Available Node.js JavaScript VM environment types:
nodejs-basic - basic Node.js, for non-UI testing, does not expect any node modules
nodejs-jsdom - Node.js with JSdom.js, for broswer-UI testing, must provision 'jsdom' module
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envconfNodejsType
  • Default: nodejs-jsdom

<envconfNodejsVars>

Environment variables for the Node.js JavaScript VM executable. Normally should define NODE_PATH to point to the Node.js modules provisioning result. Separator parameter: commonSequenceSeparator. Mapping parameter: commonMappingPattern. Some Node.js environment variables:
NODE_MODULE_CONTEXTS - set to 0 to disable inter-module isolation via sandboxing
NODE_DEBUG - set to comma-separated list of module names to enable logging
NODE_PATH - set to absolute path to the provisioned node_modules folder
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envconfNodejsVars
  • Default: NODE_MODULE_CONTEXTS=0 ★ NODE_PATH=${project.basedir}/test-tool/node/node_modules ★

<envconfSystemProperties>

System properties injected during environment configuration invocation. Normally includes settings for scala-js-junit-tools. Separator parameter: commonSequenceSeparator. Mapping parameter: commonMappingPattern.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envconfSystemProperties
  • Default: basedir = ${project.basedir} ★

<envconfWebjarsFolder>

Folder with extracted webjars resources. Specific scripts should be activated in JavaScript VM via parameter: envconfWebjarsScriptList Normally webjars folder should point to the extraction result of the webjars provisioning invocation. Absolute path.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.envconfWebjarsFolder
  • Default: ${project.basedir}/test-tool/webjars

<envconfWebjarsScriptList>

List of scripts which should be activated inside JavaScript VM during tests. These scripts must be provided inside the provisioning folder: envconfWebjarsFolder. Separator parameter: commonSequenceSeparator. Relative path.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envconfWebjarsScriptList
  • Default:

<skip>

Force to skip all executions of this plugin.
  • Type: boolean
  • Required: No
  • User Property: scalor.skip
  • Default: false

<skipEnvConf>

Flag to skip environment configuration.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipEnvConf
  • Default: false

<skipLogReason>

Enable logging of reason for skipping an execution.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipLogReason
  • Default: true

<skipPackagingList>

List of packaging types, which are skipped by this plugin.
  • Type: java.lang.String[]
  • Required: No
  • User Property: scalor.skipPackagingList
  • Default: pom