kitchen-ansiblepush 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82964df38e42759e837ed505d7f760afaff977cb
+  data.tar.gz: 75caa47b0cbc04aaf182fc12e1e6fecd5364b658
+SHA512:
+  metadata.gz: 1cf540b68aa64e6d803f41f7f8345f483e907552bf8477d349998958864b5445da5fc3760a1002c8f23aec5b55bb1f036ee6f86dff142a10f9df70776f7ceff6
+  data.tar.gz: f0f45bd5780a607f2c1fbe6bc1cdbe3b3abe43d719164ef56ead52f6c31ce175c6ace4fd04445e4c7eb9cfb51bb3e90d7a2b3017b352d05b81f83c3a107f3cc2

data/README.md

@@ -0,0 +1,61 @@
+# kitchen-ansiblepush
+
+A test-kitchen plugin that adds the support for ansible in push mode
+
+## TODO
+* Tests
+
+## Intro
+This kitchen plugin adds ansible as a provisioner in push mode. Ansible will run from your host rather than run from guest machines.  
+
+## How to install 
+
+### Ruby gem
+```
+gem install kitchen-ansiblepush
+```
+
+### To install from code 
+``` 
+git clone git@github.com:ahelal/kitchen-ansiblepush.git
+cd kitchen-ansiblepush
+gem build kitchen-ansiblepush.gemspec
+sudo gem install kitchen-ansiblepush-<version>.gem
+```
+
+## kitchen.yml Options
+```yaml
+provisioner         :
+    ## required options
+    name                : ansible_push
+    playbook            : "../../plays/web.yml"     # Path to Play yaml
+    ##
+    ## Optional  argument
+    ansible_config      : "/path/to/ansible/ansible.cfg" # path to ansible config file
+    verbose             : "vvvv" #  verbose level v, vv, vvv, vvvv
+    diff                : true  # print file diff
+    mygroup             : "web" # ansible group 
+    raw_arguments       : "--timeout=200"
+    extra_vars          : "@vars.yml"
+    tags                : [ "that", "this" ]
+    skip_tags           : [ "notme", "orme" ]
+    start_at_task       : [ "five" ]
+    # Hash of other groups
+    groups              : 
+         db             :
+            - db01
+    sudo                : true
+    sudo_user           : root
+    remote_user         : ubuntu
+    private_key         : "/path..../id_rsa"
+    ask_vault_pass      : true
+    vault_password_file : "/..../file"
+    host_key_checking   : false
+    generate_inv        : true
+    
+```
+## idempotency test
+If you want to check your code is idempotent you can use the idempotency_test. Essentially, this will run Ansible twice and check nothing changed in the next run. If something changed it will list the tasks. Note: If your using Ansible callback in your config this might conflict.
+```yaml
+    idempotency_test: True
+```

data/bin/kitchen-ansible-inventory

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'json'
+require 'kitchen-ansible/util-inventory.rb'
+
+all =  []
+groups =  Hash.new
+hosts =  Hash.new
+if File.exist?(TEMP_GROUP_FILE)
+  groups = YAML::load_file TEMP_GROUP_FILE
+end
+
+Dir.glob(TEMP_INV_DIR + '/ansiblepush_host_*.yml') do |inv_yml|
+  vm = YAML::load_file inv_yml
+  vm.each do |host, host_attr|
+    if host_attr["mygroup"]
+      if host_attr["mygroup"].is_a?(Hash)
+        host_attr["mygroup"].each do | group |
+          groups[group] ||= []
+          groups[group] << host
+        end
+      elsif host_attr["mygroup"].kind_of?(String)
+        groups[host_attr["mygroup"]] ||= []
+        groups[host_attr["mygroup"]] << host
+      end
+    end
+    host_attr.delete("mygroup")
+    hosts[host] = host_attr
+    all << host
+  end
+end
+
+inventory = { "all" => all, "_meta" => { "hostvars" => hosts }}
+
+
+
+inventory = groups.merge(inventory)
+
+# Print our inventory
+puts JSON.pretty_generate(inventory)

