inspec 4.3.2 → 4.6.3

data/lib/inspec/secrets.rb

@@ -1,18 +1,14 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'inspec/plugin/v1'
+require "inspec/plugin/v1"
 
 module Inspec
   SecretsBackend = PluginRegistry.new
 
   def self.secrets(version)
     if version != 1
-      raise 'Only secrets version 1 is supported!'
+      raise "Only secrets version 1 is supported!"
     end
     Inspec::Plugins::Secret
   end
 end
 
-require 'inspec/secrets/yaml'
+require "inspec/secrets/yaml"

data/lib/inspec/secrets/yaml.rb

@@ -1,15 +1,13 @@
-# encoding: utf-8
-
-require 'yaml'
+require "yaml"
 
 module Secrets
   class YAML < Inspec.secrets(1)
-    name 'yaml'
+    name "yaml"
 
     attr_reader :inputs
 
     def self.resolve(target)
-      unless target.is_a?(String) && File.file?(target) && ['.yml', '.yaml'].include?(File.extname(target).downcase)
+      unless target.is_a?(String) && File.file?(target) && [".yml", ".yaml"].include?(File.extname(target).downcase)
         return nil
       end
       new(target)

data/lib/inspec/shell.rb

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'pry'
+require "pry"
 
 module Inspec
   # A pry based shell for inspec. Given a runner (with a configured backend and
@@ -19,7 +15,7 @@ module Inspec
       # context creates to evaluate each individual test file. We want to
       # pretend like we are constantly appending to the same file and want
       # to capture the local variable context from inside said class.
-      @ctx_binding = @runner.eval_with_virtual_profile('binding')
+      @ctx_binding = @runner.eval_with_virtual_profile("binding")
       configure_pry
       @ctx_binding.pry
     end
@@ -35,28 +31,28 @@ module Inspec
       that = self
 
       # Add the help command
-      Pry::Commands.block_command 'help', 'Show examples' do |resource|
+      Pry::Commands.block_command "help", "Show examples" do |resource|
         that.help(resource)
       end
 
       # configure pry shell prompt
-      Pry.config.prompt_name = 'inspec'
+      Pry.config.prompt_name = "inspec"
       Pry.prompt = [proc { "#{readline_ignore("\e[1m\e[32m")}#{Pry.config.prompt_name}> #{readline_ignore("\e[0m")}" }]
 
       # Add a help menu as the default intro
-      Pry.hooks.add_hook(:before_session, 'inspec_intro') do
+      Pry.hooks.add_hook(:before_session, "inspec_intro") do
         intro
         print_target_info
       end
 
       # Track the rules currently registered and what their merge count is.
-      Pry.hooks.add_hook(:before_eval, 'inspec_before_eval') do
+      Pry.hooks.add_hook(:before_eval, "inspec_before_eval") do
         @runner.reset
       end
 
       # After pry has evaluated a commanding within the binding context of a
       # test file, register all the rules it discovered.
-      Pry.hooks.add_hook(:after_eval, 'inspec_after_eval') do
+      Pry.hooks.add_hook(:after_eval, "inspec_after_eval") do
         @runner.load
         @runner.run_tests if !@runner.all_rules.empty?
       end
@@ -81,7 +77,7 @@ module Inspec
     end
 
     def intro
-      puts 'Welcome to the interactive InSpec Shell'
+      puts "Welcome to the interactive InSpec Shell"
       puts "To find out how to use it, type: #{mark 'help'}"
       puts
     end
@@ -114,13 +110,13 @@ module Inspec
 
           #{print_target_info}
         EOF
-      elsif topic == 'resources'
+      elsif topic == "resources"
         resources.sort.each do |resource|
           puts " - #{resource}"
         end
-      elsif topic == 'matchers'
+      elsif topic == "matchers"
         print_matchers_help
-      elsif !Inspec::Resource.registry[topic].nil?
+      elsif !Inspec::Resource.registry[topic].nil? # TODO: fix unnecessary logic
         topic_info = Inspec::Resource.registry[topic]
         info = "#{mark 'Name:'} #{topic}\n\n"
         unless topic_info.desc.nil?

data/lib/inspec/shell_detector.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-require 'etc'
-require 'rbconfig'
+require "etc"
+require "rbconfig"
 
 module Inspec
   #
@@ -36,7 +35,7 @@ module Inspec
 
     def detect
       # Most of our detection code assumes a unix-like environment
-      return nil if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+      return nil if RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
 
       shellpath = detect_by_ppid
 
@@ -57,7 +56,7 @@ module Inspec
 
     def detect_by_ppid
       ppid = Process.ppid
-      if Dir.exist?('/proc')
+      if Dir.exist?("/proc")
         File.readlink("/proc/#{ppid}/exe")
       else
         `ps -cp #{ppid} -o command=`.chomp
@@ -65,7 +64,7 @@ module Inspec
     end
 
     def detect_by_env
-      ENV['SHELL']
+      ENV["SHELL"]
     end
 
     def detect_by_getpwuid
@@ -76,7 +75,7 @@ module Inspec
     # Strip any leading path elements
     #
     def shellname(shellpath)
-      shellpath.split('/').last
+      shellpath.split("/").last
     end
 
     #

data/lib/inspec/source_reader.rb

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/plugin/v1'
+require "inspec/plugin/v1"
 
 module Inspec
   # Pre-checking of target resolution. Make sure that SourceReader plugins
@@ -18,11 +14,11 @@ module Inspec
 
   def self.source_reader(version)
     if version != 1
-      raise 'Only source readers version 1 is supported!'
+      raise "Only source readers version 1 is supported!"
     end
     Inspec::Plugins::SourceReader
   end
 end
 
-require 'source_readers/inspec'
-require 'source_readers/flat'
+require "source_readers/inspec"
+require "source_readers/flat"

data/lib/inspec/ui.rb

@@ -1,6 +1,3 @@
-require 'tty-table'
-require 'tty-prompt'
-
 module Inspec
   # Provides simple terminal UI interaction primitives for CLI commands and plugins.
   class UI
@@ -18,15 +15,15 @@ module Inspec
     }.freeze
 
     GLYPHS = {
-      bullet: '•', # BULLET, Unicode: U+2022, UTF-8: E2 80 A2
-      check: '✔', #  HEAVY CHECK MARK, Unicode: U+2714, UTF-8: E2 9C 94
-      swirl: '↺', # ANTICLOCKWISE OPEN CIRCLE ARROW, Unicode U+21BA, UTF-8: E2 86 BA
-      script_x: '×', # MULTIPLICATION SIGN, Unicode: U+00D7, UTF-8: C3 97
-      question: '?', # normal ASCII question mark
-      em_dash: '─', # BOX DRAWINGS LIGHT HORIZONTAL Unicode: U+2500, UTF-8: E2 94 80
-      heavy_dash: '≖', # RING IN EQUAL TO, Unicode: U+2256, UTF-8: E2 89 96
-      vertical_dash: '│', # BOX DRAWINGS LIGHT VERTICAL, Unicode: U+2502, UTF-8: E2 94 82
-      table_corner: '⨀', # N-ARY CIRCLED DOT OPERATOR, Unicode: U+2A00, UTF-8: E2 A8 80
+      bullet: "•", # BULLET, Unicode: U+2022, UTF-8: E2 80 A2
+      check: "✔", #  HEAVY CHECK MARK, Unicode: U+2714, UTF-8: E2 9C 94
+      swirl: "↺", # ANTICLOCKWISE OPEN CIRCLE ARROW, Unicode U+21BA, UTF-8: E2 86 BA
+      script_x: "×", # MULTIPLICATION SIGN, Unicode: U+00D7, UTF-8: C3 97
+      question: "?", # normal ASCII question mark
+      em_dash: "─", # BOX DRAWINGS LIGHT HORIZONTAL Unicode: U+2500, UTF-8: E2 94 80
+      heavy_dash: "≖", # RING IN EQUAL TO, Unicode: U+2256, UTF-8: E2 89 96
+      vertical_dash: "│", # BOX DRAWINGS LIGHT VERTICAL, Unicode: U+2502, UTF-8: E2 94 82
+      table_corner: "⨀", # N-ARY CIRCLED DOT OPERATOR, Unicode: U+2A00, UTF-8: E2 A8 80
     }.freeze
 
     EXIT_NORMAL = 0
@@ -62,7 +59,7 @@ module Inspec
       print_or_return(str.to_s, opts[:print])
     end
 
-    def plain_line(str = '', opts = { print: true })
+    def plain_line(str = "", opts = { print: true })
       print_or_return(str.to_s + "\n", opts[:print])
     end
 
@@ -96,11 +93,11 @@ module Inspec
       end
 
       result = "\n"
-      result += ' ' + (color? ? GLYPHS[:em_dash] : '-') * dash_length + ' '
-      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:white] : ''
+      result += " " + (color? ? GLYPHS[:em_dash] : "-") * dash_length + " "
+      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:white] : ""
       result += str
