2.1 KiB

Raw Blame History

Testing the Cookbook

This cookbook uses bundler and berkshelf to isolate dependencies. Make sure you have ruby 1.9.x, bundler, rake, build essentials and the header files for gecode installed before continuing. Make sure that you're using gecode version 3. More info here.

We have four test suites which you can run either, individually (there are three rake tasks):

$ rake lint
$ rake style
$ rake knife
$ rake unit

or altogether:

$ rake test

The rake tasks will take care of installing the needed gem dependencies and cookbooks with berkshelf.

Rubocop

Rubocop is a static Ruby code analyzer, based on the community Ruby style guide. We are attempting to adhere to this where applicable, slowly cleaning up the cookbooks until we can turn on Rubocop for gating the commits.

Attribute Rules

Since there are slight style differences between the coding of attributes, recipes and metadata files there are specific .rubocop.yml files for each of:

Gemfile and metadata.rb attributes/*.rb recipes/.rubocop.yml spec/.rubocop.yml

Knife

knife cookbook test is used to check the cookbook's Ruby and ERB files for basic syntax errors.

Foodcritic

Foodcritic is a lint tool for Chef cookbooks. We ignore the following rules:

FC003 these cookbooks are not intended for Chef Solo.

Chefspec

ChefSpec is a unit testing framework for testing Chef cookbooks. ChefSpec makes it easy to write examples and get fast feedback on cookbook changes without the need for virtual machines or cloud servers.

2.1 KiB Raw Blame History