inspec-core 3.5.0 → 3.6.2

data/lib/inspec/control_eval_context.rb

@@ -40,7 +40,8 @@ module Inspec
           if hook
             # OK, load the hook if it hasn't been already.  We'll then know a module,
             # which we can then inject into the context
-            registry.activate(:control_dsl, method_name) unless hook.activated?
+            hook.activate
+
             # Inject the module's methods into the context.
             # implementation_class is the field name, but this is actually a module.
             self.class.include(hook.implementation_class)

data/lib/inspec/dsl.rb

@@ -38,7 +38,7 @@ module Inspec::DSL
     if hook
       # OK, load the hook if it hasn't been already.  We'll then know a module,
       # which we can then inject into the context
-      registry.activate(:outer_profile_dsl, method_name) unless hook.activated?
+      hook.activate
       # Inject the module's methods into the context
       # implementation_class is the field name, but this is actually a module.
       self.class.include(hook.implementation_class)
@@ -78,7 +78,7 @@ module Inspec::DSL
   end
 
   def self.filter_included_controls(context, profile, &block)
-    mock = Inspec::Backend.create({ backend: 'mock' })
+    mock = Inspec::Backend.create(Inspec::Config.mock)
     include_ctx = Inspec::ProfileContext.for_profile(profile, mock, {})
     include_ctx.load(block) if block_given?
     # remove all rules that were not registered

data/lib/inspec/errors.rb

@@ -13,6 +13,11 @@ module Inspec
   class ReporterError < Error; end
   class ImpactError < Error; end
 
+  # Config file loading
+  class ConfigError < Error; end
+  class ConfigError::MalformedJson < ConfigError; end
+  class ConfigError::Invalid < ConfigError; end
+
   class Attribute
     class Error < Inspec::Error; end
     class ValidationError < Error

data/lib/inspec/plugin/v1/plugin_types/resource.rb

@@ -52,7 +52,7 @@ module Inspec
       if hook
         # OK, load the hook if it hasn't been already.  We'll then know a module,
         # which we can then inject into the resource
-        registry.activate(:resource_dsl, method_name) unless hook.activated?
+        hook.activate
         # Inject the module's methods into the resource as class methods.
         # implementation_class is the field name, but this is actually a module.
         extend(hook.implementation_class)

data/lib/inspec/plugin/v2/activator.rb

@@ -3,7 +3,7 @@ module Inspec::Plugin::V2
     :plugin_name,
     :plugin_type,
     :activator_name,
-    :'activated?',
+    :activated?,
     :exception,
     :activation_proc,
     :implementation_class,
@@ -14,8 +14,29 @@ module Inspec::Plugin::V2
     end
 
     def activated?(new_value = nil)
-      return self[:'activated?'] if new_value.nil?
-      self[:'activated?'] = new_value
+      return self[:activated?] if new_value.nil?
+      self[:activated?] = new_value
+    end
+
+    # Load a plugin, but if an error is encountered, store it and continue
+    def activate
+      return if activated?
+      # rubocop: disable Lint/RescueException
+      begin
+        impl_class = self[:activation_proc].call
+        self[:activated?] = true
+        self[:implementation_class] = impl_class
+      rescue Exception => ex
+        self[:exception] = ex
+        Inspec::Log.error "Could not activate #{self[:plugin_type]} hook named '#{self[:activator_name]}' for plugin #{self[:plugin_name]}"
+      end
+      # rubocop: enable Lint/RescueException
+    end
+
+    # Load a plugin, but if an error is encountered, re-throw it
+    def activate!
+      activate
+      raise exception if exception
     end
   end
 end

data/lib/inspec/plugin/v2/loader.rb

@@ -102,7 +102,7 @@ module Inspec::Plugin::V2
 
         # OK, activate.
         if activate_me
-          registry.activate(:cli_command, act.activator_name)
+          act.activate
           act.implementation_class.register_with_thor
         end
       end

data/lib/inspec/plugin/v2/registry.rb

@@ -67,19 +67,15 @@ module Inspec::Plugin::V2
       end
     end
 
-    def activate(plugin_type, hook_name)
-      activator = find_activators(plugin_type: plugin_type, activator_name: hook_name).first
-      # We want to capture literally any possible exception here, since we are storing them.
-      # rubocop: disable Lint/RescueException
-      begin
-        impl_class = activator.activation_proc.call
-        activator.activated?(true)
-        activator.implementation_class = impl_class
-      rescue Exception => ex
-        activator.exception = ex
-        Inspec::Log.error "Could not activate #{activator.plugin_type} hook named '#{activator.activator_name}' for plugin #{plugin_name}"
+    # Convenience method for when you expect exactly one
+    def find_activator(filters = {})
+      matched_plugins = find_activators(filters)
+      if matched_plugins.count > 1
+        raise Inspec::Plugin::V2::LoadError, "Plugin hooks search returned multiple results for filter #{filters.inspect} - use more filters, or use find_activators (plural)"
+      elsif matched_plugins.empty?
+        raise Inspec::Plugin::V2::LoadError, "Plugin hooks search returned zero results for filter #{filters.inspect}"
       end
-      # rubocop: enable Lint/RescueException
+      matched_plugins.first
     end
 
     def register(name, status)

data/lib/inspec/profile.rb

@@ -67,7 +67,8 @@ module Inspec
       new(reader, opts)
     end
 
-    def self.for_fetcher(fetcher, opts)
+    def self.for_fetcher(fetcher, config)
+      opts = config.respond_to?(:final_options) ? config.final_options : config
       opts[:vendor_cache] = opts[:vendor_cache] || Cache.new
       path, writable = fetcher.fetch
       for_path(path, opts.merge(target: fetcher.target, writable: writable))
@@ -113,7 +114,7 @@ module Inspec
       #
       # This will cause issues if a profile attempts to load a file via `inspec.profile.file`
       train_options = options.reject { |k, _| k == 'target' } # See https://github.com/chef/inspec/pull/1646
-      @backend = options[:backend].nil? ? Inspec::Backend.create(train_options) : options[:backend].dup
+      @backend = options[:backend].nil? ? Inspec::Backend.create(Inspec::Config.new(train_options)) : options[:backend].dup
       @runtime_profile = RuntimeProfile.new(self)
       @backend.profile = @runtime_profile
 

data/lib/inspec/profile_vendor.rb

@@ -2,6 +2,7 @@
 # author: Adam Leff
 
 require 'inspec/profile'
+require 'inspec/config'
 
 module Inspec
   class ProfileVendor
@@ -49,7 +50,7 @@ module Inspec
     def profile_opts
       {
         vendor_cache: Inspec::Cache.new(cache_path.to_s),
-        backend: Inspec::Backend.create(target: 'mock://'),
+        backend: Inspec::Backend.create(Inspec::Config.mock),
       }
     end
 

data/lib/inspec/rspec_extensions.rb

@@ -17,7 +17,7 @@ module Inspec
       if hook
         # OK, load the hook if it hasn't been already.  We'll then know a module,
         # which we can then inject into the context
-        registry.activate(:describe_dsl, method_name) unless hook.activated?
+        hook.activate
 
         # Inject the module's methods into the example group contexts.
         # implementation_class is the field name, but this is actually a module.
@@ -46,7 +46,7 @@ module Inspec
       if hook
         # OK, load the hook if it hasn't been already.  We'll then know a module,
         # which we can then inject into the context
-        registry.activate(:test_dsl, method_name) unless hook.activated?
+        hook.activate
 
         # Inject the module's methods into the example group contexts.
         # implementation_class is the field name, but this is actually a module.

data/lib/inspec/runner.rb

@@ -10,6 +10,7 @@ require 'inspec/profile_context'
 require 'inspec/profile'
 require 'inspec/metadata'
 require 'inspec/secrets'
+require 'inspec/config'
 require 'inspec/dependencies/cache'
 # spec requirements
 
@@ -34,7 +35,10 @@ module Inspec
     attr_reader :backend, :rules, :attributes
     def initialize(conf = {})
       @rules = []
-      @conf = conf.dup
+      # If we were handed a Hash config (by audit cookbook or kitchen-inspec),
+      # upgrade it to a proper config. This handles a lot of config finalization,
+      # like reporter parsing.
+      @conf = conf.is_a?(Hash) ? Inspec::Config.new(conf) : conf
       @conf[:logger] ||= Logger.new(nil)
       @target_profiles = []
       @controls = @conf[:controls] || []
@@ -42,10 +46,6 @@ module Inspec
       @create_lockfile = @conf[:create_lockfile]
       @cache = Inspec::Cache.new(@conf[:vendor_cache])
 
