inspec-plugin-example 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d4a170b96fee2fbd49a4d4dd495d18ede831062
+  data.tar.gz: c7124ddcbd2329caeb070af15f117803c08fe7cb
+SHA512:
+  metadata.gz: 595c7a2fee421bf162ba9362fdda451f44096d3274a6de13c5bcfd2b599cc1b7b940eab8177af43bbad19e4b5d4a98d3aebdd2cf1439e15d0d20265bdb1c21aa
+  data.tar.gz: 8aa5a80245dd857644d0ccc70b0e003ffd9f9c4ae3f48d7d9d9c2662979dd62108c36ee18ffccc25ad7eb545e7d113c5991e8e48bf7e0d29979384fa8772eda5

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "bundler"
+  gem "rake"
+  gem "chefstyle"
+end
+
+group :tools do
+  gem "github_changelog_generator"
+  gem "rb-readline"
+end

data/README.md

@@ -0,0 +1,62 @@
+# InSpec Plugin Example
+
+This repository provides an example of building a plugin for use with [InSpec](https://inspec.io).
+
+# 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.
+
+# Installation #
+
+`inspec-plugin-example` is a plugin for InSpec and may be installed as follows
+
+```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
+```
+
+## * or build a gem: ##
+
+```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
+```
+
+# Usage #
+
+    inspec example help
+
+    inspec example control
+
+    inspec example version
+
+# Code Examples #
+
+## 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.
+
+## lib/example/control.rb ##
+
+This shows how to use InSpec objects for building and printing Controls.
+
+## lib/example/version.rb ##
+
+The version of the plugin may be defined and exposed with ```inspec example version```
+
+# Code #
+
+InSpec uses ```chefstyle``` for code formatting.

data/inspec-plugin-example.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inspec-plugin-example/version"
+
+Gem::Specification.new do |spec|
+  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.files = %w{
+    README.md inspec-plugin-example.gemspec Gemfile
+  } + Dir.glob(
+    "{bin,docs,examples,lib,tasks,test}/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "inspec", ">=1.51.6", "<3.0.0"
+end

data/lib/inspec-plugin-example.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "inspec-plugin-example/cli"
+require "inspec-plugin-example/version"

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require "inspec/plugins"
+require "thor"
+require "inspec-plugin-example/control"
+require "inspec-plugin-example/second"
+
+module Example
+  class CLI < Thor
+    namespace "example"
+
+    map %w{-v --version} => "version"
+
+    desc "version", "Display version information", hide: true
+    def version
+      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"
+    def control
+      Inspec::Log.level = :debug if options[:debug]
+      Example::Control.print
+    end
+  end
+
+  Inspec::Plugins::CLI.add_subcommand(CLI, "example", "example SUBCOMMAND ...", "Example commands", {})
+end
+
+module SecondExample
+  class CLI < Thor
+    namespace "example2"
+
+    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

@@ -0,0 +1,39 @@
+#
+# Author:: Matt Ray (<matt@chef.io>)
+#
+# 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
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+#
+# Author:: Matt Ray (<matt@chef.io>)
+#
+# Copyright:: 2018, Chef Software, Inc <legal@chef.io>
+#
+
+module SecondExample
+  class Second
+
+    def self.print
+      puts "another example print out"
+    end
+
+  end
+end

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

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: inspec-plugin-example
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Matt Ray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.51.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.51.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Example for implementing an InSpec plugin.
+email:
+- matt@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- inspec-plugin-example.gemspec
+- lib/inspec-plugin-example.rb
+- lib/inspec-plugin-example/cli.rb
+- lib/inspec-plugin-example/control.rb
+- lib/inspec-plugin-example/second.rb
+- lib/inspec-plugin-example/version.rb
+homepage: https://github.com/mattray/inspec-plugin-example
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: InSpec Plugin Example
+test_files: []