kitchen-verifier-serverspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45596196f4147bbd86339157709190ad793aff46
+  data.tar.gz: 31b268ebeec5166107f965bbe2064331a902a4c0
+SHA512:
+  metadata.gz: b9765cf70d0cea811609f74ee390c061ccdf7da528afcc271947be7c709ee00dc738961827b853ea6ac6ebd54f424fe3e211beb709676989b50eecb0f2d65909
+  data.tar.gz: 6aaddb1ef845aaf60d00c7660e8711d1f3fcd6987a3aaa0d4dd19544cf57f3210d491def18fab0948e03662ad601f464107b7ff579067eaaed44c8e86cfb76e8

data/README.md

@@ -0,0 +1,84 @@
+[![Gem Version](https://badge.fury.io/rb/kitchen-verifier-serverspec.svg)](http://badge.fury.io/rb/kitchen-verifier-serverspec)
+[![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/kitchen-verifier-serverspec?type=total&color=brightgreen)](https://rubygems.org/gems/kitchen-verifier-serverspec)
+[![Build Status](https://travis-ci.org/neillturner/kitchen-verifier-serverspec.png)](https://travis-ci.org/neillturner/kitchen-verifier-serverspec)
+
+# Kitchen::Verifier::Serverspec
+
+A Test Kitchen Serverspec Verifer without having to transit the Busser layer.
+
+This is a first version. Currently it only supports running serverspec remotely on the server. 
+It could be easily enhanced to run serverspec locally on your workstation. Also the installs 
+don't cover all the possible options yet.
+
+
+## Installation
+
+On your workstation add this line to your Gemfile:
+
+    gem 'kitchen-verifier-serverspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-verifier-serverspec
+
+When it runs it install serverspec on the remote server. This can be configured by passing a Gemfile like this: 
+
+```
+source 'https://rubygems.org'
+
+gem 'net-ssh','~> 2.9'
+gem 'serverspec'
+```
+
+this allows extra dependencies to be specified and the version of serverspec specified. 
+
+## Usage
+
+
+An example of the verifier serverspec options in your `.kitchen.yml` file:
+
+```yaml
+verifier:
+  name: serverspec
+
+suites:
+  - name: base
+    verifier:
+      patterns:
+      - modules/mycompany_base/spec/acceptance/base_spec.rb
+```
+
+See example [https://github.com/neillturner/puppet_beaker_repo](https://github.com/neillturner/puppet_beaker_repo)
+
+# Serverspec Verifier Options
+
+key | default value | Notes
+----|---------------|--------
+sleep | 0 |
+serverspec_command | nil | custom command to run serverspec
+format | 'documentation' | format of serverspec output
+color | true | enable color in the output
+default_path | '/tmp/kitchen' | Set the default path where serverspec looks for patterns
+patterns | [] | array of patterns for spec test files
+gemfile | nil | custom gemfile to use to install serverspec
+install_commmand | 'bundle install' | command to install serverspec
+test_serverspec_installed | true | only run install_command if serverspec not installed
+extra_flags | nil | extra flags to add to ther serverspec command
+remove_default_path | false | remove the default_path after successful serverspec run
+http_proxy | nil | use http proxy when installing ruby, serverspec and running serverspec
+https_proxy | nil | use https proxy when installing puppet, ruby, serverspec and running serverspec
+sudo | nil | use sudo to run commands
+
+
+## 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-serverspec.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'kitchen/verifier/serverspec_version'
+
+Gem::Specification.new do |s|
+  s.name          = 'kitchen-verifier-serverspec'
+  s.license       = 'Apache-2.0'
+  s.version       = Kitchen::Verifier::SERVERSPEC_VERSION
+  s.authors       = ['Neill Turner']
+  s.email         = ['neillwturner@gmail.com']
+  s.homepage      = 'https://github.com/neillturner/kitchen-verifier-serverspec'
+  s.summary       = 'Serverspec verifier for Test-Kitchen without having to transit the Busser layer. '
+  candidates = Dir.glob('{lib}/**/*') + ['README.md', 'kitchen-verifier-serverspec.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'
+  s.add_dependency 'net-ssh', '~> 2.0'
+  s.description = <<-EOF
+Serverspec verifier for Test-Kitchen without having to transit the Busser layer.
+EOF
+end

data/lib/kitchen/verifier/serverspec.rb

@@ -0,0 +1,242 @@
+# -*- encoding: utf-8 -*-
+#
+# 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
+    # Serverspec verifier for Kitchen.
+    #
+    class Serverspec < Kitchen::Verifier::Base
+      require 'mixlib/shellout'
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      default_config :sleep, 0
+      default_config :serverspec_command, nil
+      default_config :shellout_opts, {}
+      default_config :live_stream, $stdout
+      default_config :remote_exec, true
+      default_config :format, 'documentation'
+      default_config :color, true
+      default_config :default_path, '/tmp/kitchen'
+      default_config :patterns, []
+      default_config :gemfile, nil
+      default_config :install_commmand, 'bundle install'
+      default_config :test_serverspec_installed, true
+      default_config :extra_flags, nil
+      default_config :remove_default_path, false
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Verify on instance=#{instance} with state=#{state}")
+        sleep_if_set
+        merge_state_to_env(state)
+        if config[:remote_exec]
+          instance.transport.connection(state) do |conn|
+            conn.execute(install_command)
+            conn.execute(serverspec_commands)
+          end
+        else
+          shellout
+        end
+        debug("[#{name}] Verify completed.")
+      end
+
+      ## for legacy drivers.
+      def run_command
+        sleep_if_set
+        if config[:remote_exec]
+          serverspec_commands
+        else
+          shellout
+          init
+        end
+      end
+
+      def setup_cmd
+        sleep_if_set
+        if config[:remote_exec]
+          install_command
+        else
+          shellout
+          init
+        end
+      end
+
+      private
+
+      def serverspec_commands
+        if config[:serverspec_command]
+          <<-INSTALL
+          #{config[:serverspec_command]}
+          INSTALL
+        else
+          <<-INSTALL
+          if [ -d #{config[:default_path]} ]; then
+            cd #{config[:default_path]}
+            #{rspec_commands}
+            #{remove_default_path}
+          else
+            echo "ERROR: Default path '#{config[:default_path]}' does not exist"
+            exit 1
+          fi
+          INSTALL
+        end
+      end
+
+      def install_command
+        info('Installing ruby, bundler and serverspec')
+        <<-INSTALL
+          if [ ! $(which ruby) ]; then
+            echo '-----> Installing ruby, will try to determine platform os'
+            if [ -f /etc/centos-release ] || [ -f /etc/redhat-release ] || [ -f /etc/oracle-release ]; then
+              #{sudo_env('yum')} -y install ruby
+            else
+              if [ -f /etc/system-release ] || [ grep -q 'Amazon Linux' /etc/system-release ]; then
+                #{sudo_env('yum')} -y install ruby
+              else
+                #{sudo('apt-get')} -y install ruby
+              fi
+            fi
+          fi
+          #{install_bundler}
+          if [ -d #{config[:default_path]} ]; then
+            #{install_serverspec}
+          else
+            echo "ERROR: Default path '#{config[:default_path]}' does not exist"
+            exit 1
+          fi
+        INSTALL
+      end
+
+      def install_bundler
+        <<-INSTALL
+          if [ $(#{sudo('gem')} list bundler -i) == 'false' ]; then
+            #{sudo('gem')} install #{gem_proxy_parm} --no-ri --no-rdoc bundler
+          fi
+        INSTALL
+      end
+
+      def install_serverspec
+        <<-INSTALL
+          #{test_serverspec_installed}
+            #{install_gemfile}
+            #{sudo_env('bundler')} install --gemfile=#{config[:default_path]}/Gemfile
+          #{fi_test_serverspec_installed}
+        INSTALL
+      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 'serverspec'" >> #{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_serverspec_installed
+        config[:test_serverspec_installed] ? "if [ $(#{sudo('gem')} list serverspec -i) == 'false' ]; then" : nil
+      end
+
+      def fi_test_serverspec_installed
+        config[:test_serverspec_installed] ? 'fi' : nil
+      end
+
+      def rspec_commands
+        info('Running Serverspec')
+        config[:patterns].map { |s| "rspec #{color} -f #{config[:format]} --default-path  #{config[:default_path]} #{config[:extra_flags]} -P #{s}" }.join('\n')
+      end
+
+      def sudo_env(pm)
+        s = https_proxy ? "https_proxy=#{https_proxy}" : nil
+        p = http_proxy ? "http_proxy=#{http_proxy}" : nil
+        p || s ? "#{sudo('env')} #{p} #{s} #{pm}" : sudo(pm).to_s
+      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
+        puts
+      end
+
+      def shellout
+        cmd = Mixlib::ShellOut.new(config[:command], config[:shellout_opts])
+        cmd.live_stream = config[:live_stream]
+        cmd.run_command
+        begin
+          cmd.error!
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          raise ActionFailed, "Action #verify 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
+        end
+        config[:shellout_opts].merge!(env_state)
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/serverspec_version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Kitchen
+  module Verifier
+    SERVERSPEC_VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-verifier-serverspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neill Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 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: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Serverspec verifier for Test-Kitchen without having to transit the Busser layer.
+email:
+- neillwturner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- kitchen-verifier-serverspec.gemspec
+- lib/kitchen/verifier/serverspec.rb
+- lib/kitchen/verifier/serverspec_version.rb
+homepage: https://github.com/neillturner/kitchen-verifier-serverspec
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Serverspec verifier for Test-Kitchen without having to transit the Busser
+  layer.
+test_files: []