-      result += color? ? ANSI_CODES[:reset] : ''
-      result += ' ' + (color? ? GLYPHS[:em_dash] : '-') * dash_length + ' '
+      result += color? ? ANSI_CODES[:reset] : ""
+      result += " " + (color? ? GLYPHS[:em_dash] : "-") * dash_length + " "
       result += "\n\n"
 
       print_or_return(result, opts[:print])
@@ -109,11 +106,11 @@ module Inspec
     # Issues a one-line message, with 'ERROR: ' prepended in bold red.
     def error(str, opts = { print: true })
       str = str.dup.to_s
-      result = ''
-      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:red] : ''
-      result += 'ERROR:'
-      result += color? ? ANSI_CODES[:reset] : ''
-      result += ' '
+      result = ""
+      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:red] : ""
+      result += "ERROR:"
+      result += color? ? ANSI_CODES[:reset] : ""
+      result += " "
       result += str
       result += "\n"
       print_or_return(result, opts[:print])
@@ -122,11 +119,11 @@ module Inspec
     # Issues a one-line message, with 'WARNING: ' prepended in bold yellow.
     def warning(str, opts = { print: true })
       str = str.dup.to_s
-      result = ''
-      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:yellow] : ''
-      result += 'WARNING:'
-      result += color? ? ANSI_CODES[:reset] : ''
-      result += ' '
+      result = ""
+      result += color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:yellow] : ""
+      result += "WARNING:"
+      result += color? ? ANSI_CODES[:reset] : ""
+      result += " "
       result += str
       result += "\n"
       print_or_return(result, opts[:print])
@@ -137,15 +134,15 @@ module Inspec
       if color?
         result = ANSI_CODES[:bold] + GLYPHS[:heavy_dash] * 80 + ANSI_CODES[:reset] + "\n"
       else
-        result = '-' * 80 + "\n"
+        result = "-" * 80 + "\n"
       end
       print_or_return(result, opts[:print])
     end
 
     # Makes a bullet point.
     def list_item(str, opts = { print: true })
-      bullet = color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:white] + GLYPHS[:bullet] + ANSI_CODES[:reset] : '*'
-      result = ' ' + bullet + ' ' + str.to_s + "\n"
+      bullet = color? ? ANSI_CODES[:bold] + ANSI_CODES[:color][:white] + GLYPHS[:bullet] + ANSI_CODES[:reset] : "*"
+      result = " " + bullet + " " + str.to_s + "\n"
       print_or_return(result, opts[:print])
     end
 
@@ -158,6 +155,8 @@ module Inspec
     #   t << ['', '', 1]
     #  end
     def table(opts = { print: true })
