inspec-core 3.0.64 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b87fd12aaccae196f61c1fe4066fd1b207b9f68139f510a92bf4a5c8ae700b
-  data.tar.gz: 6450a4e5b0e50e14988a6fccfa00fb220ebb179e7d532839d87fcf1e772cfcb3
+  metadata.gz: 25ed99e0e7240b826ba13f6d6b1a9a1fdfb41a587b8534f714712541172c1e91
+  data.tar.gz: d3664df03d103f551e706847a518bc3a38845312905f9b54dda42277669e88c6
 SHA512:
-  metadata.gz: 0e00c26b123e61c4104f57ae4ef87c6909ea8070a325b9ebb5c29c9e2969d9ea46ebae07938f6004b1056e5582bcc985e9c8ce0caa0057721910155b01f48bac
-  data.tar.gz: cd7ab8068c6f18ff97f0d3b798bee1da0bad4bc268fff6a994cb5a607ec73cbf0ee92c025ae12d92d24dbb47b452f24027a03f2c39ced82a427feb32b1fa1578
+  metadata.gz: f998135df5aaf1aafd2516d4baa1ce29b0f53e0625d296e5b05d3071a0cbeb12ee8d1b2adfa84e731a945c55afd3481291128628b30a6a380b8f39b094d7a54e
+  data.tar.gz: f7a5db33d49a097aa4834709d555b6e41fa4bcb02e489916c6b77769c488f8a8b389f6776259c4c9e8bce1e9ac29d85d8181b234b28c2a61bfa1830056e8f29e

data/lib/fetchers/git.rb

@@ -89,7 +89,7 @@ module Fetchers
     def resolve_ref(ref_name)
       command_string = "git ls-remote \"#{@remote_url}\" \"#{ref_name}*\""
       cmd = shellout(command_string)
-      raise "Error running '#{command_string}': #{cmd.stderr}" unless cmd.stderr == ''
+      raise "Error running '#{command_string}': #{cmd.stderr}" unless cmd.exitstatus == 0
       ref = parse_ls_remote(cmd.stdout, ref_name)
       if !ref
         raise "Unable to resolve #{ref_name} to a specific git commit for #{@remote_url}"

data/lib/fetchers/url.rb

@@ -24,6 +24,8 @@ module Fetchers
         resolve_from_string(target[:url], opts, target[:username], target[:password])
       elsif target.is_a?(String)
         resolve_from_string(target, opts)
+      elsif target.is_a?(URI)
+        resolve_from_string(target.to_s, opts)
       end
     end
 
@@ -94,8 +96,8 @@ module Fetchers
     attr_reader :files, :archive_path
 
     def initialize(url, opts)
-      @target = url
-      @target_uri = parse_uri(@target)
+      @target = url.to_s
+      @target_uri = url.is_a?(URI) ? url : parse_uri(url)
       @insecure = opts['insecure']
       @token = opts['token']
       @config = opts

data/lib/inspec/base_cli.rb

@@ -5,6 +5,7 @@
 require 'thor'
 require 'inspec/log'
 require 'inspec/profile_vendor'
+require 'inspec/ui'
 
 # Allow end of options during array type parsing
 # https://github.com/erikhuda/thor/issues/631
@@ -99,8 +100,6 @@ module Inspec
       option :reporter, type: :array,
         banner: 'one two:/output/file/path',
         desc: 'Enable one or more output reporters: cli, documentation, html, progress, json, json-min, json-rspec, junit, yaml'
-      option :color, type: :boolean,
-        desc: 'Use colors in output.'
       option :attrs, type: :array,
         desc: 'Load attributes file (experimental)'
       option :create_lockfile, type: :boolean,
@@ -219,24 +218,51 @@ module Inspec
     # but Thor interprets all methods as subcommands.  The no_commands block
     # treats them as regular methods.
     no_commands do
+      def ui
+        return @ui if defined?(@ui)
+
+        # Make a new UI object, respecting context
+        if options[:color].nil?
+          enable_color = true # If the command does not support the color option, default to on
+        else
+          enable_color = options[:color]
+        end
+
+        # UI will probe for TTY if nil - just send the raw option value
+        enable_interactivity = options[:interactive]
+
+        @ui = Inspec::UI.new(color: enable_color, interactive: enable_interactivity)
+      end
+
+      # Rationale: converting this to attr_writer breaks Thor
+      def ui=(new_ui) # rubocop: disable Style/TrivialAccessors
+        @ui = new_ui
+      end
+
       def mark_text(text)
-        "\e[0;36m#{text}\e[0m"
+        # TODO: - deprecate, call cli.ui directly
+        # Note that this one doesn't automatically print
+        ui.emphasis(text, print: false)
       end
 
       def headline(title)
-        puts "\n== #{title}\n\n"
+        # TODO: - deprecate, call cli.ui directly
+        ui.headline(title)
       end
 
       def li(entry)
-        puts " #{mark_text('*')} #{entry}"
+        # TODO: - deprecate, call cli.ui directly
+        ui.list_item(entry)
       end
 
-      def exit(code)
-        Kernel.exit code
+      def plain_text(msg)
+        # TODO: - deprecate, call cli.ui directly
+        ui.plain(msg + "\n")
       end
 
-      def plain_text(msg)
-        puts msg
+      def exit(code)
+        # TODO: - deprecate, call cli.ui directly
+        ui.exit code
       end
     end
 

data/lib/inspec/cli.rb

@@ -26,6 +26,12 @@ class Inspec::InspecCLI < Inspec::BaseCLI
   class_option :diagnose, type: :boolean,
     desc: 'Show diagnostics (versions, configurations)'
 
+  class_option :color, type: :boolean,
+    desc: 'Use colors in output.'
+
+  class_option :interactive, type: :boolean,
+    desc: 'Allow or disable user interaction'
+
   desc 'json PATH', 'read all tests in PATH and generate a JSON summary'
   option :output, aliases: :o, type: :string,
     desc: 'Save the created profile to a path'

data/lib/inspec/errors.rb

@@ -38,4 +38,6 @@ module Inspec
       attr_accessor :attribute_name
     end
   end
+
+  class UserInteractionRequired < Error; end
 end

data/lib/inspec/ui.rb

@@ -0,0 +1,216 @@
+require 'tty-table'
+require 'tty-prompt'
+
+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_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: true })
+      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 })
+      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
+
+    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
+    #=========================================================================#
+
+    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
+      @prompt ||= TTY::Prompt.new
+    end
+  end
+end

data/lib/inspec/version.rb

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

data/lib/resources/mysql_session.rb

@@ -30,7 +30,7 @@ module Inspec::Resources
       mysql_cmd = create_mysql_cmd(q, db)
       cmd = inspec.command(mysql_cmd)
       out = cmd.stdout + "\n" + cmd.stderr
-      if out =~ /Can't connect to .* MySQL server/ || out.downcase =~ /^error/
+      if out =~ /Can't connect to .* MySQL server/ || out.downcase =~ /^error /
         # skip this test if the server can't run the query
         warn("Can't connect to MySQL instance for SQL checks.")
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-core
 version: !ruby/object:Gem::Version
-  version: 3.0.64
+  version: 3.1.3
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train-core
@@ -19,7 +19,7 @@ dependencies:
         version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.11
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -288,6 +288,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: Core InSpec, local support only. See `inspec` for full support.
 email:
 - dominik.richter@gmail.com
@@ -296,15 +324,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- Gemfile
 - LICENSE
-- MAINTAINERS.md
-- MAINTAINERS.toml
 - README.md
 - bin/inspec
 - etc/plugin_filters.json
-- inspec-core.gemspec
 - lib/bundles/README.md
 - lib/bundles/inspec-compliance/api.rb
 - lib/bundles/inspec-compliance/configuration.rb
@@ -414,6 +437,7 @@ files:
 - lib/inspec/shell.rb
 - lib/inspec/shell_detector.rb
 - lib/inspec/source_reader.rb
+- lib/inspec/ui.rb
 - lib/inspec/version.rb
 - lib/matchers/matchers.rb
 - lib/plugins/README.md