kitchen-goss 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee7f23ceef71d0c2ef396aa1abe84a6d17f51743
+  data.tar.gz: 34db15db68c3a9e824b2a3f11e55bc31e3c4c409
+SHA512:
+  metadata.gz: dbdad7e7d29537f88bd1c1079304dd0bbaf9c58e3c392edad362396314207f27c9da7cbb259a37e7c343627b7fd76f6f890704e7b4b6ff5d66bcfabce44c2be3
+  data.tar.gz: 8ab394d7a74296e8aa7c117e126c8cf2c3b7e34c50b4398a377a0241a1a275ad8afe26d9cad0b2c49a01f277a758a2309f6be012971880a876ed077073b94e8f

data/README.md

@@ -0,0 +1,57 @@
+# kitchen-goss
+A test-kitchen verifier plugin for GOSS 
+
+## Intro
+[GOSS](https://github.com/aelsabbahy/goss.git) is a tool for validating a server's configuration. 
+This kitchen plugin adds Goss support as a validation to kitchen.
+
+## How to install 
+
+### Ruby gem
+```
+gem install kitchen-goss
+```
+
+### To install from code or develop
+``` 
+git clone git@github.com:ahelal/kitchen-goss.git
+cd kitchen-goss
+gem build kitchen-goss.gemspec
+gem install kitchen-goss-<version>.gem
+```
+
+## kitchen.yml configuration
+```yaml
+verifier                    :
+  name                      : "goss"
+```
+
+## kitchen.yml options
+Besides the normal config in kitchen.yml goss validation can accept the following options.
+
+```ruby
+default_config :sleep, 0
+default_config :goss_version, "v0.1.5"
+default_config :validate_output, "documentation"
+default_config :custom_install_command, nil
+default_config :goss_link, "https://github.com/aelsabbahy/goss/releases/download/$VERSION/goss-${DISTRO}-${ARCH}"
+default_config :goss_download_path, "/tmp/goss-${VERSION}-${DISTRO}-${ARCH}"
+```
+
+## Test structure
+Lets say you have a suite name **simple**
+the following structure we be required.
+```bash
+.kitchen.yml
+test/
+  \_integration/
+    \_simple/
+      \_goss/
+        \_test1.yml
+        |_test2.yml
+```
+
+
+##License
+
+MIT

data/kitchen-goss.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'kitchen/verifier/goss_version'
+
+Gem::Specification.new do |gem|
+  gem.name              = "kitchen-goss"
+  gem.version           = Kitchen::Verifier::GOSS_VERSION
+  gem.authors           = ["Adham Helal"]
+  gem.email             = ["adham.helal@gmail.com"]
+  gem.licenses          = ['MIT']
+  gem.homepage          = "https://github.com/ahelal/kitchen-goss"
+  gem.summary           = "A test-kitchen verifier plugin for GOSS"
+  candidates            = Dir.glob("{lib}/**/*") + ['README.md', 'kitchen-goss.gemspec']
+  gem.files             = candidates.sort
+  gem.platform          = Gem::Platform::RUBY
+  gem.require_paths     = ['lib']
+  gem.rubyforge_project = '[none]'
+  gem.description       = <<-EOF
+== DESCRIPTION:
+
+GOSS is a tool for validating a server's configuration. 
+This kitchen plugin adds Goss support as a validation to test-kitchen.
+
+== FEATURES:
+
+
+EOF
+
+  gem.add_runtime_dependency 'test-kitchen'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+
+end

data/lib/kitchen/verifier/goss.rb

@@ -0,0 +1,210 @@
+require 'kitchen/verifier/base'
+
+module Kitchen
+  module Verifier
+    class Goss < Kitchen::Verifier::Base
+      require 'mixlib/shellout'
+      require "kitchen/util"
+      require 'pathname'
+
+      kitchen_verifier_api_version 1
+      plugin_version Kitchen::VERSION
+
+      #
+      default_config :sleep, 0
+      default_config :goss_version, "v0.1.5"
+      default_config :validate_output, "documentation"
+      default_config :custom_install_command, nil
+      default_config :goss_link, "https://github.com/aelsabbahy/goss/releases/download/$VERSION/goss-${DISTRO}-${ARCH}"
+      default_config :goss_download_path, "/tmp/goss-${VERSION}-${DISTRO}-${ARCH}"
+
+      def install_command
+        # If cutom install
+        info('Installing with custom install command') if config[:custom_install_command]
+        return config[:custom_install_command] if config[:custom_install_command]
+
+        info('Checking/Installing GOSS')
+        prefix_command(wrap_shell_code(Util.outdent!(<<-CMD)))
+          ## Get helper
+          #{Kitchen::Util.shell_helpers}
+
+          #{goss_filename_flags}
+          download_url="#{config[:goss_link]}"
+          goss_download_path="#{config[:goss_download_path]}"
+          
+          ## Check do we need to download GOSS
+          if [ -f "/${goss_download_path}" ]; then
+            echo "GOSS is installed in ${goss_download_path}"
+          else
+            echo "Checking compatibility"
+            distro="$(uname)"
+            if [ "x${distro}" != "xLinux" ]; then
+              echo "Your distro '${distro}' is not supported."
+              exit 1
+            fi
+            echo "Trying to download GOSS to ${goss_download_path}"
+            do_download ${download_url} ${goss_download_path}
+            chmod +x ${goss_download_path}
+          fi
+        CMD
+      end
+
+      # (see Base#init_command)
+      def init_command
+        return if local_suite_files.empty?
+        debug("Remove root_path on remote server.")
+        <<-CMD
+          suite_dir="#{config[:root_path]}"
+          if [ "${suite_dir}" = "x" ]; then
+            echo "root_path is not configured."
+            exit 1
+          fi
+          ## Remove root_path
+          rm -rf #{config[:root_path]}
+          ## Create root_path
+          mkdir -p #{config[:root_path]}
+        CMD
+      end
+
+      # Runs the verifier on the instance.
+      #
+      # @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)
+        end
+      rescue Kitchen::Transport::TransportFailed => ex
+        if ex.message .include? "<TEST EXECUTION FAILED>"
+          raise ActionFailed, "Action #verify failed for #{instance.to_str}."
+        else
+          raise ActionFailed, ex.message
+        end
+      ensure
+        cleanup_sandbox
+      end
+
+      # (see Base#run_command)
+      def run_command
+        return if local_suite_files.empty?
+
+        debug("Running tests")
+        prefix_command(wrap_shell_code(Util.outdent!(<<-CMD)))
+          set +e
+          #{goss_filename_flags}
+          command_validate_opts="validate --format #{config[:validate_output]}"
+          #{run_test_command}
+        CMD
+      end
+
+      # Copies all test suite files into the suites directory in the sandbox.
+      #
+      # @api private
+      def prepare_suites
+        base = File.join(config[:test_base_path], config[:suite_name])
+
+        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
+
+      # 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, "goss/**/*")
+        #testfiles = Dir.glob(glob).reject { |f| File.directory?(f) }
+        Dir.glob(glob).reject { |f| File.directory?(f) }
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_suites
+      end
+
+      # @return [String] path to suites directory under sandbox path
+      # @api private
+      def sandbox_suites_dir
+        File.join(sandbox_path, "suites")
+      end
+
+      # @return [String] the run command to execute tests
+      # @api private
+      def run_test_command
+        <<-CMD
+          if [ ! -x "#{config[:goss_download_path]}" ]; then
+              echo "Something failed cant execute '${command}'"
+              exit 1
+          fi
+
+          test_failed=0
+          for VARIABLE in #{get_test_name}
+          do
+            #{config[:goss_download_path]} -g ${VARIABLE} ${command_validate_opts}
+            if [ "$?" -ne 0 ]; then
+              test_failed=1
+            fi
+          done
+
+          # Check exit code
+          if [ "$test_failed" -ne 0 ]; then
+            test_failed=1
+            echo "<TEST EXECUTION FAILED>"
+          fi
+          exit ${test_failed}
+        CMD
+      end
+
+      def goss_filename_flags
+          <<-CMD
+           ## Set the flags for GOSS command path
+           VERSION="#{config[:goss_version]}"
+           DISTRO="$(uname)"
+           ## Need improvements
+           if [ "$(uname -m)" = "x86_64" ]; then
+             ARCH="amd64"
+           else
+             ARCH="386"
+           fi
+          CMD
+      end
+
+      def get_test_name
+        base_path = File.join(config[:test_base_path], config[:suite_name])
+        remote_base_path = File.join(config[:root_path], "suites")
+        all_tests = ""
+        local_suite_files.each do |test_file|
+           all_tests += " " +  test_file.sub(base_path, remote_base_path)
+        end
+        all_tests
+      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
+
+    end
+  end
+end

data/lib/kitchen/verifier/goss_version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Kitchen
+  module Verifier
+    GOSS_VERSION = '0.0.2'
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-goss
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adham Helal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: "== DESCRIPTION:\n\nGOSS is a tool for validating a server's configuration.
+  \nThis kitchen plugin adds Goss support as a validation to test-kitchen.\n\n== FEATURES:\n\n\n"
+email:
+- adham.helal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- kitchen-goss.gemspec
+- lib/kitchen/verifier/goss.rb
+- lib/kitchen/verifier/goss_version.rb
+homepage: https://github.com/ahelal/kitchen-goss
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: A test-kitchen verifier plugin for GOSS
+test_files: []