kitchen-inspec 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93a2c2d193ca5d4c1eb991db653257d9b41781d3
+  data.tar.gz: b73c2b0e92c589261c0a0bf73383e1c2e4d4bd21
+SHA512:
+  metadata.gz: 1a51f2dfa9b43219fa5e871aaf0ef18f64b497b5de3d07a7a52f2f831886bea5081e8ba0b3640b35eb21b55f3f5d1c0c0342bea9755785cc85a2ee106e270d06
+  data.tar.gz: 2441a9bfaf1a3b38568a568ac82ea277eec76ca827f33435d2851850d908da22eec4c3c57a8a5bf1476f9446739ac8d64c220e9177cfc12042b4d9ca61f0b4dd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
+
+before_install: gem install bundler -v 1.10.6
+bundler_args: --without guard
+
+sudo: false
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+source "https://rubygems.org"
+gemspec
+
+group :guard do
+  gem "guard-rspec",    :require => nil
+  gem "guard-rubocop",  :require => nil
+end
+
+group :test do
+  gem "codeclimate-test-reporter", :require => nil
+end

data/Guardfile

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+ignore %r{^\.gem/}
+
+def rspec_opts
+  { :cmd => "bundle exec rspec" }
+end
+
+def rubocop_opts
+  { :all_on_start => false, :keep_failed => false, :cli => "-r finstyle" }
+end
+
+group :red_green_refactor, :halt_on_fail => true do
+  guard :rspec, rspec_opts do
+    watch(%r{^spec/(.*)_spec\.rb})
+    watch(%r{^lib/(.*)([^/]+)\.rb})   { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+    watch(%r{^spec/spec_helper\.rb})  { "spec" }
+  end
+
+  guard :rubocop, rubocop_opts do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Fletcher Nichol (<fnichol@chef.io>)
+
+Copyright (C) 2015, Chef Software Inc.
+
+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/README.md

@@ -0,0 +1,43 @@
+# Kitchen::InSpec - A Test Kitchen Verifier for InSpec
+
+This is the kitchen driver for [InSpec](https://github.com/chef/inspec). Please find an [example here](https://github.com/chef/inspec/tree/master/examples/test-kitchen)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kitchen-inspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-inspec
+
+## Usage
+
+In your .kitchen.yml include
+```
+verifier:
+  name: inspec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kitchen-inspec.
+
+## License
+
+Apache 2.0 (see [LICENSE][license])
+
+[license]: https://github.com/chef/kitchen-inspec/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run all test suites"
+task :test => [:spec]
+
+task :default => :spec
+
+require "cane/rake_task"
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = "./.cane"
+end
+
+require "finstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib/kitchen"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :style, :stats]
+
+task :default => [:test, :quality]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kitchen/inspec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kitchen-inspec.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kitchen/verifier/inspec_version"
+require "English"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitchen-inspec"
+  spec.version       = Kitchen::Verifier::INSPEC_VERSION
+  spec.license       = "Apache 2.0"
+  spec.authors       = ["Fletcher Nichol"]
+  spec.email         = ["fnichol@chef.io"]
+
+  spec.summary       = "A Test Kitchen Verifier for InSpec"
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/chef/kitchen-inspec"
+
+  spec.files         = `git ls-files -z`.split("\x0").
+    reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "test-kitchen", "~> 1.4"
+  spec.add_dependency "inspec", "~> 0.9"
+
+  spec.add_development_dependency "countloc", "~> 0.4"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  spec.add_development_dependency "finstyle",  "1.5.0"
+  spec.add_development_dependency "cane",      "2.6.2"
+end

data/lib/kitchen/verifier/inspec.rb

@@ -0,0 +1,143 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@chef.io>)
+# Author:: Christoph Hartmann (<chartmann@chef.io>)
+#
+# Copyright (C) 2015, Chef Software Inc.
+#
+# 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/inspec_version"
+require "kitchen/verifier/base"
+
+require "uri"
+
+module Kitchen
+
+  module Verifier
+
+    # InSpec verifier for Kitchen.
+    #
+    # @author Fletcher Nichol <fnichol@chef.io>
+    class Inspec < Kitchen::Verifier::Base
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::Verifier::INSPEC_VERSION
+
+      # (see Base#call)
+      def call(state)
+        transport_data = instance.transport.diagnose.merge(state)
+
+        runner_options = case (name = instance.transport.name.downcase)
+                         when "ssh"
+                           runner_options_for_ssh(transport_data)
+                         when "winrm"
+                           runner_options_for_winrm(transport_data)
+                         else
+                           raise Kitchen::UserError, "Verifier #{name}",
+                             " does not support the #{name} Transport"
+                         end
+        tests = local_suite_files
+
+        runner = ::Inspec::Runner.new(runner_options)
+        runner.add_tests(tests)
+        debug("Running specs from: #{tests.inspect}")
+        runner.run
+      end
+
+      private
+
+      # Determines whether or not a local workstation file exists under a
+      # Chef-related directory.
+      #
+      # @return [truthy,falsey] whether or not a given file is some kind of
+      #   Chef-related file
+      # @api private
+      def chef_data_dir?(base, file)
+        file =~ %r{^#{base}/(data|data_bags|environments|nodes|roles)/}
+      end
+
+      # (see Base#load_needed_dependencies!)
+      def load_needed_dependencies!
+        require "inspec"
+      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, "**/*_spec.rb")
+        Dir.glob(glob).reject do |f|
+          chef_data_dir?(base, f) || File.directory?(f)
+        end
+      end
+
+      # Returns a configuration Hash that can be passed to a `Inspec::Runner`.
+      #
+      # @return [Hash] a configuration hash of string-based keys
+      # @api private
+      def runner_options_for_ssh(config_data)
+        kitchen = instance.transport.send(:connection_options, config_data).dup
+
+        opts = {
+          "backend" => "ssh",
+          "logger" => logger,
+          # pass-in sudo config from kitchen verifier
+          "sudo" => config[:sudo],
+          "host" => kitchen[:hostname],
+          "port" => kitchen[:port],
+          "user" => kitchen[:username],
+          "keepalive" => kitchen[:keepalive],
+          "keepalive_interval" => kitchen[:keepalive_interval],
+          "connection_timeout" => kitchen[:timeout],
+          "connection_retries" => kitchen[:connection_retries],
+          "connection_retry_sleep" => kitchen[:connection_retry_sleep],
+          "max_wait_until_ready" => kitchen[:max_wait_until_ready],
+          "compression" => kitchen[:compression],
+          "compression_level" => kitchen[:compression_level]
+        }
+        opts["key_files"] = kitchen[:keys] unless kitchen[:keys].nil?
+        opts["password"] = kitchen[:password] unless kitchen[:password].nil?
+
+        opts
+      end
+
+      # Returns a configuration Hash that can be passed to a `Inspec::Runner`.
+      #
+      # @return [Hash] a configuration hash of string-based keys
+      # @api private
+      def runner_options_for_winrm(config_data)
+        kitchen = instance.transport.send(:connection_options, config_data).dup
+
+        opts = {
+          "backend" => "winrm",
+          "logger" => logger,
+          "host" => URI(kitchen[:endpoint]).hostname,
+          "port" => URI(kitchen[:endpoint]).port,
+          "user" => kitchen[:user],
+          "password" => kitchen[:pass],
+          "connection_retries" => kitchen[:connection_retries],
+          "connection_retry_sleep" => kitchen[:connection_retry_sleep],
+          "max_wait_until_ready" => kitchen[:max_wait_until_ready]
+        }
+
+        opts
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/inspec_version.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@chef.io>)
+# Author:: Christoph Hartmann (<chartmann@chef.io>)
+#
+# Copyright (C) 2015, Chef Software Inc.
+#
+# 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
+
+  module Verifier
+
+    # Version string for InSpec Kitchen verifier
+    INSPEC_VERSION = "0.9.0"
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-inspec
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Fletcher Nichol
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-03 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: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: countloc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: finstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: A Test Kitchen Verifier for InSpec
+email:
+- fnichol@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kitchen-inspec.gemspec
+- lib/kitchen/verifier/inspec.rb
+- lib/kitchen/verifier/inspec_version.rb
+homepage: http://github.com/chef/kitchen-inspec
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen Verifier for InSpec
+test_files: []
+has_rdoc: