Extend Plugin-System for CLI Plugins

bin/inspec

@@ -10,7 +10,7 @@ require 'pp'
 require_relative '../lib/inspec'
 require_relative '../lib/utils/json_log'
 
-class InspecCLI < Thor # rubocop:disable Metrics/ClassLength
+class Inspec::InspecCLI < Thor # rubocop:disable Metrics/ClassLength
   class_option :diagnose, type: :boolean,
     desc: 'Show diagnostics (versions, configurations)'
 
@@ -251,4 +251,17 @@ class InspecCLI < Thor # rubocop:disable Metrics/ClassLength
     print "\n"
   end
 end
-InspecCLI.start(ARGV)
+
+# load CLI plugins before the Inspec CLI has been started
+Inspec::Plugins::CLI.registry.each { |_subcommand, params|
+  Inspec::InspecCLI.register(
+    params[:klass],
+    params[:subcommand_name],
+    params[:usage],
+    params[:description],
+    params[:options],
+  )
+}
+
+# start the CLI
+Inspec::InspecCLI.start(ARGV)

lib/bundles/README.md

@@ -0,0 +1,3 @@
+# InSpec Bundled Plugins
+
+This directory contains bundled InSpec plugins. Those plugins are shipped with InSpec temporarily only. Over the next months we are going to stabilize the InSpec Plugin API. Once this API reached stability, all bundled plugins will be externalized.

lib/inspec.rb

@@ -11,11 +11,13 @@
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require 'inspec/version'
-require 'inspec/plugins'
 require 'inspec/profile'
-require 'inspec/resource'
 require 'inspec/rspec_json_formatter'
 require 'inspec/rule'
+require 'matchers/matchers'
 require 'inspec/runner'
+# ensure resource and plugins are loaded after runner, because the runner loads
+# targets
+require 'inspec/resource'
+require 'inspec/plugins'
 require 'inspec/shell'
-require 'matchers/matchers'

lib/inspec/plugins.rb

@@ -5,8 +5,10 @@
 require 'forwardable'
 
 module Inspec
+  # Resource Plugins
   module Plugins
     autoload :Resource, 'inspec/plugins/resource'
+    autoload :CLI, 'inspec/plugins/cli'
   end
 
   class PluginCtl
@@ -21,6 +23,11 @@ def initialize(home = nil)
                .map { |x| File.dirname(x) }
                .map { |x| Dir[File.join(x, 'lib', 'inspec-*.rb')] }
                .flatten
+
+      # load bundled plugins
+      bundled_dir = File.expand_path(File.dirname(__FILE__))
+      @paths += Dir[File.join(bundled_dir, '..', 'bundles', 'inspec-*.rb')].flatten
+
       # map paths to names
       @registry = Hash[@paths.map { |x|
         [File.basename(x, '.rb'), x]

lib/inspec/plugins/cli.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+module Inspec
+  module Plugins
+    # stores all CLI plugin, we expect those to the `Thor` subclasses
+    class CLI
+      def self.registry
+        @registry ||= {}
+      end
+
+      def self.register(klass, subcommand_name, usage, description, options = {})
+        registry[subcommand_name] = {
+          klass: klass,
+          subcommand_name: subcommand_name,
+          usage: usage,
+          description: description,
+          options: options,
+        }
+      end
+    end
+  end
+end

test/unit/plugin_test.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'helper'
+require 'inspec/plugins'
+require 'thor'
+
+describe 'plugin system' do
+
+  describe 'with an empty profile' do
+    let(:cli_reg) { Inspec::Plugins::CLI }
+
+    it 'is empty' do
+      cli_reg.registry.must_equal({})
+    end
+
+    it 'stores one cli plugin' do
+      plugin = {
+        klass: Thor.new,
+        subcommand_name: 'my_cmd',
+        usage: 'usage my_cmd',
+        description: 'desc of my_cmd',
+        options: { test: 1 }
+      }
+      cli_reg.register(
+        plugin[:klass],
+        plugin[:subcommand_name],
+        plugin[:usage],
+        plugin[:description],
+        plugin[:options]
+      )
+      cli_reg.registry['my_cmd'].must_equal(plugin)
+    end
+  end
+end