Skip to content

npmExecuteEndToEndTests

Description

Executes end to end tests by running the npm script configured via the runScript property.

Parameters

name mandatory default possible values
appUrls no
buildDescriptorExcludeList no
onlyRunInProductiveBranch no true, false
parallelExecution no
productiveBranch no master
runScript no
script yes
  • appUrls - The URLs under which the app is available after deployment. Each element of appUrls must be a map containing a property url, an optional property credentialId, and an optional property parameters. The optional property parameters can be used to pass additional parameters to the end-to-end test deployment reachable via the given application URL. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter --tag scenario1 should be passed to the test, specify parameters: ["--tag", "scenario1"]. These parameters are appended to the npm command during execution.
  • buildDescriptorExcludeList - List of build descriptors and therefore modules to exclude from execution of the npm scripts. The elements of the list can either be a path to the build descriptor or a pattern.
  • onlyRunInProductiveBranch - Boolean to indicate whether the step should only be executed in the productive branch or not.
  • parallelExecution - Executes the deployments in parallel.
  • productiveBranch - The branch used as productive branch, defaults to master.
  • runScript - Script to be executed from package.json.
  • script - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

Step configuration

We recommend to define values of step parameters via config.yml file.

In following sections of the config.yml the configuration is possible:

parameter general step/stage
appUrls X
buildDescriptorExcludeList X
onlyRunInProductiveBranch X
parallelExecution X X
productiveBranch X X
runScript X
script