inspec 4.3.2 → 4.6.3

data/lib/inspec/dependencies/requirement.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-require 'inspec/cached_fetcher'
-require 'semverse'
+require "inspec/cached_fetcher"
+require "semverse"
 
 module Inspec
   #
@@ -9,7 +8,7 @@ module Inspec
   #
   class Requirement
     def self.from_metadata(dep, cache, opts)
-      raise 'Cannot load empty dependency.' if dep.nil? || dep.empty?
+      raise "Cannot load empty dependency." if dep.nil? || dep.empty?
 
       req_path = opts[:cwd]
 
@@ -82,13 +81,13 @@ module Inspec
 
     def to_hash
       h = {
-        'name' => name,
-        'resolved_source' => resolved_source,
-        'version_constraints' => version_constraints,
+        "name" => name,
+        "resolved_source" => resolved_source,
+        "version_constraints" => version_constraints,
       }
 
       if !dependencies.empty?
-        h['dependencies'] = dependencies.map(&:to_hash)
+        h["dependencies"] = dependencies.map(&:to_hash)
       end
 
       h

data/lib/inspec/dependencies/resolver.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-# author: Steven Danna <steve@chef.io>
-require 'inspec/log'
-require 'inspec/errors'
+require "inspec/log"
+require "inspec/errors"
 
 module Inspec
   #
@@ -37,7 +35,7 @@ module Inspec
       deps.each do |dep|
         if seen_items_local.include?(dep.name)
           problem_cookbook = if top_level
-                               'the inspec.yml for this profile.'
+                               "the inspec.yml for this profile."
                              else
                                "the dependency information for #{path_string.split(' ').last}"
                              end
@@ -49,7 +47,7 @@ module Inspec
     end
 
     # Here deps is an Array of Inspec::Requirement
-    def resolve(deps, top_level = true, seen_items = {}, path_string = '') # rubocop:disable Metrics/AbcSize
+    def resolve(deps, top_level = true, seen_items = {}, path_string = "") # rubocop:disable Metrics/AbcSize
       graph = {}
       if top_level
         Inspec::Log.debug("Starting traversal of dependencies #{deps.map(&:to_s)}")
@@ -81,7 +79,7 @@ module Inspec
         end
       end
 
-      Inspec::Log.debug('Dependency traversal complete.') if top_level
+      Inspec::Log.debug("Dependency traversal complete.") if top_level
       graph
     end
   end

data/lib/inspec/describe.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
 module Inspec
   class DescribeBase
     def initialize(action)
@@ -17,11 +13,11 @@ module Inspec
     def one(&block)
       return unless block_given?
       instance_eval(&block)
-      @action.call('describe.one', @checks, nil)
+      @action.call("describe.one", @checks, nil)
     end
 
     def describe(*args, &block)
-      @checks.push(['describe', args, block])
+      @checks.push(["describe", args, block])
     end
   end
 end

data/lib/inspec/dist.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Inspec
+  module Dist
+    # When referencing a product directly, like InSpec
+    PRODUCT_NAME = "Chef InSpec"
+
+    # The inspec executable
+    EXEC_NAME = "inspec"
+
+    # The name of the server product
+    SERVER_PRODUCT_NAME = "Chef Server"
+
+    # name of the automate product
+    AUTOMATE_PRODUCT_NAME = "Chef Automate"
+
+    # name of the compliance product
+    COMPLIANCE_PRODUCT_NAME = "Chef Compliance"
+  end
+end

data/lib/inspec/dsl.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
 # copyright: 2015, Dominik Richter
-# author: Dominik Richter
-# author: Christoph Hartmann
-require 'inspec/log'
-require 'inspec/plugin/v2'
+require "inspec/log"
+require "inspec/plugin/v2"
 
 module Inspec::DSL
   def require_controls(id, &block)
@@ -20,7 +17,7 @@ module Inspec::DSL
   alias include_rules include_controls
 
   def require_resource(options = {})
-    raise 'You must specify a specific resource name when calling require_resource()' if options[:resource].nil?
+    raise "You must specify a specific resource name when calling require_resource()" if options[:resource].nil?
 
     from_profile = options[:profile] || profile_name
     target_name = options[:as] || options[:resource]
@@ -84,7 +81,7 @@ module Inspec::DSL
     # remove all rules that were not registered
     context.all_rules.each do |r|
       id = Inspec::Rule.rule_id(r)
-      fid = Inspec::Rule.profile_id(r) + '/' + id
+      fid = Inspec::Rule.profile_id(r) + "/" + id
       unless include_ctx.rules[id] || include_ctx.rules[fid]
         context.remove_rule(fid)
       end

data/lib/inspec/dsl_shared.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Inspec
   #
   # Contains methods we would like in multiple DSL
@@ -10,7 +9,7 @@ module Inspec
       alias __ruby_require require
 
       def require(path)
-        rbpath = path + '.rb'
+        rbpath = path + ".rb"
         return __ruby_require(path) if !@require_loader.exists?(rbpath)
         return false if @require_loader.loaded?(rbpath)
 

data/lib/inspec/env_printer.rb

@@ -1,16 +1,15 @@
-# encoding: utf-8
-require 'inspec/shell_detector'
-require 'erb'
-require 'shellwords'
+require "inspec/shell_detector"
+require "erb"
+require "shellwords"
 
 module Inspec
   class EnvPrinter
     attr_reader :shell
 
     EVAL_COMMANDS = {
-      'bash' => 'eval \"$(inspec env bash)\"',
-      'fish' => 'inspec env fish > ~/.config/fish/completions/inspec.fish',
-      'zsh' => 'eval \"$(inspec env zsh)\"',
+      "bash" => 'eval \"$(inspec env bash)\"',
+      "fish" => "inspec env fish > ~/.config/fish/completions/inspec.fish",
+      "zsh" => 'eval \"$(inspec env zsh)\"',
     }.freeze
 
     def initialize(command_class, shell = nil)
@@ -36,7 +35,7 @@ module Inspec
     private
 
     def print_completion_for_shell
-      erb = ERB.new(File.read(completion_template_path), nil, '-')
+      erb = ERB.new(File.read(completion_template_path), nil, "-")
       puts erb.result(TemplateContext.new(@command_class).get_bindings)
     end
 
@@ -49,7 +48,7 @@ module Inspec
     end
 
     def completion_dir
-      File.join(File.dirname(__FILE__), 'completions')
+      File.join(File.dirname(__FILE__), "completions")
     end
 
     def completion_template_path
@@ -57,7 +56,7 @@ module Inspec
     end
 
     def shells_with_completions
-      Dir.glob("#{completion_dir}/*.sh.erb").map { |f| File.basename(f, '.sh.erb') }
+      Dir.glob("#{completion_dir}/*.sh.erb").map { |f| File.basename(f, ".sh.erb") }
     end
 
     def print_usage_guidance
@@ -91,7 +90,7 @@ module Inspec
 
     def exit_no_shell
       if @detected
-        $stderr.puts '# Unable to automatically detect shell and no shell was provided.'
+        $stderr.puts "# Unable to automatically detect shell and no shell was provided."
       end
       $stderr.puts <<~EOF
         #
@@ -109,7 +108,7 @@ module Inspec
         @command_class = command_class
       end
 
-      def get_bindings # rubocop:disable Style/AccessorMethodName
+      def get_bindings # rubocop:disable Naming/AccessorMethodName
         binding
       end
 

data/lib/inspec/errors.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
 module Inspec
   class Error < StandardError; end
 

data/lib/inspec/exceptions.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # copyright: 2017, Chef Software Inc.
 
 module Inspec

data/lib/inspec/expect.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
 # copyright: 2016, Chef Software Inc.
-# author: Dominik Richter
-# author: Christoph Hartmann
 
-require 'rspec/expectations'
+require "rspec/expectations"
 
 module Inspec
   class Expect
@@ -25,11 +22,11 @@ module Inspec
     def example_group
       that = self
 
-      opts = { 'caller' => calls[0][3] }
+      opts = { "caller" => calls[0][3] } # TODO: this needs overhaul. no magic #s
       if !calls[0][3].nil? && !calls[0][3].empty? &&
-         (m = calls[0][3][0].match(/^([^:]*):(\d+):/))
-        opts['file_path'] = m[0]
-        opts['line_number'] = m[1]
+          (m = calls[0][3][0].match(/^([^:]*):(\d+):/))
+        opts["file_path"] = m[0]
+        opts["line_number"] = m[1]
       end
 
       RSpec::Core::ExampleGroup.describe(that.value, opts) do

