kitchen-yansible 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da916e8bba8652a388e29c59ae55a3b284f235079feaf3ab5c5be934abe1aae2
+  data.tar.gz: 3cfd7f8c238238cec9d607dbd4e1fe2b5be81983524bce8d57af1f811d90c3d2
+SHA512:
+  metadata.gz: 66ff510329b64430d75ae50aba3580e862d434ee9dd5788c47d99b6d201c5a8477b88a5c5b94207b892139758f544feb32efb72a6b9f6b88114eddae1c85ace6
+  data.tar.gz: 076f4e1cac5146328c00a9bf261845d6f9815358ad863cdca8383209ab11acd58d9cc254f881ab7bfae9def630bf3a9cfe050f20ae4b095fbbc7954a0e30797e

data/kitchen-yansible.gemspec

@@ -0,0 +1,59 @@
+# Author: Eugene Akhmetkhanov <axmetishe+github@gmail.com>
+# Date: 03-01-2020
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'kitchen-yansible/version'
+
+Gem::Specification.new do |s|
+  s.name                        = 'kitchen-yansible'
+  s.license                     = 'Apache-2.0'
+  s.version                     = Kitchen::Yansible::VERSION
+  s.authors                     = ['Eugene Akhmetkhanov']
+  s.email                       = ['axmetishe+github@gmail.com']
+  s.homepage                    = 'https://github.com/axmetishe/kitchen-yansible'
+  s.summary                     = 'Yet Another Ansible Test-Kitchen Provisioner'
+  s.files                       = (Dir.glob('{lib}/**/*') + ['kitchen-yansible.gemspec']).sort
+  s.platform                    = Gem::Platform::RUBY
+  s.require_paths               = ['lib']
+  s.rubyforge_project           = '[none]'
+  s.description                 = <<-EOF
+Yet Another Ansible Test Kitchen Provisioner
+
+Features:
+  - Local and remote execution using single provisioner
+    - Local Ansible sandbox configuration using Virtualenv
+    - Local execution using Ansible from PATH
+    - Remote Ansible installation via Pip and Virtualenv
+  - Dependency management
+    - Path based
+    - Git repositories
+  - Drivers
+    - Docker
+    - Vagrant
+  - Platforms
+    - RHEL-based - CentOS, Fedora, Amazon Linux, Oracle Linux
+    - Debian-based - Debian, Ubuntu
+    - Windows via PS Remoting (Local executor only)
+
+EOF
+
+  s.add_runtime_dependency      'test-kitchen', '~> 2.0'
+  s.add_runtime_dependency      'rugged',       '~> 0.25'
+end

data/lib/kitchen-yansible/tools/dependencies.rb

@@ -0,0 +1,90 @@
+# Author: Eugene Akhmetkhanov <axmetishe+github@gmail.com>
+# Date: 11-01-2020
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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 'rugged'
+
+module Kitchen
+  module Yansible
+    module Tools
+      module Dependencies
+        def git_clone(name, url, path)
+          info("Cloning '#{name}' Git repository.")
+          Rugged::Repository.clone_at(url, path, { :ignore_cert_errors => true })
+        end
+
+        def prepare_dependencies(dependencies)
+          dependencies.each do |dependency|
+            info("Processing '#{dependency[:name]}' dependency.")
+            dependency_target_path = File.join(dependencies_tmp_dir, dependency[:name])
+            if dependency.key?(:path)
+              info('Processing as path type.')
+              if File.exist?(dependency[:path])
+                copy_dirs(dependency[:path], dependency_target_path)
+              else
+                warn("Dependency path '#{dependency[:path]}' doesn't exists. Omitting copy operation.")
+              end
+            end
+            if dependency.key?(:repo)
+              if dependency[:repo].downcase == 'git'
+                info('Processing as Git repository.')
+                begin
+                  repo = Rugged::Repository.new(dependency_target_path)
+                  if repo.remotes.first.url.eql?(dependency[:url])
+                    warn("Dependency cloned already.")
+                  else
+                    warn("Removing directory #{dependency_target_path} due to repository origin difference.")
+                    FileUtils.remove_entry_secure(dependency_target_path)
+                    git_clone(dependency[:name], dependency[:url], dependency_target_path)
+                  end
+                rescue
+                  if File.exist?(dependency_target_path)
+                    warn("Dependency path '#{dependency_target_path}' is not a valid Git repository. Removing then.")
+                    FileUtils.remove_entry_secure(dependency_target_path)
+                  end
+                  repo = git_clone(dependency[:name], dependency[:url], dependency_target_path)
+                end
+
+                raw_ref = dependency.key?(:ref) ? dependency[:ref] : 'master'
+                begin
+                  repo.rev_parse(raw_ref)
+                rescue
+                  message = unindent(<<-MSG)
+
+                    ===============================================================================
+                     Invalid Git reference - #{raw_ref}
+                     Please check '#{dependency[:name]}' dependency configuration.
+                    ===============================================================================
+                  MSG
+                  raise UserError, message
+                end
+
+                info("Resetting '#{dependency[:name]}' repository to '#{raw_ref}' reference.")
+                repo.checkout(raw_ref, {:strategy => :force})
+                repo.close
+              else
+                raise UserError, "Working with '#{dependency[:repo]}' repository is not implemented yet."
+              end
+            end
+          end unless dependencies.nil?
+        end
+      end
+    end
+  end
+end

