inspec 2.1.81 → 2.1.83

data/lib/inspec/formatters/json_rspec.rb

@@ -1,20 +1,20 @@
-module Inspec::Formatters
-  class RspecJson < RSpec::Core::Formatters::JsonFormatter
-    RSpec::Core::Formatters.register self
-
-    private
-
-    # We are cheating and overriding a private method in RSpec's core JsonFormatter.
-    # This is to avoid having to repeat this id functionality in both dump_summary
-    # and dump_profile (both of which call format_example).
-    # See https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/formatters/json_formatter.rb
-    #
-    # rspec's example id here corresponds to an inspec test's control name -
-    # either explicitly specified or auto-generated by rspec itself.
-    def format_example(example)
-      res = super(example)
-      res[:id] = example.metadata[:id]
-      res
-    end
-  end
-end
+module Inspec::Formatters
+  class RspecJson < RSpec::Core::Formatters::JsonFormatter
+    RSpec::Core::Formatters.register self
+
+    private
+
+    # We are cheating and overriding a private method in RSpec's core JsonFormatter.
+    # This is to avoid having to repeat this id functionality in both dump_summary
+    # and dump_profile (both of which call format_example).
+    # See https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/formatters/json_formatter.rb
+    #
+    # rspec's example id here corresponds to an inspec test's control name -
+    # either explicitly specified or auto-generated by rspec itself.
+    def format_example(example)
+      res = super(example)
+      res[:id] = example.metadata[:id]
+      res
+    end
+  end
+end

data/lib/inspec/formatters/show_progress.rb

@@ -1,12 +1,12 @@
-module Inspec::Formatters
-  class ShowProgress < RSpec::Core::Formatters::ProgressFormatter
-    RSpec::Core::Formatters.register self
-
-    # remove summary output from progress
-    %w{dump_summary dump_failures dump_pending message seed start_dump}.each do |m|
-      define_method(m) do |*args|
-        # override
-      end
-    end
-  end
-end
+module Inspec::Formatters
+  class ShowProgress < RSpec::Core::Formatters::ProgressFormatter
+    RSpec::Core::Formatters.register self
+
+    # remove summary output from progress
+    %w{dump_summary dump_failures dump_pending message seed start_dump}.each do |m|
+      define_method(m) do |*args|
+        # override
+      end
+    end
+  end
+end

data/lib/inspec/library_eval_context.rb

@@ -1,58 +1,58 @@
-# encoding: utf-8
-# author: Steven Danna
-# author: Victoria Jeffrey
-require 'inspec/plugins/resource'
-require 'inspec/dsl_shared'
-
-module Inspec
-  #
-  # LibaryEvalContext constructs an instance of an anonymous class
-  # that library files will be instance_exec'd against.
-  #
-  # The anonymous class ensures that `Inspec.resource(1)` will return
-  # an anonymouse class that is suitable as the parent class of an
-  # inspec resource. The class returned will have the resource
-  # registry used by all dsl methods bound to the resource registry
-  # passed into the #create constructor.
-  #
-  #
-  class LibraryEvalContext
-    def self.create(registry, require_loader)
-      c = Class.new do
-        extend Inspec::ResourceDSL
-        include Inspec::ResourceBehaviors
-        define_singleton_method :__resource_registry do
-          registry
-        end
-      end
-
-      c2 = Class.new do
-        define_singleton_method :resource do |version|
-          Inspec.validate_resource_dsl_version!(version)
-          c
-        end
-      end
-
-      c3 = Class.new do
-        include Inspec::DSL::RequireOverride
-        def initialize(require_loader)
-          @require_loader = require_loader
-          @inspec_binding = nil
-        end
-
-        def __inspec_binding
-          @inspec_binding
-        end
-      end
-
-      c3.const_set(:Inspec, c2)
-      res = c3.new(require_loader)
-
-      # Provide the local binding for this context which is necessary for
-      # calls to `require` to create all dependent objects in the correct
-      # context.
-      res.instance_variable_set('@inspec_binding', res.instance_eval('binding'))
-      res
-    end
-  end
-end
+# encoding: utf-8
+# author: Steven Danna
+# author: Victoria Jeffrey
+require 'inspec/plugins/resource'
+require 'inspec/dsl_shared'
+
+module Inspec
+  #
+  # LibaryEvalContext constructs an instance of an anonymous class
+  # that library files will be instance_exec'd against.
+  #
+  # The anonymous class ensures that `Inspec.resource(1)` will return
+  # an anonymouse class that is suitable as the parent class of an
+  # inspec resource. The class returned will have the resource
+  # registry used by all dsl methods bound to the resource registry
+  # passed into the #create constructor.
+  #
+  #
+  class LibraryEvalContext
+    def self.create(registry, require_loader)
+      c = Class.new do
+        extend Inspec::ResourceDSL
+        include Inspec::ResourceBehaviors
+        define_singleton_method :__resource_registry do
+          registry
+        end
+      end
+
+      c2 = Class.new do
+        define_singleton_method :resource do |version|
+          Inspec.validate_resource_dsl_version!(version)
+          c
+        end
+      end
+
+      c3 = Class.new do
+        include Inspec::DSL::RequireOverride
+        def initialize(require_loader)
+          @require_loader = require_loader
+          @inspec_binding = nil
+        end
+
+        def __inspec_binding
+          @inspec_binding
+        end
+      end
+
+      c3.const_set(:Inspec, c2)
+      res = c3.new(require_loader)
+
+      # Provide the local binding for this context which is necessary for
+      # calls to `require` to create all dependent objects in the correct
+      # context.
+      res.instance_variable_set('@inspec_binding', res.instance_eval('binding'))
+      res
+    end
+  end
+end

