kitchen-ansible 0.0.33 → 0.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b4d280df66920431cf01969f165457c8e884fc2
-  data.tar.gz: a9a62abb6f496d3d862f0a30776f4642ed739822
+  metadata.gz: 383772e19dae10c7d068e546b69d07d6953ee1a2
+  data.tar.gz: 7a40e84ce0e131f6cb6bfefa4798ebea0a5ec637
 SHA512:
-  metadata.gz: e2c4d149b73a3959c182003b11cf28414f05f3fdad19d92d46876cbcf161142ae05b14a2dc5f5a2486995fc6dc73759a0dd7ed4a553dc82331aa6512acf62990
-  data.tar.gz: eda4854cba439e31bbbe4c6bdb388088343ca62970950123e0843e2ed1a87d31b469cffd4a36750f46c6bd7bca7c7fc09a7c396b86fdaa8a29a3098232f1e86d
+  metadata.gz: f20a609cbc3b8032e0d04717b8ce2eb87fc341d354db705f16252105ba992cb86c2f71c87b94908f4db3e6d7d3d729878569f6684d7ac6cb2d494b05c1193172
+  data.tar.gz: 50dbedb9520c1527a94341eecd0f20ffa19417e00b563d98fdec33ded9312a866cd4260e04b561573bc19e8bb02e04a380305731221220c7f6bd44807fdd4153

data/README.md

