inspec-resource-pack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 526cf6f51d3c1b1e7f940524e97ad3290c145cbf96e1a6a97f54836acfef07f1
+  data.tar.gz: 1ebb3618679cf8b8120e48b6d343db68030f38cb5c841c1c1f4ff5330add82b8
+SHA512:
+  metadata.gz: 8d9b8f1ad84c4d0d86f0809848a5dcdcc0bb207af641716031068b695229567be3d7ed2a58b9b065124691ec3dd0f60e0c309b18da7235149293f4ed7455de71
+  data.tar.gz: 45362a4ae99b34e6dd6c927aba57e4829366077a5387a0c5815216f75d67a55ee073e371e666b81135c2ae007e8d771bf29fd1a5f07dd2c8a9c431202e670f43

data/Gemfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'byebug'
+  gem 'minitest'
+  gem 'rake'
+  gem 'rubocop', '= 0.49.1' # Need to keep in sync with main InSpec project, so config files will work
+end

data/README.md

@@ -0,0 +1,28 @@
+# ResourcePack Plugin
+
+This plugin was generated by `inspec init plugin`, and apparently the author, 'Lynn Frank', did not update the README.
+
+## To Install This Plugin
+
+Assuming it has been published to RubyGems, you can install this gem using:
+
+```
+you@machine $ inspec plugin install inspec-resource-pack
+```
+
+## What This Plugin Does
+
+No idea.
+
+## Developing This Plugin
+
+The generated plugin contains everything a real-world, industrial grade plugin would have, including:
+
+* an (possibly incomplete) implementation of one or more InSpec Plugin Types
+* documentation (you are reading it now)
+* tests, at the unit and functional level
+* a .gemspec, for packaging and publishing it as a gem
+* a Gemfile, for managing its dependencies
+* a Rakefile, for running development tasks
+* Rubocop linting support for using the base InSpec project rubocop.yml (See Rakefile)
+

data/inspec-resource-pack.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+# As plugins are usually packaged and distributed as a RubyGem,
+# we have to provide a .gemspec file, which controls the gembuild
+# and publish process.  This is a fairly generic gemspec.
+
+# It is traditional in a gemspec to dynamically load the current version
+# from a file in the source tree.  The next three lines make that happen.
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inspec-resource-pack/version'
+
+Gem::Specification.new do |spec|
+  # Importantly, all InSpec plugins must be prefixed with `inspec-` (most
+  # plugins) or `train-` (plugins which add new connectivity features).
+  spec.name          = 'inspec-resource-pack'
+
+  # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
+  spec.version       = InspecPlugins::ResourcePack::VERSION
+  spec.authors       = ['Lynn Frank']
+  spec.email         = ['franklin.webber@gmail.com']
+  spec.summary       = 'Test resources defined in a profile'
+  spec.description   = '["Adds some testing helper files to be able to unit test"]'
+  spec.homepage      = 'https://github.com/burtlo/inspec-resource-pack'
+  spec.license       = 'Apache-2.0'
+
+  # Though complicated-looking, this is pretty standard for a gemspec.
+  # It just filters what will actually be packaged in the gem (leaving
+  # out tests, etc)
+  spec.files = %w{
+    README.md inspec-resource-pack.gemspec Gemfile
+  } + Dir.glob(
+    'lib/**/*', File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ['lib']
+
+  # If you rely on any other gems, list them here with any constraints.
+  # This is how `inspec plugin install` is able to manage your dependencies.
+  # For example, perhaps you are writing a thing that talks to AWS, and you
+  # want to ensure you have `aws-sdk` in a certain version.
+
+  # All plugins should mention inspec, > 2.2.78
+  # 2.2.78 included the v2 Plugin API
+  spec.add_dependency 'inspec', '>=2.2.78', '<4.0.0'
+end

data/lib/inspec-resource-pack/cli_command.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'inspec/resource'
+require 'plugins/inspec-init/lib/inspec-init/renderer'
+
+module InspecPlugins
+  module ResourcePack
+    class GenerateCLI < Inspec.plugin(2, :cli_command)
+      subcommand_desc 'generate resource_pack', 'Create an InSpec profile that is resource pack'
+
+      # The usual rhythm for a Thor CLI file is description, options, command method.
+      # Thor just has you call DSL methods in sequence prior to each command.
+
+      # Let's make a command, 'do_something'. This will then be available
+      # as `inspec my-command do-something
+      # (Change this method name to be something sensible for your plugin.)
+
+      # First, provide a usage / description. This will appear
+      # in `inspec help my-command`.
+      # As this is a usage message, you should write the command as it should appear
+      # to the user (if you want it to have dashes, use dashes)
+      desc 'resource_pack NAME', 'Create a custom resource pack'
+
+      option :overwrite, type: :boolean, default: false,
+             desc: 'Overwrites existing directory'
+
+      def resource_pack(new_resource_pack_name)
+        base_templates_path = File.absolute_path(File.join(__FILE__,'..','..','templates'))
+        resource_pack_template = 'resource_pack'
+
+        render_opts = {
+          templates_path: base_templates_path,
+          overwrite: options[:overwrite]
+        }
+        renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)
+
+        vars = { name: new_resource_pack_name }
+
+        renderer.render_with_values(resource_pack_template, 'resource pack', vars)
+
+        # ui.exit(:success) # or :usage_error
+        ui.exit
+      end
+    end
+  end
+end