data/callback/changes_callback.py

@@ -0,0 +1,97 @@
+import json
+import os
+import errno
+
+change_dir = "/tmp/kitchen_ansible_callback"
+change_file = change_dir + "/changes"
+
+class CallbackModule(object):
+    def __init__(self):
+        if not os.path.exists(change_dir):
+            os.makedirs(change_dir)
+        
+        try:
+            os.remove(change_file)
+        except OSError as e: # this would be "except OSError, e:" before Python 2.6
+            if e.errno != errno.ENOENT: # errno.ENOENT = no such file or directory
+                raise # re-raise exception if a different error occured
+
+        
+
+    def write_changed_to_file(self, host, res, name=None):
+        changed_data = dict()
+        invocation = res.get("invocation", {})
+        changed_data["changed_module_args"] = invocation.get("module_args", "")
+        changed_data["changed_module_name"] = invocation.get("module_name", "")
+        changed_data["host"] = host
+        if name:
+            changed_data["task_name"] = name
+        changed_data["changed_msg"] = res.get("msg", "")
+
+        try:
+            with open(change_file, 'at') as the_file:
+                the_file.write(json.dumps(changed_data) + "\n")
+        except Exception, e:
+            print "Ansible callback idempotency: Write to file failed '%s' error:'%s'" % (change_file, e)
+            exit(1)
+
+    def on_any(self, *args, **kwargs):
+        pass
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        pass
+
+    def runner_on_ok(self, host, res):
+        if res.get("changed"):
+            self.write_changed_to_file(host, res, self.current_task)
+
+    def runner_on_skipped(self, host, item=None):
+        pass
+
+    def runner_on_unreachable(self, host, res):
+        pass
+
+    def runner_on_no_hosts(self):
+        pass
+
+    def runner_on_async_poll(self, host, res, jid, clock):
+        pass
+
+    def runner_on_async_ok(self, host, res, jid):
+        pass
+
+    def runner_on_async_failed(self, host, res, jid):
+        pass
+
+    def playbook_on_start(self):
+        pass
+
+    def playbook_on_notify(self, host, handler):
+        pass
+
+    def playbook_on_no_hosts_matched(self):
+        pass
+
+    def playbook_on_no_hosts_remaining(self):
+        pass
+
+    def playbook_on_task_start(self, name, is_conditional):
+        self.current_task = name
+
+    def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
+        pass
+
+    def playbook_on_setup(self):
+        pass
+
+    def playbook_on_import_for_host(self, host, imported_file):
+        pass
+
+    def playbook_on_not_import_for_host(self, host, missing_file):
+        pass
+
+    def playbook_on_play_start(self, name):
+        pass
+
+    def playbook_on_stats(self, stats):
+        pass

data/kitchen-ansiblepush.gemspec

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'kitchen-ansible/version'
+
+Gem::Specification.new do |gem|
+  gem.name              = "kitchen-ansiblepush"
+  gem.version           = Kitchen::AnsiblePush::VERSION
+  gem.authors           = ["Adham Helal"]
+  gem.email             = ["adham.helal@gmail.com"]
+  gem.licenses          = ['MIT']
+  gem.homepage          = "https://github.com/ahelal/kitchen-ansiblepush"
+  gem.summary           = "ansible provisioner for test-kitchen"
+  candidates            = Dir.glob("{lib}/**/*") + ['README.md', 'kitchen-ansiblepush.gemspec', 'callback/changes_callback.py']
+  gem.files             = candidates.sort
+  gem.platform          = Gem::Platform::RUBY
+  gem.require_paths     = ['lib']
+  gem.executables       = ['kitchen-ansible-inventory']
+  gem.rubyforge_project = '[none]'
+  gem.description       = <<-EOF
+== DESCRIPTION:
+
+Ansible push Provisioner for Test Kitchen
+
+== FEATURES:
+
+Supports running ansible in push mode
+
+EOF
+
+  gem.add_runtime_dependency 'test-kitchen'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+
+end

