DEVELOPMENT:

Before working on the code, if you plan to contribute your changes, you need to read the Opscode Contributing document.

• wiki.opscode.com/display/opscode/Contributing

You will also need to set up the repository with the appropriate branches. We document the process on the Chef Wiki.

• wiki.opscode.com/display/opscode/Working+with+Git

Once your repository is set up, you can start working on the code. We do use BDD/TDD with RSpec and Cucumber, so you’ll need to get a development environment running.

ENVIRONMENT:

In order to have a development environment where changes to the Chef code can be tested, we’ll need to install a few things after setting up the Git repository.

Requirements:

Install these via your platform’s preferred method; for example apt, yum, ports, emerge, etc.

• Git
• CouchDB
• libxml2 development package (for webrat)
• libxslt develoment package (for webrat)

Install the following RubyGems.

• ohai
• rake
• rspec
• cucumber
• webrat
• merb-core
• roman-merb_cucumber

Ohai is also by Opscode and available on GitHub, github.com/opscode/ohai/tree/master.

roman-merb_cucumber is available from GitHub:

  gem install --source http://gems.github.com/ roman-merb_cucumber

Starting the Environment:

Once everything is installed, run the dev:features rake task. Since the features do integration testing, root access is required.

  sudo rake dev:features

The dev:features task:

• Installs chef, chef-server, chef-server-slice gems. It will fail if required gems above are missing.
• Starts chef-server on ports 4000 and 4001.
• Starts chef-indexer.
• Starts CouchDB on port 5984.
• Starts the stompserver on port 61613.

You’ll know its running when you see:

   ~ Activating slice 'ChefServerSlice' ...
  merb : worker (port 4000) ~ Starting Mongrel at port 4000
  merb : worker (port 4000) ~ Successfully bound to port 4000
  merb : worker (port 4001) ~ Starting Mongrel at port 4001
  merb : worker (port 4001) ~ Successfully bound to port 4001

You’ll want to leave this terminal running the dev environment.

Web Interface:

With the dev environment running, you can now access the web interface via localhost:4000/. Supply an OpenID to log in.

Spec testing:

We use RSpec for unit/spec tests.

  rake spec

This doesn’t actually use the development environment, because it does the testing on all the Chef internals. For integration/usage testing, we use Cucumber features.

Integration testing:

We test integration with Cucumber. The available feature tests are rake tasks:

  rake features                            # Run Features with Cucumber
  rake features:api                        # Run Features with Cucumber
  rake features:api:nodes                  # Run Features with Cucumber
  rake features:api:nodes:create           # Run Features with Cucumber
  rake features:api:nodes:delete           # Run Features with Cucumber
  rake features:api:nodes:list             # Run Features with Cucumber
  rake features:api:nodes:show             # Run Features with Cucumber
  rake features:api:nodes:update           # Run Features with Cucumber
  rake features:api:roles                  # Run Features with Cucumber
  rake features:api:roles:create           # Run Features with Cucumber
  rake features:api:roles:delete           # Run Features with Cucumber
  rake features:api:roles:list             # Run Features with Cucumber
  rake features:api:roles:show             # Run Features with Cucumber
  rake features:api:roles:update           # Run Features with Cucumber
  rake features:client                     # Run Features with Cucumber
  rake features:language                   # Run Features with Cucumber
  rake features:language:recipe_include    # Run Features with Cucumber
  rake features:provider:package:macports  # Run Features with Cucumber
  rake features:provider:remote_file       # Run Features with Cucumber
  rake features:search                     # Run Features with Cucumber