Skip to content
Test Kitchen is an integration tool for developing and testing infrastructure code and software on isolated target platforms.
Branch: master
Clone or download
Latest commit f165d43 May 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add lockbot config Aug 6, 2018
bin Fix ChefStyle offenses Dec 9, 2016
docs Add example lifecycle hook for cloud-init Mar 28, 2019
features Update the tests to look for 18.04 Feb 26, 2019
lib Merge pull request #1562 from test-kitchen/lcg/berkshelf-path May 30, 2019
spec Add berkshelf_path config option May 18, 2019
support Remove support for Chef 10 / 11 from chef-zero / chef-solo Feb 25, 2019
templates Merge pull request #1524 from test-kitchen/plugin_init Feb 26, 2019
test use a less volitile test cookbook for integration ci Jul 5, 2016
.gitattributes Adding gitattributes file for managing line ending conversions Apr 2, 2016
.gitignore First pass at Hugoification Sep 19, 2018
.gitmodules First pass at Hugoification Sep 19, 2018
.rubocop.yml appease Rubocop: update namespace for FileName Mar 6, 2018
.travis.yml f: travis config May 15, 2019
.yardopts Add yard documentation. Dec 2, 2012
Berksfile Fix ChefStyle offenses Dec 9, 2016
CHANGELOG.md Release 2.2.5 May 15, 2019
CONTRIBUTING.md Update release process to use github changelog generator Feb 26, 2016
ECOSYSTEM.md EOL space Oct 13, 2017
Gemfile f May 14, 2019
Gemfile.proxy_tests run integration tests on travis and appveyor and move off EC2 Mar 30, 2016
Guardfile Fix ChefStyle offenses Dec 9, 2016
LICENSE Jamie: A Chef Convergence Integration Test Harness. Dec 1, 2012
MAINTAINERS.md LT Tyler Ball Nov 16, 2018
README.md Update the travis badge URL Apr 30, 2019
RELEASE_NOTES.md Release Test Kitchen 2.2.0 Apr 26, 2019
Rakefile Adding rake task for doc deployment Nov 2, 2018
appveyor.yml Test on Ruby 2.5 in Appveyor Feb 26, 2019
kitchen.appveyor.yml Accept the license in the appveyor kitchen config May 17, 2019
kitchen.dokken.yml Rename the kitchen files to not be hidden Feb 25, 2019
kitchen.proxy.yml f: travis config May 15, 2019
test-kitchen.gemspec f: travis config May 15, 2019
testing_windows.md provide the option to run all winrm commands through a scheduled task Apr 21, 2016

README.md

Test Kitchen

Gem Version Build Status

Website http://kitchen.ci
Source Code http://kitchen.ci/docs/getting-started/
Slack #test-kitchen channel on Chef Community Slack, transcript
Twitter @kitchenci

Test Kitchen is an integration tool for developing and testing infrastructure code and software on isolated target platforms.

Getting Started Guide

To learn how to install and setup Test Kitchen for developing infrastructure code, check out the Getting Started Guide.

If you want to get going super fast, then try the Quick Start next...

Quick Start

Test Kitchen is a RubyGem and can be installed with:

$ gem install test-kitchen

If you use Bundler, you can add gem "test-kitchen" to your Gemfile and make sure to run bundle install.

Next add support to your library, Chef cookbook, or empty project with kitchen init:

$ kitchen init

A .kitchen.yml will be created in your project base directory. This file describes your testing configuration; what you want to test and on which target platforms. Each of these suite and platform combinations are called instances. By default your instances will be converged with Chef Solo and run in Vagrant virtual machines.

Get a listing of your instances with:

$ kitchen list

Run Chef on an instance, in this case default-ubuntu-1204, with:

$ kitchen converge default-ubuntu-1204

Destroy all instances with:

$ kitchen destroy

You can clone a Chef cookbook project that contains Test Kitchen support and run through all the instances in serial by running:

$ kitchen test

Usage

There is help included with the kitchen help subcommand which will list all subcommands and their usage:

$ kitchen help test

More verbose logging for test-kitchen can be specified when running test-kitchen from the command line using:

$ kitchen test -l debug

For the provisioner (e.g. chef-solo or chef-zero) add a log_level item to the provisioner section of the .kitchen.yml For more information on setting log_level see the configuration documentation.

Documentation

Documentation is being added on the Test Kitchen website. Please read and contribute to improve them!

Versioning

Test Kitchen aims to adhere to Semantic Versioning 2.0.0.

Community and Ecosystem

If you would like to see a few of the plugins or ecosystem helpers, please look at ECOSYSTEM.md.

Development

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors

Created and maintained by Fletcher Nichol (fnichol@nichol.ca) and a growing community of contributors.

License

Apache License, Version 2.0 (see LICENSE)

You can’t perform that action at this time.