data/lib/kitchen-ansible/util-inventory.rb

@@ -0,0 +1,30 @@
+TEMP_INV_DIR = ".kitchen/ansiblepush"
+TEMP_GROUP_FILE = "#{TEMP_INV_DIR}/ansiblepush_groups_inventory.yml"
+
+
+
+def write_instance_inventory(name, host, mygroup, instance_connection_option)
+  Dir.mkdir TEMP_INV_DIR if !File.exist?(TEMP_INV_DIR)
+  port = instance_connection_option[:port]  
+  keys = instance_connection_option[:keys]  
+  user = instance_connection_option[:user]  
+
+  temp_hash = Hash.new
+  temp_hash["ansible_ssh_host"] = host
+  temp_hash["ansible_ssh_port"] = port if port
+  temp_hash["ansible_ssh_private_key_file"] = keys[0] if keys
+  temp_hash["ansible_ssh_user"] = user if user
+  temp_hash["mygroup"] = mygroup if mygroup
+
+  host = { name => temp_hash }
+  File.open("%s/ansiblepush_host_%s.yml" % [TEMP_INV_DIR, name], "w") do |file|
+    file.write host.to_yaml
+  end
+end
+
+def write_group_inventory(groups)
+  Dir.mkdir TEMP_INV_DIR if !File.exist?(TEMP_INV_DIR)
+  File.open(TEMP_GROUP_FILE, "w") do |file|
+    file.write groups.to_yaml
+  end
+end

data/lib/kitchen-ansible/version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module AnsiblePush
+    VERSION = "0.3.1"
+  end
+end

data/lib/kitchen/provisioner/ansible_push.rb

