inspec-chef 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afe50e575ce5384475bd4c1f0ba240df92727baf14cde3a96f35e2a474eceb8c
-  data.tar.gz: 6f51ad5775fa43d5ea7eff553608f91f24de4e3248ffcd8722fd92c4e393fba7
+  metadata.gz: f13512640633f549c0a190e61f94cc2044c9d551401ccb4371e8f1cd37cd102b
+  data.tar.gz: a47a60292470aad2385de9697c024f7457883fc64eedff78b455a79f7406b367
 SHA512:
-  metadata.gz: 645ab50c1f28a99b7b545d205aa460a819bcdc1380853ed6cbdf0538a53dfb140dd08d0733dab722c9a2cc9b9f4198ae808ff5fe0efb8a2e5ac05ca7e7d2b01a
-  data.tar.gz: e7a43170a680e81d11416e72aca2b81e85aa961ca6120fe44e2d4a0c366cebab152741336d3ff5e4ad9f06b914e66de73790ca3ae67bf59f53a4cd832b32491d
+  metadata.gz: e848365caa7f68c3a0f4509284a530f62095274540787201a458c39fdd077862765261b46d95acc9267874580c0f9045914172f5a53da284114e889831639936
+  data.tar.gz: 4ff246d1449d0266ebb3c8bb9774f7f77f0ff209f04cb9263defb492bc628d0ba964740c8fcd803a011507dca113a842a15e8797496b7319ff76cceaef8f91ce

data/README.md

@@ -21,7 +21,7 @@ the plugin from RubyGems and install/register it with InSpec.
 
 You can verify successful installation via `inspec plugin list`
 
-## Configuration
+## Configuration for Chef Infra Server
 
 Each plugin option may be set either as an environment variable, or as a plugin
 option in your Chef InSpec configuration file at ~/.inspec/config.json. For
@@ -51,6 +51,28 @@ This plugin supports the following options:
 | INSPEC_CHEF_CLIENT   | chef_api_client   | The name of the client of the Chef server to connect as |
 | INSPEC_CHEF_KEY      | chef_api_key      | Path to the private certificate identifying the node |
 
+## Configuration for TestKitchen
+
+To allow dev/prod parity, this input plugin detects if it is called from within
+TestKitchen. As these tests should not access the Chef Server (to provide the
+needed test data instead of live data), it will then revert on using the
+`data_bags_path` and `attributes` from kitchen's `provisioner` section:
+
+```yaml
+suites:
+  - name: default
+    verifier:
+      load_plugins: true
+    data_bags_path: "test/integration/data_bags"
+    attributes:
+      java:
+        install_flavor: "oracle"
+```
+
+Please note, that support for `load_plugins` is not available on versions 1.3.1
+and below of the `kitchen-inspec` verifier plugin. Please check
+[kitchen-inspec PR #247 on GitHub](https://github.com/inspec/kitchen-inspec/pull/247) for finding official versions supporting this feature.
+
 ## Usage
 
 When this plugin is loaded, you can use databag items as inputs:

data/inspec-chef.gemspec

@@ -36,4 +36,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "chef-api", "~> 0.10"
   spec.add_dependency "jmespath", "~> 1.4"
+
+  spec.add_development_dependency "bump", "~> 0.8"
 end

data/lib/inspec-chef/input.rb

@@ -16,15 +16,17 @@ module InspecPlugins::Chef
     def initialize
       @plugin_conf = Inspec::Config.cached.fetch_plugin_config("inspec-chef")
 
-      @chef_endpoint = fetch_plugin_setting("endpoint")
-      @chef_client   = fetch_plugin_setting("client")
-      @chef_api_key  = fetch_plugin_setting("key")
+      unless Inspec::Config.cached.final_options.logger.is_a?(Kitchen::Logger)
+        @chef_endpoint = fetch_plugin_setting("endpoint")
+        @chef_client   = fetch_plugin_setting("client")
+        @chef_api_key  = fetch_plugin_setting("key")
 
-      if chef_endpoint.nil? || chef_client.nil? || chef_api_key.nil?
-        raise "ERROR: Need configuration of chef endpoint, client name and api key."
-      end
+        if chef_endpoint.nil? || chef_client.nil? || chef_api_key.nil?
+          raise "ERROR: Need configuration of chef endpoint, client name and api key."
+        end
 
-      connect_to_chef_server
+        connect_to_chef_server
+      end
     end
 
     # Fetch method used for Input plugins
@@ -44,6 +46,19 @@ module InspecPlugins::Chef
 
     private
 
+    # Check if this is called from within TestKitchen
+    def inside_testkitchen?
+      !! defined?(::Kitchen::Logger)
+    end
+
+    # Reach for Kitchen data and return its evaluated config
+    def kitchen_provisioner_config
+      require 'binding_of_caller'
+      kitchen = binding.callers.find { |b| b.frame_description == 'verify' }.receiver
+
+      kitchen.provisioner.send(:provided_config)
+    end
+
     # Get plugin setting via environment, config file or default
     def fetch_plugin_setting(setting_name, default = nil)
       env_var_name = "INSPEC_CHEF_#{setting_name.upcase}"
@@ -62,14 +77,33 @@ module InspecPlugins::Chef
 
     # Retrieve a Databag item from Chef Server
     def get_databag_item(databag, item)
-      chef_api.data_bag_item.fetch(item, bag: databag).data
+      unless inside_testkitchen?
+        unless chef_api.data_bags.any? { |k| k.name == databag }
+          raise format('Databag "%s" not found on Chef Infra Server', databag)
+        end
+
+        chef_api.data_bag_item.fetch(item, bag: databag).data
+      else
+        config = kitchen_provisioner_config
+        filename = File.join(config[:data_bags_path], databag, item + '.json')
+
+        begin
+          contents = JSON.load(File.read(filename))
+        rescue
+          raise format('Error accessing databag file %s, check TestKitchen configuration', filename)
+        end
+      end
     end
 
     # Retrieve attributes of a node
     def get_attributes(node)
-      data = get_search(:node, "name:#{node}")
+      unless inside_testkitchen?
+        data = get_search(:node, "name:#{node}")
 
-      merge_attributes(data)
+        merge_attributes(data)
+      else
+        kitchen_provisioner_config[:attributes]
+      end
     end
 
     # Low-level Chef search expression

data/lib/inspec-chef/version.rb

@@ -5,6 +5,6 @@
 # to learn the current version.
 module InspecPlugins
   module Chef
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-chef
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-api
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !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'
 description: This plugin allows InSpec 'inputs' to be provided by Chef Server.
 email:
 - theinen@tecracer.de