summaryrefslogtreecommitdiff
path: root/kitchen-tests/README.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-04-22 10:34:43 -0700
committerTim Smith <tsmith@chef.io>2019-04-22 10:34:43 -0700
commit1b7cf9dda96f876cac199a499597d27919a6aded (patch)
tree349c67c7da6e6c20f2abad2a09660c928a9cfd3e /kitchen-tests/README.md
parent96e71f2d2fc0b84cd06a77a89f88dc236add430a (diff)
downloadchef-1b7cf9dda96f876cac199a499597d27919a6aded.tar.gz
Merge the local and travis kitchen tests into a single config
Make sure people are doing their local testing the same way it will run in Travis. The local testing didn't actually work before so this is a pretty solid win. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'kitchen-tests/README.md')
-rw-r--r--kitchen-tests/README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/kitchen-tests/README.md b/kitchen-tests/README.md
index 95234ca383..9bf20a8fab 100644
--- a/kitchen-tests/README.md
+++ b/kitchen-tests/README.md
@@ -4,7 +4,7 @@ Here we seek to provide end-to-end testing of Chef Client through cookbooks whic
## Getting started
-All the gems needed to run these tests can be installed with Bundler.
+These tests run in Docker containers so make sure to install Docker on your workstation. Once docker is installed all the gems needed to run these tests can be installed with Bundler.
```shell
chef/kitchen-tests$ bundle install
@@ -19,21 +19,21 @@ chef/kitchen-tests$ bundle exec kitchen list
You should see output similar to
```shell
-Instance Driver Provisioner Verifier Transport Last Action Last Error
-end-to-end-amazonlinux Vagrant ChefGithub Inspec Ssh <Not Created> <None>
+Instance Driver Provisioner Verifier Transport Last Action Last Error
+end-to-end-amazonlinux Dokken Dokken Inspec Dokken <Not Created> <None>
```
## Testing
-We use Test Kitchen to build instances, test client code, and destroy instances. If you are unfamiliar with Test Kitchen we recommend checking out the [tutorial](http://kitchen.ci/) along with the `kitchen-vagrant` [driver documentation](https://github.com/test-kitchen/kitchen-vagrant). Test Kitchen is configured to manipulate instances using [Vagrant](https://www.vagrantup.com/) when testing locally, and Docker via [kitchen-dokken](https://github.com/someara/kitchen-dokken/) when testing pull requests on [Travis CI](https://travis-ci.com/).
+We use Test Kitchen to build instances, test client code, and destroy instances. If you are unfamiliar with Test Kitchen we recommend checking out the [tutorial](http://kitchen.ci/) along with the `kitchen-dokken` [driver documentation](https://github.com/someara/kitchen-dokken). Test Kitchen is configured to manipulate instances using [Docker](https://www.docker.com/) when testing locally and when testing pull requests on [Travis CI](https://travis-ci.com/).
### Commands
Kitchen instances are led through a series of states. The instance states, and the actions taken to transition into each state, are in order:
-- `destroy`: Delete all information for and terminate one or more instances.
+- `destroy`: Delete all information for and terminate one or more instances.
- This is equivalent to running `vagrant destroy` to stop and delete a Vagrant machine.
-- `create`: Start one or more instances.
+- `create`: Start one or more instances.
- This is equivalent to running `vagrant up --no-provision` to start a Vagrant instance.
- `converge`: Use a provisioner to configure one or more instances.
- By default, Test Kitchen is configured to use the `ChefSolo` provisioner which:
@@ -53,7 +53,7 @@ To see a list of available commands, type `bundle exec kitchen help`. To see mor
### Configuring your tests
-Test Kitchen is configured for local testing in the `kitchen.yml` file which resides in this directory. You will need to configure the provisioner before running the tests.
+Test Kitchen is configured in the `kitchen.yml` file which resides in this directory. You will need to configure the provisioner before running the tests.
The provisioner can be configured to pull client source code from a GitHub repository using any valid Git reference. You are encouraged to modify any of these settings, but please return them to their original values before submitting a pull request for review (unless, of course, your changes are enhancements to the default provisioner settings).
@@ -66,8 +66,8 @@ The branch you choose must be accessible on GitHub. You cannot use a local commi
### Testing pull requests
-These end-to-end tests are also configured to run on Travis-CI with docker containers when you submit a pull request to `chef/chef`. Kitchen is configured to pull chef client source code from the branch it is testing. There is no need to modify `kitchen.travis.yml` unless you are contributing tests.
+These end-to-end tests are also configured to run on Travis-CI with docker containers when you submit a pull request to `chef/chef`. Kitchen is configured to pull chef client source code from the branch it is testing. There is no need to modify `kitchen.yml` unless you are contributing tests.
## Contributing
-We would love to fill out our end-to-end testing coverage! If you have cookbooks and tests that you would like to see become a part of client testing, we encourage you to submit a pull request with your additions. We request that you do not add platforms to `kitchen.travis.yml`. Please file a request to add a platform under [Issues](https://github.com/chef/chef/issues).
+We would love to fill out our end-to-end testing coverage! If you have cookbooks and tests that you would like to see become a part of client testing, we encourage you to submit a pull request with your additions. We request that you do not add platforms to `kitchen.yml`. Please file a request to add a platform under [Issues](https://github.com/chef/chef/issues).