inspec 3.0.64 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f5da4d58d4425b073427f0f90dc006643623916be1454fd4b1ddb668f4fe2d
-  data.tar.gz: cdf6f97f65e44e2851f8f248b27d2e140240059897295b2741aee7331e0929b7
+  metadata.gz: 54ccf8c9157dd5a8f7641ef3612d2e2909cafcceaa3c54cd5e6cbfbee95cd71e
+  data.tar.gz: 3080398f8bb9aaa6095c7d6d345b0b6be9e3e0ad97825faeb5f9d3475dfaedd6
 SHA512:
-  metadata.gz: 939b2fc5860f0078a4ee1a2c7fa116da34195491abc5de4f7019a3082e07aafdc660bfc6c2f75e5a007b6cf2e825feb8e5e44a5edb925c5e26a530097ae8bff6
-  data.tar.gz: dccf29ea24c69ceedb303e4e3893fdfef9f147d4b4476f0fc7190b7270b872ad0e0256c2a61f5d7a17ed7f3a86b5fda450e9ea35ad6ab404ec5c58bfba3724ca
+  metadata.gz: 064c5a157f5b79bf2c2be616dcf99ac4d4ad850236f16ea0b86aa02ca6e87c1d20bf2db18e43ac1cc487b3aebf9462c9a412b5a7ee2d4d705496dcd3047a201b
+  data.tar.gz: bdf94be09e23b2c7ec9ba244858f01f3de9139f5bb96df207fe69c5543b5d670dc52a90dd06e8d449360eb92243289c7df57d8bcf3de46943be9f7d59a3cf35d

data/Gemfile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+gemspec name: 'inspec'
+
+gem 'ffi', '>= 1.9.14'
+gem 'aws-sdk', '~> 2'
+
+group :test do
+  gem 'bundler', '~> 1.5'
+  gem 'minitest', '~> 5.5'
+  gem 'rake', '>= 10'
+  gem 'rubocop', '= 0.49.1'
+  gem 'simplecov', '~> 0.10'
+  gem 'concurrent-ruby', '~> 1.0'
+  gem 'mocha', '~> 1.1'
+  gem 'ruby-progressbar', '~> 1.8'
+  gem 'webmock', '~> 2.3.2'
+  gem 'jsonschema', '~> 2.0.2'
+  gem 'passgen'
+  gem 'm'
+  gem 'pry-byebug'
+end
+
+group :integration do
+  gem 'berkshelf', '~> 5.2'
+  gem 'test-kitchen', '~> 1.6'
+  gem 'kitchen-vagrant'
+  # we need winrm v2 support >= 0.15.1
+  gem 'kitchen-inspec', '>= 0.15.1'
+  gem 'kitchen-ec2'
+  gem 'kitchen-dokken'
+end
+
+group :tools do
+  gem 'pry', '~> 0.10'
+  gem 'rb-readline'
+  gem 'license_finder'
+  gem 'git', '~> 1.4'
+end
+
+# gems for Maintainers.md generation
+group :maintenance do
+  gem 'tomlrb'
+
+  # To sync maintainers with github
+  gem 'octokit'
+  gem 'netrc'
+end
+
+group :deploy do
+  gem 'inquirer'
+end

data/inspec.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'inspec'
+  spec.version       = Inspec::VERSION
+  spec.authors       = ['Dominik Richter']
+  spec.email         = ['dominik.richter@gmail.com']
+  spec.summary       = 'Infrastructure and compliance testing.'
+  spec.description   = 'InSpec provides a framework for creating end-to-end infrastructure tests. You can use it for integration or even compliance testing. Create fully portable test profiles and use them in your workflow to ensure stability and security. Integrate InSpec in your change lifecycle for local testing, CI/CD, and deployment verification.'
+  spec.homepage      = 'https://github.com/inspec/inspec'
+  spec.license       = 'Apache-2.0'
+
+  # the gemfile and gemspec are necessary for appbundler so don't remove it
+  spec.files = %w{Gemfile inspec.gemspec README.md LICENSE} + Dir.glob(
+    '{bin,lib,etc}/**/*', File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+
+  spec.executables   = %w{inspec}
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_dependency 'train', '~> 1.5', '>= 1.5.11'
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'json', '>= 1.8', '< 3.0'
+  spec.add_dependency 'method_source', '~> 0.8'
+  spec.add_dependency 'rubyzip', '~> 1.2', '>= 1.2.2'
+  spec.add_dependency 'rspec', '~> 3'
+  spec.add_dependency 'rspec-its', '~> 1.2'
+  spec.add_dependency 'pry', '~> 0'
+  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'mixlib-log'
+  spec.add_dependency 'sslshake', '~> 1.2'
+  spec.add_dependency 'parallel', '~> 1.9'
+  spec.add_dependency 'faraday', '>=0.9.0'
+  spec.add_dependency 'tty-table', '~> 0.10'
+  spec.add_dependency 'tty-prompt', '~> 0.17'
+  # Used for Azure profile until integrated into train
+  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'tomlrb', '~> 1.2'
+  spec.add_dependency 'addressable', '~> 2.4'
+  spec.add_dependency 'parslet', '~> 1.5'
+  spec.add_dependency 'semverse'
+  spec.add_dependency 'htmlentities'
+  spec.add_dependency 'multipart-post'
+  spec.add_dependency 'term-ansicolor'
+end

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
 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
@@ -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
@@ -210,6 +210,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.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'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -333,10 +361,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
 - README.md
 - bin/inspec
 - etc/plugin_filters.json
+- inspec.gemspec
 - lib/bundles/README.md
 - lib/bundles/inspec-compliance/api.rb
 - lib/bundles/inspec-compliance/configuration.rb
@@ -446,6 +476,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