data/lib/inspec/fetcher.rb

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/plugin/v1'
+require "inspec/plugin/v1"
 
 module Inspec
   class FetcherRegistry < PluginRegistry
@@ -33,15 +29,16 @@ module Inspec
 
   def self.fetcher(version)
     if version != 1
-      raise 'Only fetcher version 1 is supported!'
+      raise "Only fetcher version 1 is supported!"
     end
     Inspec::Plugins::Fetcher
   end
 end
 
-require 'fetchers/local'
-require 'fetchers/url'
-require 'fetchers/git'
+# TODO: remove. require up, not down.
+require "fetchers/local"
+require "fetchers/url"
+require "fetchers/git"
 
 # TODO: Remove in 4.0 when Compliance fetcher plugin is created
-require 'plugins/inspec-compliance/lib/inspec-compliance/api'
+require "plugins/inspec-compliance/lib/inspec-compliance/api"

data/lib/inspec/file_provider.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
-require 'rubygems/package'
-require 'zlib'
-require 'zip'
+require "rubygems/package"
+require "pathname"
+require "zlib"
+require "zip"
 
 module Inspec
   class FileProvider
@@ -10,9 +10,9 @@ module Inspec
         MockProvider.new(path)
       elsif File.directory?(path)
         DirProvider.new(path)
-      elsif File.exist?(path) && path.end_with?('.tar.gz', 'tgz')
+      elsif File.exist?(path) && path.end_with?(".tar.gz", "tgz")
         TarProvider.new(path)
-      elsif File.exist?(path) && path.end_with?('.zip')
+      elsif File.exist?(path) && path.end_with?(".zip")
         ZipProvider.new(path)
       elsif File.exist?(path)
         DirProvider.new(path)
@@ -72,7 +72,7 @@ module Inspec
       @files = if File.file?(path)
                  [path]
                else
-                 Dir[File.join(Shellwords.shellescape(path), '**', '*')]
+                 Dir[File.join(Shellwords.shellescape(path), "**", "*")]
                end
       @path = path
     end
@@ -99,13 +99,13 @@ module Inspec
       @files = []
       walk_zip(@path) do |io|
         while (entry = io.get_next_entry)
-          name = entry.name.sub(%r{/+$}, '')
-          @files.push(name) unless name.empty? || name.squeeze('/') =~ %r{\.{2}(?:/|\z)}
+          name = entry.name.sub(%r{/+$}, "")
+          @files.push(name) unless name.empty? || name.squeeze("/") =~ %r{\.{2}(?:/|\z)}
         end
       end
     end
 
-    def extract(destination_path = '.')
+    def extract(destination_path = ".")
       FileUtils.mkdir_p(destination_path)
 
       Zip::File.open(@path) do |archive|
@@ -156,17 +156,17 @@ module Inspec
         @files = tar.find_all(&:file?)
 
         # delete all entries with no name
-        @files = @files.find_all { |x| !x.full_name.empty? && x.full_name.squeeze('/') !~ %r{\.{2}(?:/|\z)} }
+        @files = @files.find_all { |x| !x.full_name.empty? && x.full_name.squeeze("/") !~ %r{\.{2}(?:/|\z)} }
 
         # delete all entries that have a PaxHeader
-        @files = @files.delete_if { |x| x.full_name.include?('PaxHeader/') }
+        @files = @files.delete_if { |x| x.full_name.include?("PaxHeader/") }
 
         # replace all items of the array simply with the relative filename of the file
-        @files.map! { |x| Pathname.new(x.full_name).relative_path_from(Pathname.new('.')).to_s }
+        @files.map! { |x| Pathname.new(x.full_name).relative_path_from(Pathname.new(".")).to_s }
       end
     end
 
-    def extract(destination_path = '.')
+    def extract(destination_path = ".")
       FileUtils.mkdir_p(destination_path)
 
       walk_tar(@path) do |files|
@@ -179,7 +179,7 @@ module Inspec
           FileUtils.remove_entry(final_path) if File.exist?(final_path)
 
           FileUtils.mkdir_p(File.dirname(final_path))