-      # parse any ad-hoc runners reporter formats
-      # this has to happen before we load the test_collector
-      @conf = Inspec::BaseCLI.parse_reporters(@conf) if @conf[:type].nil?
-
       @test_collector = @conf.delete(:test_collector) || begin
         require 'inspec/runner_rspec'
         RunnerRspec.new(@conf)

data/lib/inspec/shell.rb

@@ -104,7 +104,7 @@ module Inspec
       puts <<~EOF
         You are currently running on:
 
-        #{Inspec::BaseCLI.detect(params: ctx.platform.params, indent: 4, color: 39)}
+        #{Inspec::BaseCLI.format_platform_info(params: ctx.platform.params, indent: 4, color: 39)}
       EOF
     end
 

data/lib/inspec/ui.rb

@@ -61,7 +61,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
 
@@ -81,7 +81,7 @@ module Inspec
     #                   High-Level formatting methods
     #=========================================================================#
 
-    def emphasis(str, opts = { print: true })
+    def emphasis(str, opts = { print: false })
       cyan(str, opts)
     end
 

data/lib/inspec/version.rb

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

data/lib/plugins/inspec-habitat/lib/inspec-habitat/profile.rb

@@ -103,7 +103,7 @@ module InspecPlugins
       def create_profile_object
         @profile = Inspec::Profile.for_target(
           path,
-          backend: Inspec::Backend.create(target: 'mock://'),
+          backend: Inspec::Backend.create(Inspec::Config.mock),
         )
       end
 

data/lib/plugins/inspec-init/lib/inspec-init/cli.rb

@@ -8,35 +8,10 @@ module InspecPlugins
     class CLI < Inspec.plugin(2, :cli_command)
       subcommand_desc 'init SUBCOMMAND', 'Generate InSpec code'
 
-      #-------------------------------------------------------------------#
-      #                     inspec init profile
-      #-------------------------------------------------------------------#
-      def self.valid_profile_platforms
-        # Look in the 'template/profiles' directory and detect which platforms are available.
-        profile_templates_dir = File.join(File.dirname(__FILE__), 'templates', 'profiles')
-        Dir.glob(File.join(profile_templates_dir, '*')).select { |p| File.directory?(p) }.map { |d| File.basename(d) }
-      end
+      TEMPLATES_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates'))
 
-      no_commands do
-        def valid_profile_platforms
-          self.class.valid_profile_platforms
-        end
-      end
-
-      desc 'profile [OPTIONS] NAME', 'Generate a new profile'
-      option :platform, default: 'os', type: :string, aliases: [:p],
-             desc: "Which platform to generate a platform for: choose from #{valid_profile_platforms.join(', ')}"
-      option :overwrite, type: :boolean, default: false,
-             desc: 'Overwrites existing directory'
-      def profile(new_profile_name)
-        unless valid_profile_platforms.include?(options[:platform])
-          puts "Unable to generate profile: No template available for platform '#{options[:platform]}' (expected one of: #{valid_profile_platforms.join(', ')})"
-          exit 1
-        end
-        template_path = File.join('profiles', options[:platform])
-        renderer = InspecPlugins::Init::Renderer.new(self, options)
-        renderer.render_with_values(template_path, name: new_profile_name)
-      end
+      require_relative 'cli_profile'
+      require_relative 'cli_plugin'
     end
   end
 end

data/lib/plugins/inspec-init/lib/inspec-init/cli_plugin.rb