@@ -4,25 +4,29 @@
 [![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/kitchen-ansible?type=total&color=brightgreen)](https://rubygems.org/gems/kitchen-ansible)
 [![Build Status](https://travis-ci.org/neillturner/kitchen-ansible.png)](https://travis-ci.org/neillturner/kitchen-ansible)
 
-A Test Kitchen Provisioner for Ansible
+A Test Kitchen Provisioner for Ansible.
 
 The provisioner works by passing the ansible repository based on attributes in `.kitchen.yml` & calling `ansible-playbook`.
 
 It installs Ansible on the server and runs `ansible-playbook` using host localhost.
 
-Has been tested against the Ubuntu 12.04 and Centos 6.5 boxes running in vagrant/virtualbox.
+It has been tested against the Ubuntu 12.04, Ubuntu 14.04, Centos 6.5 and Debian 6/7/8  boxes running in vagrant/virtualbox.
 
 ## Requirements
-You'll need a driver box without a chef installation so ansible can be installed.
+- [test-kitchen](https://github.com/test-kitchen/test-kitchen)
+- a driver box without a chef installation so ansible can be installed.
 
 ## Installation & Setup
-You'll need the test-kitchen & kitchen-ansible gems installed in your system, along with [kitchen-vagrant](https://github.com/test-kitchen/kitchen-vagrant) or some other suitable driver for test-kitchen.
+Install the kitchen-ansible gem in your system, along with [kitchen-vagrant](https://github.com/test-kitchen/kitchen-vagrant) or some other suitable driver for test-kitchen:
 
-Please see the Provisioner Options (https://github.com/neillturner/kitchen-ansible/blob/master/provisioner_options.md).
+```
+gem install kitchen-ansible
+gem install kitchen-vagrant
+```
 
 ## Example kitchen.yml file
 
-based on the example ansible setup for tomcat at  https://github.com/ansible/ansible-examples/tree/master/tomcat-standalone
+Based on the example ansible setup for tomcat at https://github.com/ansible/ansible-examples/tree/master/tomcat-standalone
 
 ```yaml
 ---
@@ -35,7 +39,7 @@ provisioner:
   hosts: tomcat-servers
   require_ansible_repo: true
   ansible_verbose: true
-  ansible_version:   1.6.2-1.el6
+  ansible_version: latest
   extra_vars:
     a: b
 
@@ -48,188 +52,164 @@ platforms:
       network:
       - ['forwarded_port', {guest: 8080, host: 8080}]
       - [ 'private_network', { ip: '192.168.33.11' } ]
-
-verifier:
-  ruby_bindir: '/usr/bin'
 ```
-**NOTE:** With Test-Kitchen 1.4 you no longer need chef install to run the tests. You just need ruby installed version 1.9 or higher and also add to the `.kitchen.yml` file
 
-```yaml
-provisioner:
-  name: ansible_playbook
-  hosts: test-kitchen
-  require_chef_for_busser: false
-  require_ruby_for_busser: true
+## Ruby install to run serverspec verify
+
+By default test-kitchen installs chef to get a ruby version sutable for run serverspec in the Verify step.
 
+Instead ruby can just be installed by specifing the provisioner option:
+```
+require_ruby_for_busser false
+```
+And set the verifer section:
+```
 verifier:
+  name: Busser
+  plugin:
+  - Ansiblespec
   ruby_bindir: '/usr/bin'
 ```
-where `/usr/bin` is the location of the ruby command.
-
-
-## Test-Kitchen Serverspec
-
-To run the verify step with the test-kitchen serverspec setup your ansible repository as follows:
-
-NOTE: See https://github.com/delphix/ansible-package-caching-proxy for an example.
+and create a Gemfile to add additionl ruby gems in directory test/integration/default/ansiblespec
+```
+source 'https://rubygems.org'
 
-In the root directory for your Ansible role:
+gem 'rake'
+```
 
-Create a `.kitchen.yml`, much like one the described above:
+Please see the [Provisioner Options](https://github.com/neillturner/kitchen-ansible/blob/master/provisioner_options.md) for a complete listing.
 
-```yaml
-  ---
-  driver:
-    name: vagrant
 
-  provisioner:
-    name: ansible_playbook
-    playbook: default.yml
-    ansible_yum_repo: "https://download.fedoraproject.org/pub/epel/7/x86_64/e/epel-release-7-5.noarch.rpm"
-    ansible_verbose: true
-    ansible_verbosity: 3
-    hosts: all
+## Test-Kitchen Ansiblespec
 
-  platforms:
-    - name: ubuntu-12.04
-      driver_config:
-        box: ubuntu/precise32
-    - name: centos-7
-      driver_config:
-         box: chef/centos-7.0
+This can run tests against multiple servers with multiple roles in any of three formats:
 
-  verifier:
-    ruby_bindir: '/usr/bin'
+  * ansiblespec - tests are specified with the roles in the ansible repository. (default)
+  * serverspec - tests are in test-kitchen serverspec format
+  * spec - tests are stored in the spec directory with a directory for each role.
 
-  suites:
-    - name: default
-```
+Serverspec uses ssh to communicate with the server to be tested and reads the ansible playbook and inventory files to determine the hosts to test and the roles for each host.
 
-Then for serverspec:
+- Set pattern: 'serverspec' in the config.yml file (see below) to perform tests in test-kitchen serverspec format.
+(See https://github.com/delphix/ansible-package-caching-proxy for an example of using test-kitchen serverspec).
+- Set pattern: 'spec' in the config.yml file (see below) to perform tests in for roles specified in the spec directory.
+- By default pattern: ansiblespec is set. See example [https://github.com/neillturner/ansible_repo](https://github.com/neillturner/ansible_repo)
 
-```bash
-  mkdir -p test/integration/default/serverspec/localhost
-  echo "require 'serverspec'" >> test/integration/default/serverspec/spec_helper.rb
-  echo "set :backend, :exec" >> test/integration/default/serverspec/spec_helper.rb
-```
 
-Create a basic playbook `test/integration/default.yml` so that kitchen can use your role (this should include any dependencies for your role):
+### Example usage to create tomcat servers:
 
-```yaml
-  ---
-  - name: wrapper playbook for kitchen testing "my_role"
-    hosts: localhost
-    roles:
-      - my_role
 ```
+                                                                     TOMCAT SERVERS
+     TEST KITCHEN              ANSIBLE AND SERVERSPEC
+     WORKSTATION               SERVER                             +------------------------+
+                             +-----------------------+            |   +---------+          |
+                             |                       |            |   |Tomcat   |          |
++-------------------+        |                   +---------------->   |         |          |
+|                   |        |                   |   |            |   +---------+          |
+|    Workstation    |        |                   |   |    +------->                        |
+|    test-kitchen   |        |                   |   |    |       |                        |
+|    kitchen-ansible|        |                   |   |    |       |                        |
+|                   |  create|                   |   |    |       +------------------------+
+|     CREATE +--------------->      install      |   |    |
+|                   |  server|      and run      |   |    |
+|     CONVERGE+-------------------->ANSIBLE  +---+   |    |       +------------------------+
+|                   |        |               +-------------------->  +----------+          |
+|                   |        | install and run       |    |       |  |Tomcat    |          |
+|    VERIFY+------------------>Busser-ansiblespec +-------+       |  |          |          |
++-------------------+        |  +                 |  |            |  +----------+          |
+                             |  +--->ServerSpec   +--------------->                        |
+                             |                       |            |                        |
+                             +-----------------------+            |                        |
+                                                                  +------------------------+
+
+
+                   * All connections over SSH
 
-Create your serverspec tests in `test/integration/default/serverspec/localhost/my_roles_spec.rb`:
-
-```ruby
-  require 'spec_helper'
-
-  if os[:family] == 'ubuntu'
-        describe '/etc/lsb-release' do
-          it "exists" do
-              expect(file('/etc/lsb-release')).to be_file
-          end
-        end
-  end
-
-  if os[:family] == 'redhat'
-    describe '/etc/redhat-release' do
-      it "exists" do
-          expect(file('/etc/redhat-release')).to be_file
-      end
-    end
-  end
 ```
 
-## Test-Kitchen Ansiblespec
+See [ansible-sample-tdd](https://github.com/volanja/ansible-sample-tdd)
 
-test-kitchen normally uses tests setup in `test/integration/....` directory. Ansiblespec format puts the tests with the
-roles in the ansible repository and the spec helper is specified in the ansible repository under the spec directory.
+### Usage
 
-To implement this with test-kitchen setup the ansible repository with:
+#### Directory
 
-* the spec files with the roles.
+In the ansible repository specify:
 
-* the spec_helper in the spec folder.
-
-* a dummy `test/integration/<suite>/ansiblespec/localhost/<suite>_spec.rb` containing just a dummy comment.
-
-See example [https://github.com/neillturner/ansible_repo](https://github.com/neillturner/ansible_repo)
+* spec files with the roles.
+* spec_helper in the spec folder (with code as below).
+* test/integration/<suite>/ansiblespec containing config.yml and ssh private keys to access the servers.
 
 ```
 .
 +-- roles
-��� +-- mariadb
-��� ��� +-- spec
-��� ��� ��� +-- mariadb_spec.rb
-��� ��� +-- tasks
-��� ��� ��� +-- main.yml
-��� ��� +-- templates
-��� ���     +-- mariadb.repo
-��� +-- nginx
-���     +-- handlers
-���     ��� +-- main.yml
-���     +-- spec
-���     ��� +-- nginx_spec.rb
-���     +-- tasks
-���     ��� +-- main.yml
-���     +-- templates
-���     ��� +-- nginx.repo
-���     +-- vars
-���         +-- main.yml
+¦   +-- mariadb
+¦   ¦   +-- spec
+¦   ¦   ¦   +-- mariadb_spec.rb
+¦   ¦   +-- tasks
+¦   ¦   ¦   +-- main.yml
+¦   ¦   +-- templates
+¦   ¦       +-- mariadb.repo
+¦   +-- nginx
+¦       +-- handlers
+¦       ¦   +-- main.yml
+¦       +-- spec
+¦       ¦   +-- nginx_spec.rb
+¦       +-- tasks
+¦       ¦   +-- main.yml
+¦       +-- templates
+¦       ¦   +-- nginx.repo
+¦       +-- vars
+¦           +-- main.yml
 +-- spec
     +-- spec_helper.rb
+    +-- my_private_key.pem
 +-- test
     +-- integration
         +-- default      # name of test-kitchen suite
             +-- ansiblespec
-                +-- localhost
-                    +-- default_spec.rb   # <suite>_spec.rb
+                +-- config.yml
+
 ```
 
-In the root directory for your Ansible role create a `.kitchen.yml`, the same as for test-kitchen serverspec above.
 
-When test-kitchen runs the verify step will
-* detect the dummy `/test/integration/<suite>/ansiblespec` directory
-* install the busser-ansiblespec plugin instead of the normal busser-serverspec plugin
-* serverspec will be called using the ansiblespec conventions.
-* tests will run against all the roles in the playbook.
+#### spec_helper
 
-See [busser-ansiblespec](https://github.com/neillturner/busser-ansiblespec)
+```
+require 'rubygems'
+require 'bundler/setup'
+
+require 'serverspec'
+require 'pathname'
+require 'net/ssh'
+
+RSpec.configure do |config|
+  set :host,  ENV['TARGET_HOST']
+  # ssh via password
+  set :ssh_options, :user => 'root', :password => ENV['LOGIN_PASSWORD'] if ENV['LOGIN_PASSWORD']
+  # ssh via ssh key
+  set :ssh_options, :user => 'root', :host_key => 'ssh-rsa', :keys => [ ENV['SSH_KEY'] ] if ENV['SSH_KEY']
+  set :backend, :ssh
+  set :request_pty, true
+end
+```
 
+#### config.yml
 
-## Testing multiple playbooks
-To test different playbooks in different suites you can easily overwrite the provisioner settings in each suite seperately.
-```yaml
+This goes in directory test/integration/default/ansiblespec  where default is the name of test-kitchen suite.
+
+```
 ---
-  driver:
-    name: vagrant
+-
+  playbook: default.yml
+  inventory: hosts
+  kitchen_path: '/tmp/kitchen'
+  pattern: 'ansiblespec'    # or spec or serverspec
+  ssh_key: 'spec/my_private_key.pem'
+  login_password: 'myrootpassword'
+```
 
-  provisioner:
-    name: ansible_playbook
+See [busser-ansiblespec](https://github.com/neillturner/busser-ansiblespec)
 
-  platforms:
-    - name: ubuntu-12.04
-      driver_config:
-        box: ubuntu/precise32
-    - name: centos-7
-      driver_config:
-         box: chef/centos-7.0
-
-  suites:
-    - name: database
-      provisioner:
-        playbook: postgres.yml
-        hosts: database
-    - name: application
-      provisioner:
-        playbook: web_app.yml
-        hosts: web_application
-```
 ## Alternative Virtualization/Cloud providers for Vagrant
 This could be adapted to use alternative virtualization/cloud providers such as Openstack/AWS/VMware Fusion according to whatever is supported by Vagrant.
 ```yaml
@@ -249,9 +229,9 @@ platforms:
           #security-groups: []
 ```
 
-*Notes*
+## Notes
 
-* The `default` in all of the above is the name of the test suite defined in the 'suites' section of your `.kitchen.yml`, so if you have more than suite of tests or change the name, you'll need to adapt my example accordingly.
+* The `default` in all of the above is the name of the test suite defined in the 'suites' section of your `.kitchen.yml`, so if you have more than suite of tests or change the name, you'll need to adapt the example accordingly.
 * serverspec test files *must* be named `_spec.rb`
 * Since I'm using Vagrant, my `box` definitions refer to Vagrant boxes, either standard, published boxes available from <http://atlas.hashicorp.com/boxes> or custom-created boxes (perhaps using [Packer][packer] and [bento][bento]), in which case you'll need to provide the url in `box_url`.
 
@@ -263,7 +243,7 @@ platforms:
 ## Tips
 
 You can easily skip previous instructions and jump directly to the broken statement you just fixed by passing
-an environment variable. Add folloing to your .kitchen.yml
+an environment variable. Add the following to your `.kitchen.yml`:
 
 ```yaml
 provisioner:
@@ -271,8 +251,8 @@ provisioner:
   ansible_extra_flags: <%= ENV['ANSIBLE_EXTRA_FLAGS'] %>
 ```
 
-run:
+Then run:
 
 `ANSIBLE_EXTRA_FLAGS='--start-at-task="myrole | name of last working instruction"' kitchen converge`
 
-You save a LOT of time not running working instructions.
+You save a lot of time not running working instructions.

data/kitchen-ansible.gemspec

@@ -1,17 +1,17 @@
 # encoding: utf-8
 
-$:.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'kitchen-ansible/version'
 
 Gem::Specification.new do |s|
-  s.name          = "kitchen-ansible"
-  s.license       = "Apache-2.0"
+  s.name          = 'kitchen-ansible'
+  s.license       = 'Apache-2.0'
   s.version       = Kitchen::Ansible::VERSION
-  s.authors       = ["Neill Turner"]
-  s.email         = ["neillwturner@gmail.com"]
-  s.homepage      = "https://github.com/neillturner/kitchen-ansible"
-  s.summary       = "ansible provisioner for test-kitchen"
-  candidates = Dir.glob("{lib}/**/*") +  ['README.md', 'provisioner_options.md', 'kitchen-ansible.gemspec']
+  s.authors       = ['Neill Turner']
+  s.email         = ['neillwturner@gmail.com']
+  s.homepage      = 'https://github.com/neillturner/kitchen-ansible'
+  s.summary       = 'ansible provisioner for test-kitchen'
+  candidates = Dir.glob('{lib}/**/*') +  ['README.md', 'provisioner_options.md', 'kitchen-ansible.gemspec']
   s.files = candidates.sort
   s.platform      = Gem::Platform::RUBY
   s.require_paths = ['lib']

data/lib/kitchen-ansible/version.rb

@@ -1,5 +1,6 @@
+# -*- encoding: utf-8 -*-
 module Kitchen
   module Ansible
-    VERSION = "0.0.33"
+    VERSION = '0.0.34'
   end
 end

data/lib/kitchen/provisioner/ansible/config.rb

@@ -20,9 +20,7 @@
 require 'json'
 
 module Kitchen
-
   module Provisioner
-
     module Ansible
       #
       # Ansible Playbook provisioner.
@@ -30,6 +28,7 @@ module Kitchen
       class Config
         include Kitchen::Configurable
 
+        attr_writer :instance
         attr_reader :instance
 
         default_config :ansible_sudo, true
@@ -42,11 +41,11 @@ module Kitchen
         default_config :enable_yum_epel, false
         default_config :extra_vars, {}
         default_config :tags, []
-        default_config :ansible_apt_repo, "ppa:ansible/ansible"
-        default_config :ansible_yum_repo, "https://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm"
-        default_config :ansible_sles_repo, "http://download.opensuse.org/repositories/systemsmanagement/SLE_12/systemsmanagement.repo"
-        default_config :python_sles_repo, "http://download.opensuse.org/repositories/devel:/languages:/python/SLE_12/devel:languages:python.repo"
-        default_config :chef_bootstrap_url, "https://www.getchef.com/chef/install.sh"
+        default_config :ansible_apt_repo, 'ppa:ansible/ansible'
+        default_config :ansible_yum_repo, 'https://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm'
+        default_config :ansible_sles_repo, 'http://download.opensuse.org/repositories/systemsmanagement/SLE_12/systemsmanagement.repo'
+        default_config :python_sles_repo, 'http://download.opensuse.org/repositories/devel:/languages:/python/SLE_12/devel:languages:python.repo'
+        default_config :chef_bootstrap_url, 'https://www.getchef.com/chef/install.sh'
         # Until we can truly make busser work without /opt/chef/embedded/bin/gem being installed, we still need Chef Omnibus
         # (Reference: https://github.com/neillturner/kitchen-ansible/issues/66 )
         default_config :require_chef_for_busser, true
@@ -65,15 +64,18 @@ module Kitchen
         default_config :https_proxy, nil
         default_config :no_proxy, nil
         default_config :ansible_playbook_command, nil
+        default_config :ansible_host_key_checking, false
+        default_config :set_private_key_permissions, false
+        default_config :idempotency_test, nil
 
         default_config :playbook do |provisioner|
-          provisioner.calculate_path('default.yml', :file) or
-            raise "No playbook found or specified!  Please either set a playbook in your .kitchen.yml config, or create a default wrapper playbook for your role in test/integration/playbooks/default.yml or test/integration/default.yml"
+          provisioner.calculate_path('default.yml', :file) ||
+            fail('No playbook found or specified!  Please either set a playbook in your .kitchen.yml config, or create a default wrapper playbook for your role in test/integration/playbooks/default.yml or test/integration/default.yml')
         end
 
         default_config :roles_path do |provisioner|
-          provisioner.calculate_path('roles') or
-            raise 'No roles_path detected. Please specify one in .kitchen.yml'
+          provisioner.calculate_path('roles') ||
+            fail('No roles_path detected. Please specify one in .kitchen.yml')
         end
 
         default_config :group_vars_path do |provisioner|
@@ -124,10 +126,6 @@ module Kitchen
           init_config(config)
         end
 
-        def set_instance(instance)
-          @instance = instance
-        end
-
         def []=(attr, val)
           config[attr] = val
         end
@@ -137,7 +135,7 @@ module Kitchen
         end
 
         def key?(k)
-          return config.key?(k)
+          config.key?(k)
         end
 
         def keys
@@ -145,9 +143,8 @@ module Kitchen
         end
 
         def calculate_path(path, type = :directory)
-
-          if not instance
-            raise "Please ensure that an instance is provided before calling calculate_path"
+          unless instance
+            fail 'Please ensure that an instance is provided before calling calculate_path'
           end
 
           base = config[:test_base_path]
@@ -162,11 +159,7 @@ module Kitchen
             type == :directory ? File.directory?(c) : File.file?(c)
           end
         end
-
-
       end
-
     end
   end
-
 end