-          File.open(final_path, 'wb') { |f| f.write(file.read) }
+          File.open(final_path, "wb") { |f| f.write(file.read) }
         end
       end
     end
@@ -214,8 +214,8 @@ module Inspec
 
   class RelativeFileProvider
     BLACKLIST_FILES = [
-      '/pax_global_header',
-      'pax_global_header',
+      "/pax_global_header",
+      "pax_global_header",
     ].freeze
 
     attr_reader :files
@@ -239,7 +239,7 @@ module Inspec
                      .map { |x| x[prefix.length..-1] }
                      .map do |x|
                        path = Pathname.new(x)
-                       path.absolute? ? path.to_s : path.relative_path_from(Pathname.new('.')).to_s
+                       path.absolute? ? path.to_s : path.relative_path_from(Pathname.new(".")).to_s
                      end
     end
 
@@ -259,7 +259,7 @@ module Inspec
     private
 
     def get_prefix(fs)
-      return '' if fs.empty?
+      return "" if fs.empty?
 
       # filter backlisted files
       fs -= BLACKLIST_FILES
@@ -288,15 +288,15 @@ module Inspec
     end
 
     def get_files_prefix(fs)
-      return '' if fs.empty?
+      return "" if fs.empty?
 
       file = fs[0]
       bn = File.basename(file)
       # no more prefixes
-      return '' if bn == file
+      return "" if bn == file
 
       i = file.rindex(bn)
-      pre = file[0..i-1]
+      pre = file[0..i - 1]
 
       rest = fs.find_all { |f| !f.start_with?(pre) }
       return pre if rest.empty?
@@ -304,8 +304,8 @@ module Inspec
       new_pre = get_prefix(rest)
       return new_pre if pre.start_with? new_pre
       # edge case: completely different prefixes; retry prefix detection
-      a = File.dirname(pre + 'a')
-      b = File.dirname(new_pre + 'b')
+      a = File.dirname(pre + "a")
+      b = File.dirname(new_pre + "b")
       get_prefix([a, b])
     end
   end

data/lib/inspec/formatters.rb

@@ -1,3 +1,3 @@
-require 'inspec/formatters/base'
-require 'inspec/formatters/json_rspec'
-require 'inspec/formatters/show_progress'
+require "inspec/formatters/base"
+require "inspec/formatters/json_rspec"
+require "inspec/formatters/show_progress"

data/lib/inspec/formatters/base.rb

@@ -1,5 +1,5 @@
-require 'rspec/core'
-require 'rspec/core/formatters/base_formatter'
+require "rspec/core"
+require "rspec/core/formatters/base_formatter"
 
 module Inspec::Formatters
   class Base < RSpec::Core::Formatters::BaseFormatter
@@ -43,7 +43,7 @@ module Inspec::Formatters
           next unless e
 
           if example.metadata[:sensitive]
-            hash[:message] = '*** sensitive output suppressed ***'
+            hash[:message] = "*** sensitive output suppressed ***"
           else
             hash[:message] = exception_message(e)
           end
@@ -101,9 +101,9 @@ module Inspec::Formatters
 
       all_unique_controls.each do |control|
         next unless control[:results]
-        if control[:results].any? { |r| r[:status] == 'failed' }
+        if control[:results].any? { |r| r[:status] == "failed" }
           failed += 1
-        elsif control[:results].any? { |r| r[:status] == 'skipped' }
+        elsif control[:results].any? { |r| r[:status] == "skipped" }
           skipped += 1
         else
           passed += 1
@@ -162,8 +162,8 @@ module Inspec::Formatters
         res[:profile_id] = pid
       end
 
-      if res[:status] == 'pending'
-        res[:status] = 'skipped'
+      if res[:status] == "pending"
+        res[:status] = "skipped"
         res[:skip_message] = example.metadata[:description]
         res[:resource] = example.metadata[:described_class].to_s
       end
@@ -173,7 +173,7 @@ module Inspec::Formatters
 
     def format_expectation_message(example)
       if (example.metadata[:example_group][:description_args].first == example.metadata[:example_group][:described_class]) ||
-         example.metadata[:example_group][:described_class].nil?
+          example.metadata[:example_group][:described_class].nil?
         example.metadata[:description]
       else
         "#{example.metadata[:example_group][:description]} #{example.metadata[:description]}"