test-kitchen 1.23.2 → 1.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9219cf297ee744f00b2e77febd43103a4cfbbb4b8e12c31e4be80cf66cf30127
-  data.tar.gz: d2bad7b27981a7dad6b2a3437a828c91626c196233bd5d81060e6cc91cfc8a9c
+  metadata.gz: f1bfec4fe44eff1b8640b167fba7a0323858851c665ece2531ad771006c7ac5c
+  data.tar.gz: b1973b75fc30bc473b7ed6bd1fa5c1cea1fc6fb08ce075e823aae824c2268904
 SHA512:
-  metadata.gz: e09373f94e6b8cde1525c248a87c722b629a28d4afa005ca0f512699968898ca119778f8cddc35b8ae03d85802567019e9edd69c8566470df693f6bf0c7ae4fb
-  data.tar.gz: 354ab8c97efd79db86a6c2e49533057281c76bbb85a683ef69c2cf640ac8c294db04ee5dd4e0501f7978026b2460cd585f83b7aafc374f6202606fc5d85c6bfa
+  metadata.gz: 21b54008f37b7c73709f4f2d8594a0d47407b9f37240c481a8653aebffbf69cc451cd7bf02c04c564e48601521d60a1afb370965939e77ccd0271fccdf1fe0bf
+  data.tar.gz: b77cdca63287e4e87f1ea28151b66583c6ba73e24ad89be37a4dd405e544fb0e3b23abad3a67cf390647753ecdd8f57cb249007321c3d8e62bba0171ab10435b

data/.gitignore

@@ -29,3 +29,10 @@ kitchen.yml
 kitchen.local.yml
 Berksfile.lock
 *.swp
+*~
+.sass-cache
+_site/
+_cache
+.tddium*
+docs/public
+

data/.travis.yml

@@ -27,10 +27,6 @@ branches:
 
 matrix:
   include:
-    - rvm: 2.5.1
-      before_install:
-      # https://github.com/travis-ci/travis-ci/issues/8978
-      - gem update --system
     - rvm: 2.4.4
       # To run the proxy tests we need additional gems than what Test Kitchen normally uses
       # for testing

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Change Log
 
+## [v1.23.3](https://github.com/test-kitchen/test-kitchen/tree/v1.23.3) (2018-11-30)
+[Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.23.2...v1.23.3)
+
+**Fixed bugs:**
+
+- Chef 13 Cookbook Root Aliases Not Found [\#1230](https://github.com/test-kitchen/test-kitchen/issues/1230)
+
+**Closed issues:**
+
+- WinRM transport leaves open connections [\#1495](https://github.com/test-kitchen/test-kitchen/issues/1495)
+- Add Rake Tasks for doc gen and deployment [\#1467](https://github.com/test-kitchen/test-kitchen/issues/1467)
+- Docs - migrate to Hugo [\#1458](https://github.com/test-kitchen/test-kitchen/issues/1458)
+- Docs for fixture cookbooks [\#1457](https://github.com/test-kitchen/test-kitchen/issues/1457)
+- Docs for Setting Environment for Chef provisioner [\#1455](https://github.com/test-kitchen/test-kitchen/issues/1455)
+- Docs for Reboot [\#1454](https://github.com/test-kitchen/test-kitchen/issues/1454)
+- Docs for Silencing Chef Deprecation Warnings [\#1452](https://github.com/test-kitchen/test-kitchen/issues/1452)
+- Docs for Shell Provisioner [\#1451](https://github.com/test-kitchen/test-kitchen/issues/1451)
+- Add documentation for elevated transport [\#1054](https://github.com/test-kitchen/test-kitchen/issues/1054)
+
+**Merged pull requests:**
+
+- Fixing failing travis test from PR merge [\#1499](https://github.com/test-kitchen/test-kitchen/pull/1499) ([tyler-ball](https://github.com/tyler-ball))
+- LT Tyler Ball [\#1497](https://github.com/test-kitchen/test-kitchen/pull/1497) ([robbkidd](https://github.com/robbkidd))
+- Close underlying winrm connections gracefully [\#1496](https://github.com/test-kitchen/test-kitchen/pull/1496) ([dwoz](https://github.com/dwoz))
+- Fixing code block formatting [\#1494](https://github.com/test-kitchen/test-kitchen/pull/1494) ([cheeseplus](https://github.com/cheeseplus))
+- Add more WinRM timeout config options [\#1493](https://github.com/test-kitchen/test-kitchen/pull/1493) ([dwoz](https://github.com/dwoz))
+- Adding rake task for doc deployment [\#1492](https://github.com/test-kitchen/test-kitchen/pull/1492) ([cheeseplus](https://github.com/cheeseplus))
+- Rename page and minor formatting fixes [\#1491](https://github.com/test-kitchen/test-kitchen/pull/1491) ([cheeseplus](https://github.com/cheeseplus))
+- Fixing the doc for chef provisioners [\#1490](https://github.com/test-kitchen/test-kitchen/pull/1490) ([cheeseplus](https://github.com/cheeseplus))
+- Add docs for fixtures and lifecycle hooks [\#1489](https://github.com/test-kitchen/test-kitchen/pull/1489) ([cheeseplus](https://github.com/cheeseplus))
+- Fix \#1454 - add reboot doc [\#1488](https://github.com/test-kitchen/test-kitchen/pull/1488) ([cheeseplus](https://github.com/cheeseplus))
+- Updating for chefstyle 0.11 [\#1487](https://github.com/test-kitchen/test-kitchen/pull/1487) ([cheeseplus](https://github.com/cheeseplus))
+- Add Docs for Shell Provisioner [\#1486](https://github.com/test-kitchen/test-kitchen/pull/1486) ([pwelch](https://github.com/pwelch))
+- Add retry support for WinRM [\#1480](https://github.com/test-kitchen/test-kitchen/pull/1480) ([bdwyertech](https://github.com/bdwyertech))
+- DOCS - improve documentation language [\#1479](https://github.com/test-kitchen/test-kitchen/pull/1479) ([JohnVonNeumann](https://github.com/JohnVonNeumann))
+- Acknowledge the existence of kitchen-azurerm and add an example configuration [\#1466](https://github.com/test-kitchen/test-kitchen/pull/1466) ([stuartpreston](https://github.com/stuartpreston))
+- Middleman -\> Hugo conversion [\#1459](https://github.com/test-kitchen/test-kitchen/pull/1459) ([cheeseplus](https://github.com/cheeseplus))
+- Docs merge [\#1450](https://github.com/test-kitchen/test-kitchen/pull/1450) ([cheeseplus](https://github.com/cheeseplus))
+- Support cookbook root aliases and VERSION file [\#1446](https://github.com/test-kitchen/test-kitchen/pull/1446) ([cheeseplus](https://github.com/cheeseplus))
+
 ## [v1.23.2](https://github.com/test-kitchen/test-kitchen/tree/v1.23.2) (2018-08-06)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.23.0...v1.23.2)
 

data/MAINTAINERS.md

@@ -10,7 +10,7 @@ receive a veto from the Lieutenant or the Project Lead.
 * [Fletcher Nichol](https://github.com/fnichol)
 
 ## Lieutenants
-* [Seth Thomas](https://github.com/cheeseplus)
+* [Tyler Ball](https://github.com/tyler-ball)
 
 ## Maintainers
 
@@ -23,6 +23,7 @@ receive a veto from the Lieutenant or the Project Lead.
 * [Noah Kantrowitz](https://github.com/coderanger)
 * [Robb Kidd](https://github.com/robbkidd)
 * [Sean Omeara](http://github.com/someara)
+* [Seth Thomas](https://github.com/cheeseplus)
 * [Steven Murawski](http://github.com/smurawski)
 * [Salim Afiune](http://github.com/afiune)
 * [Tim Smith](http://github.com/tas50)

data/Rakefile

@@ -66,3 +66,12 @@ rescue LoadError
   puts "github_changelog_generator is not available." \
        " (sudo) gem install github_changelog_generator to generate changelogs"
 end
+
+namespace :docs do
+  desc "Deploy docs"
+  task :deploy do
+    sh "cd docs && hugo"
+    sh "aws --profile chef-cd s3 sync docs/public s3://test-kitchen-legacy.cd.chef.co --delete --acl public-read"
+    sh "aws --profile chef-cd cloudfront create-invalidation --distribution-id EQD8MRW086SRT --paths '/*'"
+  end
+end

data/docs/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Contributing
+
+1. Visit [#kitchenci](http://webchat.freenode.net/?channels=kitchenci) on Freenode IRC to discuss
+2. Fork https://github.com/test-kitchen/kitchen-docs
+3. Create your feature branch (`git checkout -b new-docs`)
+4. Commit your changes (`git commit -am 'Added some new documentation'`)
+5. Push your feature branch (`git push origin new-docs`)
+6. Create a Pull Request

data/docs/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fletcher Nichol
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/docs/README.md

@@ -0,0 +1,78 @@
+Documentation for KitchenCI.
+
+## Overview
+
+To preview the documentation in your browser run the following:
+
+~~~ shell
+bundle install
+bundle exec middleman server
+~~~
+
+While the Getting Started guide is written in primarily [Markdown][markdown] a few pages use [Slim](http://slim-lang.com/), an HTML templating engine for Ruby.
+
+Then go view the docs at [http://localhost:4567](http://localhost:4567). Edits to the documentation source files should cause the `middleman` server to reload so you can see your changes update live.
+
+## Hosting
+
+All documentation will be hosted on the official Kitchen website (http://kitchen.ci), which is a static site built with [Middleman][middleman].
+
+The important parts to familiarize yourself with for contributing to the KitchenCI documentation are the markdown renderer and syntax highlighting engines used to power http://kitchen.ci.
+
+Markdown rendering is handled by [kramdown][kramdown]. It would be worth your while to briefly review the kramdown documentation as there are some subtle differences (as well as a number of helpful extensions) that deviate from the Markdown standard.
+
+Syntax Highlighting is handled by [middleman-syntax][syntax], which uses [Rouge][rouge], which is a ruby-based syntax highlighting engine that is compatible with [Pygments][pygments] templates and supports things like "fenced code blocks" and language-specific syntax highlighting from Markdown.
+
+## Style Guide
+
+There are four elements that may be used for "styling" the docs content: in-line code highlighting, code blocks, blockquotes, and a special hack around markdown tables that we'll use for what we call "Pro-Tips".
+
+### In-line Code Highlighting
+
+To highlight `some code` inline with other content, just "quote" the text using backtick characters (`). See [the kramdown documentation](http://kramdown.gettalong.org/syntax.html#code-spans) for more details.
+
+### Fenced Code Blocks
+
+To highlight a block of code, start and finish the block with three or more tilde characters (`~`). To enable syntax-highlighting, just indicate the code language after the tildes on the first line.
+
+For example, this code:
+
+    ~~~yaml
+    ---
+    title: "KitchenCI Overview"
+    next:
+      url: installing-kitchen
+      text: "Installing KitchenCI"
+    ---
+    ~~~
+
+...will yield this output:
+
+~~~~yaml
+---
+title: "KitchenCI Overview"
+next:
+  url: installing-kitchen
+  text: "Installing KitchenCI"
+---
+~~~~
+
+See [the kramdown documentation](http://kramdown.gettalong.org/syntax.html#fenced-code-blocks) for more information.
+
+### Blockquotes
+
+To draw attention to some content with a blockquote, just start the line(s) with a `>` (right angle bracket / greater than symbol). See [the kramdown documentation](http://kramdown.gettalong.org/syntax.html#blockquotes) for more information.
+
+## License
+The Kitchen Documentation is released under the [MIT license][mit-license].
+
+
+[markdown]: http://daringfireball.net/projects/markdown/syntax
+[kitchenci]: http://kitchen.ci
+[middleman]: http://middlemanapp.com
+[pages]: http://pages.github.com/
+[kramdown]: http://kramdown.gettalong.org/
+[syntax]: https://github.com/middleman/middleman-syntax
+[rouge]: https://github.com/jayferd/rouge
+[pygments]: http://pygments.org/
+[mit-license]: MIT-LICENSE.txt

data/docs/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

data/docs/config.toml

@@ -0,0 +1,36 @@
+baseURL = "/"
+languageCode = "en-us"
+title = "Kitchen Documentation"
+theme = "kitchen"
+pygmentsCodeFences = true
+
+[params]
+enable_search = true  # set to true to show search bar
+
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+
+[[menu.docs]]
+identifier = "getting_started"
+name = "Getting Started"
+weight = 5
+
+[[menu.docs]]
+identifier = "drivers"
+name = "Drivers"
+weight = 10
+
+[[menu.docs]]
+identifier = "provisioners"
+name = "Provisioners"
+weight = 15
+
+[[menu.docs]]
+identifier = "verifiers"
+name = "Verifiers"
+weight = 20
+
+[[menu.docs]]
+identifier = "reference"
+name = "Reference"
+weight = 50

data/docs/content/docs/_index.md

@@ -0,0 +1,5 @@
+---
+title: "Docs"
+layout: redirect
+redirect_url: /docs/getting-started
+---

data/docs/content/docs/drivers/_index.md

@@ -0,0 +1,27 @@
+---
+title: Drivers
+menu:
+  docs:
+    parent: drivers
+    weight: 10
+---
+
+A Test-Kitchen *driver*  is what supports configuring the compute instance that is used for isolated testing. This is typically a local hypervisor, hypervisor abstraction layer (Vagrant), or cloud service (EC2).
+
+ChefDK / Chef Workstation include:
+
+* [kitchen-vagrant](https://github.com/test-kitchen/kitchen-vagrant)
+* [kitchen-ec2](https://github.com/test-kitchen/kitchen-ec2)
+* [kitchen-digitalocean](https://github.com/test-kitchen/kitchen-digitalocean)
+* [kitchen-dokken](https://github.com/someara/kitchen-dokken)
+* [kitchen-google](https://github.com/test-kitchen/kitchen-google)
+* [kitchen-hyperv](https://github.com/test-kitchen/kitchen-hyperv)
+* [kitchen-azurerm](https://github.com/test-kitchen/kitchen-azurerm)
+
+Community Drivers:
+
+* [kitchen-docker](https://github.com/test-kitchen/kitchen-docker)
+* [kitchen-openstack](https://github.com/test-kitchen/kitchen-openstack)
+* [kitchen-terraform](https://github.com/newcontext-oss/kitchen-terraform)
+
+There are other drivers that have existed over the life of test-kitchen that we do not list here, either because they are un-maintained or have been supplanted by other drivers.

data/docs/content/docs/drivers/azurerm.md

@@ -0,0 +1,44 @@
+---
+title: AzureRM
+menu:
+  docs:
+    parent: drivers
+    weight: 15
+---
+
+kitchen-azurerm is a Test Kitchen *driver* for Microsoft Azure. A full example reference can be found [here](https://github.com/test-kitchen/kitchen-azurerm#kitchenyml-example-1---linuxubuntu).
+
+Example **kitchen.yml**:
+
+```
+---
+driver:
+  name: azurerm
+  subscription_id: '4801fa9d-YOUR-GUID-HERE-b265ff49ce21'
+  location: 'West Europe'
+  machine_size: 'Standard_D2_V2'
+
+provisioner:
+  name: chef_zero
+  retry_on_exit_code:
+    - 20
+    - 35
+  max_retries: 10
+  wait_for_retry: 180
+  client_rb:
+    exit_status: :enabled
+
+platforms:
+  - name: windows2016
+    driver:
+      image_urn: MicrosoftWindowsServer:WindowsServer:2016-Datacenter:latest
+    transport:
+      name: winrm
+      elevated: true
+
+suites:
+  - name: default
+    run_list:
+      - recipe[mycookbook::default]
+    attributes:
+```

data/docs/content/docs/drivers/vagrant.md

@@ -0,0 +1,39 @@
+---
+title: Vagrant
+menu:
+  docs:
+    parent: drivers
+    weight: 15
+---
+
+Full example reference can be found [here](https://github.com/test-kitchen/kitchen-vagrant/blob/master/example/kitchen.vagrant.yml)
+
+
+```
+---
+driver:
+  name: vagrant
+  provider: virtualbox
+
+provisioner:
+  name: chef_zero
+
+verifier:
+  name: inspec  
+
+platforms:
+  - name: ubuntu-16.04
+  - name: centos-7
+  - name: openbsd-5.6
+    driver:
+      box: openbsd-5.6 
+      box_url: http://url.tld/openbsd-5.6.box
+
+suites:
+  - name: default
+    attributes:
+      cookbook:
+        attribute: 'value'
+    run_list:
+      - recipe[cookbook::default]
+```

data/docs/content/docs/getting-started/00-introduction.md

@@ -0,0 +1,14 @@
+---
+title: "Introduction"
+slug: introduction
+menu:
+  docs:
+    parent: getting_started
+    weight: 1
+---
+
+The best way to understand what kitchen does is to see it in action so we're going to use it to help us write a simple Chef cookbook. This cookbook will be complete with tests that verify the cookbook does what it's supposed to do. Kitchen comes at the process of software development with an approach that embraces the idea that writing the tests *first*, watching them fail, and then writing the code to make them pass is a great way to go.  Also known as *red, green, refactor*, it's a great way to write quality software.  By the end of this guide, you'll be familiar with this approach.
+
+<div class="sidebar--footer">
+<a class="button primary-cta" href="/docs/getting-started/installing">Next - Installing</a>
+</div>

data/docs/content/docs/getting-started/01-installing.md

@@ -0,0 +1,64 @@
+---
+title: "Installing"
+slug: installing
+menu:
+  docs:
+    parent: getting_started
+    weight: 10
+---
+
+As this is a quick start guide, it doesn't assume any great familiarity with Chef or Ruby and takes you through the process of writing a Chef cookbook with automated testing as standard. In order to follow this guide, we'll need a few tools first.
+
+##### Pre-requisites
+
+- 64 bit operating system
+- CPU Virtualization enabled
+
+In order to virtualize a 64 bit operating system, one must also be running a 64 bit operating system. Most importantly, the CPU itself must support hardware virtualization extensions and this must be enabled in the BIOS/EFI. Most modern processors support virtualization extensions in the form of VT-x (Intel) or AMD-V (AMD).
+
+<div class="callout">
+<h3 class="callout--title">Windows and Hyper-V</h3>
+Unfortunately Hyper-V doesn't like other hypervisors running at the same time and it must be disabled as a Windows Feature for VirtualBox to function properly.
+</div>
+
+##### ChefDK
+
+First, install the [ChefDK](https://downloads.chef.io/chefdk). This package includes Chef, Kitchen, Berkshelf, and a variety of useful tools for the Chef ecosystem.
+
+~~~
+$ chef --version
+Chef Development Kit Version: 3.2.30
+chef-client version: 14.4.56
+delivery version: master (6862f27aba89109a9630f0b6c6798efec56b4efe)
+berks version: 7.0.6
+kitchen version: 1.23.2
+inspec version: 2.2.70
+~~~
+
+##### VirtualBox
+
+VirtualBox is a hypervisor that lets you run virtual machines on your local workstation. Obtain the correct installer for your platform [here](https://www.virtualbox.org/wiki/Downloads). Verify that the command is accessible and in the $PATH with the following:
+
+~~~
+$ VBoxManage --version
+5.2.18r124319
+~~~
+
+##### Vagrant
+
+Vagrant manages hypervisors such as VirtualBox and makes it easy to distribute pre-packaged virtual machines, known as "boxes". Obtain the correct installer for your platform [here](https://www.vagrantup.com/downloads.html).
+
+~~~
+$ vagrant --version
+Vagrant 2.1.5
+~~~
+
+We've just installed ChefDK, VirtualBox, and Vagrant. The reason we have done so is that the default `driver` for test-kitchen is `kitchen-vagrant` which uses Vagrant to create, manage, and destroy local virtual machines. Vagrant itself supports many different hypervisors and clouds but for the purposes of this exercise we are interested in the default local virtualization provided by VirtualBox.
+
+Kitchen is modular so that one may use a variety of different drivers (Vagrant, EC2, Docker), provisioners (Chef, Ansible, Puppet), or verifiers (InSpec, Serverspec, BATS) but for the purposes of the guide we're focusing on the default "happy path" of Vagrant with VirtualBox, Chef, and InSpec.
+
+
+<div class="sidebar--footer">
+<a class="button primary-cta" href="/docs/getting-started/getting-help">Next - Getting Help</a>
+<a class="sidebar--footer--back" href="/docs/getting-started/">Back to previous step</a>
+</div>