data/lib/inspec-resource-pack/plugin.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+# 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.
+
+# Presumably this is light
+require 'inspec-resource-pack/version'
+
+# 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.
+  # inspec-resource-pack => ResourcePack
+  module ResourcePack
+    # This simple class handles the plugin definition, so calling it simply Plugin is OK.
+    #   Inspec.plugin returns various Classes, intended to be superclasses for various
+    # plugin components. Here, the one-arg form gives you the Plugin Definition superclass,
+    # which mainly gives you access to the hook / plugin_type DSL.
+    #   The number '2' says you are asking for version 2 of the plugin API. If there are
+    # future versions, InSpec promises plugin API v2 will work for at least two more InSpec
+    # major versions.
+    class Plugin < ::Inspec.plugin(2)
+      plugin_name :'inspec-resource-pack'
+
+      cli_command :generate do
+        require 'inspec-resource-pack/cli_command'
+        InspecPlugins::ResourcePack::GenerateCLI
+      end
+    end
+  end
+end

data/lib/inspec-resource-pack/version.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+# This file simply makes it easier for CI engines to update
+# the version stamp, and provide a clean way for the gemspec
+# to learn the current version.
+module InspecPlugins
+  module ResourcePack
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/inspec-resource-pack.rb

@@ -0,0 +1,16 @@
+# 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-resource-pack/plugin'

data/lib/templates/resource_pack/inspec.yml

@@ -0,0 +1,10 @@
+name: <%= name %>
+title: InSpec Resource Pack
+maintainer: The Authors
+copyright: The Authors
+copyright_email: you@example.com
+license: Apache-2.0
+summary: An InSpec Resource Pack
+version: 0.1.0
+supports:
+  platform: os

data/lib/templates/resource_pack/libraries/example.rb

@@ -0,0 +1,22 @@
+class ExampleResource < Inspec.resource(1)
+  name 'example'
+
+  def initialize(alternate_path = nil)
+    @path = alternate_path || default_path
+  end
+
+  def default_path
+    if inspec.os.windows?
+      'C:\example\bin\example.bat'
+    else
+      '/usr/bin/example'
+    end
+  end
+
+  attr_reader :path
+
+  def version
+    raw_result = inspec.command("#{path} --version").stdout
+    raw_result.split.first
+  end
+end

