kitchen-ansiblepush 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4b5ceb255051cc628af09ac710a0fadd99931d
-  data.tar.gz: d54177928e491e1f6d73e851c6d3baee468b0c5b
+  metadata.gz: 2a0b0a4fa393de63e8bd3466018bb8f615fa71c4
+  data.tar.gz: 28c252f822f9d7a1a95c33023a2f7acf25733720
 SHA512:
-  metadata.gz: 7cd93aaac94558292f01820391fd742989db1e901cef5031ed12a6ba1548476861590962e608ab97e782abd1e7ae965c7672aeb3fd57ae7cf935581c23b4c412
-  data.tar.gz: 5a4d583388acd1eb84e7a182d811f00628a39ad1c4828c8cb7f5a9b403e6906b9994eb79358dbeb6c6f0b531cd144fd3924058685d828424f0a5b93af581803a
+  metadata.gz: 619db0de823c83576045e5895b72003acfe3440b151fff0b678722f8f5d271fb79d5af34632ba32d81c86505666d1b6ad8917046d48b49fc3c1012d361f77024
+  data.tar.gz: d628391563eac8b09f20ef5865b05c72a877525bdc727ed4e2e38143bf182335e8e86de0bc145f0820dd7c1e3dce4313f55ddc33a35de5e109689400242e91fe

data/bin/kitchen-ansible-inventory

@@ -1,45 +1,6 @@
 #!/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
+require 'kitchen-ansible/print_inventory_cli.rb'
 
-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
-      elsif host_attr["mygroup"].kind_of?(Array)
-        host_attr["mygroup"].each do | group |
-          groups[group] ||= []
-          groups[group] << host
-        end
-      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)
+print_inventory = PrintInventory.new
+print_inventory.run

data/callback/changes.py

