DEVELOPING.md

Development

To work on the Liberty cookbook first ensure you have Bundler installed.

$ gem install bundler

Next, use Bundler to install Liberty cookbook dependencies:

$ bundle install

Finally, use Rake to execute various tasks. For example:

$ rake all

Testing

To check syntax of the cookbook files execute:

$ rake syntax

To run Foodcritic (lint-like tool) on the cookbook execute:

$ rake foodcritic

To run ChefSpec tests execute:

$ rake rspec

The tests and cookbooks used by ChefSpec are located in the spec/ directory.

To run test-kitchen tests execute:

$ rake kitchen

In order to run the test-kitchen tests you must first configure them. Please see How to run 'test kitchen' tests for more information. The tests and cookbooks used by test-kitchen are located in the test/ directory.

Documentation

We use knife-cookbook-doc tool to generate the README.md file which contains the cookbook documentation. See the knife-cookbook-doc tool documentation on details how to document the cookbook's attributes, recipes, and resources. To regenerate the README.md file run the following command:

$ rake doc

Don't forget to check-in and commit the modified README.md file.