inspec-plugin-example 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d4a170b96fee2fbd49a4d4dd495d18ede831062
-  data.tar.gz: c7124ddcbd2329caeb070af15f117803c08fe7cb
+SHA256:
+  metadata.gz: eda4dfd762de64ea1e42623e37a878cb3888e01ee3352331b4f86d3ce6b26ba5
+  data.tar.gz: 16448cf8748eea56bc5844b79717f8011635e0871ac864cf95d25e4d0f61afea
 SHA512:
-  metadata.gz: 595c7a2fee421bf162ba9362fdda451f44096d3274a6de13c5bcfd2b599cc1b7b940eab8177af43bbad19e4b5d4a98d3aebdd2cf1439e15d0d20265bdb1c21aa
-  data.tar.gz: 8aa5a80245dd857644d0ccc70b0e003ffd9f9c4ae3f48d7d9d9c2662979dd62108c36ee18ffccc25ad7eb545e7d113c5991e8e48bf7e0d29979384fa8772eda5
+  metadata.gz: 0cf5a756fdffba033d245e3139d5b788771d552a29fe3fbd5954d5ed9ebed6d98288a2dcaabe24758ca4387d48ccbfd246130a04b819e8aa38526e2ae8e7f465
+  data.tar.gz: d16e349b87bfa53cfbc148bb3391bf602190f6c1201b254781f85c58d3153cb4e3ade1833900f837a9dbe1aa346307e53cbf6ea9af886513b7f4c6407ab8261f

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 group :test do
   gem "bundler"
   gem "rake"
-  gem "chefstyle"
+  gem 'rubocop', '= 0.49.1'
 end
 
 group :tools do

data/README.md

@@ -1,62 +1,68 @@
 # InSpec Plugin Example
 
-This repository provides an example of building a plugin for use with [InSpec](https://inspec.io).
+This repository provides an example of building a version 2 plugin for use with [InSpec](https://inspec.io). It was built following the instructions from the [Developing InSpec Plugins for the v2 plugin API](https://github.com/inspec/inspec/blob/master/docs/dev/plugins.md) instructions.
 
 # Requirements #
 
-This has been built with Ruby 2.4.4 and InSpec 2.0. It most likely works with InSpec 1.5.x and its versions of Ruby.
+This has been built with Ruby 2.5.1 and InSpec 3.0. It most likely works with InSpec 2.3 and later its versions of Ruby.
 
 # Installation #
 
-`inspec-plugin-example` is a plugin for InSpec and may be installed as follows
+`inspec-plugin-example` is a plugin for InSpec and may be installed by following the [Developing InSpec Plugins for the v2 plugin API](https://github.com/inspec/inspec/blob/master/docs/dev/plugins.md#how-plugins-are-located-and-loaded) instructions.
 
-```bash
-# install InSpec
-gem install inspec
-```
-
-Then install the `inspec-plugin-example` plugin via `~/.inspec/plugins` or a gem build:
-
-## * for development: ##
-
-```bash
-# Install `inspec-plugin-example` via a symlink:
-git clone git@github.com:mattray/inspec-plugin-example ~/inspec-plugin-example
-mkdir -p ~/.inspec/plugins
-ln -s ~/inspec-plugin-example/ ~/.inspec/plugins/inspec-plugin-example
-inspec example help
-```
+## ~/.inspec/plugins.json
 
-## * or build a gem: ##
+When developing this plugin, this was the contents of my `~/.inspec/plugins.json`
 
-```bash
-# Build the `inspec-plugin-example` then install:
-git clone https://github.com/mattray/inspec-plugin-example && cd inspec-plugin-example && gem build *gemspec && gem install *gem
-inspec example help
+```json
+{
+    "plugins_config_version" : "1.0.0",
+    "plugins": [
+        {
+            "name": "inspec-plugin-example",
+            "installation_type": "path",
+            "installation_path": "/Users/mattray/ws/inspec-plugin-example/lib/inspec-plugin-example.rb"
+        }
+    ]
+}
 ```
 
 # Usage #
 
-    inspec example help
-
     inspec example control
 
+    inspec example help
+
     inspec example version
 
+    inspec example2 second
+
 # Code Examples #
 
+## lib/inspec-plugin-example.rb ##
+
+Entry point for the plugin code.
+
+## lib/inspec-plugin-example/plugin.rb ##
+
+Declares `example` and `example2` as InSpec subcommands within the `inspec-plugin-example` namespace.
+
 ## lib/inspec-plugin-example/cli.rb ##
 
-InSpec uses [Thor](http://whatisthor.com/) for adding command-line options. This shows how to add Thor subcommands for use with InSpec.
+Defines the `example` and `example2` CliCommands for use with InSpec.
+
+## lib/inspec-plugin-example/control.rb ##
+
+Example of calling another module from a CliCommand used by `inspec example control`
 
-## lib/example/control.rb ##
+## lib/inspec-plugin-example/second.rb ##
 
-This shows how to use InSpec objects for building and printing Controls.
+Example of a second CliCommand used by `inspec example2 control`
 
-## lib/example/version.rb ##
+## lib/inspec-plugin-example/version.rb ##
 
-The version of the plugin may be defined and exposed with ```inspec example version```
+The version of the plugin may be defined and exposed with `inspec example version`
 
 # Code #
 
-InSpec uses ```chefstyle``` for code formatting.
+Uses the `.rubocop.yml` from InSpec for code formatting.

data/inspec-plugin-example.gemspec

@@ -1,26 +1,26 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require "inspec-plugin-example/version"
+require 'inspec-plugin-example/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "inspec-plugin-example"
+  spec.name          = 'inspec-plugin-example'
   spec.version       = Example::VERSION
-  spec.authors       = ["Matt Ray"]
-  spec.email         = ["matt@chef.io"]
-  spec.summary       = "InSpec Plugin Example"
-  spec.description   = "Example for implementing an InSpec plugin."
-  spec.homepage      = "https://github.com/mattray/inspec-plugin-example"
-  spec.license       = "Apache-2.0"
+  spec.authors       = ['Matt Ray']
+  spec.email         = ['matt@chef.io']
+  spec.summary       = 'InSpec Plugin Example'
+  spec.description   = 'Example for implementing an InSpec plugin.'
+  spec.homepage      = 'https://github.com/mattray/inspec-plugin-example'
+  spec.license       = 'Apache-2.0'
 
   spec.files = %w{
     README.md inspec-plugin-example.gemspec Gemfile
   } + Dir.glob(
-    "{bin,docs,examples,lib,tasks,test}/**/*", File::FNM_DOTMATCH
+    '{bin,docs,examples,lib,tasks,test}/**/*', File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }
 
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "inspec", ">=1.51.6", "<3.0.0"
+  spec.add_dependency 'inspec', '>=2.3', '<4.0.0'
 end

data/lib/inspec-plugin-example.rb

@@ -1,7 +1,15 @@
-# encoding: utf-8
+# This file is known as the "entry point."
+# This is the file InSpec will try to load if it
+# thinks your plugin is installed.
+
+# The *only* thing this file should do is setup the
+# load path, then load the plugin definition file.
+
+# Next two lines simply add the path of the gem to the load path.
+# This is not needed when being loaded as a gem; but when doing
+# plugin development, you may need it.  Either way, it's harmless.
 
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require "inspec-plugin-example/cli"
-require "inspec-plugin-example/version"
+require_relative 'inspec-plugin-example/plugin'

data/lib/inspec-plugin-example/cli.rb

@@ -1,44 +1,55 @@
-# encoding: utf-8
-require "inspec/plugins"
-require "thor"
-require "inspec-plugin-example/control"
-require "inspec-plugin-example/second"
+require_relative 'control'
+require_relative 'second'
+require_relative 'version'
 
-module Example
-  class CLI < Thor
-    namespace "example"
+module InspecPlugins::Example
+  class CliCommand < Inspec.plugin(2, :cli_command) # Note two-arg form
+    subcommand_desc 'example SUBCOMMAND', 'InSpec Example Plugin commands'
 
-    map %w{-v --version} => "version"
+    class_option :debug,
+                 desc: 'Verbose debugging messages',
+                 type: :boolean,
+                 default: false
+
+    desc 'version', 'Display version information' # , hide: true
+    long_desc <<-LONGDESC
+      'version' shows you an example of how to see the version of your plugin
+
+      That's what this is!
+    LONGDESC
 
-    desc "version", "Display version information", hide: true
     def version
+      Inspec::Log.level = :debug if options[:debug]
+      Inspec::Log.debug 'Example::Version debugging message'
       say("InSpec Example Plugin v#{Example::VERSION}")
     end
 
-    class_option :debug,
-      :desc    => "Verbose debugging messages",
-      :type    => :boolean,
-      :default => false
+    desc 'control', 'Display an example InSpec Control'
+    long_desc <<-LONGDESC
+      'control' Provides an example of working with InSpec Controls
+    LONGDESC
+
+    option :example,
+           aliases: '-e',
+           desc: 'Example option',
+           type: :boolean,
+           default: false
 
-    desc "control", "Display an example InSpec Control"
     def control
       Inspec::Log.level = :debug if options[:debug]
-      Example::Control.print
+      Example::Control.print(options)
     end
   end
-
-  Inspec::Plugins::CLI.add_subcommand(CLI, "example", "example SUBCOMMAND ...", "Example commands", {})
 end
 
-module SecondExample
-  class CLI < Thor
-    namespace "example2"
+module InspecPlugins::SecondExample
+  class CliCommand < Inspec.plugin(2, :cli_command) # Note two-arg form
+    subcommand_desc 'example2 SUBCOMMAND', 'Second InSpec Example Plugin commands'
+
+    desc 'second', 'Second InSpec subcommand example'
 
-    desc "second", "Second InSpec subcommand example"
     def second
       SecondExample::Second.print
     end
   end
-
-  Inspec::Plugins::CLI.add_subcommand(CLI, "example2", "example2 SUBCOMMAND ...", "Additional Example commands", {})
 end

data/lib/inspec-plugin-example/control.rb

@@ -4,36 +4,12 @@
 # Copyright:: 2018, Chef Software, Inc <legal@chef.io>
 #
 
-require "inspec/objects/control"
-require "inspec/objects/ruby_helper"
-require "inspec/objects/describe"
-
 module Example
   class Control
-
-    def self.print
-      Inspec::Log.debug "Example::Control debugging message"
-      # Example of adding a Control
-      ctrl = ::Inspec::Control.new
-      ctrl.id = "InSpecPluginExample"
-      ctrl.title = "Example of an InSpec Control"
-      ctrl.desc = "Description of an Example InSpec Control"
-      ctrl.impact = "1.0"
-      # Example of adding a Resource
-      describe = ::Inspec::Describe.new
-      # describes the Resource with the id as argument
-      describe.qualifier.push(["file", "/tmp/test.txt"])
-      # ensure the Resource exists
-      describe.add_test(nil, "exist", nil)
-      # example of testing a Resource
-      describe.add_test("mode", "cmp", "0644")
-
-      ctrl.add_test(describe)
-
-      # print out the Control
-      puts "title 'Example File Title'\n\n"
-      puts ctrl.to_ruby
+    def self.print(options)
+      Inspec::Log.debug 'Example::Control debugging message'
+      puts "This used to be an example of creating a control, now it's just a subcommand example."
+      puts 'I see your example option!' if options[:example]
     end
-
   end
 end

data/lib/inspec-plugin-example/plugin.rb

@@ -0,0 +1,42 @@
+# Plugin Definition file
+# The purpose of this file is to declare to InSpec what plugin_types (capabilities)
+# are included in this plugin, and provide hooks that will load them as needed.
+
+# It is important that this file load successfully and *quickly*.
+# Your plugin's functionality may never be used on this InSpec run; so we keep things
+# fast and light by only loading heavy things when they are needed.
+
+require 'inspec/plugin/v2'
+
+# The InspecPlugins namespace is where all plugins should declare themselves.
+# The 'Inspec' capitalization is used throughout the InSpec source code; yes, it's
+# strange.
+
+module InspecPlugins
+  # Pick a reasonable namespace here for your plugin.  A reasonable choice
+  # would be the CamelCase version of your plugin gem name.
+  module Example
+    class Plugin < ::Inspec.plugin(2)
+      # Internal machine name of the plugin. InSpec will use this in errors, etc.
+      plugin_name :'inspec-plugin-example'
+
+      cli_command :example do
+        # Calling this hook doesn't mean example is being executed - just
+        # that we should be ready to do so. So, load the file that defines the
+        # functionality.
+        # For example, InSpec will activate this hook when `inspec help` is
+        # executed, so that this plugin's usage message will be included in the help.
+        require_relative 'cli'
+
+        # Having loaded our functionality, return a class that will let the
+        # CLI engine tap into it.
+        InspecPlugins::Example::CliCommand
+      end
+
+      cli_command :example2 do
+        require_relative 'cli'
+        InspecPlugins::SecondExample::CliCommand
+      end
+    end
+  end
+end

data/lib/inspec-plugin-example/second.rb

@@ -6,10 +6,8 @@
 
 module SecondExample
   class Second
-
     def self.print
-      puts "another example print out"
+      puts 'another example print out'
     end
-
   end
 end

data/lib/inspec-plugin-example/version.rb

@@ -1,10 +1,3 @@
-# encoding: UTF-8
-#
-# Author:: Matt Ray (<matt@chef.io>)
-#
-# Copyright:: 2018, Chef Software, Inc <legal@chef.io>
-#
-
 module Example
-  VERSION = "0.4.0".freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-plugin-example
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Ray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inspec
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.51.6
+        version: '2.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.51.6
+        version: '2.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 description: Example for implementing an InSpec plugin.
 email:
 - matt@chef.io
@@ -43,6 +43,7 @@ files:
 - lib/inspec-plugin-example.rb
 - lib/inspec-plugin-example/cli.rb
 - lib/inspec-plugin-example/control.rb
+- lib/inspec-plugin-example/plugin.rb
 - lib/inspec-plugin-example/second.rb
 - lib/inspec-plugin-example/version.rb
 homepage: https://github.com/mattray/inspec-plugin-example
@@ -65,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: InSpec Plugin Example