Skip to content

Latest commit

 

History

History
107 lines (79 loc) · 3.55 KB

README.md

File metadata and controls

107 lines (79 loc) · 3.55 KB
Raw

chef-acceptance helps develop and run acceptance tests from your laptop and from Chef Delivery.

Why chef-acceptance?

chef-acceptance makes it easy to develop acceptance tests for a project. You can run any type of suites for your project (test-kitchen, pedant, chef provisioning, rspec, etc...) but it enforces a structure so that you can run all of your different acceptance tests in the same way. It also gives you a CLI interface so that you can build your tests without breaking your pipeline until they are ready.

There are a few reasons we wrote a new tool to do this.

  1. chef-acceptance is meant to test complete packages rather than the source code.
  2. It gives a tool that can be run locally the same way as it will be ran in CI. This allows developers to test their acceptance test without bogging down the CI pipeline.
  3. It allows developers to choose what testing framework they want to use for acceptance testing. chef-acceptance can be used to run Test Kitchen tests or run Chef Provisioning and Inspec.

Initialize a project for acceptance

Create an acceptance directory to your project

mkdir acceptance

cd acceptance

Generate a test suite

chef-acceptance generate my-test-suite

Output

acceptance
└── my-test-suite
    └── .acceptance
         └── acceptance-cookbook
            ├── .gitignore
            ├── metadata.rb
            └── recipes
                ├── destroy.rb
                ├── provision.rb
                └── verify.rb

Now you can run your acceptance test phases

# chef-acceptance <command> <suite-name> [options]
chef-acceptance provision my-test-suite
chef-acceptance verify my-test-suite
chef-acceptance destroy my-test-suite

# Run the commands in sequence
chef-acceptance test my-test-suite

Commands

For available options of commands run: chef-acceptance help <command-name>

chef-acceptance provision <suite-regex> Runs the provision recipe for the matching acceptance suites.

chef-acceptance verify <suite-regex> Runs the tests for the matching acceptance suites.

chef-acceptance destroy <suite-regex> Destroy your acceptance setup.

chef-acceptance test <suite-regex> Runs the provision, verify, and destroy recipes for the matching acceptance suites.

Running provision, verify, destroy or test without specifying a suite name will run all suites.

chef-acceptance generate <suite-name> Generates acceptance test suite scaffold that you can modify.

Not implemented

Once your acceptance tests are strong you can add this to your build cookbook to run your tests in Chef Delivery:

chef_acceptance 'spincycle' do
  acceptance_directory File.join(node['delivery']['project_workspace'], 'acceptance')
  action :provision
end

chef_acceptance 'spincycle' do
  action :verify
end

Change Log

See CHANGELOG.md.

Releasing chef-acceptance

This project uses the gem-release plugin to manage the release process. Once ready to release chef-acceptance from master perform the following steps.

  1. Verify the "Unreleased" section of the change log is up to date. The changes will determine the next SemVer release version.
  2. Update the change log to reflect the version and date
  3. Add the version tag compare link to the footer of the change log even though the tag has not yet been pushed. Follow the pattern.
  4. Review and commit changes with comment "vX.Y.Z change log". Push change.
  5. Bump version and tag version
gem bump --version X.Y.Z --tag