kitchen-verifier-awspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 439b2fa25d3c19394ff49322bb6bb8ee0c79fc07
+  data.tar.gz: 0cc6b65b38db8950f8ede043aec10e3eabda80d2
+SHA512:
+  metadata.gz: 716f3a29a0b99d27b66f565e5d1263f9f6ce50f5377dd0b100a1cd46ebc7a653edf78ca316c1bfb0862c351fabb639a6dbae14dd877433518b0b301a2d551a16
+  data.tar.gz: dc4d1de954472fba80ab691bb704565692624162845d478db743d8bad34879e7f91c525b03caa8a319aa98f120d54d80bcd0bd4207d23f867d1f33ae235591a1

data/README.md

@@ -0,0 +1,154 @@
+[![Gem Version](https://badge.fury.io/rb/kitchen-verifier-awspec.svg)](http://badge.fury.io/rb/kitchen-verifier-awspec)
+[![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/kitchen-verifier-awspec?type=total&color=brightgreen)](https://rubygems.org/gems/kitchen-verifier-awspec)
+[![Build Status](https://travis-ci.org/neillturner/kitchen-verifier-awspec.png)](https://travis-ci.org/neillturner/kitchen-verifier-awspec)
+
+# Kitchen::Verifier::Awspec
+
+A Test Kitchen Awspec Verifer.
+
+Can by used in conjunction with kitchen-cloudformation and kitchen-terraform to validate AWS infrastructure changes.
+
+
+## Installation
+
+On your workstation add this line to your Gemfile:
+
+    gem 'kitchen-verifier-awspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-verifier-awspec
+
+When it runs it installs awspec on the workstation.
+This can be configured by passing a Gemfile like this:
+
+```
+source 'https://rubygems.org'
+
+gem 'net-ssh','~> 2.9'
+gem 'awspec'
+```
+
+This allows extra dependencies to be specified and the version of awspec specified.
+
+# Awspec Verifier Options
+
+key | default value | Notes
+----|---------------|--------
+additional_install_commmand | nil | Additional shell command to be used at install stage. Can be multiline. See examples below.
+additional_awspec_command | nil | additional command to run awspec. Can be multiline. See examples below.
+bundler_path | | override path for bundler command
+color | true | enable color in the output
+custom_install_commmand | nil | Custom shell command to be used at install stage. Can be multiline. See examples below.
+custom_awspec_command | nil | custom command to run awspec. Can be multiline. See examples below.
+default_path | '/tmp/kitchen' | Set the default path where awspec looks for patterns
+default_pattern | false | use default dir behaviour of busser i.e. test/integration/SUIT_NAME/awspec/*_spec.rb
+env_vars | {} | environment variable to set for rspec and can be used in the spec_helper. It will automatically pickup any environment variables set with a KITCHEN_ prefix.
+extra_flags | nil | extra flags to add to ther awspec command
+format | 'documentation' | format of awspec output
+gemfile | nil | custom gemfile to use to install awspec
+http_proxy | nil | use http proxy when installing ruby, awspec and running awspec
+https_proxy | nil | use https proxy when installing puppet, ruby, awspec and running awspec
+patterns | [] | array of patterns for spec test files
+remove_default_path | false | remove the default_path after successful awspec run
+rspec_path | | override path for rspec command
+sleep | 0 |
+sudo | nil | use sudo to run commands
+sudo_command | 'sudo -E -H' | sudo command to run when sudo set to true
+test_awspec_installed | true | only run install_command if awspec not installed
+
+
+## Usage
+
+Verifier awspec runs locally on your workstation and uses aws sdk to verify the aws resources.
+
+Verifier Awspec allows the awspec files to be anywhere in the repository or in the awspec default location i.e /spec.
+
+
+## Example
+
+.kitchen.yml file. See example directory for a full example.
+```yaml
+---
+driver:
+  name: cloudformation
+  stack_name: awspecTest
+  ssh_key: spec/test.pem
+  template_file: EC2InstanceSample.yml
+#  parameters:
+#    - KeyName: test
+
+provisioner:
+  name: dummy
+
+platforms:
+  - name: aws
+
+verifier:
+  name: awspec
+
+suites:
+  - name: base
+    verifier:
+      patterns:
+      - spec/test_spec.rb
+
+```
+
+In a command line run the follow line commands to setup environment variables for AWS and run test-kitchen
+
+```
+cd kitchen-verifier-awspec/example
+
+# configure aws keys via either a profile
+export AWS_DEFAULT_PROFILE=myprofile
+# or set keys directly
+export AWS_ACCESS_KEY_ID=myaccesskey
+export AWS_SECRET_ACCESS_KEY=mysecretkey
+
+export AWS_REGION=eu-west-1
+# for windows set the ssl cert file
+set SSL_CERT_FILE=C:/repository/kitchen-verifier-awspec/example/ca-bundle.crt
+
+kitchen list
+
+kitchen create base-aws -l debug
+
+kitchen converge base-aws -l debug
+
+kitchen verify base-aws -l debug
+
+kitchen destroy base-aws -l debug
+```
+
+#### custom_install_command example usage
+
+* One liner
+```yaml
+    custom_install_command: yum install -y git
+```
+* Multiple lines, a.k.a embed shell script
+```yaml
+  custom_install_command: |
+     command1
+     command2
+```
+* Multiple lines join without new line
+```yaml
+  custom_install_command: >
+     command1 &&
+     command2
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run style checks and RSpec tests (`bundle exec rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/kitchen-verifier-awspec.gemspec

@@ -0,0 +1,30 @@
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'kitchen/verifier/awspec_version'
+
+Gem::Specification.new do |s|
+  s.name          = 'kitchen-verifier-awspec'
+  s.license       = 'Apache-2.0'
+  s.version       = Kitchen::Verifier::AWSPEC_VERSION
+  s.authors       = ['Neill Turner']
+  s.email         = ['neillwturner@gmail.com']
+  s.homepage      = 'https://github.com/neillturner/kitchen-verifier-awspec'
+  s.summary       = 'Awspec verifier for Test-Kitchen'
+  candidates = Dir.glob('{lib}/**/*') + ['README.md', 'kitchen-verifier-awspec.gemspec']
+  s.files = candidates.sort
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.rubyforge_project = '[none]'
+  s.add_dependency 'test-kitchen', '~> 1.4'
+  if RUBY_VERSION >= '2.0'
+    s.add_dependency 'net-ssh', '~> 3'
+  else
+    s.add_dependency 'json', '~> 1.8'
+    s.add_dependency 'net-ssh', '~> 2.9'
+    s.add_dependency 'rubocop', '~> 0.41.2'
+  end
+  s.description = <<-EOF
+Awspec verifier for Test-Kitchen
+EOF
+end

data/lib/kitchen/verifier/awspec.rb

@@ -0,0 +1,322 @@
+#
+# 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/verifier/base'
+
+module Kitchen
+  module Verifier
+    # Awspec verifier for Kitchen.
+    class Awspec < Kitchen::Verifier::Base
+      require 'mixlib/shellout'
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      default_config :sleep, 0
+      default_config :awspec_command, nil
+      default_config :custom_awspec_command, nil
+      default_config :additional_awspec_command, nil
+      default_config :shellout_opts, {}
+      default_config :live_stream, $stdout
+      default_config :sudo_command, 'sudo -E -H'
+      default_config :format, 'documentation'
+      default_config :color, true
+      default_config :default_path, '/tmp/kitchen'
+      default_config :patterns, []
+      default_config :default_pattern, false
+      default_config :gemfile, nil
+      default_config :custom_install_command, nil
+      default_config :additional_install_command, nil
+      default_config :test_awspec_installed, true
+      default_config :extra_flags, nil
+      default_config :remove_default_path, false
+      default_config :env_vars, {}
+      default_config :bundler_path, nil
+      default_config :rspec_path, nil
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Verify on instance=#{instance} with state=#{state}")
+        sleep_if_set
+        merge_state_to_env(state)
+        config[:default_path] = Dir.pwd if config[:default_path] == '/tmp/kitchen'
+        install_command
+        awspec_commands
+        debug("[#{name}] Verify completed.")
+      end
+
+      ## for legacy drivers.
+      def run_command
+        sleep_if_set
+        awspec_commands
+      end
+
+      def setup_cmd
+        sleep_if_set
+        install_command
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_suites
+      end
+
+      def awspec_commands
+        if custom_awspec_command
+          shellout custom_awspec_command
+        else
+          if config[:additional_awspec_command]
+            c = config[:additional_awspec_command]
+            shellout c
+          end
+          c = rspec_commands
+          shellout c
+        end
+      end
+
+      def install_command
+        info('Installing with custom install command') if config[:custom_install_command]
+        return config[:custom_install_command] if config[:custom_install_command]
+        info('Installing bundler and awspec locally on workstation')
+        if config[:additional_install_command]
+          c = config[:additional_install_command]
+          shellout c
+        end
+        install_bundler
+        install_awspec
+      end
+
+      # private
+
+      def install_bundler
+        require 'bundler'
+      rescue LoadError
+        shellout `gem install --no-ri --no-rdoc  bundler`
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def install_awspec
+        if config[:test_awspec_installed]
+          begin
+            require 'awspec'
+            return
+          rescue LoadError
+            info('awspec not installed installing ...')
+          end
+        end
+        unless config[:gemfile]
+          gemfile = "#{config[:default_path]}/Gemfile"
+          unless File.exist?(gemfile)
+            File.open(gemfile, 'w') do |f|
+              f.write("source 'https://rubygems.org'\ngem 'net-ssh','~> 2.9.4'\ngem 'awspec'")
+            end
+          end
+        end
+        gemfile = config[:gemfile] if config[:gemfile]
+        begin
+          shellout "#{bundler_local_cmd} install --gemfile=#{gemfile}"
+        rescue
+          raise ActionFailed, 'Awspec install failed'
+        end
+        nil
+      end
+
+      def install_gemfile
+        if config[:gemfile]
+          <<-INSTALL
+          #{read_gemfile}
+          INSTALL
+        else
+          <<-INSTALL
+          #{sudo('rm')} -f #{config[:default_path]}/Gemfile
+          #{sudo('echo')} "source 'https://rubygems.org'" >> #{config[:default_path]}/Gemfile
+          #{sudo('echo')} "gem 'net-ssh','~> 2.9'"  >> #{config[:default_path]}/Gemfile
+          #{sudo('echo')} "gem 'awspec'" >> #{config[:default_path]}/Gemfile
+          INSTALL
+        end
+      end
+
+      def read_gemfile
+        data = "#{sudo('rm')} -f #{config[:default_path]}/Gemfile\n"
+        f = File.open(config[:gemfile], 'r')
+        f.each_line do |line|
+          data = "#{data}#{sudo('echo')} \"#{line}\" >> #{config[:default_path]}/Gemfile\n"
+        end
+        f.close
+        data
+      end
+
+      def remove_default_path
+        info('Removing default path') if config[:remove_default_path]
+        config[:remove_default_path] ? "rm -rf #{config[:default_path]}" : nil
+      end
+
+      def test_awspec_installed
+        config[:test_awspec_installed] ? "if [ $(#{sudo('gem')} list awspec -i) == 'false' ]; then" : nil
+      end
+
+      def fi_test_awspec_installed
+        config[:test_awspec_installed] ? 'fi' : nil
+      end
+
+      def rspec_commands
+        info('Running Awspec')
+        if config[:default_pattern]
+          info("Using default pattern #{config[:default_path]}/spec/*_spec.rb")
+          config[:patterns] = ["#{config[:default_path]}/spec/*_spec.rb"]
+        end
+        config[:patterns].map { |s| "#{env_vars} #{sudo_env(rspec_cmd)} #{color} -f #{config[:format]} --default-path  #{config[:default_path]} #{config[:extra_flags]} -P #{s}" }.join(';')
+      end
+
+      def rspec_cmd
+        "#{rspec_path}rspec"
+      end
+
+      def env_vars
+        return nil if config[:env_vars].none?
+        cmd = nil
+        config[:env_vars].map do |k, v|
+          info("Environment variable #{k} value #{v}")
+          ENV[k.to_s] = v.to_s
+        end
+        cmd
+      end
+
+      def sudo_env(pm)
+        # TODO: handle proxies
+        pm
+      end
+
+      def custom_awspec_command
+        return config[:custom_awspec_command] if config[:custom_awspec_command]
+        config[:awspec_command]
+      end
+
+      def bundler_cmd
+        config[:bundler_path] ? "#{config[:bundler_path]}/bundle" : '$(which bundle)'
+      end
+
+      def bundler_local_cmd
+        config[:bundler_path] ? "#{config[:bundler_path]}/bundle" : 'bundle'
+      end
+
+      def rspec_bash_cmd
+        config[:rspec_path] ? "#{config[:rspec_path]}/rspec" : '$(which rspec)'
+      end
+
+      def rspec_path
+        config[:rspec_path] ? "#{config[:rspec_path]}/" : nil
+      end
+
+      def rspec_path_option
+        config[:rspec_path] ? "--rspec-path #{config[:rspec_path]}/" : nil
+      end
+
+      def http_proxy
+        config[:http_proxy]
+      end
+
+      def https_proxy
+        config[:https_proxy]
+      end
+
+      def gem_proxy_parm
+        http_proxy ? "--http-proxy #{http_proxy}" : nil
+      end
+
+      def color
+        config[:color] ? '-c' : nil
+      end
+
+      # Sleep for a period of time, if a value is set in the config.
+      #
+      # @api private
+      def sleep_if_set
+        config[:sleep].to_i.times do
+          print '.'
+          sleep 1
+        end
+      end
+
+      def shellout(command)
+        command = command.strip
+        info("Running command: #{command}")
+        cmd = Mixlib::ShellOut.new(command, config[:shellout_opts])
+        cmd.live_stream = config[:live_stream]
+        cmd.run_command
+        begin
+          cmd.error!
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          raise ActionFailed, "Command #{command.inspect} failed for #{instance.to_str}"
+        end
+      end
+
+      def merge_state_to_env(state)
+        env_state = { :environment => {} }
+        env_state[:environment]['KITCHEN_INSTANCE'] = instance.name
+        env_state[:environment]['KITCHEN_PLATFORM'] = instance.platform.name
+        env_state[:environment]['KITCHEN_SUITE'] = instance.suite.name
+        state.each_pair do |key, value|
+          env_state[:environment]['KITCHEN_' + key.to_s.upcase] = value.to_s
+          ENV['KITCHEN_' + key.to_s.upcase] = value.to_s
+          info("Environment variable #{'KITCHEN_' + key.to_s.upcase} value #{value}")
+        end
+        # if using a driver that uses transport expose those too
+        %w(username password ssh_key port).each do |key|
+          next if instance.transport[key.to_sym].nil?
+          value = instance.transport[key.to_sym].to_s
+          ENV['KITCHEN_' + key.to_s.upcase] = value
+          info("Transport Environment variable #{'KITCHEN_' + key.to_s.upcase} value #{value}")
+        end
+        config[:shellout_opts].merge!(env_state)
+      end
+
+      def chef_data_dir?(base, file)
+        file =~ %r{^#{base}/(data|data_bags|environments|nodes|roles)/}
+      end
+
+      # Returns an Array of test suite filenames for the related suite currently
+      # residing on the local workstation. Any special provisioner-specific
+      # directories (such as a Chef roles/ directory) are excluded.
+      #
+      # @return [Array<String>] array of suite files
+      # @api private
+      def local_suite_files
+        base = File.join(config[:test_base_path], config[:suite_name])
+        glob = File.join(base, '*/**/*')
+        Dir.glob(glob).reject do |f|
+          chef_data_dir?(base, f) || File.directory?(f)
+        end
+      end
+
+      # Copies all test suite files into the suites directory in the sandbox.
+      def prepare_suites
+        base = File.join(config[:test_base_path], config[:suite_name])
+        debug("Creating local sandbox of all test suite files in #{base}")
+        local_suite_files.each do |src|
+          dest = File.join(sandbox_suites_dir, src.sub("#{base}/", ''))
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest, :preserve => true)
+        end
+      end
+
+      # @return [String] path to suites directory under sandbox path
+      # @api private
+      def sandbox_suites_dir
+        File.join(sandbox_path, 'suites')
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/awspec_version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module Verifier
+    AWSPEC_VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-verifier-awspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neill Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-04 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |
+  Awspec verifier for Test-Kitchen
+email:
+- neillwturner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- kitchen-verifier-awspec.gemspec
+- lib/kitchen/verifier/awspec.rb
+- lib/kitchen/verifier/awspec_version.rb
+homepage: https://github.com/neillturner/kitchen-verifier-awspec
+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: "[none]"
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Awspec verifier for Test-Kitchen
+test_files: []