chef-dk 0.11.2 → 0.12.0

data/acceptance/.shared/kitchen_acceptance/metadata.rb

@@ -0,0 +1 @@
+name "kitchen_acceptance"

data/acceptance/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem "mixlib-install", github: "chef/mixlib-install"
+gem "chef-acceptance", github: "chef/chef-acceptance"
+gem "test-kitchen", github: "sersut/test-kitchen", branch: "sersut/mixlib-install-update"
+gem "kitchen-ec2", github: "test-kitchen/kitchen-ec2", branch: "jk/image-search-only"
+gem "kitchen-inspec"
+gem "kitchen-vagrant"
+gem "windows_chef_zero"
+gem "winrm-transport"
+gem "berkshelf"

data/acceptance/README.md

@@ -0,0 +1,132 @@
+# Acceptance Testing for Chef DK
+This folder contains acceptance tests that are required for ChefDK
+release readiness.
+
+## Getting started
+The tests use the _chef-acceptance_ gem as the high level framework.
+All the gems needed to run these tests can be installed with Bundler.
+
+### Important Note!
+Before running chef-acceptance, you *MUST* do the following on your current session:
+
+```
+export APPBUNDLER_ALLOW_RVM=true
+```
+
+## Pre-requisites / One time set up
+
+### Set up for local VM (Vagrant)
+
+If you intend to run the acceptance tests on a local VM, the supported solution is to use Vagrant.
+Ensure that Vagrant is installed on the machine that tests will run from, along with a
+virtualization driver (E.g.: VirtualBox).
+
+Set up the KITCHEN_DRIVER environment variable appropriately (value should be "vagrant").  E.g.:
+```
+export KITCHEN_DRIVER=vagrant
+```
+Add this to your shell profile or startup script as needed.
+
+### Set up for cloud VM (EC2)
+
+If you intend to run the acceptance tests on a cloud VM, the supported solution is to use EC2.
+
+The steps you will need to do are:
+
+1. Add your AWS credentials to the machine - e.g., to the ~/.aws/credentials directory.
+   - The easiest way to do this is to download the aws command line (`brew install awscli` on OS/X) and run `aws configure`.
+2. Create or import a SSH key to AWS. (If you already have one, you can skip the import/create)
+   - In the AWS console, click Key Pairs, then Create Key Pair or Import Key Pair.
+3. Copy or move the private key file (USERNAME.pem) to the SSH folder (e.g. `~/.ssh/USERNAME.pem`).
+   - If you Created a key pair in step 2, download the private key and move it to `~/.ssh`.
+   - If you Importd a key pair in step 2, just ensure your private key is in `~/.ssh` and has the same name as the key pair (`~/.ssh/USERNAME` or `~/.ssh/USERNAME.pem`).
+4. Set AWS_SSH_KEY_ID to the SSH key name.
+   - This is **optional** if your AWS SSH key name is your local username.
+   - You may want to set this in your shell `.profile`.
+
+     ```shell
+     export AWS_SSH_KEY_ID=name-of-private-key
+     ```
+5. Set the private key to only be readable by root
+
+   ```shell
+   chmod 0400 ~/.ssh/USERNAME.pem
+   ```
+6. Set up the KITCHEN_DRIVER environment variable appropriately (value should be "ec2"). (This is optional, as ec2 is the default.) E.g.:
+
+   ```shell
+   export KITCHEN_DRIVER=ec2
+   ```
+   Add this to your shell profile or startup script as needed.
+7. **Connect to Chef VPN**. The instances you create will not have public IPs!
+
+## Setting up and running a test suite
+To get started, do a bundle install from the acceptance directory:
+```shell
+chef/acceptance$ bundle install --binstubs
+```
+
+To get some basic info and ensure chef-acceptance can be run, do:
+```shell
+chef/acceptance$ bin/chef-acceptance info
+```
+
+To run a particular test suite, do the following:
+```shell
+chef/acceptance$ bin/chef-acceptance test TEST_SUITE
+```
+
+To restrict which OS's will run, use the KITCHEN_INSTANCES environment variable:
+
+```shell
+chef/acceptance$ export KITCHEN_INSTANCES=*-ubuntu-1404
+chef/acceptance$ bin/chef-acceptance test cookbook-git
+```
+
+If KITCHEN_INSTANCES is not specified, the default instances are default-ubuntu-1404 and default-windows-windows-2012r2. All selected instances will be run in *parallel* if the driver supports it (ec2 does, vagrant doesn't).
+
+## Optional Settings
+
+In addition to the environment settings above, there are a number of
+key values that are available to set for changing the way the acceptance
+tests are run.
+
+### KITCHEN_CHEF_CHANNEL
+
+Use this setting to specify which channel we will pull the chef build from.
+The default is to use the "current" channel, unless the ARTIFACTORY_USERNAME is set
+(which normally happens when running under Jenkins), in which case the default is
+changed to "unstable".
+
+```shell
+export KITCHEN_CHEF_CHANNEL=name-of-channel
+```
+
+
+### KITCHEN_CHEF_VERSION
+
+Use this setting to override the version of the Chef client that is installed. The default is to get the latest version in the desired channel.
+
+```shell
+export KITCHEN_CHEF_VERSION=version-of-chef-client
+```
+
+### ARTIFACTORY_USERNAME / ARTIFACTORY_PASSWORD
+
+If the desired channel to get the Chef client from is "unstable", the following settings need to be exported:
+
+```shell
+export ARTIFACTORY_USERNAME=username
+export ARTIFACTORY_PASSWORD=password
+```
+
+## Future Work
+
+Currently, there is no simple mechanism for chef-acceptance
+to build an Omnibus package of the developers local chef
+instance and run acceptance tests on it - the only packages
+that can be exercised are ones that come from one of the
+pipeline channels (unstable, current or stable).
+
+This is not an issue when adding acceptance tests for pre-existing functionality (as that functionality is presumed
+to already be in a build in one of the pipeline channels).

data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore

@@ -0,0 +1,2 @@
+nodes/
+tmp/

data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb

@@ -0,0 +1,2 @@
+name "acceptance-cookbook"
+depends "kitchen_acceptance"

data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb

@@ -0,0 +1 @@
+kitchen "destroy"

data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb

@@ -0,0 +1 @@
+kitchen "setup"

data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb

@@ -0,0 +1 @@
+kitchen "verify"

data/acceptance/trivial/.kitchen.yml

@@ -0,0 +1,7 @@
+verifier:
+  name: inspec
+
+suites:
+  - name: chefdk-current-install
+    includes: [ubuntu-14.04]
+    run_list:

data/acceptance/trivial/test/integration/chefdk-current-install/inspec/chef_client_spec.rb

@@ -0,0 +1,5 @@
+chef_version = ENV["KITCHEN_CHEF_VERSION"].split("+")[0]
+describe command("chef -v") do
+  its("exit_status") { should eq 0 }
+  its(:stdout) { should match /Chef Development Kit Version: #{chef_version}/ } if chef_version != "latest"
+end

data/bin/chef

@@ -1,25 +1,25 @@
-#!/usr/bin/env ruby
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# Set a trap for ctrl-C right away so we don't surface interrupt exceptions inside of rubygems or whatever.
-Kernel.trap(:INT) { print("\n"); exit 1 }
-
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
-require 'chef-dk/cli'
-
-ChefDK::CLI.new(ARGV.clone).run
+#!/usr/bin/env ruby
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Set a trap for ctrl-C right away so we don't surface interrupt exceptions inside of rubygems or whatever.
+Kernel.trap(:INT) { print("\n"); exit 1 }
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'chef-dk/cli'
+
+ChefDK::CLI.new(ARGV.clone).run

data/chef-dk.gemspec

@@ -1,64 +1,64 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chef-dk/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "chef-dk"
-  gem.version       = ChefDK::VERSION
-  gem.authors       = [ "Daniel DeLeo", "Lamont Granquist", "Serdar Sutay" ]
-  gem.email         = [ "dan@chef.io", "lamont@chef.io", "serdar@chef.io"]
-  gem.description   = "A streamlined development and deployment workflow for Chef platform."
-  gem.summary       = gem.description
-  gem.homepage      = "https://www.chef.io/"
-
-  gem.required_ruby_version = '>= 2.0'
-
-  gem.files = %w(Gemfile Rakefile LICENSE README.md CONTRIBUTING.md warning.txt) + Dir.glob("*.gemspec") +
-      Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
-  gem.executables   = %w( chef )
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency "mixlib-cli", "~> 1.5"
-  gem.add_dependency "mixlib-shellout", "~> 2.0"
-  gem.add_dependency "ffi-yajl", ">= 1.0", "< 3.0"
-
-  gem.add_dependency "minitar", "~> 0.5.4"
-
-  gem.add_dependency "chef", "~> 12.5"
-
-  gem.add_dependency "solve", "~> 2.0", ">= 2.0.1"
-
-  gem.add_dependency "cookbook-omnifetch", "~> 0.2", ">= 0.2.2"
-
-  gem.add_dependency "diff-lcs", "~> 1.0"
-  gem.add_dependency "paint", "~> 1.0"
-
-  gem.add_dependency "chef-provisioning", "~> 1.2"
-
-  gem.add_development_dependency "github_changelog_generator", "!= 1.10.2", "!= 1.10.3", "!= 1.11.0"
-
-  %w(rspec-core rspec-expectations rspec-mocks).each do |dev_gem|
-    gem.add_development_dependency dev_gem, "~> 3.0"
-  end
-
-  gem.post_install_message = File.read(File.join(__dir__, 'warning.txt'))
-
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef-dk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "chef-dk"
+  gem.version       = ChefDK::VERSION
+  gem.authors       = [ "Daniel DeLeo", "Lamont Granquist", "Serdar Sutay" ]
+  gem.email         = [ "dan@chef.io", "lamont@chef.io", "serdar@chef.io"]
+  gem.description   = "A streamlined development and deployment workflow for Chef platform."
+  gem.summary       = gem.description
+  gem.homepage      = "https://www.chef.io/"
+
+  gem.required_ruby_version = '>= 2.0'
+
+  gem.files = %w(Gemfile Rakefile LICENSE README.md CONTRIBUTING.md warning.txt) + Dir.glob("*.gemspec") +
+      Dir.glob("{lib,spec,acceptance}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
+  gem.executables   = %w( chef )
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mixlib-cli", "~> 1.5"
+  gem.add_dependency "mixlib-shellout", "~> 2.0"
+  gem.add_dependency "ffi-yajl", ">= 1.0", "< 3.0"
+
+  gem.add_dependency "minitar", "~> 0.5.4"
+
+  gem.add_dependency "chef", "~> 12.5"
+
+  gem.add_dependency "solve", "~> 2.0", ">= 2.0.1"
+
+  gem.add_dependency "cookbook-omnifetch", "~> 0.2", ">= 0.2.2"
+
+  gem.add_dependency "diff-lcs", "~> 1.0"
+  gem.add_dependency "paint", "~> 1.0"
+
+  gem.add_dependency "chef-provisioning", "~> 1.2"
+
+  gem.add_development_dependency "github_changelog_generator"
+
+  %w(rspec-core rspec-expectations rspec-mocks).each do |dev_gem|
+    gem.add_development_dependency dev_gem, "~> 3.0"
+  end
+
+  gem.post_install_message = File.read(File.join(__dir__, 'warning.txt'))
+
+end

data/lib/chef-dk.rb

@@ -1,19 +1,19 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-module ChefDK
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module ChefDK
+end

data/lib/chef-dk/authenticated_http.rb

@@ -1,40 +1,40 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'chef/http'
-require 'chef/http/authenticator'
-require 'chef/http/json_input'
-require 'chef/http/json_output'
-require 'chef/http/decompressor'
-require 'chef/http/validate_content_length'
-
-module ChefDK
-  class AuthenticatedHTTP < Chef::HTTP
-
-    use JSONInput
-    use JSONOutput
-    use Decompressor
-    use Authenticator
-
-    # ValidateContentLength should come after Decompressor
-    # because the order of middlewares is reversed when handling
-    # responses.
-    use ValidateContentLength
-
-  end
-end
-
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/http'
+require 'chef/http/authenticator'
+require 'chef/http/json_input'
+require 'chef/http/json_output'
+require 'chef/http/decompressor'
+require 'chef/http/validate_content_length'
+
+module ChefDK
+  class AuthenticatedHTTP < Chef::HTTP
+
+    use JSONInput
+    use JSONOutput
+    use Decompressor
+    use Authenticator
+
+    # ValidateContentLength should come after Decompressor
+    # because the order of middlewares is reversed when handling
+    # responses.
+    use ValidateContentLength
+
+  end
+end
+