kitchen-nodes-lobatoa 0.10.0

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'github_changelog_generator/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << '--display-cop-names'
+end
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.future_release = Kitchen::Provisioner::NODES_VERSION
+  config.enhancement_labels = ['enhancement']
+  config.bug_labels = ['bug']
+  config.exclude_labels = %w(duplicate question invalid wontfix no_changelog)
+  config.exclude_tags = [
+    'v0.1.0.dev', 'v0.2.0.dev', 'v0.2.0.dev.1',
+    'v0.2.0.dev.2', 'v0.2.0.dev.3', 'v0.2.0.dev.4',
+    'v0.6.4.dev', 'v0.6.3', 'v0.6.2', 'v0.6.1'
+  ]
+end
+
+task default: [:test, :style]

data/kitchen-nodes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/provisioner/nodes_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-nodes-lobatoa'
+  spec.version       = Kitchen::Provisioner::NODES_VERSION
+  spec.authors       = ['Matt Wrock']
+  spec.email         = ['matt@mattwrock.com']
+  spec.description   = 'A Test Kitchen Provisioner for Chef Nodes'
+  spec.summary       = spec.description
+  spec.homepage      = ''
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-ping'
+  spec.add_dependency 'win32-security'
+  spec.add_dependency 'test-kitchen'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'fakefs', '~> 0.4'
+  spec.add_development_dependency 'github_changelog_generator', '1.11.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.37', '>= 0.37.1'
+end

data/lib/kitchen/provisioner/finder.rb

@@ -0,0 +1,25 @@
+module Kitchen
+  module Provisioner
+    # Locates active IPs that are not localhost
+    # there are separate implementations for
+    # different kitchen transports
+    module Finder
+      @finder_registry = {}
+
+      def self.for_transport(transport, state)
+        @finder_registry.each do |registered_transport, finder|
+          if transport.class <= registered_transport
+            return finder.new(transport.connection(state))
+          end
+        end
+      end
+
+      def self.register_finder(transport, finder)
+        @finder_registry[transport] = finder
+      end
+    end
+  end
+end
+
+require 'kitchen/provisioner/finder/ssh'
+require 'kitchen/provisioner/finder/winrm'

data/lib/kitchen/provisioner/finder/ssh.rb

@@ -0,0 +1,107 @@
+module Kitchen
+  module Transport
+    class Ssh < Kitchen::Transport::Base
+      # Monkey patch of test-kitchen ssh transport
+      # that returns stdout
+      class Connection < Kitchen::Transport::Base::Connection
+        def node_execute(command, &block)
+          return if command.nil?
+          out, exit_code = node_execute_with_exit_code(command, &block)
+
+          if exit_code.nonzero?
+            raise Transport::SshFailed,
+                  "SSH exited (#{exit_code}) for command: [#{command}]"
+          end
+          out
+        rescue Net::SSH::Exception => ex
+          raise SshFailed, "SSH command failed (#{ex.message})"
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def node_execute_with_exit_code(command)
+          exit_code = nil
+          out = []
+          session.open_channel do |channel|
+            channel.request_pty
+            channel.exec(command) do |_ch, _success|
+              channel.on_data do |_ch, data|
+                out << data
+                yield data if block_given?
+              end
+
+              channel.on_extended_data do |_ch, _type, data|
+                out << data
+                yield data if block_given?
+              end
+
+              channel.on_request('exit-status') do |_ch, data|
+                exit_code = data.read_long
+              end
+            end
+          end
+          session.loop
+          [out.join("\n"), exit_code]
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+
+  module Provisioner
+    module Finder
+      # SSH implementation for returning active non-localhost IPs
+      class Ssh
+        IP4REGEX = /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/
+
+        Finder.register_finder(Kitchen::Transport::Ssh, self)
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        def find_ips
+          ips = []
+          5.times do
+            begin
+              ips = run_ifconfig
+            rescue Kitchen::Transport::TransportFailed
+              ips = run_ip_addr
+            end
+            return ips unless ips.empty?
+            sleep 0.5
+          end
+          ips
+        end
+
+        def find_fqdn
+          @connection.node_execute('hostname -f').chomp.chomp
+        end
+
+        private
+
+        def run_ifconfig
+          response = @connection.node_execute('/sbin/ifconfig -a')
+          ips = []
+          response.split(/^\S+/).each do |device|
+            next if !device.include?('RUNNING') || device.include?('LOOPBACK')
+            next if IP4REGEX.match(device).nil?
+            ips << IP4REGEX.match(device)[1]
+          end
+          ips.compact
+        end
+
+        def run_ip_addr
+          response = @connection.node_execute('/sbin/ip -4 addr show')
+          ips = []
+          response.split(/^[0-9]+: /).each do |device|
+            next if device.include?('LOOPBACK') || device.include?('NO-CARRIER')
+            next if device == ''
+            found_ips = IP4REGEX.match(device)
+            ips << IP4REGEX.match(device)[1] unless found_ips.nil?
+          end
+          ips.compact
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/finder/winrm.rb

@@ -0,0 +1,49 @@
+module Kitchen
+  module Transport
+    class Winrm < Kitchen::Transport::Base
+      # Monkey patch of test-kitchen winrm transport
+      # that returns stdout
+      class Connection < Kitchen::Transport::Base::Connection
+        def node_execute(command, &block)
+          unelevated_session.run(command, &block)
+        end
+      end
+    end
+  end
+
+  module Provisioner
+    module Finder
+      # WinRM implementation for returning active non-localhost IPs
+      class Winrm
+        Finder.register_finder(Kitchen::Transport::Winrm, self)
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        def find_ips
+          out = @connection.node_execute(
+            '(ipconfig) -match \'IPv[46] Address\''
+          )
+          data = []
+          out.stdout.lines.each do |line|
+            data << Regexp.last_match[1] if line.chomp =~ /:\s*(\S+)/
+          end
+          data
+        end
+
+        def find_fqdn
+          out = @connection.node_execute <<-EOS
+            [System.Net.Dns]::GetHostByName($env:computername) |
+              FL HostName |
+              Out-String |
+              % { \"{0}\" -f $_.Split(':')[1].Trim() }
+          EOS
+          data = ''
+          data = out.stdout.chomp unless out.stdout.nil?
+          data
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/nodes.rb

@@ -0,0 +1,164 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Matt Wrock (<matt@mattwrock.com>)
+#
+# Copyright (C) 2015, Matt Wrock
+#
+# 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 'kitchen'
+require 'kitchen/provisioner/chef_zero'
+require 'kitchen/provisioner/finder'
+require 'kitchen/provisioner/run_list_expansion_from_kitchen'
+require 'net/ping'
+require 'chef/run_list'
+
+module Kitchen
+  module Provisioner
+    # Nodes provisioner for Kitchen.
+    #
+    # @author Matt Wrock <matt@mattwrock.com>
+    class Nodes < ChefZero
+      default_config :reset_node_files, false
+
+      def create_sandbox
+        create_node
+      ensure
+        super
+      end
+
+      def create_node
+        FileUtils.mkdir_p(node_dir) unless Dir.exist?(node_dir)
+
+        node_def = if File.exist?(node_file)
+                     updated_node_def
+                   else
+                     node_template
+                   end
+        return unless node_def
+
+        File.open(node_file, 'w') do |out|
+          out << JSON.pretty_generate(node_def)
+        end
+      end
+
+      def updated_node_def
+        if config[:reset_node_files]
+          node_template
+        else
+          nil
+        end
+      end
+
+      def state_file
+        @state_file ||= Kitchen::StateFile.new(
+          config[:kitchen_root],
+          instance.name
+        ).read
+      end
+
+      def ipaddress
+        state = state_file
+
+        if %w(127.0.0.1 localhost).include?(state[:hostname])
+          return get_reachable_guest_address(state)
+        end
+        state[:hostname]
+      end
+
+      def fqdn
+        state = state_file
+        begin
+          [:username, :password].each do |prop|
+            state[prop] = instance.driver[prop] if instance.driver[prop]
+          end
+          Finder.for_transport(instance.transport, state).find_fqdn
+        rescue
+          nil
+        end
+      end
+
+      def recipes
+        rl = config[:run_list].map do |item|
+          ::Chef::RunList::RunListItem.new item
+        end
+        rle = RunListExpansionFromKitchen.new(
+          chef_environment,
+          rl,
+          nil,
+          config[:roles_path]
+        )
+        rle.expand
+        rle.recipes
+      end
+
+      def chef_environment
+        env = '_default'
+        if config[:client_rb] && config[:client_rb][:environment]
+          env = config[:client_rb][:environment]
+        end
+        env
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def node_template
+        {
+          id: instance.name,
+          chef_environment: chef_environment,
+          automatic: {
+            ipaddress: ipaddress,
+            platform: instance.platform.name.split('-')[0].downcase,
+            fqdn: fqdn,
+            recipes: recipes
+          },
+          normal: config[:attributes],
+          run_list: config[:run_list],
+          named_run_list: config[:named_run_list]
+        }
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def node_dir
+        config[:nodes_path] || File.join(config[:test_base_path], 'nodes')
+      end
+
+      def node_file
+        File.join(node_dir, "#{instance.name}.json")
+      end
+
+      def get_reachable_guest_address(state)
+        active_ips(instance.transport, state).each do |address|
+          next if address == '127.0.0.1'
+          return address if reachable?(address)
+        end
+      end
+
+      def reachable?(address)
+        Net::Ping::External.new.ping(address) ||
+          Net::Ping::TCP.new(address, 5985).ping ||
+          Net::Ping::TCP.new(address, 5986).ping ||
+          Net::Ping::TCP.new(address, 22).ping
+      end
+
+      def active_ips(transport, state)
+        # inject creds into state for legacy drivers
+        [:username, :password].each do |prop|
+          state[prop] = instance.driver[prop] if instance.driver[prop]
+        end
+        ips = Finder.for_transport(transport, state).find_ips
+        raise 'Unable to retrieve IPs' if ips.empty?
+        ips
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/nodes_version.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Matt Wrock (<matt@mattwrock.com>)
+#
+# Copyright (C) 2015, Matt Wrock
+#
+# 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 Kitchen
+  # Version string for Nodes Kitchen driver
+  module Provisioner
+    NODES_VERSION = '0.10.0'.freeze
+  end
+end

data/lib/kitchen/provisioner/run_list_expansion_from_kitchen.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Matt Wrock (<matt@mattwrock.com>)
+#
+# Copyright (C) 2015, Matt Wrock
+#
+# 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/role'
+
+module Kitchen
+  module Provisioner
+    # fetches roles from kitchen roles directory
+    class RunListExpansionFromKitchen < ::Chef::RunList::RunListExpansion
+      def initialize(environment, run_list_items, source = nil, role_dir = nil)
+        @role_dir = role_dir
+        super(environment, run_list_items, source)
+      end
+
+      def fetch_role(name, included_by)
+        role_file = File.join(@role_dir, name)
+        ::Chef::Role.from_disk(role_file)
+      rescue ::Chef::Exceptions::RoleNotFound
+        role_not_found(name, included_by)
+      end
+    end
+  end
+end