kitchen-chefzero-nodes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44ac7594d4c8c6f1337e404aafa2e32aec4a7faa
+  data.tar.gz: cec1c8f38ddd069ccf23be174eb17e3d89d25448
+SHA512:
+  metadata.gz: 57186d05037fe12095c9004335ea302ea3c4c6bd496f45075f6e2f834c26e7ebc956a9174ed626b70ffe7ee968b79588cb65e3b1d98b5dd7dd188cf73de19594
+  data.tar.gz: 95c486a953f785d2171c67dd8f35a0e59b0b2cf3974232684c5ff47a34eed44db10eb506deb30f1d746334200987599d19355b024275c371ffce708948a64a82

data/.gitignore

@@ -0,0 +1,17 @@
+# Editors etc
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+
+*.gem
+.bundle/
+.config/
+.kitchen/
+Gemfile.lock
+Policyfile.lock.json
+pkg/
+test/integration/nodes
+.kitchen.local.yml

data/.kitchen.yml

@@ -0,0 +1,46 @@
+---
+driver:
+  name: vagrant
+  provider: parallels
+
+provisioner:
+  name: chef_zero_nodes
+  nodes_path: test/integration/nodes
+  policyfile: test/integration/cookbooks/test/Policyfile.rb
+
+platforms:
+  - name: el6
+    driver:
+      box: bento/centos-6.8
+
+  - name: win2012R2
+    driver:
+      box: win-2012r2-base
+      customize:
+        memsize: 2048
+        cpus: 2
+
+suites:
+  - name: sftp
+    transport:
+      name: sftp
+    provisioner:
+      named_run_list: sftp
+    excludes:
+      - win2012R2
+
+  - name: winrm
+    transport:
+      name: winrm
+    provisioner:
+      named_run_list: win
+    excludes:
+      - el6
+
+  - name: ssh
+    transport:
+      name: ssh
+    provisioner:
+      named_run_list: ssh
+    excludes:
+      - win2012R2

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+AlignParameters:
+  Enabled: false
+ClassLength:
+  Enabled: false
+CyclomaticComplexity:
+  Enabled: false
+Documentation:
+  Enabled: false
+Encoding:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+PerceivedComplexity:
+  Enabled: false
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 (Sep 17, 2016)
+  - Initial release of kitchen-chefzero-nodes

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :rake do
+  gem 'rake'
+end
+
+group :lint do
+  gem 'rubocop', '~> 0.37'
+end
+
+group :unit do
+  gem 'chefspec', '~> 4.5'
+  gem 'rspec', '~> 3.0'
+end
+
+group :kitchen do
+  gem 'chef-dk', '~> 0.10'
+  gem 'test-kitchen', '~> 1.5'
+  gem 'kitchen-sync', '~> 2.0'
+  gem 'kitchen-vagrant', '~> 0.19'
+end

data/README.md