data/lib/templates/resource_pack/spec/example_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'libraries/example'
+
+describe_inspec_resource 'example' do
+  context 'on windows' do
+    # This helper method here is the equivalent to the first line within the environment
+    #   that defines an os that returns a true when the names align.
+    # let(:platform) { 'windows' }
+
+    environment do
+      os.returns(windows?: true, linux?: false)
+      command('C:\example\bin\example.bat --version').returns(stdout: '0.1.0 (windows-build)')
+    end
+
+    its(:version) { should eq('0.1.0') }
+  end
+
+  context 'on linux' do
+    let(:platform) { 'linux' }
+
+    environment do
+      command('/usr/bin/example --version').returns(stdout: '0.1.0 (GNULinux-build)')
+    end
+
+    its(:version) { should eq('0.1.0') }
+  end
+end

data/lib/templates/resource_pack/spec/spec_helper.rb

@@ -0,0 +1,173 @@
+require 'inspec'
+require 'rspec/its'
+
+# To test each of your resources, they will need to be required
+# to have the InSpec registry know about it.
+#
+#     require './libraries/ohai.rb'
+
+RSpec.configure do |config|
+  #
+  # Add a convienent name for the example group to the RSpec
+  # lexicon. This enables a user to write:
+  #     describe_inspec_resource 'ohai'
+  #
+  # As opposed to appending a type to the declaration of the spec:
+  #     describe 'ohai', type: :inspec_resource'
+  #
+  config.alias_example_group_to :describe_inspec_resource, type: :inspec_resource
+end
+
+shared_context 'InSpec Resource', type: :inspec_resource do
+  # The name of the resource which is the string in the
+  #   top-level description should be the name field of
+  #   the InSpec resource as it would appears in the registry.
+  let(:resource_name) { self.class.top_level_description }
+
+  # Find the resource in the registry based on the resource_name.
+  #   The resource classes stored here are not exactly instances
+  #   of the Resource class (e.g. OhaiResource). They are
+  #   instead wrapped with the backend transport mechanism which
+  #   they will be executed against.
+  let(:resource_class) { Inspec::Resource.registry[resource_name] }
+
+  #
+  def self.environment_builder(builder = nil)
+    if builder
+      @environment_builder = builder
+    else
+      @environment_builder
+    end
+  end
+
+  def self.environment(&block)
+    environment_builder(DoubleBuilder.new(&block))
+
+    # Create a backend helper which will generate a backend double
+    #   based on the definitions that have been building up in
+    #   all the environment builders in th current context and their
+    #   parent contexts.
+    let(:backend) do
+      # For all the possible platforms assign a false result unless the platform name matches
+      possible_platforms = %w{aix redhat debian suse bsd solaris linux unix windows hpux darwin}
+      os_platform_mock_results = possible_platforms.inject({}) { |acc, elem| acc["#{elem}?"] = (elem == platform.to_s) ; acc }
+      platform_builder = DoubleBuilder.new { os.returns(os_platform_mock_results) }
+
+      env_builders = [ platform_builder ] + self.class.parent_groups.map(&:environment_builder).compact
+      starting_double = RSpec::Mocks::Double.new('backend')
+      env_builders.inject(starting_double) { |acc, elem| elem.evaluate(self, acc) }
+    end
+  end
+
+  # Create an instance of the resource with the mock backend and the resource name
+  def resource(*args)
+    resource_class.new(backend, resource_name, *args)
+  end
+
+  # Provide an alias of the resource to subject. By setting the subject
+  #   creates an implicit subject to work with the `rspec-its`.
+  let(:subject) { resource }
+
+  # Provide a helper to help define the environment where the plugin is run in the unit tests
+  let(:platform) do
+    "spec"
+  end
+
+  # This is a no-op backend that should be overridden.
+  #   Below is a helper method #environment which provides some
+  #   shortcuts for hiding some of the RSpec mocking/stubbing double language.
+  def backend
+    double(
+      <<~BACKEND
+        A mocked underlying backend has not been defined. This can be done through the environment
+        helper method. Which enables you to specify how the mock envrionment will behave to all requests.
+
+            environment do
+              command('which ohai').returns(stdout: '/path/to/ohai')
+              command('/path/to/ohai').returns(stdout: '{ "os": "mac_os_x" }')
+            end
+      BACKEND
+    )
+  end
+end
+
+# This class serves only to create a context to enable a new domain-specific-language (DSL)
+#   for defining a backend in a simple way. The DoubleBuilder is constructed with the current
+#   test context which it later defines the #backend method that returns the test double that
+#   is built with this DSL.
+class DoubleBuilder
+  def initialize(&block)
+    @content_block = block
+  end
+
+  def evaluate(test_context, backend)
+    # Evaluate the block provided to queue up a bunch of backend double definitions.
+    instance_exec(&@content_block)
+
+    backend_doubles = self.backend_doubles
+    test_context.instance_exec do
+      # With all the backend double definitions defined,
+      # create a backend to append all these doubles
+      backend_doubles.each do |backend_double|
+        if backend_double.has_inputs?
+          allow(backend).to receive(backend_double.name).with(*backend_double.inputs).and_return(backend_double.outputs)
+        else
+          allow(backend).to receive(backend_double.name).with(no_args).and_return(backend_double.outputs)
+        end
+      end
+    end
+
+    backend
+  end
+
+  # Store all the doubling specified in the initial part of #evaluate
+  def backend_doubles
+    @backend_doubles ||= []
+  end
+
+  def method_missing(backend_method_name, *args, &_block)
+    backend_double = BackendDouble.new(backend_method_name)
+    backend_double.inputs = args unless args.empty?
+    backend_doubles.push backend_double
+    # NOTE: The block is ignored.
+    self
+  end
+
+  class InSpecResouceMash < Hashie::Mash
+    disable_warnings
+  end
+
+  # When defining a new aspect of the environment (e.g. command, file)
+  # you will often want a result from that detail. Because of the fluent
+  # interface this double builder provides this is a way to grab the last
+  # build double and append a mock of a return object.
+  #
+  # @TODO this shouldn't be used without a double being created, an
+  #   error will be generated with that last_double coming back as a nil.
+  #   There may be some interesting behavior that could be undertaken
+  #   here when no aspect is provided. It may also be better to throw a
+  #   useful exception that describes use.
+  def returns(method_signature_as_hash)
+    return_result = InSpecResouceMash.new(method_signature_as_hash)
+    last_double = backend_doubles.last
+    results_double_name = "#{last_double.name}_#{last_double.inputs}_RESULTS"
+    last_double.outputs = RSpec::Mocks::Double.new(results_double_name, return_result)
+    self
+  end
+
+  # Create a object to hold the backend doubling information
+  class BackendDouble
+    class NoInputsSpecifed; end
+
+    def initialize(name)
+      @name = name
+      @inputs = NoInputsSpecifed
+    end
+
+    def has_inputs?
+      inputs != NoInputsSpecifed
+    end
+
+    attr_accessor :name, :inputs, :outputs
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: inspec-resource-pack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lynn Frank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.78
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.78
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: '["Adds some testing helper files to be able to unit test"]'
+email:
+- franklin.webber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- inspec-resource-pack.gemspec
+- lib/inspec-resource-pack.rb
+- lib/inspec-resource-pack/cli_command.rb
+- lib/inspec-resource-pack/plugin.rb
+- lib/inspec-resource-pack/version.rb
+- lib/templates/resource_pack/inspec.yml
+- lib/templates/resource_pack/libraries/example.rb
+- lib/templates/resource_pack/spec/example_spec.rb
+- lib/templates/resource_pack/spec/spec_helper.rb
+homepage: https://github.com/burtlo/inspec-resource-pack
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Test resources defined in a profile
+test_files: []