test-kitchen 1.23.3 → 1.23.4

data/docs/content/docs/getting-started/02-getting-help.md

@@ -1,59 +0,0 @@
----
-title: "Getting Help"
-slug: getting-help
-menu:
-  docs:
-    parent: getting_started
-    weight: 20
----
-
-Use the `kitchen help` for a quick reminder of what the `kitchen` command provides:
-
-~~~
-$ kitchen help
-Commands:
-  kitchen console                                 # Kitchen Console!
-  kitchen converge [INSTANCE|REGEXP|all]          # Change instance state to converge. Use a provisioner to configure one or more instances
-  kitchen create [INSTANCE|REGEXP|all]            # Change instance state to create. Start one or more instances
-  kitchen destroy [INSTANCE|REGEXP|all]           # Change instance state to destroy. Delete all information for one or more instances
-  kitchen diagnose [INSTANCE|REGEXP|all]          # Show computed diagnostic configuration
-  kitchen doctor INSTANCE|REGEXP                  # Check for common system problems
-  kitchen exec INSTANCE|REGEXP -c REMOTE_COMMAND  # Execute command on one or more instance
-  kitchen help [COMMAND]                          # Describe available commands or one specific command
-  kitchen init                                    # Adds some configuration to your cookbook so Kitchen can rock
-  kitchen list [INSTANCE|REGEXP|all]              # Lists one or more instances
-  kitchen login INSTANCE|REGEXP                   # Log in to one instance
-  kitchen package INSTANCE|REGEXP                 # package an instance
-  kitchen setup [INSTANCE|REGEXP|all]             # Change instance state to setup. Prepare to run automated tests. Install busser and related gems on on...
-  kitchen test [INSTANCE|REGEXP|all]              # Test (destroy, create, converge, setup, verify and destroy) one or more instances
-  kitchen verify [INSTANCE|REGEXP|all]            # Change instance state to verify. Run automated tests on one or more instances
-  kitchen version                                 # Print Kitchen's version information
-~~~
-
-For more detailed help on a given subcommand, add it to end of the `help` subcommand. Let's take a look at the useful `kitchen diagnose` subcommand. This particular command is helpful when trying to visualize the layers of kitchen configuration and troubleshoot.
-
-~~~
-$ kitchen help diagnose
-Usage:
-  kitchen diagnose [INSTANCE|REGEXP|all]
-
-Options:
-      [--loader], [--no-loader]                # Include data loader diagnostics
-      [--plugins], [--no-plugins]              # Include plugin diagnostics
-      [--instances], [--no-instances]          # Include instances diagnostics
-                                               # Default: true
-      [--all], [--no-all]                      # Include all diagnostics
-  -l, [--log-level=LOG_LEVEL]                  # Set the log level (debug, info, warn, error, fatal)
-      [--log-overwrite], [--no-log-overwrite]  # Set to false to prevent log overwriting each time Kitchen runs
-      [--color], [--no-color]                  # Toggle color output for STDOUT logger
-  -t, [--test-base-path=TEST_BASE_PATH]        # Set the base path of the tests
-
-Show computed diagnostic configuration
-~~~
-
-Remember, you can also ask for assistance in the [Chef Community Slack](http://community-slack.chef.io/) `#test-kitchen` channel where community members can help answer questions.
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/creating-cookbook">Next - Creating a Cookbook</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/installing">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/03-creating-cookbook.md

@@ -1,46 +0,0 @@
----
-title: "Creating a Cookbook"
-slug: creating-cookbook
-menu:
-  docs:
-    parent: getting_started
-    weight: 30
----
-
-In order to keep our example as simple as possible let's create a Chef cookbook to automate the installation and management of the [Git](http://git-scm.com/) distributed version control tool. It's true that there is already a very capable [Git cookbook](https://supermarket.chef.io/cookbooks/git) available on the [Chef Supermarket](https://supermarket.chef.io/cookbooks) but this simple example will us to show all the features of test-kitchen in a workflow.
-
-First of all, let's generate a cookbook skeleton.
-
-~~~
-$ chef generate cookbook git_cookbook
-Generating cookbook git_cookbook
-- Ensuring correct cookbook file content
-- Committing cookbook files to git
-- Ensuring delivery configuration
-- Ensuring correct delivery build cookbook content
-- Adding delivery configuration to feature branch
-- Adding build cookbook to feature branch
-- Merging delivery content feature branch to master
-
-Your cookbook is ready. Type `cd git_cookbook` to enter it.
-
-There are several commands you can run to get started locally developing and testing your cookbook.
-Type `delivery local --help` to see a full list.
-
-Why not start by writing a test? Tests for the default recipe are stored at:
-
-test/integration/default/default_test.rb
-
-If you'd prefer to dive right in, the default recipe can be found at:
-
-recipes/default.rb
-~~~
-
-> **Congratulations. You've authored a Chef cookbook.**
-
-Make sure you've changed into the new cookbook directory via `cd git_cookbook`. Next we'll talk about what just happened and how kitchen configuration works.
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/kitchen-yml">Next - The kitchen.yml</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/getting-help">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/04-kitchen-yml.md

@@ -1,56 +0,0 @@
----
-title: "kitchen.yml"
-slug: kitchen-yml
-menu:
-  docs:
-    parent: getting_started
-    weight: 40
----
-
-<div class="callout">
-<h3 class="callout--title">Note</h3>
-As of test-kitchen 1.21.0, we now prefer <code>kitchen.yml</code> over <code>.kitchen.yml</code>. This preference applies to <code>kitchen.local.yml</code> as well. This is backward compatible so the dot versions continue to work.
-</div>
-
-Let's turn our attention to the `.kitchen.yml` file for a minute. While ChefDK may have created the initial file automatically, it's expected that you will read and edit this file. After all, you know what you want to test... right?
-
-For the moment let's say we only care about running our Chef cookbook on Ubuntu 16.04 with the latest Chef version. In that case, we can edit the `.kitchen.yml` file so that we pin the version of Chef and trim the list of `platforms` to only one entry like so:
-
-~~~
----
-driver:
-  name: vagrant
-
-provisioner:
-  name: chef_zero
-
-verifier:
-  name: inspec
-
-platforms:
-  - name: ubuntu-16.04
-
-suites:
-  - name: default
-    run_list:
-      - recipe[git_cookbook::default]
-    verifier:
-      inspec_tests:
-        - test/integration/default
-    attributes:
-~~~
-
-To see the results of our work, let's run the `kitchen list` subcommand:
-
-~~~
-$ kitchen list
-Instance             Driver   Provisioner  Verifier  Transport  Last Action    Last Error
-default-ubuntu-1604  Vagrant  ChefZero     Inspec    Ssh        <Not Created>  <None>
-~~~
-
-Let's talk about what an **instance** is and how kitchen interacts with these.
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/instances">Next - Instances</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/creating-cookbook">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/05-instances.md

@@ -1,79 +0,0 @@
----
-title: "Instances"
-slug: instances
-menu:
-  docs:
-    parent: getting_started
-    weight: 50
----
-
-What is this `default-ubuntu-1604` thing and what is an **Instance**?
-
-A Kitchen **Instance** is a combination of a **Suite** and a **Platform** as laid out in your `.kitchen.yml` file. Kitchen has auto-named our only instance by combining the **Suite** name (`"default"`) and the **Platform** name (`"ubuntu-16.04"`) into a form that is safe for DNS and hostname records, namely `"default-ubuntu-1604"`.
-
-Let's spin this **Instance** up to see what happens. We're going to be painfully explicit and ask kitchen to _only_ create the `default-ubuntu-1604` instance:
-
-~~~
-$ kitchen create default-ubuntu-1604
------> Starting Kitchen (v1.23.2)
------> Creating <default-ubuntu-1604>...
-       Bringing machine 'default' up with 'virtualbox' provider...
-       ==> default: Box 'bento/ubuntu-16.04' could not be found. Attempting to find and install...
-           default: Box Provider: virtualbox
-           default: Box Version: >= 0
-       ==> default: Loading metadata for box 'bento/ubuntu-16.04'
-           default: URL: https://vagrantcloud.com/bento/ubuntu-16.04
-       ==> default: Adding box 'bento/ubuntu-16.04' (v201808.24.0) for provider: virtualbox
-           default: Downloading: https://vagrantcloud.com/bento/boxes/ubuntu-16.04/versions/201808.24.0/providers/virtualbox.box
-==> default: Successfully added box 'bento/ubuntu-16.04' (v201808.24.0) for 'virtualbox'!
-       ==> default: Importing base box 'bento/ubuntu-16.04'...
-       ==> default: Matching MAC address for NAT networking...
-       ==> default: Checking if box 'bento/ubuntu-16.04' is up to date...
-       ==> default: Setting the name of the VM: default-ubuntu-1604_default_1537456236914_97965
-       ==> default: Clearing any previously set network interfaces...
-       ==> default: Preparing network interfaces based on configuration...
-           default: Adapter 1: nat
-       ==> default: Forwarding ports...
-           default: 22 (guest) => 2222 (host) (adapter 1)
-       ==> default: Booting VM...
-       ==> default: Waiting for machine to boot. This may take a few minutes...
-           default: SSH address: 127.0.0.1:2222
-           default: SSH username: vagrant
-           default: SSH auth method: private key
-           default:
-           default: Vagrant insecure key detected. Vagrant will automatically replace
-           default: this with a newly generated keypair for better security.
-           default:
-           default: Inserting generated public key within guest...
-           default: Removing insecure key from the guest if it's present...
-           default: Key inserted! Disconnecting and reconnecting using new SSH key...
-       ==> default: Machine booted and ready!
-       ==> default: Checking for guest additions in VM...
-       ==> default: Setting hostname...
-       ==> default: Mounting shared folders...
-           default: /tmp/omnibus/cache => /Users/cheeseplus/.kitchen/cache
-       ==> default: Machine not provisioned because `--no-provision` is specified.
-       [SSH] Established
-       Vagrant instance <default-ubuntu-1604> created.
-       Finished creating <default-ubuntu-1604> (1m16.59s).
------> Kitchen is finished. (1m17.05s)
-~~~
-
-Kitchen calls this the **Create Action** and several subcommands that we'll learn about later map directly to other **actions**. If you are a Vagrant user then the line containing `vagrant up --no-provision` will look familiar. This may take several minutes depending on
-your internet connection as kitchen will automatically fetch the `bento/ubuntu-16.04`
-Vagrant box if it does not already exist.
-
-Let's check the status of our instance now:
-
-~~~
-$ kitchen list
-Instance             Driver   Provisioner  Verifier  Transport  Last Action    Last Error
-default-ubuntu-1604  Vagrant  ChefZero     Inspec    Ssh        Created        <None>
-~~~
-
-Ok, we have an instance created and ready for some Chef code. Onward!
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/writing-recipe">Next - Writing a Recipe</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/kitchen-yml">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/06-writing-recipe.md

@@ -1,21 +0,0 @@
----
-title: "Writing a Recipe"
-slug: writing-recipe
-menu:
-  docs:
-    parent: getting_started
-    weight: 60
----
-
-Here we go, time to automate our Git installation! Open `recipes/default.rb` in your editor of choice and add the following:
-
-~~~
-package "git"
-~~~
-
-Hrm. That was a bit too easy. Let's put our code to the test right away!
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/running-converge">Next - Running Kitchen Converge</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/instances">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/07-running-converge.md

@@ -1,134 +0,0 @@
----
-title: "kitchen converge"
-slug: running-converge
-menu:
-  docs:
-    parent: getting_started
-    weight: 70
----
-
-Now that we have a recipe, let's use `kitchen converge` to see if it works:
-
-~~~
------> Starting Kitchen (v1.23.2)
------> Creating <default-ubuntu-1604>...
-       Bringing machine 'default' up with 'virtualbox' provider...
-       ==> default: Importing base box 'bento/ubuntu-16.04'...
-       ==> default: Matching MAC address for NAT networking...
-       ==> default: Checking if box 'bento/ubuntu-16.04' is up to date...
-       ==> default: Setting the name of the VM: default-ubuntu-1604_default_1537636613635_14010
-       ==> default: Clearing any previously set network interfaces...
-       ==> default: Preparing network interfaces based on configuration...
-           default: Adapter 1: nat
-       ==> default: Forwarding ports...
-           default: 22 (guest) => 2222 (host) (adapter 1)
-       ==> default: Booting VM...
-       ==> default: Waiting for machine to boot. This may take a few minutes...
-           default: SSH address: 127.0.0.1:2222
-           default: SSH username: vagrant
-           default: SSH auth method: private key
-           default:
-           default: Vagrant insecure key detected. Vagrant will automatically replace
-           default: this with a newly generated keypair for better security.
-           default:
-           default: Inserting generated public key within guest...
-           default: Removing insecure key from the guest if it's present...
-           default: Key inserted! Disconnecting and reconnecting using new SSH key...
-       ==> default: Machine booted and ready!
-       ==> default: Checking for guest additions in VM...
-       ==> default: Setting hostname...
-       ==> default: Mounting shared folders...
-           default: /tmp/omnibus/cache => /Users/cheeseplus/.kitchen/cache
-       ==> default: Machine not provisioned because `--no-provision` is specified.
-       [SSH] Established
-       Vagrant instance <default-ubuntu-1604> created.
-       Finished creating <default-ubuntu-1604> (0m37.44s).
------> Converging <default-ubuntu-1604>...
-       Preparing files for transfer
-       Preparing dna.json
-       Resolving cookbook dependencies with Berkshelf 7.0.6...
-       Removing non-cookbook files before transfer
-       Preparing validation.pem
-       Preparing client.rb
------> Installing Chef Omnibus (install only if missing)
-       Downloading https://omnitruck.chef.io/install.sh to file /tmp/install.sh
-       Trying wget...
-       Download complete.
-       ubuntu 16.04 x86_64
-       Getting information for chef stable  for ubuntu...
-       downloading https://omnitruck.chef.io/stable/chef/metadata?v=&p=ubuntu&pv=16.04&m=x86_64
-         to file /tmp/install.sh.1548/metadata.txt
-       trying wget...
-       sha1     174eb82ebe2eddc9c370487de6c124907f6d2f3a
-       sha256   70ce695d2bf9fb01279a726148c0600544f1cd431642fa98d6696ef4c1dfc3c9
-       url      https://packages.chef.io/files/stable/chef/14.5.27/ubuntu/16.04/chef_14.5.27-1_amd64.deb
-       version  14.5.27
-       downloaded metadata file looks valid...
-       downloading https://packages.chef.io/files/stable/chef/14.5.27/ubuntu/16.04/chef_14.5.27-1_amd64.deb
-         to file /tmp/omnibus/cache/chef_14.5.27-1_amd64.deb
-       trying wget...
-       Comparing checksum with sha256sum...
-
-       WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
-
-       You are installing an omnibus package without a version pin.  If you are installing
-       on production servers via an automated process this is DANGEROUS and you will
-       be upgraded without warning on new releases, even to new major releases.
-       Letting the version float is only appropriate in desktop, test, development or
-       CI/CD environments.
-
-       WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
-
-       Installing chef
-       installing with dpkg...
-       Selecting previously unselected package chef.
-(Reading database ... 38378 files and directories currently installed.)
-       Preparing to unpack .../cache/chef_14.5.27-1_amd64.deb ...
-       Unpacking chef (14.5.27-1) ...
-       Setting up chef (14.5.27-1) ...
-       Thank you for installing Chef!
-       Transferring files to <default-ubuntu-1604>
-       Starting Chef Client, version 14.5.27
-       Creating a new client identity for default-ubuntu-1604 using the validator key.
-       resolving cookbooks for run list: ["git_cookbook::default"]
-       Synchronizing Cookbooks:
-         - git_cookbook (0.1.0)
-       Installing Cookbook Gems:
-       Compiling Cookbooks...
-       Converging 1 resources
-       Recipe: git_cookbook::default
-         * apt_package[git] action install (up to date)
-
-       Running handlers:
-       Running handlers complete
-       Chef Client finished, 0/1 resources updated in 01 seconds
-       Downloading files from <default-ubuntu-1604>
-       Finished converging <default-ubuntu-1604> (0m22.49s).
------> Kitchen is finished. (1m2.47s)
-~~~
-
-If you are a Chef user then part of the output above should look familiar to you. Here's what happened at a high level:
-
-* Chef was installed on the instance
-* The `git_cookbook` files and a minimal Chef configuration were built and uploaded to the instance
-* A Chef run was initiated using the run-list and node attributes specified in the `.kitchen.yml` file
-
-Looking closely at the run, there are two important things we want to note: git was already installed as part of the base image so Chef reports `(up to date)` as it didn't have to do anything.
-
-<div class="callout">
-<h3 class="callout--title">Pro Tip</h3>
-This highlights a property of configuration management systems, like Chef, called <b>idempotence</b> - in this context, Chef saw that we requested to install git but as it was already installed there was nothing to do. This concept is very useful when thinking about configuration management generally as unlike a bash script, Chef isn't a series of commands but a set of declarations about the desired state.
-</div>
-
-A **converge** will leave the machine running and kitchen automatically uploads changes each converge so that one can iterate rapidly on configuration code. A lot of time and effort has gone into ensuring that the exit code of kitchen is always appropriate. Here is the Kitchen Command Guarantee:
-
-* I will always exit with code **0** if my operation was successful.
-* I will always exit with a non-zero code if **any** part of my operation was not successful.
-* Any behavior to the contrary **is a bug**.
-
-This exit code behavior is a fundamental prerequisite for any tool working in a Continuous Integration (CI) environment.
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/manually-verifying">Next - Manually Verifying</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/writing-recipe">Back to previous step</a>
-</div>

data/docs/content/docs/getting-started/08-manually-verifying.md

@@ -1,55 +0,0 @@
----
-title: "Manually Verifying"
-slug: manually-verifying
-menu:
-  docs:
-    parent: getting_started
-    weight: 80
----
-
-If you're a skeptical person then you might be asking:
-
-> "How can we be sure that Git was actually installed?"
-
-Let's verify this right now.
-
-Kitchen has a **login** subcommand for just these kinds of situations:
-
-~~~
-Welcome to Ubuntu 16.04.5 LTS (GNU/Linux 4.4.0-116-generic x86_64)
-
- * Documentation:  https://help.ubuntu.com
- * Management:     https://landscape.canonical.com
- * Support:        https://ubuntu.com/advantage
-
-0 packages can be updated.
-0 updates are security updates.
-
-
-Last login: Sat Sep 22 17:17:36 2018 from 10.0.2.2
-vagrant@default-ubuntu-1604:~$
-~~~
-
-As you can see by the prompt above we are now in the `default-ubuntu-1604` instance. We'll denote the prompt in an instance with `$ ` for clarity. Now to check if Git is installed:
-
-~~~
-$ which git
-/usr/bin/git
-$ git --version
-git version 2.7.4
-~~~
-
-Rockin. Now we can exit out back to our workstation:
-
-~~~
-$ exit
-logout
-Connection to 127.0.0.1 closed.
-~~~
-
-Feel free to use the **login** subcommand any time you have the urge to poke around, uninstall packages, turn off services, grep logs, etc. Go to town, this is a sandbox and isn't production after all.
-
-<div class="sidebar--footer">
-<a class="button primary-cta" href="/docs/getting-started/writing-test">Next - Writing a Test</a>
-<a class="sidebar--footer--back" href="/docs/getting-started/running-converge">Back to previous step</a>
-</div>