inspec-core 2.1.67

data/lib/inspec/runner_mock.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+module Inspec
+  class RunnerMock
+    attr_reader :tests, :profiles
+    attr_writer :backend
+    def initialize
+      reset
+    end
+
+    def reset
+      @tests = []
+      @profiles = []
+    end
+
+    def add_profile(profile)
+      @profiles.push(profile)
+    end
+
+    def add_test(example, _rule)
+      @tests.push(example)
+    end
+
+    def example_group(*in_args, &in_block)
+      Class.new do
+        define_method :args do
+          in_args
+        end
+        define_method :block do
+          in_block
+        end
+      end
+    end
+
+    def run(_with = nil)
+      puts 'uhm.... nothing or something... dunno, ask your admin'
+    end
+  end
+end

data/lib/inspec/runner_rspec.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'rspec/core'
+require 'rspec/its'
+require 'inspec/formatters'
+
+# There be dragons!! Or borgs, or something...
+# This file and all its contents cannot be unit-tested. both test-suits
+# collide and disable all unit tests that have been added.
+
+module Inspec
+  class RunnerRspec
+    def initialize(conf)
+      @conf = conf
+      @formatter = nil
+      reset
+    end
+
+    # Create a new RSpec example group from arguments and block.
+    #
+    # @param [Type] *args list of arguments for this example
+    # @param [Type] &block the block associated with this example group
+    # @return [RSpecExampleGroup]
+    def example_group(*args, &block)
+      RSpec::Core::ExampleGroup.describe(*args, &block)
+    end
+
+    # Add a full profile to the runner. Only pulls in metadata
+    #
+    # @param [Inspec::Profile] profile
+    # @return [nil]
+    def add_profile(profile)
+      RSpec.configuration.formatters
+           .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
+           .each do |fmt|
+        fmt.add_profile(profile)
+      end
+    end
+
+    # Configure the backend of the runner.
+    #
+    # @param [Inspec::Backend] backend
+    # @return [nil]
+    def backend=(backend)
+      RSpec.configuration.formatters
+           .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
+           .each do |fmt|
+        fmt.backend = backend
+      end
+    end
+
+    # Add an example group to the list of registered tests.
+    #
+    # @param [RSpecExampleGroup] example test
+    # @param [String] rule_id the ID associated with this check
+    # @return [nil]
+    def add_test(example, rule)
+      set_rspec_ids(example, rule)
+      @tests.example_groups.push(example)
+    end
+
+    # Retrieve the list of tests that have been added.
+    #
+    # @return [Array] full list of tests
+    def tests
+      @tests.ordered_example_groups
+    end
+
+    # Run all registered tests with an optional test runner.
+    #
+    # @param [RSpecRunner] with is an optional RSpecRunner
+    # @return [int] 0 if all went well; otherwise nonzero
+    def run(with = nil)
+      with ||= RSpec::Core::Runner.new(nil)
+      @rspec_exit_code = with.run_specs(tests)
+      @formatter.results
+    end
+
+    # Return a proper exit code to the runner
+    #
+    # @return [int] exit code
+    def exit_code
+      return @rspec_exit_code if @formatter.results.empty?
+      stats = @formatter.results[:statistics][:controls]
+      if stats[:failed][:total] == 0 && stats[:skipped][:total] == 0
+        0
+      elsif stats[:failed][:total] > 0
+        100
+      elsif stats[:skipped][:total] > 0
+        101
+      else
+        @rspec_exit_code
+      end
+    end
+
+    # Empty the list of registered tests.
+    #
+    # @return [nil]
+    def reset
+      @tests = RSpec::Core::World.new
+      # resets "pending examples" in reporter
+      RSpec.configuration.reset
+      configure_output
+    end
+
+    private
+
+    # Set optional formatters and output
+    #
+    #
+    def set_optional_formatters
+      return if @conf['reporter'].nil?
+      if @conf['reporter'].key?('json-rspec')
+        # We cannot pass in a nil output path. Rspec only accepts a valid string or a IO object.
+        if @conf['reporter']['json-rspec']&.[]('file').nil?
+          RSpec.configuration.add_formatter(Inspec::Formatters::RspecJson)
+        else
+          RSpec.configuration.add_formatter(Inspec::Formatters::RspecJson, @conf[:reporter]['json-rspec']['file'])
+        end
+        @conf['reporter'].delete('json-rspec')
+      end
+
+      formats = @conf['reporter'].select { |k, _v| %w{documentation progress html}.include?(k) }
+      formats.each do |k, v|
+        # We cannot pass in a nil output path. Rspec only accepts a valid string or a IO object.
+        if v&.[]('file').nil?
+          RSpec.configuration.add_formatter(k.to_sym)
+        else
+          RSpec.configuration.add_formatter(k.to_sym, v['file'])
+        end
+        @conf['reporter'].delete(k)
+      end
+    end
+
+    # Configure the output formatter and stream to be used with RSpec.
+    #
+    # @return [nil]
+    def configure_output
+      RSpec.configuration.output_stream = $stdout
+      @formatter = RSpec.configuration.add_formatter(Inspec::Formatters::Base)
+      RSpec.configuration.add_formatter(Inspec::Formatters::ShowProgress, $stderr) if @conf[:show_progress]
+      set_optional_formatters
+      RSpec.configuration.color = @conf['color']
+    end
+
+    # Make sure that all RSpec example groups use the provided ID.
+    # At the time of creation, we didn't yet have full ID support in RSpec,
+    # which is why they were added to metadata directly. This is evaluated
+    # by the InSpec adjusted json formatter (rspec_json_formatter).
+    #
+    # @param [RSpecExampleGroup] example object which contains a check
+    # @return [Type] description of returned object
+    def set_rspec_ids(example, rule)
+      assign_rspec_ids(example.metadata, rule)
+      example.filtered_examples.each do |e|
+        assign_rspec_ids(e.metadata, rule)
+      end
+      example.children.each do |child|
+        set_rspec_ids(child, rule)
+      end
+    end
+
+    def assign_rspec_ids(metadata, rule)
+      metadata[:id] = ::Inspec::Rule.rule_id(rule)
+      metadata[:profile_id] = ::Inspec::Rule.profile_id(rule)
+      metadata[:impact] = rule.impact
+      metadata[:title] = rule.title
+      metadata[:desc] = rule.desc
+      metadata[:code] = rule.instance_variable_get(:@__code)
+      metadata[:source_location] = rule.instance_variable_get(:@__source_location)
+    end
+  end
+end

