inspec-tkinfo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ef0db5c35e4ea1f8cc82ac1bdf4f128d09b82572aeffde44411967cd174dc64
+  data.tar.gz: 6f82d1cfa0dd1dfeb04c9accca20a20199a7468e5a6e6ac0a843be126d0de500
+SHA512:
+  metadata.gz: 13eace66037c8080c6e31b697677fdcdbc31decfe89abcb79791ee2d808d36054dcc5f4f30cf68d6c6687b56d3f895af99671515543c8c0e5f548c15c8afc8bf
+  data.tar.gz: 17a94644d484461014c40ab583332e6258df65b2fc430f476cdb7fcd85ad65296f7824a83e4ab12c798d91c635b287b301bb284d3774fe1ca63c0a42eaf82de5

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+gemspec
+
+gem "inspec-bin"
+
+group :development do
+  gem "chefstyle", "0.13.0"
+  gem "m"
+  gem "bundler"
+  gem "minitest"
+  gem "rake"
+  gem "rubocop"
+end

data/README.md

@@ -0,0 +1,33 @@
+# inspec-tkinfo
+
+InSpec plugin to retrieve Test Kitchen data as inputs.
+
+## Use Case
+
+In some cases you want to get info about the Test Kitchen environment that
+your InSpec verifier is running in. This plugin offers some insight into
+instance name, platform name and suite name.
+
+## Installation
+
+Simply execute `inspec plugin install inspec-tkinfo`, which will get
+the plugin from RubyGems and install/register it with InSpec.
+
+You can verify successful installation via `inspec plugin list`
+
+## Usage
+
+You have three input names available:
+- KITCHEN_INSTANCE_NAME ('default-amazon2')
+- KITCHEN_SUITE_NAME ('default')
+- KITCHEN_PLATFORM_NAME ('amazon2')
+
+Use them in your InSpec tests like this:
+
+```ruby
+instance_name = input('KITCHEN_INSTANCE_NAME')
+
+describe file("/etc/#{instance_name}") do
+  it { should exist }
+end
+```

data/inspec-tkinfo.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+# As plugins are usually packaged and distributed as a RubyGem,
+# we have to provide a .gemspec file, which controls the gembuild
+# and publish process.  This is a fairly generic gemspec.
+
+# It is traditional in a gemspec to dynamically load the current version
+# from a file in the source tree.  The next three lines make that happen.
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "inspec-tkinfo/version"
+
+Gem::Specification.new do |spec|
+  # Importantly, all InSpec plugins must be prefixed with `inspec-` (most
+  # plugins) or `train-` (plugins which add new connectivity features).
+  spec.name          = "inspec-tkinfo"
+
+  # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
+  spec.version       = InspecPlugins::TKInfo::VERSION
+  spec.authors       = ["Thomas Heinen"]
+  spec.email         = ["theinen@tecracer.de"]
+  spec.summary       = "InSpec plugin to retrieve Test Kitchen data as inputs."
+  spec.description   = "Allows reading instance name, suite name and platform name in tests."
+  spec.homepage      = "https://github.com/tecracer-theinen/inspec-tkinfo"
+  spec.license       = "Apache-2.0"
+
+  # Though complicated-looking, this is pretty standard for a gemspec.
+  # It just filters what will actually be packaged in the gem (leaving
+  # out tests, etc)
+  spec.files = %w{
+    README.md inspec-tkinfo.gemspec Gemfile
+  } + Dir.glob(
+    "lib/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bump", "~> 0.8"
+  spec.add_development_dependency "minitest", "~> 5.11"
+end

data/lib/inspec-tkinfo.rb

@@ -0,0 +1,4 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "inspec-tkinfo/plugin"

data/lib/inspec-tkinfo/input.rb

@@ -0,0 +1,55 @@
+module InspecPlugins
+  module TKInfo
+    class Input < Inspec.plugin(2, :input)
+
+      # ========================================================================
+      # Dependency Injection
+
+      attr_writer :kitchen_instance
+
+      def kitchen_instance
+        require "binding_of_caller"
+
+        @kitchen_instance ||= binding.callers.find { |b| b.frame_description == "verify_action" }.receiver
+      end
+
+      # ========================================================================
+      # Input Plugin API
+
+      # Fetch method used for Input plugins
+      def fetch(_profile_name, input)
+        return nil unless valid_plugin_input?(input)
+
+        raise "Plugin can only be run via TestKitchen" unless inside_testkitchen?
+
+        case input
+        when "KITCHEN_INSTANCE_NAME"
+          kitchen_instance.name
+        when "KITCHEN_SUITE_NAME"
+          kitchen_instance.suite.name
+        when "KITCHEN_PLATFORM_NAME"
+          kitchen_instance.platform.name
+        end
+      end
+
+      private
+
+      # ========================================================================
+      # Helper Methods
+
+      # Verify if input is valid for this plugin
+      def valid_plugin_input?(input)
+        %w{
+          KITCHEN_INSTANCE_NAME
+          KITCHEN_SUITE_NAME
+          KITCHEN_PLATFORM_NAME
+        }.include? input
+      end
+
+      # Check if this is called from within TestKitchen
+      def inside_testkitchen?
+        !! defined?(::Kitchen)
+      end
+    end
+  end
+end

data/lib/inspec-tkinfo/plugin.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+# Plugin Definition file
+# The purpose of this file is to declare to InSpec what plugin_types (capabilities)
+# are included in this plugin, and provide hooks that will load them as needed.
+
+# It is important that this file load successfully and *quickly*.
+# Your plugin's functionality may never be used on this InSpec run; so we keep things
+# fast and light by only loading heavy things when they are needed.
+
+require "inspec-tkinfo/version"
+module InspecPlugins
+  module TKInfo
+    class Plugin < ::Inspec.plugin(2)
+      # Internal machine name of the plugin. InSpec will use this in errors, etc.
+      plugin_name :'inspec-tkinfo'
+
+      # Define an Input plugin type.
+      input :tkinfo do
+        require_relative "input.rb"
+        InspecPlugins::TKInfo::Input
+      end
+    end
+  end
+end

data/lib/inspec-tkinfo/version.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+# This file simply makes it easier for CI engines to update
+# the version stamp, and provide a clean way for the gemspec
+# to learn the current version.
+module InspecPlugins
+  module TKInfo
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: inspec-tkinfo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Heinen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: Allows reading instance name, suite name and platform name in tests.
+email:
+- theinen@tecracer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- inspec-tkinfo.gemspec
+- lib/inspec-tkinfo.rb
+- lib/inspec-tkinfo/input.rb
+- lib/inspec-tkinfo/plugin.rb
+- lib/inspec-tkinfo/version.rb
+homepage: https://github.com/tecracer-theinen/inspec-tkinfo
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: InSpec plugin to retrieve Test Kitchen data as inputs.
+test_files: []