@@ -0,0 +1,69 @@
+# Kitchen::ChefZeroNodes
+
+Provisioner `chef_zero_nodes` extends `chef_zero` by adding one more step in the end of converge - it downloads the resulted node
+JSON object to the `nodes_path` on the host machine after successful converge. It allows you to use this node object for searches while converging another
+Test Kitchen suites. So, you can use actual node attributes like ipaddress/fqdn to communicate nodes with each other.
+
+For example, 'web' node need to search 'db' node ip.
+In `chef_zero` we have to create mock in node_path for this search. `chef_zero_nodes` will save mock automatically after 'db' successful converge.
+
+## Requirements
+
+* ChefDK 0.12.0+
+* Test Kitchen 1.10+
+
+## Supports
+
+* Linux
+* Windows 2012 RC2
+
+## Installation
+
+```
+gem install kitchen-chefzero-nodes
+```
+
+## Configuration
+
+Use `chef_zero_nodes` instead of `chef_zero` for the kitchen provisioner name.
+
+```
+provisioner:
+  name: chef_zero_nodes
+```
+
+## Development
+
+* Source hosted at [GitHub](https://github.com/scopenco/kitchen-chefzero-nodes)
+* Report issues/questions/feature requests on [GitHub Issues](https://github.com/scopenco/kitchen-chefzero-nodes/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+
+1. Run `bundle install`
+2. Run `rake` for unit testing
+
+## Authors
+
+Created and maintained by [Andrei Skopenko][author] (<andrei@skopenko.net>)
+
+## License
+
+Apache 2.0
+
+
+[author]:           https://github.com/scopenco
+[issues]:           https://github.com/scopenco/kitchen-policyfile-nodes/issues
+[license]:          https://github.com/scopenco/kitchen-policyfile-nodes/blob/master/LICENSE
+[repo]:             https://github.com/scopenco/kitchen-policyfile-nodes
+[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
+[chef_omnibus_dl]:  http://www.getchef.com/chef/install/

data/Rakefile

@@ -0,0 +1,41 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'kitchen'
+require 'chef-dk/cli'
+
+# Rubocop
+desc 'Run Ruby style checks'
+RuboCop::RakeTask.new(:rubocop)
+
+# Rspec
+desc 'Run ChefSpec examples'
+RSpec::Core::RakeTask.new(:spec)
+
+# Integration tests. Kitchen.ci
+namespace :integration do
+  desc 'Run Test Kitchen with Vagrant'
+  task :vagrant do
+    Kitchen.logger = Kitchen.default_file_logger
+    Kitchen::Config.new.instances.each do |instance|
+      instance.test(:verify)
+    end
+  end
+end
+
+namespace :policyfile do
+  desc 'Run "chef update" for Policyfile.rb'
+  task :update do
+    Dir.glob('test/integration/cookbooks/test/Policyfile.rb').each do |file|
+      cli = ChefDK::CLI.new(['update', file])
+      subcommand_name, *subcommand_params = cli.argv
+      subcommand = cli.instantiate_subcommand(subcommand_name)
+      subcommand.run_with_default_options(subcommand_params)
+    end
+  end
+end
+
+# Default
+task default: ['rubocop', 'spec', 'policyfile:update', 'integration:vagrant']

data/kitchen-chefzero-nodes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/provisioner/chef_zero_nodes_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-chefzero-nodes'
+  spec.version       = Kitchen::Provisioner::CHEF_ZERO_NODES_VERSION
+  spec.authors       = ['Andrei Skopenko']
+  spec.email         = ['andrei@skopenko.net']
+  spec.description   = 'Test Kitchen provisioner based on chef_zero that generates searchable nodes'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/Parallels/kitchen-chefzero-nodes'
+  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 'test-kitchen', '~> 1.7'
+  spec.add_dependency 'chef-dk', '~> 0.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.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/chef_zero_nodes.rb

@@ -0,0 +1,175 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Andrei Skopenko (<andrei@skopenko.net>)
+#
+# Copyright 2015 Andrei Skopenko
+#
+# 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/provisioner/chef_zero'
+require 'kitchen/provisioner/base'
+require 'kitchen/driver/ssh_base'
+require 'kitchen/transport/ssh'
+require 'kitchen/transport/winrm'
+
+# continue loading if kitchen-sync not installed
+begin
+  require 'kitchen/transport/sftp'
+rescue LoadError
+  puts 'Ignoring sftp transport...'
+end
+
+module Kitchen
+  module Driver
+    class SSHBase
+      # ChefZeroNodes needs to access to legacy_ssh_base_converge method
+      # used by some drivers like kithen-vz. This method
+      # add additional command after chef_client run complete.
+      #
+      # @param state [Hash] mutable instance state
+      # @raise [ActionFailed] if the action could not be completed
+      def converge(state)
+        provisioner = instance.provisioner
+        provisioner.create_sandbox
+        sandbox_dirs = Dir.glob("#{provisioner.sandbox_path}/*")
+        instance.transport.connection(backcompat_merged_state(state)) do |conn|
+          conn.execute(env_cmd(provisioner.install_command))
+          conn.execute(env_cmd(provisioner.init_command))
+          info("Transferring files to #{instance.to_str}")
+          conn.upload(sandbox_dirs, provisioner[:root_path])
+          debug('Transfer complete')
+          conn.execute(env_cmd(provisioner.prepare_command))
+          conn.execute(env_cmd(provisioner.run_command))
+          # Download node json object generated by chef_client
+          info("Transferring #{provisioner.unix_int_node_file} " \
+               "from instance to #{provisioner.ext_node_file}")
+          conn.execute(env_cmd(conn.download(provisioner.unix_int_node_file,
+                                             provisioner.ext_node_file)))
+          debug('Transfer complete')
+        end
+      rescue Kitchen::Transport::TransportFailed => ex
+        raise ActionFailed, ex.message
+      ensure
+        instance.provisioner.cleanup_sandbox
+      end
+    end
+  end
+end
+
+module Kitchen
+  module Transport
+    class Ssh
+      class Connection
+        # Download JSON node file from instance to
+        # node_path over SCP
+        #
+        # @param remote [String] file path on instance
+        # @param local [String] file path on host
+        def download(remote, local)
+          FileUtils.mkdir_p(File.dirname(local))
+          session.scp.download!(remote, local, {})
+          logger.debug("Downloaded #{remote} to #{local}")
+        rescue Net::SSH::Exception => ex
+          raise SshFailed, "SCP download failed (#{ex.message})"
+        end
+      end
+    end
+  end
+end
+
+module Kitchen
+  module Transport
+    class Winrm
+      class Connection
+        # Download JSON node file from instance to
+        # node_path over Winrm
+        #
+        # @param remote [String] file path on instance
+        # @param local [String] file path on host
+        # TODO need to fix scheme
+        def download(remote, local)
+          FileUtils.mkdir_p(File.dirname(local))
+          file_manager ||= WinRM::FS::FileManager.new(service)
+          file_manager.download(remote, local)
+          logger.debug("Downloaded #{remote} to #{local}")
+        rescue Kitchen::Transport::WinrmFailed => ex
+          raise WinrmFailed, "Winrm download failed (#{ex.message})"
+        end
+      end
+    end
+  end
+end
+
+module Kitchen
+  module Provisioner
+    class Base
+      # ChefZeroNodes needs to access to provision of the instance
+      # without invoking the behavior of Base#call because we need to
+      # add additional command after chef_client run complete.
+      #
+      # @param state [Hash] mutable instance state
+      # @raise [ActionFailed] if the action could not be completed
+      def call(state)
+        create_sandbox
+        sandbox_dirs = Dir.glob(File.join(sandbox_path, '*'))
+
+        instance.transport.connection(state) do |conn|
+          conn.execute(install_command)
+          conn.execute(init_command)
+          info("Transferring files to #{instance.to_str}")
+          conn.upload(sandbox_dirs, config[:root_path])
+          debug('Transfer complete')
+          conn.execute(prepare_command)
+          conn.execute(run_command)
+          # Download node json object generated by chef_client
+          int_node_file = windows_os? ? win_int_node_file : unix_int_node_file
+          info("Transferring #{int_node_file} " \
+               "from instance to #{ext_node_file}")
+          conn.download(int_node_file, ext_node_file)
+          debug('Transfer complete')
+        end
+      rescue Kitchen::Transport::TransportFailed => ex
+        raise ActionFailed, ex.message
+      ensure
+        cleanup_sandbox
+      end
+    end
+
+    class ChefZero
+      # ChefZeroNodes needs to access the base behavior of creating the
+      # sandbox directory without invoking the behavior of
+      # ChefZero#create_sandbox, we need to override json node.
+      alias create_chefzero_sandbox create_sandbox
+    end
+
+    class ChefZeroNodes < ChefZero
+      # (see ChefZero#create_sandbox)
+      def create_sandbox
+        FileUtils.rm(ext_node_file) if File.exist?(ext_node_file)
+        create_chefzero_sandbox
+      end
+
+      def ext_node_file
+        File.join(config[:nodes_path], "#{instance.name}.json")
+      end
+
+      def unix_int_node_file
+        File.join(config[:root_path], 'nodes', "#{instance.name}.json")
+      end
+
+      def win_int_node_file
+        File.join(config[:root_path], 'nodes', "#{instance.name}.json").tr('/', '\\')
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_zero_nodes_version.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Andrei Skopenko (<andrei@skopenko.net>)
+#
+# Copyright 2015 Andrei Skopenko
+#
+# 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 chefzero_nodes Kitchen driver
+  module Provisioner
+    CHEF_ZERO_NODES_VERSION = '1.0.0'.freeze
+  end
+end

data/test/integration/cookbooks/test/Policyfile.rb

@@ -0,0 +1,7 @@
+name 'test'
+default_source :supermarket
+cookbook 'test', path: './'
+run_list 'test::default'
+named_run_list 'sftp', 'test::default'
+named_run_list 'win', 'test::default'
+named_run_list 'ssh', 'test::search'

data/test/integration/cookbooks/test/metadata.rb

@@ -0,0 +1 @@
+name 'test'

data/test/integration/cookbooks/test/recipes/default.rb

@@ -0,0 +1,17 @@
+#
+# Cookbook Name:: test
+# Resource:: default
+#
+# Copyright 2015 Andrei Skopenko
+#
+# 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.

data/test/integration/cookbooks/test/recipes/search.rb

@@ -0,0 +1,33 @@
+#
+# Cookbook Name:: test
+# Resource:: search
+#
+# Copyright 2015 Andrei Skopenko
+#
+# 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.
+
+sftp_node = search(:node, "name:sftp-* AND platform:#{node['platform']}")
+ruby_block 'save sftp attributes' do
+  block do
+    parent = File.join(ENV['TEMP'] || '/tmp', 'kitchen')
+    IO.write(File.join(parent, 'sftp.json'), sftp_node[0].to_json)
+  end
+end
+
+win_node = search(:node, 'platform:windows')
+ruby_block 'save win attributes' do
+  block do
+    parent = File.join(ENV['TEMP'] || '/tmp', 'kitchen')
+    IO.write(File.join(parent, 'win.json'), win_node[0].to_json)
+  end
+end

data/test/integration/ssh/serverspec/default_spec.rb

@@ -0,0 +1,36 @@
+require 'serverspec'
+require 'json'
+
+set :backend, :exec
+
+describe 'sftp node' do
+  let(:node) do
+    JSON.parse(
+      IO.read(File.join(ENV['TEMP'] || '/tmp', 'kitchen/sftp.json'))
+    )
+  end
+
+  it 'has ip' do
+    expect(node['automatic'].key?('ipaddress')).to eq(true)
+  end
+
+  it 'has fqdn' do
+    expect(node['automatic'].key?('fqdn')).to eq(true)
+  end
+end
+
+describe 'win node' do
+  let(:node) do
+    JSON.parse(
+      IO.read(File.join(ENV['TEMP'] || '/tmp', 'kitchen/win.json'))
+    )
+  end
+
+  it 'has ip' do
+    expect(node['automatic'].key?('ipaddress')).to eq(true)
+  end
+
+  it 'has fqdn' do
+    expect(node['automatic'].key?('fqdn')).to eq(true)
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-chefzero-nodes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrei Skopenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: chef-dk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+description: Test Kitchen provisioner based on chef_zero that generates searchable
+  nodes
+email:
+- andrei@skopenko.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".kitchen.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- kitchen-chefzero-nodes.gemspec
+- lib/kitchen/provisioner/chef_zero_nodes.rb
+- lib/kitchen/provisioner/chef_zero_nodes_version.rb
+- test/integration/cookbooks/test/Policyfile.rb
+- test/integration/cookbooks/test/metadata.rb
+- test/integration/cookbooks/test/recipes/default.rb
+- test/integration/cookbooks/test/recipes/search.rb
+- test/integration/ssh/serverspec/default_spec.rb
+homepage: https://github.com/Parallels/kitchen-chefzero-nodes
+licenses:
+- Apache 2.0
+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: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Test Kitchen provisioner based on chef_zero that generates searchable nodes
+test_files:
+- test/integration/cookbooks/test/Policyfile.rb
+- test/integration/cookbooks/test/metadata.rb
+- test/integration/cookbooks/test/recipes/default.rb
+- test/integration/cookbooks/test/recipes/search.rb
+- test/integration/ssh/serverspec/default_spec.rb
+has_rdoc: