inspec 4.18.51 → 4.18.85

data/lib/inspec/secrets.rb

@@ -1,15 +0,0 @@
-require "inspec/plugin/v1"
-
-module Inspec
-  SecretsBackend = PluginRegistry.new
-
-  def self.secrets(version)
-    if version != 1
-      raise "Only secrets version 1 is supported!"
-    end
-
-    Inspec::Plugins::Secret
-  end
-end
-
-require "inspec/secrets/yaml"

data/lib/inspec/secrets/yaml.rb

@@ -1,29 +0,0 @@
-require "yaml"
-
-module Secrets
-  class YAML < Inspec.secrets(1)
-    name "yaml"
-
-    attr_reader :inputs
-
-    def self.resolve(target)
-      unless target.is_a?(String) && File.file?(target) && [".yml", ".yaml"].include?(File.extname(target).downcase)
-        return nil
-      end
-
-      new(target)
-    end
-
-    # array of yaml file paths
-    def initialize(target)
-      @inputs = ::YAML.load_file(target)
-
-      if @inputs == false || !@inputs.is_a?(Hash)
-        Inspec::Log.warn("#{self.class} unable to parse #{target}: invalid YAML or contents is not a Hash")
-        @inputs = nil
-      end
-    rescue => e
-      raise "Error reading InSpec inputs: #{e}"
-    end
-  end
-end

data/lib/inspec/shell.rb

@@ -1,211 +0,0 @@
-require "pry"
-
-module Inspec
-  # A pry based shell for inspec. Given a runner (with a configured backend and
-  # all that jazz), this shell will produce a pry shell from which you can run
-  # inspec/ruby commands that will be run within the context of the runner.
-  class Shell
-    def initialize(runner)
-      @runner = runner
-    end
-
-    def start
-      # This will hold a single evaluation binding context as opened within
-      # the instance_eval context of the anonymous class that the profile
-      # 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")
-      configure_pry
-      @ctx_binding.pry
-    end
-
-    def configure_pry # rubocop:disable Metrics/AbcSize
-      # Delete any before_session, before_eval, and after_eval hooks so we can
-      # replace them with our own. Pry 0.10 used to have a single method to clear
-      # all hooks, but this was removed in Pry 0.11.
-      %i{before_session before_eval after_eval}.each do |event|
-        Pry.hooks.get_hooks(event).keys.map { |hook| Pry.hooks.delete_hook(event, hook) }
-      end
-
-      that = self
-
-      # Add the help command
-      Pry::Commands.block_command "help", "Show examples" do |resource|
-        that.help(resource)
-      end
-
-      # configure pry shell prompt
-      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
-        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
-        @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
-        @runner.load
-        @runner.run_tests unless @runner.all_rules.empty?
-      end
-
-      # Don't print out control class inspection when the user uses DSL methods.
-      # Instead produce a result of evaluating their control.
-      Pry.config.print = proc do |_output_, value, pry|
-        next unless @runner.all_rules.empty?
-
-        pry.pager.open do |pager|
-          pager.print pry.config.output_prefix
-          Pry::ColorPrinter.pp(value, pager, Pry::Terminal.width! - 1)
-        end
-      end
-    end
-
-    def readline_ignore(code)
-      "\001#{code}\002"
-    end
-
-    def mark(x)
-      "\e[1m\e[39m#{x}\e[0m"
-    end
-
-    def intro
-      puts "Welcome to the interactive InSpec Shell"
-      puts "To find out how to use it, type: #{mark "help"}"
-      puts
-    end
-
-    def print_target_info
-      ctx = @runner.backend
-      puts <<~EOF
-        You are currently running on:
-
-        #{Inspec::BaseCLI.format_platform_info(params: ctx.platform.params, indent: 4, color: 39)}
-      EOF
-    end
-
-    def help(topic = nil)
-      if topic.nil?
-
-        puts <<~EOF
-          Available commands:
-
-              `[resource]` - run resource on target machine
-              `help resources` - show all available resources that can be used as commands
-              `help [resource]` - information about a specific resource
-              `help matchers` - show information about common matchers
-              `exit` - exit the InSpec shell
-
-          You can use resources in this environment to test the target machine. For example:
-
-              command('uname -a').stdout
-              file('/proc/cpuinfo').content => "value"
-
-          #{print_target_info}
-        EOF
-      elsif topic == "resources"
-        require "inspec/resources"
-        resources.sort.each do |resource|
-          puts " - #{resource}"
-        end
-      elsif topic == "matchers"
-        print_matchers_help
-      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?
-          info += "#{mark "Description:"}\n\n"
-          info += "#{topic_info.desc}\n\n"
-        end
-
-        unless topic_info.example.nil?
-          info += "#{mark "Example:"}\n\n"
-          info += "#{topic_info.example}\n\n"
-        end
-
-        info += "#{mark "Web Reference:"}\n\n"
-        info += "https://www.inspec.io/docs/reference/resources/#{topic}\n\n"
-        puts info
-      else
-        begin
-          require "inspec/resources/#{topic}"
-          help topic
-        rescue LoadError
-          # TODO: stderr!
-          puts "The resource #{topic} does not exist. For a list of valid resources, type: help resources"
-        end
-      end
-    end
-
-    def resources
-      Inspec::Resource.registry.keys
-    end
-
-    def print_matchers_help
-      puts <<~EOL
-        Matchers are used to compare resource values to expectations. While some
-        resources implement their own custom matchers, the following matchers are
-        common amongst all resources:
-
-        #{mark "be"}
-
-        The #{mark "be"} matcher can be used to compare numeric values.
-
-          its('size') { should be >= 10 }
-
-        #{mark "cmp"}
-
-        The #{mark "cmp"} matcher is like #{mark "eq"} but less restrictive. It will try
-        to fit the resource value to the expectation.
-
-        "Protocol" likely returns a string, but cmp will ensure it's a number before
-        comparing:
-
-          its('Protocol') { should cmp 2 }
-          its('Protocol') { should cmp '2' }
-
-        "users" may return an array, but if it contains only one item, cmp will compare
-        it as a string or number as needed:
-
-          its('users') { should cmp 'root' }
-
-        cmp is not case-sensitive:
-
-          its('log_format') { should cmp 'raw' }
-          its('log_format') { should cmp 'RAW' }
-
-        #{mark "eq"}
-
-        The #{mark "eq"} matcher tests for exact equality of two values. Value type
-        (string, number, etc.) is important and must be the same. For a less-restrictive
-        comparison matcher, use the #{mark "cmp"} matcher.
-
-          its('RSAAuthentication') { should_not eq 'no' }
-
-        #{mark "include"}
-
-        The #{mark "include"} matcher tests to see if a value is included in a list.
-
-          its('users') { should include 'my_user' }
-
-        #{mark "match"}
-
-        The #{mark "match"} matcher can be used to test a string for a match using a
-        regular expression.
-
-          its('content') { should_not match /^MyKey:\\s+some value/ }
-
-        For more examples, see: https://www.inspec.io/docs/reference/matchers/
-
-      EOL
-    end
-  end
-end

data/lib/inspec/shell_detector.rb

@@ -1,89 +0,0 @@
-require "etc"
-require "rbconfig"
-
-module Inspec
-  #
-  # ShellDetector attempts to detect the shell the invoking user is
-  # running by checking:
-  #
-  #  - The command of our parent
-  #  - The SHELL environment variable
-  #  - The shell returned by getpwuid for our process UID
-  #
-  # Since none of these methods is fullproof, the detected shell is
-  # verified against a list of known shells before being returned to
-  # the caller.
-  #
-  class ShellDetector
-    NOT_DETECTED = Object.new.freeze
-    KNOWN_SHELLS = %w{bash zsh ksh csh sh fish}.freeze
-
-    def initialize
-      @shell = NOT_DETECTED
-    end
-
-    def shell
-      @shell = detect unless detected?(@shell)
-      @shell
-    end
-
-    def shell!
-      @shell = detect
-    end
-
-    private
-
-    def detect
-      # Most of our detection code assumes a unix-like environment
-      return nil if RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
-
-      shellpath = detect_by_ppid
-
-      if shellpath.nil? || shellpath.empty? || !known_shell?(shellpath)
-        shellpath = detect_by_env
-      end
-
-      if shellpath.nil? || shellpath.empty? || !known_shell?(shellpath)
-        shellpath = detect_by_getpwuid
-      end
-
-      shellname(shellpath) if known_shell?(shellpath)
-    end
-
-    def detected?(arg)
-      arg != NOT_DETECTED
-    end
-
-    def detect_by_ppid
-      ppid = Process.ppid
-      if Dir.exist?("/proc")
-        File.readlink("/proc/#{ppid}/exe")
-      else
-        `ps -cp #{ppid} -o command=`.chomp
-      end
-    end
-
-    def detect_by_env
-      ENV["SHELL"]
-    end
-
-    def detect_by_getpwuid
-      Etc.getpwuid(Process.uid).shell
-    end
-
-    #
-    # Strip any leading path elements
-    #
-    def shellname(shellpath)
-      shellpath.split("/").last
-    end
-
-    #
-    # Only return shells that we know about, just to be sure we never
-    # do anything very silly.
-    #
-    def known_shell?(shell)
-      KNOWN_SHELLS.include?(shellname(shell))
-    end
-  end
-end

data/lib/inspec/source_reader.rb

@@ -1,26 +0,0 @@
-require "inspec/plugin/v1"
-
-module Inspec
-  # Pre-checking of target resolution. Make sure that SourceReader plugins
-  # always receive a fetcher.
-  class SourceReaderRegistry < PluginRegistry
-    def resolve(target)
-      return nil if target.nil?
-
-      super(target)
-    end
-  end
-
-  SourceReader = SourceReaderRegistry.new
-
-  def self.source_reader(version)
-    if version != 1
-      raise "Only source readers version 1 is supported!"
-    end
-
-    Inspec::Plugins::SourceReader
-  end
-end
-
-require "source_readers/inspec"
-require "source_readers/flat"

data/lib/inspec/ui.rb

@@ -1,213 +0,0 @@
-module Inspec
-  # Provides simple terminal UI interaction primitives for CLI commands and plugins.
-  class UI
-    ANSI_CODES = {
-      reset: "\e[0m",
-      bold: "\e[1m",
-      color: {
-        red: "\e[38;5;9m", # 256-color light red
-        green: "\e[38;5;41m",  # 256-color light green
-        yellow: "\e[33m",
-        cyan: "\e[36m",
-        white: "\e[37m",
-        grey: "\e[38;5;247m",  # 256-color medium grey
-      },
-    }.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
-    }.freeze
-
-    EXIT_NORMAL = 0
-    EXIT_USAGE_ERROR = 1
-    EXIT_PLUGIN_ERROR = 2
-    EXIT_FATAL_DEPRECATION = 3
-    EXIT_LICENSE_NOT_ACCEPTED = 172
-    EXIT_FAILED_TESTS = 100
-    EXIT_SKIPPED_TESTS = 101
-
-    attr_reader :io
-
-    def initialize(opts = {})
-      @color = opts[:color].nil? ? true : opts[:color]
-      @interactive = opts[:interactive].nil? ? $stdout.isatty : opts[:interactive]
-      @io = opts[:io] || $stdout
-    end
-
-    def color?
-      @color
-    end
-
-    def print_or_return(str, print_flag)
-      io.print(str) if print_flag
-      str
-    end
-
-    #=========================================================================#
-    #                   Low-level formatting methods
-    #=========================================================================#
-
-    def plain(str, opts = { print: true })
-      print_or_return(str.to_s, opts[:print])
-    end
-
-    def plain_line(str = "", opts = { print: true })
-      print_or_return(str.to_s + "\n", opts[:print])
-    end
-
-    def bold(str, opts = { print: true })
-      result = color? ? io.print(ANSI_CODES[:bold] + str.to_s + ANSI_CODES[:reset]) : str.to_s
-      print_or_return(result, opts[:print])
-    end
-
-    ANSI_CODES[:color].keys.each do |color|
-      define_method(color) do |str, opts = { print: true }|
-        result = color? ? (ANSI_CODES[:color][color] + str.to_s + ANSI_CODES[:reset]) : str.to_s
-        print_or_return(result, opts[:print])
-      end
-    end
-
-    #=========================================================================#
-    #                   High-Level formatting methods
-    #=========================================================================#
-
-    def emphasis(str, opts = { print: false })
-      cyan(str, opts)
-    end
-
-    def headline(str, opts = { print: true })
-      str = str.dup.to_s
-      if str.length < 76
-        dash_length = 80 - str.length - 4 # 4 spaces
-        dash_length /= 2
-      else
-        dash_length = 0
-      end
-
-      result = "\n"
-      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 += "\n\n"
-
-      print_or_return(result, opts[:print])
-    end
-
-    # 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 += str
-      result += "\n"
-      print_or_return(result, opts[:print])
-    end
-
-    # 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 += str
-      result += "\n"
-      print_or_return(result, opts[:print])
-    end
-
-    # Draws a horizontal line.
-    def line(opts = { print: true })
-      if color?
-        result = ANSI_CODES[:bold] + GLYPHS[:heavy_dash] * 80 + ANSI_CODES[:reset] + "\n"
-      else
-        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"
-      print_or_return(result, opts[:print])
-    end
-
-    # Makes a table.  Call with a block; block arg will be a TTY::Table object,
-    # with an extension for setting the header.
-    # Typical use:
-    # ui.table do |t|
-    #   t.header = ['Name', 'Rank', 'Cereal Number']
-    #   t << ['Crunch', 'Captain', 1]
-    #   t << ['', '', 1]
-    #  end
-    def table(opts = { print: true })
-      require "inspec/ui_table_helper"
-
-      the_table = TableHelper.new
-      yield(the_table)
-
-      colorizer = proc do |data, row, _col|
-        if color? && row == 0
-          ANSI_CODES[:bold] + ANSI_CODES[:color][:white] + data.to_s + ANSI_CODES[:reset]
-        else
-          data
-        end
-      end
-      render_mode = color? ? :unicode : :ascii
-      padding = [0, 1, 0, 1] # T R B L
-      result = the_table.render(render_mode, filter: colorizer, padding: padding) + "\n"
-      print_or_return(result, opts[:print])
-    end
-
-    #=========================================================================#
-    #                        Exit Codes
-    #=========================================================================#
-
-    def exit(code_sym = :normal)
-      # If it's a number, give them a pass for now.
-      if code_sym.is_a? Numeric
-        code_int = code_sym
-      else
-        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)
-        end
-        code_int = self.class.const_get(code_const)
-      end
-      Kernel.exit(code_int)
-    end
-
-    #=========================================================================#
-    #                        Interactivity
-    #=========================================================================#
-    def interactive?
-      @interactive
-    end
-
-    # 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."
-      end
-
-      require "tty-prompt"
-
-      @prompt ||= TTY::Prompt.new
-    end
-  end
-end