data/lib/kitchen-yansible/tools/exec.rb

@@ -0,0 +1,111 @@
+# Author: Eugene Akhmetkhanov <axmetishe+github@gmail.com>
+# Date: 07-01-2020
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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 'open3'
+
+module Kitchen
+  module Yansible
+    module Tools
+      module Exec
+        def unindent(s)
+          s.gsub(/^#{s.scan(/^[ \t]+(?=\S)/).min}/, '')
+        end
+
+        def check_command(command, args: '')
+          "command -v #{command}" + "#{(" #{args}" unless args.empty?)}"
+        end
+
+        def command_exists(command)
+          check_command(command, :args => '&>/dev/null')
+        end
+
+        def local_command_path(command, args: '')
+          system(check_command(command, args))
+        end
+
+        def local_command_exists(command)
+          "#{local_command_path(command, :args => '&>/dev/null')}"
+        end
+
+        def print_cmd_parameters(command, env = {})
+          env_vars = []
+          env.each { |k,v| env_vars.push("#{k}=#{v}") }
+          message = unindent(<<-MSG)
+
+            ===============================================================================
+             Environment:
+              #{env_vars.join("\n              ")}
+             Command line:
+              #{command}
+            ===============================================================================
+          MSG
+          debug(message)
+        end
+
+        def print_cmd_error(stderr, proc)
+          message = unindent(<<-MSG)
+
+            ===============================================================================
+             Command returned '#{proc.exitstatus}'.
+             stderr: '#{stderr.read}'
+            ===============================================================================
+          MSG
+          debug(message)
+          raise UserError, message unless proc.success?
+        end
+
+        def execute_local_command(command, env: {}, opts: {}, print_stdout: false, return_stdout: false)
+          print_cmd_parameters(command, env)
+
+          # noinspection RubyUnusedLocalVariable
+          Open3.popen3(env, command, opts) { |stdin, stdout, stderr, thread|
+            if print_stdout
+              while (line = stdout.gets)
+                puts line
+              end
+            end
+            proc = thread.value
+
+            print_cmd_error(stderr, proc)
+            return_stdout ? stdout.read : proc.success?
+          }
+        end
+
+        # Helpers
+        def sudo_env(pm)
+          s = @config[:https_proxy] ? "https_proxy=#{@config[:https_proxy]}" : nil
+          p = @config[:http_proxy] ? "http_proxy=#{@config[:http_proxy]}" : nil
+          n = @config[:no_proxy] ? "no_proxy=#{@config[:no_proxy]}" : nil
+          p || s ? "#{sudo('env')} #{p} #{s} #{n} #{pm}" : "#{sudo(pm)}"
+        end
+
+        # Taken from https://github.com/test-kitchen/test-kitchen/blob/master/lib/kitchen/provisioner/base.rb
+        def sudo(script)
+          "sudo -E #{script}"
+        end
+
+        def detect_platform
+          @instance.driver.diagnose[:name] == 'docker' ?
+            @instance.driver.diagnose[:platform].to_s : @instance.platform.name.to_s
+        end
+      end
+    end
+  end
+end

data/lib/kitchen-yansible/tools/files.rb

@@ -0,0 +1,179 @@
+# Author: Eugene Akhmetkhanov <axmetishe+github@gmail.com>
+# Date: 07-01-2020
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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 Kitchen
+  module Yansible
+    module Tools
+      module Files
+        ANSIBLE_INVENTORY = "inventory.yml"
+
+        def inventory_file
+          File.join(instance_tmp_dir, ANSIBLE_INVENTORY)
+        end
+
+        def remote_file_path(file_path, fallback: nil)
+          if @config[:remote_executor]
+            File.join(@config[:root_path], file_path)
+          else
+            fallback.nil? ? file_path : fallback
+          end
+        end
+
+        def prepare_ansible_config
+          if @config[:ansible_config]
+            copy_files(@config[:ansible_config], File.join(sandbox_path, @config[:ansible_config]))
+          end
+        end
+
+        def prepare_playbook_file
+          if @config[:remote_executor]
+            copy_files(@config[:playbook], File.join(sandbox_path, @config[:playbook]))
+          end
+        end
+
+        def prepare_inventory_file
+          if @config[:remote_executor]
+            copy_files(inventory_file, File.join(sandbox_path, ANSIBLE_INVENTORY))
+          end
+        end
+
+        def generate_sandbox_path(directory)
+          path = File.join(sandbox_path, directory)
+          Dir.mkdir(path) unless File.exist?(path)
+          path
+        end
+
+        def executor_tmp_dir
+          if !@executor_tmp_dir && !instance.nil?
+            @executor_tmp_dir = File.join(config[:kitchen_root], %w[ .kitchen yansible ])
+          end
+          Dir.mkdir(@executor_tmp_dir) unless File.exist?(@executor_tmp_dir)
+          @executor_tmp_dir
+        end
+
+        def instance_tmp_dir
+          if !@instance_tmp_dir && !instance.nil?
+            @instance_tmp_dir = File.join(executor_tmp_dir, @instance.name)
+          end
+          Dir.mkdir(@instance_tmp_dir) unless File.exist?(@instance_tmp_dir)
+          @instance_tmp_dir
+        end
+
+        def dependencies_tmp_dir
+          if !@dependencies_tmp_dir && !instance.nil?
+            @dependencies_tmp_dir = File.join(instance_tmp_dir, 'dependencies')
+          end
+          Dir.mkdir(@dependencies_tmp_dir) unless File.exist?(@dependencies_tmp_dir)
+          @dependencies_tmp_dir
+        end
+
+        def venv_root
+          if !@venv_root && !instance.nil?
+            @venv_root = File.join(instance_tmp_dir, 'venv')
+          end
+          @venv_root
+        end
+
+        def generate_inventory(inventory_file, remote: false)
+          connection = @instance.transport.instance_variable_get(:@connection_options)
+          transport_conf = @instance.transport.diagnose
+          host_conn_vars = {}
+
+          debug("===> Connection options")
+          debug(connection.to_s)
+          debug("===> Transport options")
+          debug(transport_conf.to_s)
+          if remote
+            debug("Generating inventory stub for execution on remote target")
+            host_conn_vars['ansible_connection'] = 'local'
+            host_conn_vars['ansible_host'] = 'localhost'
+          else
+            debug("Generating inventory for execution on local host with remote targets")
+            host_conn_vars['ansible_connection'] = transport_conf[:name] if transport_conf[:name]
+            host_conn_vars['ansible_password'] = connection[:password] if connection[:password]
+
+            case transport_conf[:name]
+            when 'winrm'
+              host_conn_vars['ansible_host'] = URI.parse(connection[:endpoint]).hostname
+              host_conn_vars['ansible_user'] = connection[:user] if connection[:user]
+              host_conn_vars['ansible_winrm_transport'] = @config[:ansible_winrm_auth_transport] if @config[:ansible_winrm_auth_transport]
+              host_conn_vars['ansible_winrm_scheme'] = transport_conf[:winrm_transport] == :ssl ? 'https' : 'http'
+              host_conn_vars['ansible_winrm_server_cert_validation'] = @config[:ansible_winrm_cert_validation] if @config[:ansible_winrm_cert_validation]
+            when 'ssh'
+              host_conn_vars['ansible_host'] = connection[:hostname]
+              host_conn_vars['ansible_user'] = connection[:username] if connection[:username]
+              host_conn_vars['ansible_port'] = connection[:port] if connection[:port]
+              host_conn_vars['ansible_ssh_retries'] = connection[:connection_retries] if connection[:connection_retries]
+              host_conn_vars['ansible_private_key_file'] = connection[:keys].first if connection[:keys]
+              host_conn_vars['ansible_host_key_checking'] = @config[:ansible_host_key_checking] if @config[:ansible_host_key_checking]
+            else
+              message = unindent(<<-MSG)
+  
+                ===============================================================================
+                 Unsupported transport - #{transport_conf[:name]}
+                 SSH and WinRM transports are allowed.
+                ===============================================================================
+              MSG
+              raise UserError, message
+            end
+          end
+
+          # noinspection RubyStringKeysInHashInspection
+          inv = { 'all' => { 'hosts' => { @instance.name => host_conn_vars } } }
+
+          File.open(inventory_file, 'w') do |file|
+            file.write inv.to_yaml
+          end
+        end
+
+        def copy_files(src, dst, overwrite: true)
+          debug("Copy '#{src}' to '#{dst}'")
+
+          FileUtils.copy_entry(src, dst, remove_destination=overwrite)
+        end
+
+        def copy_dirs(src, dst, reject: '.git')
+          expand_path=File.expand_path(src)
+          if File.exist?(expand_path)
+            debug("Copy '#{src}' to '#{dst}'.")
+            debug("'#{src}' expanded to '#{expand_path}'")
+            Dir.glob("#{expand_path}/**/{*,.*}").reject{|f| f[reject]}.each do |file|
+              target = dst + file.sub(expand_path, '')
+              if File.file?(file)
+                FileUtils.copy_entry(file, target, remove_destination: true)
+              else
+                FileUtils.mkdir_p(target) unless File.exist?(target)
+              end
+            end
+          else
+            debug("Path '#{src}' doesn't exists. Omitting copy operation.")
+          end
+        end
+
+        def copy_dirs_to_sandbox(src, dst: src, reject: '.git')
+          dest = generate_sandbox_path(dst)
+          debug("'#{src}' => '#{dest}', reject => '#{reject}'.")
+
+          copy_dirs(src, dest, reject: reject)
+        end
+      end
+    end
+  end
+end