Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 3.03 KB

TESTING.md

File metadata and controls

79 lines (47 loc) · 3.03 KB
Raw

Cookbook TESTING doc

This document describes the process for testing Chef community cookbooks using ChefDK.

Testing Prerequisites

A working ChefDK installation preferably set as your system's default ruby. ChefDK can be downloaded at https://downloads.chef.io/chef-dk/

Hashicorp's Vagrant and Oracle's Virtualbox for integration testing.

Installing dependencies

Cookbooks may require additional testing dependencies that do not ship with ChefDK directly. These can be installed into the ChefDK ruby environment with the following commands

Install dependencies:

chef exec bundle install

Update any installed dependencies to the latest versions:

chef exec bundle update

Local Delivery

For consistent testing across the cookbook we use the Delivery CLI tool and the local delivery mode. This allows us to remotely host a single Delivery project.toml file that applies to all community cookbooks.

Delivery defines testing in phases and cookbooks utilize lint, syntax, and unit phases.

To run an individual phase:

delivery local unit

To run all phases:

delivery local all

lint stage

The lint stage runs Ruby specific code linting using cookstyle (https://github.com/chef/cookstyle). Cookstyle offers a tailored RuboCop configuration enabling / disabling rules to better meet the needs of cookbook authors. Cookstyle ensures that projects with multiple authors have consistent code styling.

syntax stage

The syntax stage runs Chef cookbook specific linting and syntax checks with Foodcritic (http://www.foodcritic.io/). Foodcritic tests for over 60 different cookbook conditions and helps authors avoid bad patterns in their cookbooks.

unit stage

The unit stage runs unit testing with ChefSpec (http://sethvargo.github.io/chefspec/). ChefSpec is an extension of Rspec, specially formulated for testing Chef cookbooks. Chefspec compiles your cookbook code and converges the run in memory, without actually executing the changes. The user can write various assertions based on what they expect to have happened during the Chef run. Chefspec is very fast, and quick useful for testing complex logic as you can easily converge a cookbook many times in different ways.

Integration Testing

Integration testing is performed by Test Kitchen. After a successful converge, tests are uploaded and ran out of band of Chef. Tests should be designed to ensure that a recipe has accomplished its goal.

Integration Testing using Vagrant

Integration tests can be performed on a local workstation using either VirtualBox or VMWare as the virtualization hypervisor. To run tests against all available instances run:

chef exec kitchen test

To see a list of available test instances run:

chef exec kitchen list

To test specific instance run:

chef exec kitchen test INSTANCE_NAME