@@ -0,0 +1,245 @@
+# encoding: utf-8
+
+require_relative 'renderer'
+
+module InspecPlugins
+  module Init
+    class CLI < Inspec.plugin(2, :cli_command)
+      #-------------------------------------------------------------------#
+      #                 inspec init plugin
+      #-------------------------------------------------------------------#
+      desc 'PLUGIN_NAME [options]', 'Generates an InSpec plugin, which can extend the functionality of InSpec itself.'
+      # General options
+      option :prompt, type: :boolean, default: true, desc: 'Interactively prompt for information to put in your generated plugin.'
+      option :detail, type: :string, default: 'full', desc: "How detailed of a plugin to generate. 'full' is a normal full gem with tests; 'core' has tests but no gemspec; 'test-fixture' is stripped down for a test fixture."
+
+      # Templating vars
+      option :author_email, type: :string, default: 'you@example.com', desc: 'Author Email for gemspec'
+      option :author_name, type: :string, default: 'Your Name', desc: 'Author Name for gemspec'
+      option :description, type: :string, default: '', desc: 'Multi-line description of the plugin'
+      option :summary, type: :string, default: 'A plugin with a default summary', desc: 'One-line summary of your plugin'
+      option :license_name, type: :string, default: 'Apache-2.0', desc: 'The name of a license'
+      option :hook, type: :array, default: ['cli_command:my_command'], desc: 'A list of plugin hooks, in the form type1:name1, type2:name2, etc'
+      # These vars have calculated defaults
+      option :homepage, type: :string, default: nil, desc: 'A URL for your project, often a GitHub link'
+      option :module_name, type: :string, default: nil, desc: 'Module Name for your plugin package.  Will change plugin name to CamelCase by default.'
+      option :license_text, type: :string, default: '', hide: true
+      option :plugin_name, type: :string, default: '', hide: true # This is here to give a uniform interface
+      option :copyright, type: :string, default: nil, desc: 'A copyright statement, to be added to LICENSE'
+
+      def plugin(plugin_name)
+        plugin_type = determine_plugin_type(plugin_name)
+        snake_case = plugin_name.tr('-', '_')
+
+        template_vars = {
+          name: plugin_name,
+          plugin_name: plugin_name,
+          snake_case: snake_case,
+        }.merge(plugin_vars_from_opts)
+
+        template_path = File.join('plugins', plugin_type + '-plugin-template')
+
+        render_opts = {
+          templates_path: TEMPLATES_PATH,
+          overwrite: options[:overwrite],
+          file_rename_map: make_rename_map(plugin_type, plugin_name, snake_case),
+          skip_files: make_skip_list,
+        }
+        renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)
+
+        renderer.render_with_values(template_path, plugin_type + ' plugin', template_vars)
+      end
+
+      private
+
+      def determine_plugin_type(plugin_name)
+        plugin_type = plugin_name.match(/^(inspec|train)\-/)
+        unless plugin_type
+          ui.error('Plugin names must begin with either ' + ui.emphasis('inspec') + ' or ' + ui.emphasis('train') + ' - saw ' + ui.emphasis(plugin_name))
+          ui.exit(:usage_error)
+        end
+        options[:plugin_name] = plugin_name
+
+        plugin_type = plugin_type[1]
+        unless plugin_type == 'inspec'
+          ui.error('Sorry, only InSpec (inspec-) plugins are supported at this time: Train (train-) support is not implemented yet.')
+          ui.exit(:usage_error)
+        end
+        plugin_type
+      end
+
+      def make_rename_map(_plugin_type, plugin_name, snake_case)
+        {
+          'inspec-plugin-template.gemspec' => plugin_name + '.gemspec',
+          File.join('lib', 'inspec-plugin-template') => File.join('lib', plugin_name),
+          File.join('lib', 'inspec-plugin-template.rb') => File.join('lib', plugin_name + '.rb'),
+          File.join('lib', 'inspec-plugin-template', 'cli_command.rb') => File.join('lib', plugin_name, 'cli_command.rb'),
+          File.join('lib', 'inspec-plugin-template', 'plugin.rb') => File.join('lib', plugin_name, 'plugin.rb'),
+          File.join('lib', 'inspec-plugin-template', 'version.rb') => File.join('lib', plugin_name, 'version.rb'),
+          File.join('test', 'functional', 'inspec_plugin_template_test.rb') => File.join('test', 'functional', snake_case + '_test.rb'),
+        }
+      end
+
+      def plugin_vars_from_opts
+        # Set dynamic default - module name is straightforward.  Copyright, homepage, and license_text depend on other prompted vars.
+        options[:module_name] ||= options[:plugin_name].sub(/^(inspec|train)\-/, '').split('-').map(&:capitalize).join('')
+
+        if options[:prompt] && ui.interactive?
+          vars = options.dup.merge(vars_from_prompts)
+        elsif !options[:prompt]
+          vars = options.dup.merge(vars_from_defaults)
+
+        else
+          ui.error('You requested interactive prompting for the template variables, but this does not seem to be an interactive terminal.')
+          ui.exit(:usage_error)
+        end
+        vars.merge(parse_hook_option(options[:hook]))
+      end
+
+      def vars_from_defaults
+        options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name]
+        options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name]
+        options[:license_text] = fetch_license_text(options[:license_name])
+        options
+      end
+
+      def vars_from_prompts
+        order = {
+          author_name: {},
+          author_email: {},
+          summary: {},
+          description: { mode: :multiline },
+          module_name: {},
+          copyright: { default_setter: proc { options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name] } },
+          license_name: {
+            mode: :select,
+            choices: [
+              { name: 'Apache 2.0', value: 'Apache-2.0', default: true },
+              { name: 'Modified BSD', value: 'BSD-3-Clause' },
+              { name: 'Proprietary (Closed Source)', value: 'Proprietary' },
+              { name: 'Other (edit LICENSE yourself)', value: 'Other' },
+            ],
+          },
+          homepage: { default_setter: proc { options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name] } }
+          # TODO: Handle hooks, when we ever have more than one type of plugin
+        }
+
+        prompt_for_options(order)
+
+        options[:license_text] = fetch_license_text(options[:license_name])
+
+        options
+      end
+
+      def prompt_for_options(option_order) # rubocop: disable Metrics/AbcSize
+        option_defs = self.class.all_commands['plugin'].options
+
+        option_order.each do |opt_name, prompt_options|
+          opt_def = option_defs[opt_name]
+          prompt_options[:default_setter]&.call
+
+          case prompt_options[:mode]
+          when :select
+            options[opt_name] = ui.prompt.select('Choose ' + opt_def.description + ':', prompt_options[:choices])
+            if opt_name == :license_name && options[opt_name] == 'Other'
+              ui.plain_line 'OK, be sure to update the ' + ui.emphasis('LICENSE') + ' file with your license details.'
+            end
+          when :multiline
+            options[opt_name] = ui.prompt.multiline('Enter ' + opt_def.description + '. Press Control-D to end.', default: options[opt_name])
+          else
+            # Assume plain ask
+            options[opt_name] = ui.prompt.ask('Enter ' + opt_def.description + ':', default: options[opt_name])
+          end
+        end
+      end
+
+      def parse_hook_option(raw_option)
+        hooks_by_type = {}
+        raw_option.each do |entry|
+          parts = entry.split(':')
+          type = parts.first.to_sym
+          name = parts.last
+          if hooks_by_type.key?(type)
+            ui.error 'The InSpec plugin generator can currently only generate one hook of each type'
+            ui.exit(:usage_error)
+          end
+          hooks_by_type[type] = name
+        end
+
+        vars = { hooks: hooks_by_type }
+        if hooks_by_type.key?(:cli_command)
+          vars[:command_name_dashes] = hooks_by_type[:cli_command].tr('_', '-')
+          vars[:command_name_snake] = hooks_by_type[:cli_command].tr('-', '_')
+        end
+        vars
+      end
+
+      def fetch_license_text(license_name)
+        case license_name
+        when 'Proprietary'
+          <<~EOL
+            Proprietary software.  All Rights Reserved.
+          EOL
+        when 'Apache-2.0'
+          <<~EOL
+             Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+                 http://www.apache.org/licenses/LICENSE-2.0
+             Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+
+          EOL
+        when 'BSD-3-Clause'
+          <<~EOL
+            Modified BSD License
+            Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+            1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+            2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+            3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+            THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+          EOL
+        else
+          '"Other" license selected at plugin generation time - please insert your license here.'
+        end
+      end
+
+      def make_skip_list
+        case options[:detail]
+        when 'full'
+          []
+        when 'core'
+          [
+            'Gemfile',
+            'inspec-plugin-template.gemspec',
+            'LICENSE',
+            'Rakefile',
+          ]
+        when 'test-fixture'
+          [
+            'Gemfile',
+            'inspec-plugin-template.gemspec',
+            'LICENSE',
+            'Rakefile',
+            File.join('test', 'fixtures', 'README.md'),
+            File.join('test', 'fixtures'),
+            File.join('test', 'functional', 'inspec_plugin_template_test.rb'),
+            File.join('test', 'functional', 'README.md'),
+            File.join('test', 'unit', 'cli_args_test.rb'),
+            File.join('test', 'unit', 'plugin_def_test.rb'),
+            File.join('test', 'unit', 'README.md'),
+            File.join('test', 'unit'),
+            File.join('test', 'helper.rb'),
+            File.join('test'),
+          ]
+        else
+          ui.error "Unrecognized value for 'detail': #{options[:detail]} - expected one of full, core, test-fixture"
+          ui.exit(:usage_error)
+        end
+      end
+    end
+  end
+end