Parameters

In the step implementation, parameters are available with this.params.

Example:

module.export = {
  run: function() {
    console.log(
      this.params.param1,
      this.params.param2,
      this.params.param3);
  }
}

Below are the available methods to fill parameters values:

1. Command line paramaters option
   1. Inline parameters
   2. External file of parameters
2. Working Directory .piscosour/piscosour.json file configuration
3. Any Recipe ${RECIPE_HOME}/piscosour.json file configuration
4. Flow config.json file configuration
5. Step config.json file configuration
6. User inquire - interactive way

This is the priority order (from high to low), if a parameter is provided twice or more, with different values, then it will stay the value that is above in the list.

The effective configuration has the merge from all methods and applying this above priority. The effective configuration will be prompted if verbose mode is set using -ov parameter over the recipe command or pisco command:

$ recipe-name -ov
$ pisco -ov

The functional tests for this feature of pisco can be found in the pisco-functional-tests/test/parameters-functional-test.js file.

1. Command line parameters option

Each recipe can be run with a list of inline parameters with the following syntax:

$ pisco-recipe --param1 value1 --param2 value2 --param3 value3 --paramsFile anyfilename.json

a.- Inline parameters option

Each recipe can be run with a list of inline parameters with the following syntax:

$ pisco-recipe --param1 value1 --param2 value2 --param3 value3 ...

For example in a step implementation, this will return "value1, value2, value3":

module.export = {
  run: function() {
    console.log(
      this.params.param1,
      this.params.param2,
      this.params.param3);
    // shows "value1, value2, value3"
  }
}

Important: All parameters needs to have a value

For boolean parameters is mandatory to use --booleanParam true. In order to simplify this is possible to use this shortcut:

• --b-booleanParam -> is equivalent to --booleanParam true

If default parameter is true and you need to specify a false value is mandatory to use --booleanParam false. Since version 1.1.2 of piscosour, inline configuration admit objects. So:

$ pisco --car.model Audi

Will provoque a params object like that:

{
  "car": {
    "model": "Audi"
  }
}

b.- External file configuration

$ pisco --paramsFile anyfilename.json

Where anyfilename.json, can be any name you choose for your own parameter file.

This is very useful because you can provide complex parameters like objects and arrays.

An example of a parameter file is:

{
  "param1": "value1",
  "param2": {
    "p1": "v1",
    "p2": "v2"
  },
  "param3": [1, 2, 3]
 }

Where:

• param1 is a simple String
• param2 is an Object
• param3 is an Array

2. Working Directory .piscosour/piscosour.json file configuration

Another method to provide parameters is to create in the working directory where it is going to execute the recipe a folder .piscosour with a file called piscosour.json:

[CurrentWorkingDirectory]/.piscosour/piscosour.json

Check piscosour.json parameters syntax for more information and examples.

3. Recipe piscosour.json file configuration

You can also provide parameters editing in your recipe the file called piscosour.json:

[recipeRoot]/piscosour.json

Check piscosour.json parameters syntax for more information and examples.

4. Flow config.json file configuration

This file is placed in:

[recipeRoot]/flows/[flowName]/config.json

See flows parameters definition for more information.

5. Step config.json configuration

This file is placed in:

[recipeRoot]/steps/[stepName]/config.json

See flows parameters definition for more information.

6. User inquire - interactive way

Inquire to the user, about the values with the prompts configuration.

Example:

In a step steps/stepName/config.json

{
  "name": "stepName",
  "description": "step Name",
  "contexts": [
    "contextName"
  ],
  "prompts": [
    {
      "type": "input",
      "name": "param1",
      "required" : true,
      "message": "Value of param1",
      "default" : "value1"
    }
  ]
}

Will ask to the user for param1:

[12:16:55] Execution contexts: [ recipe ]
[12:16:55] 

 Starting | prueba | [ recipe::prueba ] 

? Value of param1 (value1)

Please see Inquire for more information.