inspec 3.0.0 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ca6936485ca0d43d8e2a6d4a666d00d35a0b34213395edf195e3464922ac05c
-  data.tar.gz: 4af42fb90e856a6fdbb03da658caf5e5a299ab490655abdee8901d292425011c
+  metadata.gz: 6f49689c3694c4ec3a2c9128df201e1ac81ffdf4981948d343d5396ed6599f1b
+  data.tar.gz: cc3f864f342fba8a7f404f69727e807cb12a397683ae2e2a217d4efd89a25586
 SHA512:
-  metadata.gz: b292beb653ebc321790748a416f99a0f0b5d9c8248e34af8ed1206d1f67764f09c9336ab61c2d8bbe2d8fa134d1faf4e4363636e4388f18b4b632ba49e9b7721
-  data.tar.gz: 335128b72b28c6b66cf9d2d9beac4a4540a597415fe019b250597e9a6dc9db33a987c7223a5999fa243c5ef9d27d2a2c284f1d5ab5662a6742f4e1ad79a40836
+  metadata.gz: 1dc4515fa59a0412e2c97d2a3b2ccc80fda17b93d823e9865eb14428da5c58d3dedadc59e999c97fc09d9c5290840176403fb8d5b5d03bc9508a34f1e9fc5f79
+  data.tar.gz: 779e7a23b102ebe6cb28d4d6ba03e95c0975691d6835ee830f40e52ad326deeb450e1a3e90f8503d013eef10251706aab2d85fb4fb8b10ffab86d229cc505a41

data/CHANGELOG.md

@@ -1,29 +1,46 @@
 # Change Log
 <!-- usage documentation: http://expeditor-docs.es.chef.io/configuration/changelog/ -->
-<!-- latest_release unreleased -->
-## Unreleased
+<!-- latest_release 3.0.9 -->
+## [v3.0.9](https://github.com/inspec/inspec/tree/v3.0.9) (2018-10-18)
 