+      require "inspec/ui_table_helper"
+
       the_table = TableHelper.new
       yield(the_table)
 
@@ -174,13 +173,6 @@ module Inspec
       print_or_return(result, opts[:print])
     end
 
-    class TableHelper < TTY::Table
-      def header=(ary)
-        cells = ary.dup.map { |label| { value: label, alignment: :center } }
-        @header = TTY::Table::Header.new(cells)
-      end
-    end
-
     #=========================================================================#
     #                        Exit Codes
     #=========================================================================#
@@ -190,7 +182,7 @@ module Inspec
       if code_sym.is_a? Numeric
         code_int = code_sym
       else
-        code_const = ('EXIT_' + code_sym.to_s.upcase).to_sym
+        code_const = ("EXIT_" + code_sym.to_s.upcase).to_sym
         unless self.class.const_defined?(code_const)
           warning("Unrecognized exit constant #{code_const} - exit with code 1")
           exit(:usage_error)
@@ -210,8 +202,10 @@ module Inspec
     # This simply returns a TTY::Prompt object, gated on interactivity being enabled.
     def prompt
       unless interactive?
-        raise Inspec::UserInteractionRequired, 'Somthing is trying to ask the user a question, but interactivity is disabled.'
+        raise Inspec::UserInteractionRequired, "Somthing is trying to ask the user a question, but interactivity is disabled."
       end
+      require "tty-prompt"
+
       @prompt ||= TTY::Prompt.new
     end
   end

data/lib/inspec/ui_table_helper.rb

@@ -0,0 +1,12 @@
+require "tty-table"
+
+module Inspec
+  class UI
+    class TableHelper < TTY::Table
+      def header=(ary)
+        cells = ary.dup.map { |label| { value: label, alignment: :center } }
+        @header = TTY::Table::Header.new(cells)
+      end
+    end
+  end
+end

data/lib/{utils → inspec/utils}/command_wrapper.rb

@@ -1,15 +1,11 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'shellwords'
+require "shellwords"
 
 class CommandWrapper
   UNIX_SHELLS = %w{sh bash zsh ksh}.freeze
 
   def self.wrap(cmd, options)
     unless options.is_a?(Hash)
-      raise 'All options for the command wrapper must be provided as a hash. '\
+      raise "All options for the command wrapper must be provided as a hash. "\
         "You entered: #{options.inspect}. Please consult the documentation."
     end
 
@@ -21,7 +17,7 @@ class CommandWrapper
     raise "Don't know how to wrap commands for shell: #{shell.inspect}." unless UNIX_SHELLS.include?(shell)
 
     path = options[:path] || shell
-    args = options[:args] || '-c'
-    path.to_s + ' ' + args + ' ' + Shellwords.escape(cmd)
+    args = options[:args] || "-c"
+    path.to_s + " " + args + " " + Shellwords.escape(cmd)
   end
 end

data/lib/{utils → inspec/utils}/convert.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
 module Converter
   # convert the value to an integer if we have numbers only
   # otherwise we return the string

data/lib/{utils → inspec/utils}/database_helpers.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
 module DatabaseHelper
   class SQLColumn
     def initialize(row, name)
@@ -10,11 +6,11 @@ module DatabaseHelper
     end
 
     def value
-      @row.nil? ? '' : @row[@name.downcase]
+      @row.nil? ? "" : @row[@name.downcase]
     end
 
     def to_s
-      'SQL Column'
+      "SQL Column"
     end
   end
 
@@ -29,7 +25,7 @@ module DatabaseHelper
     end
 
     def to_s
-      'SQL Row'
+      "SQL Row"
     end
   end
 
@@ -73,7 +69,7 @@ module DatabaseHelper
     end
 
     def to_s
-      'SQL ResultSet'
+      "SQL ResultSet"
     end
   end
 end

data/lib/inspec/utils/deprecation.rb