data/lib/inspec/log.rb

@@ -1,11 +1,11 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'mixlib/log'
-
-module Inspec
-  class Log
-    extend Mixlib::Log
-  end
-end
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'mixlib/log'
+
+module Inspec
+  class Log
+    extend Mixlib::Log
+  end
+end

data/lib/inspec/metadata.rb

@@ -1,247 +1,247 @@
-# encoding: utf-8
-# Copyright 2015 Dominik Richter
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'logger'
-require 'rubygems/version'
-require 'rubygems/requirement'
-require 'semverse'
-require 'utils/spdx'
-
-module Inspec
-  # Extract metadata.rb information
-  # A Metadata object may be created and finalized with invalid data.
-  # This allows the check CLI command to analyse the issues.
-  # Use valid? to determine if the metadata is coherent.
-  class Metadata
-    attr_reader :ref
-    attr_accessor :params, :content
-    def initialize(ref, logger = nil)
-      @ref = ref
-      @logger = logger || Logger.new(nil)
-      @content = ''
-      @params = {}
-      @missing_methods = []
-    end
-
-    %w{
-      name
-      title
-      maintainer
-      maintainer_email
-      copyright
-      copyright_email
-      license
-      summary
-      description
-      version
-      inspec_version
-    }.each do |name|
-      define_method name.to_sym do |arg|
-        params[name.to_sym] = arg
-      end
-    end
-
-    def dependencies
-      params[:depends] || []
-    end
-
-    def supports(sth, version = nil)
-      # Ignore supports with metadata.rb. This file is legacy and the way it
-      # it handles `supports` deprecated. A deprecation warning will be printed
-      # already.
-    end
-
-    def inspec_requirement
-      # using Gem::Requirement here to allow nil values which
-      # translate to [">= 0"]
-      Gem::Requirement.create(params[:inspec_version])
-    end
-
-    def supports_runtime?
-      running = Gem::Version.new(Inspec::VERSION)
-      inspec_requirement.satisfied_by?(running)
-    end
-
-    def supports_platform?(backend)
-      backend.platform.supported?(params[:supports])
-    end
-
-    # return all warn and errors
-    def valid # rubocop:disable Metrics/AbcSize
-      errors = []
-      warnings = []
-
-      %w{name version}.each do |field|
-        next unless params[field.to_sym].nil?
-        errors.push("Missing profile #{field} in #{ref}")
-      end
-
-      if params[:name] =~ %r{[\/\\]}
-        warnings.push("Your profile name (#{params[:name]}) contains a slash " \
-          'which will not be permitted in InSpec 2.0. Please change your profile ' \
-          'name in the `inspec.yml` file.')
-      end
-
-      # if version is set, ensure it is correct
-      if !params[:version].nil? && !valid_version?(params[:version])
-        errors.push('Version needs to be in SemVer format')
-      end
-
-      %w{title summary maintainer copyright license}.each do |field|
-        next unless params[field.to_sym].nil?
-        warnings.push("Missing profile #{field} in #{ref}")
-      end
-
-      # if version is set, ensure it is in SPDX format
-      if !params[:license].nil? && !Spdx.valid_license?(params[:license])
-        warnings.push("License '#{params[:license]}' needs to be in SPDX format. See https://spdx.org/licenses/.")
-      end
-
-      [errors, warnings]
-    end
-
-    # returns true or false
-    def valid?
-      errors, _warnings = valid
-      errors.empty? && unsupported.empty?
-    end
-
-    def valid_version?(value)
-      Semverse::Version.new(value)
-      true
-    rescue Semverse::InvalidVersionFormat
-      false
-    end
-
-    def method_missing(sth, *args)
-      @logger.warn "#{ref} doesn't support: #{sth} #{args}"
-      @missing_methods.push(sth)
-    end
-
-    def unsupported
-      @missing_methods
-    end
-
-    def self.symbolize_keys(obj)
-      return obj.map { |i| symbolize_keys(i) } if obj.is_a?(Array)
-      return obj unless obj.is_a?(Hash)
-
-      obj.each_with_object({}) do |(k, v), h|
-        v = symbolize_keys(v) if v.is_a?(Hash)
-        v = symbolize_keys(v) if v.is_a?(Array)
-        h[k.to_sym] = v
-      end
-    end
-
-    def self.finalize_supports_elem(elem, logger)
-      case x = elem
-      when Hash
-        x[:release] = x[:release].to_s if x[:release]
-        x
-      when Array
-        logger.warn(
-          'Failed to read supports entry that is an array. Please use '\
-          'the `supports: {os-family: xyz}` syntax.',
-        )
-        nil
-      when nil then nil
-      else
-        logger ||= Logger.new(nil)
-        logger.warn(
-          "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
-          "supports:\n  - os-family: #{x}\n\n",
-        )
-        { :'os-family' => x } # rubocop:disable Style/HashSyntax
-      end
-    end
-
-    def self.finalize_supports(supports, logger)
-      case x = supports
-      when Hash   then [finalize_supports_elem(x, logger)]
-      when Array  then x.map { |e| finalize_supports_elem(e, logger) }.compact
-      when nil    then []
-      else
-        logger ||= Logger.new(nil)
-        logger.warn(
-          "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
-          "supports:\n  - os-family: #{x}\n\n",
-        )
-        [{ :'os-family' => x }] # rubocop:disable Style/HashSyntax
-      end
-    end
-
-    def self.finalize_name(metadata, profile_id, original_target)
-      # profile_id always overwrites whatever already exists as the name
-      unless profile_id.to_s.empty?
-        metadata.params[:name] = profile_id.to_s
-        return
-      end
-
-      # don't overwrite an existing name
-      return unless metadata.params[:name].nil?
-
-      # if there's a title, there is no need to set a name too
-      return unless metadata.params[:title].nil?
-
-      # create a new name based on the original target if it exists
-      # Crudely slug the target to not contain slashes, to avoid breaking
-      # unit tests that look for warning sequences
-      return if original_target.to_s.empty?
-      metadata.params[:title] = "tests from #{original_target}"
-      metadata.params[:name] = metadata.params[:title].gsub(%r{[\\\/]}, '.')
-    end
-
-    def self.finalize(metadata, profile_id, options, logger = nil)
-      return nil if metadata.nil?
-      param = metadata.params || {}
-      options ||= {}
-      param['version'] = param['version'].to_s unless param['version'].nil?
-      metadata.params = symbolize_keys(param)
-      metadata.params[:supports] = finalize_supports(metadata.params[:supports], logger)
-      finalize_name(metadata, profile_id, options[:target])
-
-      metadata
-    end
-
-    def self.from_yaml(ref, content, profile_id, logger = nil)
-      res = Metadata.new(ref, logger)
-      res.params = YAML.load(content)
-      res.content = content
-      finalize(res, profile_id, {}, logger)
-    end
-
-    def self.from_ruby(ref, content, profile_id, logger = nil)
-      res = Metadata.new(ref, logger)
-      res.instance_eval(content, ref, 1)
-      res.content = content
-      finalize(res, profile_id, {}, logger)
-    end
-
-    def self.from_ref(ref, content, profile_id, logger = nil)
-      # NOTE there doesn't have to exist an actual file, it may come from an
-      # archive (i.e., content)
-      case File.basename(ref)
-      when 'inspec.yml'
-        from_yaml(ref, content, profile_id, logger)
-      when 'metadata.rb'
-        from_ruby(ref, content, profile_id, logger)
-      else
-        logger ||= Logger.new(nil)
-        logger.error "Don't know how to handle metadata in #{ref}"
-        nil
-      end
-    end
-
-    def self.from_file(path, profile_id, logger = nil)
-      unless File.file?(path)
-        logger ||= Logger.new(nil)
-        logger.error "Can't find metadata file #{path}"
-        return nil
-      end
-
-      from_ref(File.basename(path), File.read(path), profile_id, logger)
-    end
-  end
-end
+# encoding: utf-8
+# Copyright 2015 Dominik Richter
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'logger'
+require 'rubygems/version'
+require 'rubygems/requirement'
+require 'semverse'
+require 'utils/spdx'
+
+module Inspec
+  # Extract metadata.rb information
+  # A Metadata object may be created and finalized with invalid data.
+  # This allows the check CLI command to analyse the issues.
+  # Use valid? to determine if the metadata is coherent.
+  class Metadata
+    attr_reader :ref
+    attr_accessor :params, :content
+    def initialize(ref, logger = nil)
+      @ref = ref
+      @logger = logger || Logger.new(nil)
+      @content = ''
+      @params = {}
+      @missing_methods = []
+    end
+
+    %w{
+      name
+      title
+      maintainer
+      maintainer_email
+      copyright
+      copyright_email
+      license
+      summary
+      description
+      version
+      inspec_version
+    }.each do |name|
+      define_method name.to_sym do |arg|
+        params[name.to_sym] = arg
+      end
+    end
+
+    def dependencies
+      params[:depends] || []
+    end
+
+    def supports(sth, version = nil)
+      # Ignore supports with metadata.rb. This file is legacy and the way it
+      # it handles `supports` deprecated. A deprecation warning will be printed
+      # already.
+    end
+
+    def inspec_requirement
+      # using Gem::Requirement here to allow nil values which
+      # translate to [">= 0"]
+      Gem::Requirement.create(params[:inspec_version])
+    end
+
+    def supports_runtime?
+      running = Gem::Version.new(Inspec::VERSION)
+      inspec_requirement.satisfied_by?(running)
+    end
+
+    def supports_platform?(backend)
+      backend.platform.supported?(params[:supports])
+    end
+
+    # return all warn and errors
+    def valid # rubocop:disable Metrics/AbcSize
+      errors = []
+      warnings = []
+
+      %w{name version}.each do |field|
+        next unless params[field.to_sym].nil?
+        errors.push("Missing profile #{field} in #{ref}")
+      end
+
+      if params[:name] =~ %r{[\/\\]}
+        warnings.push("Your profile name (#{params[:name]}) contains a slash " \
+          'which will not be permitted in InSpec 2.0. Please change your profile ' \
+          'name in the `inspec.yml` file.')
+      end
+
+      # if version is set, ensure it is correct
+      if !params[:version].nil? && !valid_version?(params[:version])
+        errors.push('Version needs to be in SemVer format')
+      end
+
+      %w{title summary maintainer copyright license}.each do |field|
+        next unless params[field.to_sym].nil?
+        warnings.push("Missing profile #{field} in #{ref}")
+      end
+
+      # if version is set, ensure it is in SPDX format
+      if !params[:license].nil? && !Spdx.valid_license?(params[:license])
+        warnings.push("License '#{params[:license]}' needs to be in SPDX format. See https://spdx.org/licenses/.")
+      end
+
+      [errors, warnings]
+    end
+
+    # returns true or false
+    def valid?
+      errors, _warnings = valid
+      errors.empty? && unsupported.empty?
+    end
+
+    def valid_version?(value)
+      Semverse::Version.new(value)
+      true
+    rescue Semverse::InvalidVersionFormat
+      false
+    end
+
+    def method_missing(sth, *args)
+      @logger.warn "#{ref} doesn't support: #{sth} #{args}"
+      @missing_methods.push(sth)
+    end
+
+    def unsupported
+      @missing_methods
+    end
+
+    def self.symbolize_keys(obj)
+      return obj.map { |i| symbolize_keys(i) } if obj.is_a?(Array)
+      return obj unless obj.is_a?(Hash)
+
+      obj.each_with_object({}) do |(k, v), h|
+        v = symbolize_keys(v) if v.is_a?(Hash)
+        v = symbolize_keys(v) if v.is_a?(Array)
+        h[k.to_sym] = v
+      end
+    end
+
+    def self.finalize_supports_elem(elem, logger)
+      case x = elem
+      when Hash
+        x[:release] = x[:release].to_s if x[:release]
+        x
+      when Array
+        logger.warn(
+          'Failed to read supports entry that is an array. Please use '\
+          'the `supports: {os-family: xyz}` syntax.',
+        )
+        nil
+      when nil then nil
+      else
+        logger ||= Logger.new(nil)
+        logger.warn(
+          "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
+          "supports:\n  - os-family: #{x}\n\n",
+        )
+        { :'os-family' => x } # rubocop:disable Style/HashSyntax
+      end
+    end
+
+    def self.finalize_supports(supports, logger)
+      case x = supports
+      when Hash   then [finalize_supports_elem(x, logger)]
+      when Array  then x.map { |e| finalize_supports_elem(e, logger) }.compact
+      when nil    then []
+      else
+        logger ||= Logger.new(nil)
+        logger.warn(
+          "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
+          "supports:\n  - os-family: #{x}\n\n",
+        )
+        [{ :'os-family' => x }] # rubocop:disable Style/HashSyntax
+      end
+    end
+
+    def self.finalize_name(metadata, profile_id, original_target)
+      # profile_id always overwrites whatever already exists as the name
+      unless profile_id.to_s.empty?
+        metadata.params[:name] = profile_id.to_s
+        return
+      end
+
+      # don't overwrite an existing name
+      return unless metadata.params[:name].nil?
+
+      # if there's a title, there is no need to set a name too
+      return unless metadata.params[:title].nil?
+
+      # create a new name based on the original target if it exists
+      # Crudely slug the target to not contain slashes, to avoid breaking
+      # unit tests that look for warning sequences
+      return if original_target.to_s.empty?
+      metadata.params[:title] = "tests from #{original_target}"
+      metadata.params[:name] = metadata.params[:title].gsub(%r{[\\\/]}, '.')
+    end
+
+    def self.finalize(metadata, profile_id, options, logger = nil)
+      return nil if metadata.nil?
+      param = metadata.params || {}
+      options ||= {}
+      param['version'] = param['version'].to_s unless param['version'].nil?
+      metadata.params = symbolize_keys(param)
+      metadata.params[:supports] = finalize_supports(metadata.params[:supports], logger)
+      finalize_name(metadata, profile_id, options[:target])
+
+      metadata
+    end
+
+    def self.from_yaml(ref, content, profile_id, logger = nil)
+      res = Metadata.new(ref, logger)
+      res.params = YAML.load(content)
+      res.content = content
+      finalize(res, profile_id, {}, logger)
+    end
+
+    def self.from_ruby(ref, content, profile_id, logger = nil)
+      res = Metadata.new(ref, logger)
+      res.instance_eval(content, ref, 1)
+      res.content = content
+      finalize(res, profile_id, {}, logger)
+    end
+
+    def self.from_ref(ref, content, profile_id, logger = nil)
+      # NOTE there doesn't have to exist an actual file, it may come from an
+      # archive (i.e., content)
+      case File.basename(ref)
+      when 'inspec.yml'
+        from_yaml(ref, content, profile_id, logger)
+      when 'metadata.rb'
+        from_ruby(ref, content, profile_id, logger)
+      else
+        logger ||= Logger.new(nil)
+        logger.error "Don't know how to handle metadata in #{ref}"
+        nil
+      end
+    end
+
+    def self.from_file(path, profile_id, logger = nil)
+      unless File.file?(path)
+        logger ||= Logger.new(nil)
+        logger.error "Can't find metadata file #{path}"
+        return nil
+      end
+
+      from_ref(File.basename(path), File.read(path), profile_id, logger)
+    end
+  end
+end