@@ -29,7 +29,7 @@ class CallbackModule(CallbackBase):
             os.remove(self.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
+                raise # re-raise exception if a different error occurred
 
 
     def write_changed_to_file(self, host, res, name=None):
@@ -108,4 +108,4 @@ class CallbackModule(CallbackBase):
         pass
 
     def playbook_on_stats(self, stats):
-        pass
+        print "Call back end"

data/kitchen-ansiblepush.gemspec

@@ -27,6 +27,4 @@ Supports running ansible in push mode
 EOF
 
   gem.add_runtime_dependency 'test-kitchen', '~> 1.4'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'pry'
 end

data/lib/kitchen-ansible/idempotancy.rb

@@ -0,0 +1,30 @@
+require 'securerandom'
+
+def idempotency_test
+  info('*************** idempotency test ***************')
+  file_path = "/tmp/kitchen_ansible_callback/#{SecureRandom.uuid}.changes"
+  exec_ansible_command(
+    command_env.merge(
+      'ANSIBLE_CALLBACK_PLUGINS'   => "#{File.dirname(__FILE__)}/../../callback/",
+      'ANSIBLE_CALLBACK_WHITELIST' => 'changes',
+      'PLUGIN_CHANGES_FILE'        => file_path
+    ), command, 'ansible-playbook'
+  )
+  debug("idempotency file #{file_path}")
+  # Check ansible callback if changes has occured in the second run
+  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 idempotent tasks: #{task}" if conf[:fail_non_idempotent]
+    # If we reach this point we should give a warning
+    info('Warning idempotency test [failed]')
+  else
+    info('idempotency test [passed]')
+  end
+end

data/lib/kitchen-ansible/print_inventory_cli.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'json'
+require 'kitchen-ansible/util_inventory.rb'
+
+class PrintInventory
+  def initialize
+    @inventory = {}
+    @all = []
+    @groups = if File.exist?(TEMP_GROUP_FILE)
+                read_from_yaml TEMP_GROUP_FILE
+              else
+                {}
+              end
+    @hosts = {}
+  end
+
+  def read_from_yaml(yaml_file)
+    YAML.load_file yaml_file
+  end
+
+  def read_all_hosts
+    Dir.glob(TEMP_INV_DIR + '/ansiblepush_host_*.yml')
+  end
+
+  def construct
+    read_all_hosts.each do |inv_yml|
+      vm = read_from_yaml 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'].is_a?(String)
+            @groups[host_attr['mygroup']] ||= []
+            @groups[host_attr['mygroup']] << host
+          elsif host_attr['mygroup'].is_a?(Array)
+            host_attr['mygroup'].each do |group|
+              @groups[group] ||= []
+              @groups[group] << host
+            end
+          end
+        end
+        host_attr.delete('mygroup')
+        @hosts[host] = host_attr
+        @all << host
+      end
+    end
+
+    @inventory = { 'all' => @all, '_meta' => { 'hostvars' => @hosts } }
+    @groups.merge(@inventory)
+  end
+
+  def output_json
+    puts JSON.pretty_generate(@inventory)
+  end
+
+  def run
+    @inventory = construct
+    output_json
+  end
+end

data/lib/kitchen-ansible/version.rb

@@ -1,5 +1,5 @@
 module Kitchen
   module AnsiblePush
-    VERSION = '0.5.3'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/kitchen/provisioner/ansible_push.rb

@@ -1,10 +1,11 @@
+require 'json'
 require 'open3'
 require 'kitchen'
+require 'kitchen/errors'
 require 'kitchen/provisioner/base'
-require 'kitchen-ansible/util_inventory.rb'
-require 'kitchen-ansible/chef_installation.rb'
-require 'json'
-require 'securerandom'
+require 'kitchen-ansible/util_inventory'
+require 'kitchen-ansible/chef_installation'
+require 'kitchen-ansible/idempotancy'
 
 module Kitchen
   class Busser
@@ -23,6 +24,9 @@ module Kitchen
       default_config :groups, nil
       default_config :extra_vars, nil
       default_config :sudo, nil
+      default_config :become, nil
+      default_config :become_user, nil
+      default_config :become_method, nil
       default_config :sudo_user, nil
       default_config :remote_user, nil
       default_config :private_key, nil
@@ -42,6 +46,15 @@ module Kitchen
       default_config :fail_non_idempotent, true
       default_config :use_instance_name, false
       default_config :ansible_connection, 'smart'
+      default_config :timeout, nil
+      default_config :force_handlers, nil
+      default_config :step, nil
+      default_config :module_path, nil
+      default_config :scp_extra_args, nil
+      default_config :sftp_extra_args, nil
+      default_config :ssh_extra_args, nil
+      default_config :ssh_common_args, nil
+      default_config :module_path, nil
 
       # For tests disable if not needed
       default_config :chef_bootstrap_url, 'https://omnitruck.chef.io/install.sh'
@@ -51,12 +64,12 @@ module Kitchen
       def conf
         return @validated_config if defined? @validated_config
 
-        raise 'No playbook defined. Please specify one in .kitchen.yml' unless config[:playbook]
+        raise UserError, 'No playbook defined. Please specify one in .kitchen.yml' unless config[:playbook]
 
-        raise "playbook '#{config[:playbook]}' could not be found. Please check path" unless File.exist?(config[:playbook])
+        raise UserError, "playbook '#{config[:playbook]}' could not be found. Please check path" unless File.exist?(config[:playbook])
 
         if config[:vault_password_file] && !File.exist?(config[:vault_password_file])
-          raise "Vault password '#{config[:vault_password_file]}' could not be found. Please check path"
+          raise UserError, "Vault password '#{config[:vault_password_file]}' could not be found. Please check path"
         end
 
         # Validate that extra_vars is either a hash, or a path to an existing file
@@ -72,7 +85,7 @@ module Kitchen
             @extra_vars = '@' + extra_vars_path if extra_vars_is_valid
           end
 
-          raise "ansible extra_vars is in valid type: #{config[:extra_vars].class} value: #{config[:extra_vars]}" unless extra_vars_is_valid
+          raise UserError, "ansible extra_vars is in valid type: #{config[:extra_vars].class} value: #{config[:extra_vars]}" unless extra_vars_is_valid
         end
         info('Ansible push config validated')
         @validated_config = config
@@ -89,32 +102,53 @@ module Kitchen
         @machine_name
       end
 
+      def options_user
+        ## Support sudo and become
+        temp_options = []
+        raise UserError, '"sudo" and "become" are mutually_exclusive' if conf[:sudo] && conf[:become]
+        temp_options << '--become' if conf[:sudo] || conf[:become]
+
+        raise UserError, '"sudo_user" and "become_user" are mutually_exclusive' if conf[:sudo_user] && conf[:become_user]
+        if conf[:sudo_user]
+          temp_options << "--become-user=#{conf[:sudo_user]}"
+        elsif conf[:become_user]
+          temp_options << "--become-user=#{conf[:become_user]}"
+        end
+        temp_options << "--user=#{conf[:remote_user]}" if remote_user
+        temp_options << "--become-method=#{conf[:become_method]}" if conf[:become_method]
+        temp_options << '--ask-sudo-pass' if conf[:ask_sudo_pass]
+        temp_options
+      end
+
       def options
         return @options if defined? @options
-        options = []
+        # options = options_user | options
+        options = options_user
         options << "--extra-vars='#{extra_vars_argument}'" if conf[:extra_vars]
-        options << '--sudo' if conf[:sudo]
-        options << "--sudo-user=#{conf[:sudo_user]}" if conf[:sudo_user]
-        options << "--user=#{conf[:remote_user]}" if remote_user
         options << "--private-key=#{conf[:private_key]}" if conf[:private_key]
-        options << verbosity_argument.to_s if conf[:verbose]
         options << '--diff' if conf[:diff]
-        options << '--ask-sudo-pass' if conf[:ask_sudo_pass]
         options << '--ask-vault-pass' if conf[:ask_vault_pass]
         options << "--vault-password-file=#{conf[:vault_password_file]}" if conf[:vault_password_file]
         options << '--tags=#{as_list_argument(conf[:tags])}' if conf[:tags]
         options << '--skip-tags=#{as_list_argument(conf[:skip_tags])}' if conf[:skip_tags]
         options << "--start-at-task=#{conf[:start_at_task]}" if conf[:start_at_task]
         options << "--inventory-file=#{conf[:generate_inv_path]}" if conf[:generate_inv]
-
+        options << verbosity_argument.to_s if conf[:verbose]
         # By default we limit by the current machine,
         options << if conf[:limit]
                      "--limit=#{as_list_argument(conf[:limit])}"
                    else
                      "--limit=#{machine_name}"
                    end
-
-        # Add raw argument as final thing
+        options << "--timeout=#{conf[:timeout]}" if conf[:timeout]
+        options << "--force-handlers=#{conf[:force_handlers]}" if conf[:force_handlers]
+        options << "--step=#{conf[:step]}" if conf[:step]
+        options << "--module-path=#{conf[:module_path]}" if conf[:module_path]
+        options << "--scp-extra-args=#{conf[:scp_extra_args]}" if conf[:scp_extra_args]
+        options << "--sftp-extra-args=#{conf[:sftp_extra_args]}" if conf[:sftp_extra_args]
+        options << "--ssh-common-args=#{conf[:ssh_common_args]}" if conf[:ssh_common_args]
+        options << "--ssh-extra-args=#{conf[:ssh_extra_args]}" if conf[:ssh_extra_args]
+        # Add raw argument at the end
         options << conf[:raw_arguments] if conf[:raw_arguments]
         @options = options
       end
@@ -154,15 +188,12 @@ module Kitchen
       end
 
       def install_command
-        # Must install chef for busser and serverspec to work :(
         info('*************** AnsiblePush install_command ***************')
         # Test if ansible-playbook is installed and give a meaningful error message
         version_check = command + ' --version'
         _, stdout, stderr, wait_thr = Open3.popen3(command_env, version_check)
         exit_status = wait_thr.value
-
-        raise "#{version_check} returned a non zero '#{exit_status}' stdout : #{stdout}, stderr: #{stderr}" unless exit_status.success?
-
+        raise UserError, "#{version_check} returned a non zero '#{exit_status}' stdout : #{stdout}, stderr: #{stderr}" unless exit_status.success?
         omnibus_download_dir = conf[:omnibus_cachier] ? '/tmp/vagrant-cache/omnibus_chef' : '/tmp'
         chef_installation(conf[:chef_bootstrap_url], omnibus_download_dir)
       end
@@ -176,45 +207,17 @@ module Kitchen
             sh -c #{scripts.join("\n")}
           INSTALL
         else
-          true_command
+          true_command # Place holder so a string is returned. This will execute true on remote host
         end
       end
 
       def run_command
         info('*************** AnsiblePush run ***************')
         exec_ansible_command(command_env, command, 'ansible-playbook')
-        # idempotency test
-        if conf[:idempotency_test]
-          info('*************** idempotency test ***************')
-          file_path = "/tmp/kitchen_ansible_callback/#{SecureRandom.uuid}.changes"
-          exec_ansible_command(
-            command_env.merge(
-              'ANSIBLE_CALLBACK_PLUGINS' => "#{File.dirname(__FILE__)}/../../../callback/",
-              'PLUGIN_CHANGES_FILE'      => file_path
-            ), command, 'ansible-playbook'
-          )
-          debug("idempotency file #{file_path}")
-          # Check ansible callback if changes has occured in the second run
-          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 idempotent tasks: #{task}" if conf[:fail_non_idempotent]
-            # If we reach this point we should give a warning
-            info('Warning idempotency test [failed]')
-          else
-            info('idempotency test [passed]')
-          end
-        end
+        idempotency_test if conf[:idempotency_test]
         info('*************** AnsiblePush end run *******************')
         debug("[#{name}] Converge completed (#{conf[:sleep]}s).")
-        # Place holder so a string is returned. This will execute true on remote host
-        true_command
+        true_command # Place holder so a string is returned. This will execute true on remote host
       end
 
       protected
@@ -224,7 +227,7 @@ module Kitchen
         system(env, command.to_s)
         exit_code = $CHILD_STATUS.exitstatus
         debug("ansible-playbook exit code = #{exit_code}")
-        raise "#{desc} returned a non zero #{exit_code}. Please see the output above." if exit_code.to_i != 0
+        raise UserError, "#{desc} returned a non zero #{exit_code}. Please see the output above." if exit_code.to_i != 0
       end
 
       def instance_connection_option
@@ -254,11 +257,10 @@ module Kitchen
 
       def extra_vars_argument
         if conf[:extra_vars].is_a?(String) && conf[:extra_vars] =~ /^@.+$/
-          # A JSON or YAML file is referenced (requires Ansible 1.3+)
+          # A JSON or YAML file is referenced
           conf[: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+)
+          # Expected to be a Hash after config validation.
           conf[:extra_vars].to_json
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ansiblepush
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Adham Helal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-- !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:
 
@@ -73,6 +45,8 @@ files:
 - callback/changes.py
 - kitchen-ansiblepush.gemspec
 - lib/kitchen-ansible/chef_installation.rb
+- lib/kitchen-ansible/idempotancy.rb
+- lib/kitchen-ansible/print_inventory_cli.rb
 - lib/kitchen-ansible/util_inventory.rb
 - lib/kitchen-ansible/version.rb
 - lib/kitchen/provisioner/ansible_push.rb