@@ -0,0 +1,6 @@
+# A system to provide a unified deprecation facility for InSpec
+
+require "inspec/utils/deprecation/errors"
+require "inspec/utils/deprecation/config_file"
+require "inspec/utils/deprecation/deprecator"
+require "inspec/utils/deprecation/global_method"

data/lib/{utils → inspec/utils}/deprecation/config_file.rb

@@ -1,6 +1,6 @@
-require 'stringio'
-require 'json'
-require 'inspec/globals'
+require "stringio"
+require "json"
+require "inspec/globals"
 
 module Inspec
   module Deprecation
@@ -37,7 +37,7 @@ module Inspec
       private
 
       def open_default_config_io
-        default_path = File.join(Inspec.src_root, 'etc', 'deprecations.json')
+        default_path = File.join(Inspec.src_root, "etc", "deprecations.json")
         unless File.exist?(default_path)
           raise Inspec::Deprecation::MalformedConfigError, "Missing deprecation config file: #{default_path}"
         end
@@ -51,28 +51,28 @@ module Inspec
         validate_file_version
         validate_unknown_group_action
 
-        unless @raw_data.key?('groups')
-          raise Inspec::Deprecation::InvalidConfigFileError, 'Missing groups field'
+        unless @raw_data.key?("groups")
+          raise Inspec::Deprecation::InvalidConfigFileError, "Missing groups field"
         end
-        unless @raw_data['groups'].is_a?(Hash)
-          raise Inspec::Deprecation::InvalidConfigFileError, 'Groups field must be a Hash'
+        unless @raw_data["groups"].is_a?(Hash)
+          raise Inspec::Deprecation::InvalidConfigFileError, "Groups field must be a Hash"
         end
-        @raw_data['groups'].each do |group_name, group_info|
+        @raw_data["groups"].each do |group_name, group_info|
           validate_group_entry(group_name, group_info)
         end
       end
 
       def validate_file_version
-        unless @raw_data.key?('file_version')
-          raise Inspec::Deprecation::InvalidConfigFileError, 'Missing file_version field'
+        unless @raw_data.key?("file_version")
+          raise Inspec::Deprecation::InvalidConfigFileError, "Missing file_version field"
         end
-        unless @raw_data['file_version'] == '1.0.0'
+        unless @raw_data["file_version"] == "1.0.0"
           raise Inspec::Deprecation::InvalidConfigFileError, "Unrecognized file_version '#{@raw_data['file_version']}' - supported versions: 1.0.0"
         end
       end
 
       def validate_unknown_group_action
-        seen_action = (@raw_data['unknown_group_action'] || @unknown_group_action).to_sym
+        seen_action = (@raw_data["unknown_group_action"] || @unknown_group_action).to_sym
         unless VALID_ACTIONS.include?(seen_action)
           raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized value '#{seen_action}' for field 'unknown_group_action' - supported actions: #{VALID_ACTIONS.map(&:to_s).join(', ')}"
         end
@@ -88,15 +88,15 @@ module Inspec
 
         entry = GroupEntry.new(name.to_sym)
 
-        opts['action'] = (opts['action'] || :warn).to_sym
-        unless VALID_ACTIONS.include?(opts['action'])
+        opts["action"] = (opts["action"] || :warn).to_sym
+        unless VALID_ACTIONS.include?(opts["action"])
           raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized action for group '#{name}' - saw '#{opts['action']}', supported actions: #{VALID_ACTIONS.map(&:to_s).join(', ')}"
         end
-        entry.action = opts['action']
+        entry.action = opts["action"]
 
-        entry.suffix = opts['suffix']
-        entry.prefix = opts['prefix']
-        entry.exit_status = opts['exit_status']
+        entry.suffix = opts["suffix"]
+        entry.prefix = opts["prefix"]
+        entry.exit_status = opts["exit_status"]
 
         groups[name.to_sym] = entry
       end