data/lib/inspec/runtime_profile.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# Copyright 2017 Chef Software
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+module Inspec
+  class RuntimeProfile
+    attr_reader :files
+
+    def initialize(profile)
+      @src = profile.source_reader
+      @files = @src.data_files.keys.map do |k|
+        k.sub('files' + File::SEPARATOR, '')
+      end
+    end
+
+    # Retrieve a profile file's contents
+    #
+    # @param name [String] the name of the file
+    # @return [String] contents of the file of RuntimeError if missing
+    def file(name)
+      @src.data_files[File.join('files', name)] ||
+        raise("Cannot find file #{name} in profile.")
+    end
+  end
+end

data/lib/inspec/schema.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+require 'json'
+
+module Inspec
+  class Schema
+    STATISTICS = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'duration' => { 'type' => 'number' },
+        'controls' => {
+          'type' => 'object',
+          'optional' => true,
+          'properties' => {
+            'total' => { 'type' => 'number' },
+            'passed' => {
+              'type' => 'object',
+              'properties' => {
+                'total' => { 'type' => 'number' },
+              },
+            },
+            'skipped' => {
+              'type' => 'object',
+              'properties' => {
+                'total' => { 'type' => 'number' },
+              },
+            },
+            'failed' => {
+              'type' => 'object',
+              'properties' => {
+                'total' => { 'type' => 'number' },
+              },
+            },
+          },
+        },
+      },
+    }.freeze
+
+    PLATFORM = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'name' => { 'type' => 'string' },
+        'release' => { 'type' => 'string' },
+      },
+    }.freeze
+
+    # Tags are open right, with simple key-value associations and not restrictions
+    TAGS = { 'type' => 'object' }.freeze
+
+    RESULT = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'status' => { 'type' => 'string' },
+        'code_desc' => { 'type' => 'string' },
+        'run_time' => { 'type' => 'number' },
+        'start_time' => { 'type' => 'string' },
+        'skip_message' => { 'type' => 'string', 'optional' => true },
+        'resource' => { 'type' => 'string', 'optional' => true },
+        'message' => { 'type' => 'string', 'optional' => true },
+        'exception' => { 'type' => 'string', 'optional' => true },
+        'backtrace' => { 'type' => 'object', 'optional' => true },
+      },
+    }.freeze
+
+    REF = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'ref' => { 'type' => 'string' },
+        # TODO: One of these needs to be deprecated
+        'uri' => { 'type' => 'string', 'optional' => true },
+        'url' => { 'type' => 'string', 'optional' => true },
+      },
+    }.freeze
+    REFS = { 'type' => 'array', 'items' => REF }.freeze
+
+    CONTROL = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'id' => { 'type' => 'string' },
+        'title' => { 'type' => %w{string null} },
+        'desc' => { 'type' => %w{string null} },
+        'impact' => { 'type' => 'number' },
+        'refs' => REFS,
+        'tags' => TAGS,
+        'code' => { 'type' => 'string' },
+        'source_location' => {
+          'type' => 'object',
+          'properties' => {
+            'ref' => { 'type' => 'string' },
+            'line' => { 'type' => 'number' },
+          },
+        },
+        'results' => { 'type' => 'array', 'items' => RESULT },
+      },
+    }.freeze
+
+    SUPPORTS = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'os-family' => { 'type' => 'string', 'optional' => true },
+      },
+    }.freeze
+
+    CONTROL_GROUP = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'id' => { 'type' => 'string' },
+        'title' => { 'type' => 'string', 'optional' => true },
+        'controls' => { 'type' => 'array', 'items' => { 'type' => 'string' } },
+      },
+    }.freeze
+
+    PROFILE = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'name' => { 'type' => 'string' },
+        'version' => { 'type' => 'string', 'optional' => true },
+        'sha256' => { 'type' => 'string', 'optional' => false },
+
+        'title' => { 'type' => 'string', 'optional' => true },
+        'maintainer' => { 'type' => 'string', 'optional' => true },
+        'copyright' => { 'type' => 'string', 'optional' => true },
+        'copyright_email' => { 'type' => 'string', 'optional' => true },
+        'license' => { 'type' => 'string', 'optional' => true },
+        'summary' => { 'type' => 'string', 'optional' => true },
+
+        'supports' => {
+          'type' => 'array',
+          'items' => SUPPORTS,
+          'optional' => true,
+        },
+        'controls' => {
+          'type' => 'array',
+          'items' => CONTROL,
+        },
+        'groups' => {
+          'type' => 'array',
+          'items' => CONTROL_GROUP,
+        },
+        'attributes' => {
+          'type' => 'array',
+          # TODO: more detailed specification needed
+        },
+      },
+    }.freeze
+
+    EXEC_JSON = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'platform' => PLATFORM,
+        'profiles' => {
+          'type' => 'array',
+          'items' => PROFILE,
+        },
+        'statistics' => STATISTICS,
+        'version' => { 'type' => 'string' },
+      },
+    }.freeze
+
+    MIN_CONTROL = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'id' => { 'type' => 'string' },
+        'profile_id' => { 'type' => %w{string null} },
+        'profile_sha256' => { 'type' => 'string' },
+        'status' => { 'type' => 'string' },
+        'code_desc' => { 'type' => 'string' },
+        'skip_message' => { 'type' => 'string', 'optional' => true },
+        'resource' => { 'type' => 'string', 'optional' => true },
+        'message' => { 'type' => 'string', 'optional' => true },
+        'exception' => { 'type' => 'string', 'optional' => true },
+        'backtrace' => { 'type' => 'object', 'optional' => true },
+      },
+    }.freeze
+
+    EXEC_JSONMIN = {
+      'type' => 'object',
+      'additionalProperties' => false,
+      'properties' => {
+        'statistics' => STATISTICS,
+        'version' => { 'type' => 'string' },
+        'controls' => {
+          'type' => 'array',
+          'items' => MIN_CONTROL,
+        },
+      },
+    }.freeze
+
+    LIST = {
+      'exec-json' => EXEC_JSON,
+      'exec-jsonmin' => EXEC_JSONMIN,
+    }.freeze
+
+    def self.names
+      LIST.keys
+    end
+
+    def self.json(name)
+      v = LIST[name] ||
+          raise("Cannot find schema #{name.inspect}.")
+      JSON.dump(v)
+    end
+  end
+end