-#### Enhancements
-- Inspec 3.0 [#3512](https://github.com/inspec/inspec/pull/3512) ([jquick](https://github.com/jquick))
+#### Merged Pull Requests
+- Add missing tests for groups resource, document members property, and assorted fixes. [#3467](https://github.com/inspec/inspec/pull/3467) ([miah](https://github.com/miah))
 <!-- latest_release -->
 
-<!-- release_rollup since=2.3.24 -->
-### Changes since 2.3.24 release
+<!-- release_rollup since=3.0.0 -->
+### Changes since 3.0.0 release
 
 #### Enhancements
-- Inspec 3.0 [#3512](https://github.com/inspec/inspec/pull/3512) ([jquick](https://github.com/jquick)) <!-- 3.0.0 -->
+- Minor cleanups of plugin documentation. &#39;Plugin&#39; instead of &#39;PluginDefinition&#39; [#3527](https://github.com/inspec/inspec/pull/3527) ([mattray](https://github.com/mattray)) <!-- 3.0.5 -->
+
+#### Bug Fixes
+- Fixes corrupt plugins.json when testing a plugin outside of core [#3526](https://github.com/inspec/inspec/pull/3526) ([clintoncwolfe](https://github.com/clintoncwolfe)) <!-- 3.0.7 -->
+- FilterTable: allow Strings or Symbols as fields [#3481](https://github.com/inspec/inspec/pull/3481) ([clintoncwolfe](https://github.com/clintoncwolfe)) <!-- 3.0.2 -->
 
 #### Merged Pull Requests
-- Update the text on the generic default attribute [#3508](https://github.com/inspec/inspec/pull/3508) ([jquick](https://github.com/jquick)) <!-- 2.3.26 -->
-- Change `Inspec ` to `InSpec ` where appropriate [#3494](https://github.com/inspec/inspec/pull/3494) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 2.3.25 -->
+- Add missing tests for groups resource, document members property, and assorted fixes. [#3467](https://github.com/inspec/inspec/pull/3467) ([miah](https://github.com/miah)) <!-- 3.0.9 -->
+- Pin inspec to the new train [#3531](https://github.com/inspec/inspec/pull/3531) ([jquick](https://github.com/jquick)) <!-- 3.0.8 -->
+- Add debug and sort options for plugins [#3530](https://github.com/inspec/inspec/pull/3530) ([jquick](https://github.com/jquick)) <!-- 3.0.6 -->
+- docs: Fix small issues with the `file` resource [#3515](https://github.com/inspec/inspec/pull/3515) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 3.0.4 -->
+- Filter out inspec-k8s and inspec-release [#3525](https://github.com/inspec/inspec/pull/3525) ([miah](https://github.com/miah)) <!-- 3.0.3 -->
+- style: Fix quotes/style on the `docker` resource [#3516](https://github.com/inspec/inspec/pull/3516) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 3.0.1 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v3.0.0](https://github.com/inspec/inspec/tree/v3.0.0) (2018-10-15)
+
+#### Enhancements
+- Inspec 3.0 [#3512](https://github.com/inspec/inspec/pull/3512) ([jquick](https://github.com/jquick))
+
+#### Merged Pull Requests
+- Change `Inspec ` to `InSpec ` where appropriate [#3494](https://github.com/inspec/inspec/pull/3494) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+- Update the text on the generic default attribute [#3508](https://github.com/inspec/inspec/pull/3508) ([jquick](https://github.com/jquick))
+<!-- latest_stable_release -->
+
 ## [v2.3.24](https://github.com/inspec/inspec/tree/v2.3.24) (2018-10-12)
 
 #### Bug Fixes
 - Fix plugin install issues in different ruby envs [#3505](https://github.com/inspec/inspec/pull/3505) ([jquick](https://github.com/jquick))
-<!-- latest_stable_release -->
 
 ## [v2.3.23](https://github.com/inspec/inspec/tree/v2.3.23) (2018-10-12)
 

data/etc/plugin_filters.json

@@ -5,10 +5,18 @@
       "plugin_name": "inspec-core",
       "rationale": "This gem is a stripped-down alternate packaging of InSpec. It is not a plugin."
     },
+    {
+      "plugin_name": "inspec-k8s",
+      "rationale": "This gem is currently only a placeholder, waiting to be built."
+    },
     {
       "plugin_name": "inspec-multi-server",
       "rationale": "This gem is a script that attempts to drive a parallel execution of InSpec by wrapping and forking. It is not a plugin."
     },
+    {
+      "plugin_name": "inspec-release",
+      "rationale": "It is not plugin."
+    },
     {
       "plugin_name": "train-tax-calculator",
       "rationale": "This gem is a tax calculation tool for the Philippines. It has nothing to do the Chef Train remote execution framework, or the InSpec project."
@@ -22,4 +30,4 @@
       "rationale": "This gem is a stripped-down alternate packaging of Train. It is not a plugin."
     }
   ]
-}
+}

data/inspec.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'train', '~> 1.5'
+  spec.add_dependency 'train', '~> 1.5', '>= 1.5.4'
   spec.add_dependency 'thor', '~> 0.20'
   spec.add_dependency 'json', '>= 1.8', '< 3.0'
   spec.add_dependency 'method_source', '~> 0.8'

data/lib/inspec/plugin/v2/installer.rb

@@ -119,7 +119,7 @@ module Inspec::Plugin::V2
     # @option opts [TrueClass, FalseClass] :exact If true, use plugin_search_term exactly.  If false (default), append a wildcard.
     # @option opts [Symbol] :scope Which versions to search for.  :released (default) - all released versions.  :prerelease - Also include versioned marked prerelease. :latest - only return one version, the latest one.
     # @return [Hash of Arrays] - Keys are String names of gems, arrays contain String versions.
-    def search(plugin_query, opts = {})
+    def search(plugin_query, opts = {}) # rubocop: disable Metrics/AbcSize
       validate_search_opts(plugin_query, opts)
 
       fetcher = Gem::SpecFetcher.fetcher
@@ -133,6 +133,9 @@ module Inspec::Plugin::V2
         end
       end
 
+      # sort tuples
+      matched_tuples.sort! { |a, b| b.first.version <=> a.first.version }
+
       gem_info = {}
       matched_tuples.each do |tuple|
         gem_info[tuple.first.name] ||= []

data/lib/inspec/plugin/v2/plugin_types/cli.rb

@@ -2,6 +2,16 @@ require 'inspec/base_cli'
 
 module Inspec::Plugin::V2::PluginType
   class CliCommand < Inspec::BaseCLI
+    # initalize log options for plugins
+    def initialize(args, options, config)
+      super(args, options, config)
+      class_options = config.fetch(:class_options, nil)
+      if class_options
+        Inspec::Log.init(class_options['log_location']) if class_options.key?('log_location')
+        Inspec::Log.level = get_log_level(class_options['log_level']) if class_options.key?('log_level')
+      end
+    end
+
     # This class MUST inherit from Thor, which makes it a bit awkward to register the plugin subtype
     # Since we can't inherit from PluginBase, we use the two-arg form of register_plugin_type
     Inspec::Plugin::V2::PluginBase.register_plugin_type(:cli_command, self)
@@ -23,5 +33,12 @@ module Inspec::Plugin::V2::PluginType
       # Register with Thor
       Inspec::InspecCLI.register(self, subcommand_name, @usage_msg, @desc_msg, {})
     end
+
+    # Allow plugins to use inspec log settings
+    class_option :log_level, type: :string,
+                 desc: 'Set the log level: info (default), debug, warn, error'
+
+    class_option :log_location, type: :string,
+                desc: 'Location to send diagnostic log messages to. (default: STDOUT or Inspec::Log.error)'
   end
 end

data/lib/inspec/version.rb

@@ -4,5 +4,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '3.0.0'
+  VERSION = '3.0.9'
 end

data/lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli/cli_command.rb

@@ -367,6 +367,7 @@ module InspecPlugins
         puts 'If you disagree with this determination, please accept our apologies for the misunderstanding, and open an issue at https://github.com/inspec/inspec/issues/new'
         exit 2
       rescue Inspec::Plugin::V2::InstallError
+        raise if Inspec::Log.level == :debug
         results = installer.search(plugin_name, exact: true)
         if results.empty?
           puts(red { 'No such plugin gem ' } + plugin_name + ' could be found on rubygems.org - installation failed.')

data/lib/plugins/inspec-plugin-manager-cli/test/functional/inspec-plugin_test.rb

@@ -567,6 +567,14 @@ class PluginManagerCliInstall < MiniTest::Test
       assert_includes refusal_message, 'github.com/inspec/inspec/issues/new'
     end
   end
+
+  def test_error_install_with_debug_enabled
+    install_result = run_inspec_process_with_this_plugin('plugin install inspec-test-fixture -v 0.1.1 --log-level debug')
+
+    assert_equal 1, install_result.exit_status, 'Exit status should be 1'
+    assert_includes install_result.stdout, 'DEBUG'
+    assert_includes install_result.stderr, "can't activate rake"
+  end
 end
 
 

data/lib/plugins/shared/core_plugin_test_helper.rb

@@ -133,6 +133,7 @@ module CorePluginFunctionalHelper
       'installation_type' => 'path',
       'installation_path' => path,
     }
+    data
   end
 
   def __make_empty_plugin_file_data_structure

data/lib/resources/docker.rb

@@ -37,13 +37,13 @@ module Inspec::Resources
   class DockerImageFilter
     filter = FilterTable.create
     filter.register_custom_matcher(:exists?) { |x| !x.entries.empty? }
-    filter.register_column(:ids,              field: 'id')
-          .register_column(:repositories,     field: 'repository')
-          .register_column(:tags,             field: 'tag')
-          .register_column(:sizes,            field: 'size')
-          .register_column(:digests,          field: 'digest')
-          .register_column(:created,          field: 'createdat')
-          .register_column(:created_since,    field: 'createdsize')
+    filter.register_column(:ids,           field: 'id')
+          .register_column(:repositories,  field: 'repository')
+          .register_column(:tags,          field: 'tag')
+          .register_column(:sizes,         field: 'size')
+          .register_column(:digests,       field: 'digest')
+          .register_column(:created,       field: 'createdat')
+          .register_column(:created_since, field: 'createdsize')
     filter.install_filter_methods_on_resource(self, :images)
 
     attr_reader :images
@@ -54,10 +54,10 @@ module Inspec::Resources
 
   class DockerPluginFilter
     filter = FilterTable.create
-    filter.add(:ids,              field: 'id')
-          .add(:names,            field: 'name')
-          .add(:versions,         field: 'version')
-          .add(:enabled,          field: 'enabled')
+    filter.add(:ids,      field: 'id')
+          .add(:names,    field: 'name')
+          .add(:versions, field: 'version')
+          .add(:enabled,  field: 'enabled')
     filter.connect(self, :plugins)
 
     attr_reader :plugins
@@ -69,12 +69,12 @@ module Inspec::Resources
   class DockerServiceFilter
     filter = FilterTable.create
     filter.register_custom_matcher(:exists?) { |x| !x.entries.empty? }
-    filter.register_column(:ids,              field: 'id')
-          .register_column(:names,            field: 'name')
-          .register_column(:modes,            field: 'mode')
-          .register_column(:replicas,         field: 'replicas')
-          .register_column(:images,           field: 'image')
-          .register_column(:ports,            field: 'ports')
+    filter.register_column(:ids,      field: 'id')
+          .register_column(:names,    field: 'name')
+          .register_column(:modes,    field: 'mode')
+          .register_column(:replicas, field: 'replicas')
+          .register_column(:images,   field: 'image')
+          .register_column(:ports,    field: 'ports')
     filter.install_filter_methods_on_resource(self, :services)
 
     attr_reader :services

data/lib/resources/groups.rb

@@ -51,7 +51,7 @@ module Inspec::Resources
     filter.register_column(:names,     field: 'name')
           .register_column(:gids,      field: 'gid')
           .register_column(:domains,   field: 'domain')
-          .register_column(:members,   field: 'members')
+          .register_column(:members,   field: 'members', style: :simple)
     filter.install_filter_methods_on_resource(self, :collect_group_details)
 
     def to_s
@@ -73,10 +73,6 @@ module Inspec::Resources
   #   its('gid') { should eq 0 }
   # end
   #
-  # deprecated has matcher
-  # describe group('root') do
-  #  it { should have_gid 0 }
-  # end
   class Group < Inspec.resource(1)
     include GroupManagementSelector
 
@@ -112,13 +108,7 @@ module Inspec::Resources
       flatten_entry(group_info, 'gid')
     end
 
-    # implements rspec has matcher, to be compatible with serverspec
-    def has_gid?(compare_gid)
-      gid == compare_gid
-    end
-
     def members
-      return unless inspec.os.windows?
       flatten_entry(group_info, 'members')
     end
 
@@ -223,7 +213,7 @@ module Inspec::Resources
       end
 
       # ensure we have an array of groups
-      groups = [groups] if !groups.is_a?(Array)
+      groups = [groups] unless groups.is_a?(Array)
       groups
     end
   end

data/lib/utils/filter.rb

@@ -106,7 +106,7 @@ module FilterTable
       # If we were provided params, interpret them as criteria to be evaluated
       # against the raw data. Criteria are assumed to be hash keys.
       conditions.each do |raw_field_name, desired_value|
-        raise(ArgumentError, "'#{raw_field_name}' is not a recognized criterion - expected one of #{list_fields.join(', ')}'") unless field?(raw_field_name)
+        raise(ArgumentError, "'#{decorate_symbols(raw_field_name)}' is not a recognized criterion - expected one of #{decorate_symbols(list_fields).join(', ')}'") unless field?(raw_field_name)
         populate_lazy_field(raw_field_name, desired_value) if is_field_lazy?(raw_field_name)
         new_criteria_string += " #{raw_field_name} == #{desired_value.inspect}"
         filtered_raw_data = filter_raw_data(filtered_raw_data, raw_field_name, desired_value)
@@ -175,7 +175,15 @@ module FilterTable
       # Currently we only know about a field if it is present in a at least one row of the raw data.
       # If we have no rows in the raw data, assume all fields are acceptable (and rely on failing to match on value, nil)
       return true if raw_data.empty?
-      list_fields.include?(proposed_field) || is_field_lazy?(proposed_field)
+
+      # Most resources have Symbol keys in their raw data.  Some have Strings (looking at you, `shadow`).
+      is_field = false
+      is_field ||= list_fields.include?(proposed_field.to_s)
+      is_field ||= list_fields.include?(proposed_field.to_sym)
+      is_field ||= is_field_lazy?(proposed_field.to_s)
+      is_field ||= is_field_lazy?(proposed_field.to_sym)
+
+      is_field
     end
 
     def to_s
@@ -240,6 +248,8 @@ module FilterTable
     end
 
     def filter_raw_data(current_raw_data, field, desired_value)
+      return [] if current_raw_data.empty?
+
       method_ref = case desired_value
                    when Float   then method(:matches_float)
                    when Integer then method(:matches_int)
@@ -247,11 +257,21 @@ module FilterTable
                    else              method(:matches)
                    end
 
+      assume_symbolic_keyed_data = current_raw_data.first.keys.first.is_a? Symbol
+      field = assume_symbolic_keyed_data ? field.to_sym : field.to_s
+
       current_raw_data.find_all do |row|
         next unless row.key?(field)
         method_ref.call(row[field], desired_value)
       end
     end
+
+    def decorate_symbols(thing)
+      return thing.map { |t| decorate_symbols(t) } if thing.is_a?(Array)
+      return ':' + thing.to_s if thing.is_a? Symbol
+      return thing + ' (String)' if thing.is_a? String
+      thing
+    end
   end
 
   class Factory

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.9
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement