runas-recipe-unit-testing

runas Recipe runas-recipe-unit-testing

Unit testing with coverage for recipes and npm-libraries. Using mocha (default) and nyc for the matter.

1. Description
2. Configuration
3. More information

Description

Step for recipe and npm-library contexts. It will run the tests configured in the repo and will calculate the coverage of such test suites. It will check the thresholds for this repo in particular.

We will be able to configure our recipe parameters as usual, in our piscosour.json file. But we also can configure it in the package.json or in a .nycrc file. All the documentation in this link

Configuration

Example:

{
  "test-runner-nyc": {
    "ignoreErrors": true,
    "config": {
      "_": [
        "npm",
        "test"
      ],
      "all": true,
      "reportDir": "test-reports",
      "reporter": [
        "text-summary",
        "lcov",
        "html"
      ],
      "exclude": [
        "node_modules",
        "*-test.js",
        "test-reports/**",
        "test/**"
      ],
      "checkCoverage": true,
      "statements": 70,
      "branches": 70,
      "functions": 70,
      "lines": 70
    }
  }
}

Where:

Param	Type	Default	Description
_	Array	["npm", "test"]	Execution for the unit tests in the recipe
all	Boolean	true	Include all the files in the coverage report
reportDir	String	"test-reports"	Directory where the reports are stored
reporter	Array	["text-summary", "lcov", "html"]	Reports generated
exclude	Array	["node_modules", "*-test.js", "test-reports/", "test/"]	Files excluded
checkCoverage	Boolean	true	Check for the coverage thresholds
statements	Integer	70	Threshold for staments percent coverage
branches	Integer	70	Threshold for branches percent coverage
functions	Integer	70	Threshold for functions percent coverage
lines	Integer	70	Threshold for lines percent coverage

More information:

• Contexts: "recipe", "npm-library"
• Plugins: "test-runner-istanbul"