@@ -0,0 +1,242 @@
+require 'kitchen'
+require 'kitchen/provisioner/base'
+require 'kitchen-ansible/util-inventory.rb'
+require 'json'
+
+module Kitchen
+
+  class Busser
+    def non_suite_dirs
+      %w{data}
+    end
+  end
+
+  module Provisioner
+    class AnsiblePush < Base
+      kitchen_provisioner_api_version 2
+      default_config :ansible_config, nil
+      default_config :verbose, nil
+      default_config :diff, nil
+      default_config :groups, nil
+      default_config :extra_vars, nil
+      default_config :sudo, nil
+      default_config :sudo_user, nil
+      default_config :remote_user, nil
+      default_config :private_key, nil
+      default_config :ask_vault_pass, nil
+      default_config :vault_password_file, nil
+      default_config :limit, nil
+      default_config :tags, nil
+      default_config :skip_tags, nil
+      default_config :start_at_task, nil
+      default_config :host_key_checking, false
+      default_config :mygroup, nil
+      default_config :playbook, nil
+      default_config :generate_inv, true
+      default_config :raw_arguments, nil
+      default_config :idempotency_test, false
+
+      # For tests disable if not needed
+      default_config :chef_bootstrap_url, "https://www.getchef.com/chef/install.sh"
+
+      def prepare_command
+        validate_config
+        prepare_inventory
+        complie_config
+      end
+
+      def install_command
+        # Must install chef for busser and serverspec to work :(
+        info("*************** AnsiblePush install_command ***************")
+        omnibus_download_dir = config[:omnibus_cachier] ? "/tmp/vagrant-cache/omnibus_chef" : "/tmp"
+        chef_url = config[:chef_bootstrap_url]
+        <<-INSTALL
+          sh -c '
+          #{Util.shell_helpers}
+          if [ ! -d "/opt/chef" ]
+          then
+            echo "-----> Installing Chef Omnibus"
+            mkdir -p #{omnibus_download_dir}
+            if [ ! -x #{omnibus_download_dir}/install.sh ]
+            then
+              do_download #{chef_url} #{omnibus_download_dir}/install.sh
+            fi
+
+            sudo sh #{omnibus_download_dir}/install.sh -d #{omnibus_download_dir}
+            echo "-----> End Installing Chef Omnibus"
+          fi
+
+          # Fix for https://github.com/test-kitchen/busser/issues/12
+          if [ -h /usr/bin/ruby ]; then
+              L=$(readlink -f /usr/bin/ruby)
+              sudo rm /usr/bin/ruby
+              sudo ln  -s $L /usr/bin/ruby
+          fi
+          '
+        INSTALL
+
+      end
+
+      def run_command
+        info("*************** AnsiblePush run ***************")
+        exec_command(@command_env, @command, "ansible-playbook")
+        # idempotency test
+        if config[:idempotency_test]
+          info("*************** idempotency test ***************")
+          @command_env["ANSIBLE_CALLBACK_PLUGINS"] = "#{File.dirname(__FILE__)}/../../../callback/"
+          exec_command(@command_env, @command, "ansible-playbook")
+          # Check ansible callback if changes has occured in the second run
+          file_path = "/tmp/kitchen_ansible_callback/changes"
+          if File.file?(file_path)
+            task = 0
+            info("idempotency test [Failed]")
+            File.open(file_path, "r") do |f| 
+              f.each_line do |line|
+                task += 1
+                info(" #{task}> #{line.strip}")
+              end
+            end
+            raise "idempotency test Failed. Number of non idemptent tasks: #{task}"
+
+          else
+            info("idempotency test [passed]")
+          end
+        end
+        info("*************** AnsiblePush end run *******************")
+        debug("[#{name}] Converge completed (#{config[:sleep]}s).")
+        return nil        
+      end
+
+      protected
+
+      def exec_command(env, command, desc)
+        debug("env=%s command=%s" % [env, command] )
+        system(env, "#{command}")
+        exit_code = $?.exitstatus
+        debug("ansible-playbook exit code = #{exit_code}")
+        if exit_code.to_i != 0
+          raise "%s returned a non zeroo '%s'. Please see the output above." % [ desc, exit_code.to_s ]
+        end
+      end
+
+      def prepare_inventory
+        @machine_name = instance.to_str.gsub(/[<>]/, '').split("-").drop(1).join("-")
+        @instance_connection_option = instance.transport.instance_variable_get(:@connection_options)
+        hostname = @instance_connection_option[:hostname]
+        debug("instance_connection_option=" + @instance_connection_option.to_s)
+        write_instance_inventory(@machine_name, hostname, config[:mygroup], @instance_connection_option)
+      end
+
+      def complie_config()
+        debug("compile_config")
+        options = []
+        options << "--extra-vars=#{self.get_extra_vars_argument}" if config[:extra_vars]
+        options << "--sudo" if config[:sudo]
+        options << "--sudo-user=#{config[:sudo_user]}" if config[:sudo_user]
+        options << "--user=#{config[:remote_user]}" if self.get_remote_user
+        options << "--private-key=#{config[:private_key]}" if config[:private_key]
+        options << "#{self.get_verbosity_argument}" if config[:verbose]
+        options << "--diff" if config[:diff]
+        options << "--ask-sudo-pass" if config[:ask_sudo_pass]
+        options << "--ask-vault-pass" if config[:ask_vault_pass]
+        options << "--vault-password-file=#{config[:vault_password_file]}" if config[:vault_password_file]
+        options << "--tags=%s" % self.as_list_argument(config[:tags]) if config[:tags]
+        options << "--skip-tags=%s" % self.as_list_argument(config[:skip_tags]) if config[:skip_tags]
+        options << "--start-at-task=#{config[:start_at_task]}" if config[:start_at_task]
+        options << "--inventory-file=`which kitchen-ansible-inventory`" if config[:generate_inv]
+        ##options << "--inventory-file=#{ssh_inv}," if ssh_inv
+        
+        # By default we limit by the current machine,
+        if config[:limit]
+          options << "--limit=#{as_list_argument(config[:limit])}"
+        else
+          options << "--limit=#{@machine_name}"
+        end
+      
+        #Add raw argument as final thing
+        options << config[:raw_arguments] if config[:raw_arguments]
+
+        @command = (%w(ansible-playbook) << options << config[:playbook]).flatten.join(" ")
+        debug("Ansible push command= %s" % @command)
+        @command_env = {
+          "PYTHONUNBUFFERED" => "1", # Ensure Ansible output isn't buffered
+          "ANSIBLE_FORCE_COLOR" => "true",
+          "ANSIBLE_HOST_KEY_CHECKING" => "#{config[:host_key_checking]}",
+        }
+        @command_env["ANSIBLE_CONFIG"]=config[:ansible_config] if config[:ansible_config]
+
+        info("Ansible push compile conig done")
+      end
+
+      def validate_config()
+        if !config[:playbook]
+          raise 'No playbook defined. Please specify one in .kitchen.yml'
+        end
+
+        if !File.exist?(config[:playbook])
+          raise "playbook '%s' could not be found. Please check path" % config[:playbook]
+        end
+
+        if config[:vault_password_file] and !File.exist?(config[:vault_password_file])
+          raise "Vault password '%s' could not be found. Please check path" % config[:vault_password_file]
+        end
+
+        # Validate that extra_vars is either a hash, or a path to an existing file
+        if config[:extra_vars]
+          extra_vars_is_valid = config[:extra_vars].kind_of?(Hash) || config[:extra_vars].kind_of?(String)
+          if config[:extra_vars].kind_of?(String)
+            # Accept the usage of '@' (e.g. '@vars.yml' and 'vars.yml' are both supported)
+            match_data = /^@?(.+)$/.match(config[:extra_vars])
+            extra_vars_path = match_data[1].to_s
+            expanded_path = Pathname.new(extra_vars_path).expand_path(Dir.pwd)
+            extra_vars_is_valid = expanded_path.exist?
+            if extra_vars_is_valid
+              @extra_vars = '@' + extra_vars_path
+            end
+          end
+          if !extra_vars_is_valid
+            raise "ansible extra_vars is in valid type: %s value: %s" % [config[:extra_vars].class.to_s, config[:extra_vars].to_s]
+          end
+        end
+        info("Ansible push config validated")
+      end
+
+      def get_extra_vars_argument()
+        if config[:extra_vars].kind_of?(String) and config[:extra_vars] =~ /^@.+$/
+          # A JSON or YAML file is referenced (requires Ansible 1.3+)
+          return config[:extra_vars]
+        else
+        # Expected to be a Hash after config validation. (extra_vars as
+        # JSON requires Ansible 1.2+, while YAML requires Ansible 1.3+)
+          return config[:extra_vars].to_json
+        end
+      end
+
+      def get_remote_user
+        if config[:remote_user]
+          return config[:remote_user]
+        elsif @instance_connection_option[:username]
+          config[:remote_user] = @instance_connection_option[:username]
+          return @instance_connection_option[:username]
+        else
+          return nil
+        end
+      end
+
+      def as_list_argument(v)
+        v.kind_of?(Array) ? v.join(',') : v
+      end
+
+      def get_verbosity_argument
+        if config[:verbose].to_s =~ /^v+$/
+          # ansible-playbook accepts "silly" arguments like '-vvvvv' as '-vvvv' for now
+          return "-#{config[:verbose]}"
+        else
+        # safe default, in case input strays
+          return '-v'
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-ansiblepush
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Adham Helal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |+
+  == DESCRIPTION:
+
+  Ansible push Provisioner for Test Kitchen
+
+  == FEATURES:
+
+  Supports running ansible in push mode
+
+email:
+- adham.helal@gmail.com
+executables:
+- kitchen-ansible-inventory
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- callback/changes_callback.py
+- kitchen-ansiblepush.gemspec
+- lib/kitchen-ansible/util-inventory.rb
+- lib/kitchen-ansible/version.rb
+- lib/kitchen/provisioner/ansible_push.rb
+- bin/kitchen-ansible-inventory
+homepage: https://github.com/ahelal/kitchen-ansiblepush
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: '[none]'
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ansible provisioner for test-kitchen
+test_files: []