Skip to content
This repository has been archived by the owner on Feb 25, 2024. It is now read-only.

Latest commit

 

History

History
99 lines (61 loc) · 3.69 KB

TESTING.md

File metadata and controls

99 lines (61 loc) · 3.69 KB

Cookbook TESTING doc

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

Testing Prerequisites

A working ChefDK installation 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

NOTE: This is not yet in place, any help getting this in place is appreciated.

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

Note that many of the test targets accept custom attributes to be set via environment variables. Some of these environment variables have defaults set while others do not. Those without a default value are required to be set prior to executing the tests. See the .kitchen.yml file for all the available environment variables.

Private Images

Some operating systems have specific licenses that prevent us from making those images available freely and thus testing is not available.

Images include:

  • Windows Server 2008 R2
  • Windows Server 2012 R2
  • Windows Server 2016
  • Windows 7 Professional
  • Windows 8.1 Professional
  • Windows 10 Enterprise
  • Mac OS X 10.7-10.12
  • SLES 12 / 12SP1
  • Solaris 10.11

In order to test these operating systems you will need to obtain the appropriate licenses and images as needed. It may also be necessary to purchase and install VMWare for your platform.