chefspec-ohai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d64ccf311fb089b7f97897e42e8fdbe9ef0d7e78
+  data.tar.gz: 2e0dc97593f992fe2306639d4dc92ce972a146d4
+SHA512:
+  metadata.gz: be73a60edb56cc7349b9b1269a2f9ff69373e82a06b59bb5f6faa39a28462341eedfa1533fb98732561877aafddd288c44dc76d41fb404db3cc515b1822d3696
+  data.tar.gz: 0ea98d27be390b8b9f443d5cc20db71a365ef31f42eba2d0e2f11725b4e9d5b53182cf62c9a0b1ea1684d80a778471c86301e765844f1bacf80e2d0858577646

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Franklin Webber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# Chefspec::Ohai
+
+Traditionally if you have developed Ohai plugins for Chef you have had to test
+them on the node after they have been deployed. If they have failed during the
+deployment you will not see an error and instead see no data within the node
+object. This is tiring, confusing, and makes it difficult to practice
+test-driven development within regard to Ohai plugins.
+
+The ability to test your Ohai plugins locally with RSpec has always been possible
+if you understand how Ohai finds and loads plugins. This gem simplifies this
+process and provides a number of helpers and methods to make it express your
+expectations about your Ohai plugin.
+
+> This gem is called ChefSpec::Ohai but it does not need ChefSpec to work. It
+> relies solely on RSpec. However, when you are working with testing your
+> cookbooks you are often using ChefSpec so it seemed like naming as an extension
+> to ChefSpec was the right idea.
+
+## Installation
+
+Installation on your local workstation will require that you have this gem
+installed. To do that you can create a Gemfile for your cookbook and then perform
+the following:
+
+Create a Gemfile and then add this line to your cookbook's Gemfile:
+
+```ruby
+gem 'chefspec-ohai'
+```
+
+And then execute:
+
+    $ chef exec bundle
+
+Or install it yourself as:
+
+    $ chef exec gem install chefspec-ohai
+
+## Usage
+
+First you will want to load the helpers within `spec/spec_helper.rb` file:
+
+```ruby
+require 'chefspec'            # Auto-generated with cookbook
+require 'chefspec/berkshelf'  # Auto-generated with cookbook
+require 'chefspec/ohai'       # Added by YOU if you want to use this gem
+```
+
+Now you will want to write a specification that will test your Ohai plugin. There
+is currently no convention and no requirements for where you store your ohai
+plugin tests within the cookbook. I have chosen to create the directory
+`spec/unit/plugins`.
+
+I often choose to name the specification after the name of the file that stores
+the Ohai plugin. I were testing an Ohai plugin stored in `files/default/httpd_modules.rb`
+I would create a specifiation named `spec/unit/plugins/httpd_modules_spec.rb`.
+The most important thing is that the file ends with `_spec.rb` so that RSpec
+will automatically find this file and load it appropriately.
+
+Within the specification file that you need to require the content found in the
+`spec/spec_helper.rb`. This will ensure that this gem is loaded prior to this
+file being evaluated.
+
+This gem provides an alias of RSpec's `describe` named `describe_ohai_plugin`
+which loads some additional helper methods to assist you with expressing your
+examples and the expectations within your examples.
+
+You must specify a let helper, named `:plugin_file`, which is a relative path
+within the cookbook to the file that contains the Ohai plugin.
+
+When creating this gem there are two examples that I thought that you would
+want to assert when testing your Ohai plugin:
+
+* I expect the Ohai plugin to provide particular attributes
+* I expect the Ohai plugin, when run, to set those attributes
+
+Here is a sample specification file that asserts that an Ohai plugin provides
+particular attributes and those attributes, when run (and stubbing the environment),
+are set properly.
+
+```ruby
+require 'spec_helper'
+
+describe_ohai_plugin :Apache do
+  let(:plugin_file) { "files/default/httpd_modules.rb" }
+
+  context "default collect data" do
+    it "provides 'apache/modules'" do
+      expect(plugin).to provides_attribute("apache/modules")
+    end
+
+    it "correctly captures output" do
+      stub_plugin_shell_out('apachectl -t -D DUMP_MODULES','OUTPUT')
+      expect(plugin_attribute('apache/modules')).to eq("OUTPUT")
+    end
+  end
+end
+```
+
+Here is the plugin that is being tested with that above specification:
+
+```ruby
+Ohai.plugin(:Apache) do
+  provides 'apache/modules'
+
+  collect_data(:default) do
+    apache Mash.new
+    modules_cmd = shell_out('apachectl -t -D DUMP_MODULES')
+    apache[:modules] = modules_cmd.stdout
+  end
+end
+```
+
+## Development
+
+This gem only provides a subset of the features that are possible to specify when
+defining an Ohai plugin. I encourage you to open issues and pull-requests to
+enhance this project.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chefspec-ohai/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chefspec/ohai"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chefspec-ohai.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chefspec/ohai/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chefspec-ohai"
+  spec.version       = Chefspec::Ohai::VERSION
+  spec.authors       = ["Franklin Webber"]
+  spec.email         = ["franklin@chef.io"]
+
+  spec.summary       = %q{Provides additional RSpec helpers to test Ohai plugins}
+  spec.description   = %q{Ohai plugins often go untested within the cookbooks that we create.
+When an Ohai plugin fails it is often a trial-and-error process that requires us to redeploy it.
+This gem provides additional helpers to RSpec to be used in conjunction with ChefSpec to test your plugins.}
+  spec.homepage      = "https://github.com/burtlo/chefspec-ohai"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/chefspec/ohai.rb

@@ -0,0 +1,102 @@
+require "chefspec/ohai/version"
+
+RSpec.configure do |config|
+  #
+  # Add a convienent name for the example group to the RSpec lexicon. This
+  # allows a user to write:
+  #     'desribe_ohai_plugin :Apache'.
+  #
+  # As opposed to appending a type to the declaration of the spec:
+  #   'describe :Apache, type: :ohai_plugin'
+  #
+  config.alias_example_group_to :describe_ohai_plugin, type: :ohai_plugin
+end
+
+# This defines the shared context with all the helper methods
+shared_context 'Ohai Plugins', type: :ohai_plugin do
+
+  # The plugin helper will take the symbol name provided as the subject to the
+  # describe and create the Ohai plugin class and then instantiate that class
+  # for use within the specifications.
+  let(:plugin) do
+    ohai_plugin_class = Ohai.plugin(subject) {}
+    ohai_plugin_class.new(plugin_data)
+  end
+
+  # When an Ohai plugin is created there is a Hash of data that must be provided.
+  # It is likely not important to provide data but allowing it to be overriden
+  # here if necessary.
+  let(:plugin_data) { Hash.new }
+
+  # Loads the plugin source from the specified plugin_file helper
+  let(:plugin_source) { File.read(plugin_file) }
+  # Determine the plugin_path from the specified plugin_file
+  let(:plugin_path) { File.dirname(plugin_file) }
+  # This helper defines the path to the plugin file. This must be specified
+  # by the author of the specification. Without specifying it, overriding this
+  # helper, an error is raised informing them that it must be specifed and
+  # provides an example to get them started.
+  let(:plugin_file) do
+    raise %(
+Please specify the path to the Ohai plugin file within this cookbook.
+
+Example:
+    let(:plugin_file) { "files/default/httpd_modules.rb" }
+ )
+  end
+
+  # A Loader requires a controller. This controller may need to be overriden so
+  # it is provided as a helper.
+  let(:plugin_controller) { double('plugin_controller') }
+  # The plugin_loader will evaluate the source of the plugin with the controller
+  let(:plugin_loader) { Ohai::Loader.new(plugin_controller) }
+
+  #
+  # Before each example we want to load the plugin from source. This asks the
+  # plugin_loader to load the plugin from the specifed source and path and
+  # evalute the contents as a version 7 ohai plugin.
+  #
+  before :each do
+    ps = plugin_source
+    pp = plugin_path
+    plugin_loader.instance_eval { load_v7_plugin_class(ps,pp) }
+  end
+
+  # This provides a new matcher when wanting to make assertions that the plugin
+  # does provide the correct body of attributes. The Ohai plugin class returns
+  # an array of attributes that it provides through `#provides_attrs` which
+  # is evaluated to ensure that the expected value is within that list.
+  RSpec::Matchers.define :provides_attribute do |expected|
+    match do |plugin|
+      expect(plugin.class.provides_attrs).to include(expected)
+    end
+  end
+
+  # Provides a simplier way to stub out the shell_out that is probably going on
+  # within the Ohai plugin.
+  def stub_plugin_shell_out(command,result)
+    allow(plugin).to receive(:shell_out).with(command) { double(stdout: result) }
+  end
+
+  # To make the process of verifying the attributes a little more streamlined
+  # you can use this helper to request the attributes from the plugin itself.
+  #
+  # The attributes are not loaded into the plugin until the plugin is run.
+  # Then the plugin will provide a top-level method that matches the first
+  # element in the ohai 'provides' String.
+  #
+  # The remaining elements within the 'provides' are elements within the Mash
+  # that must be traversed to get to the value desired. That is done here and
+  # then returned.
+  def plugin_attribute(attribute)
+    plugin.run
+
+    components = attribute.split('/')
+    top_level_mash_name = components.first
+    attributes = components[1..-1]
+
+    top_level_mash = plugin.send(top_level_mash_name)
+    attributes.inject(top_level_mash) { |mash,child| mash[child] }
+  end
+
+end

data/lib/chefspec/ohai/version.rb

@@ -0,0 +1,5 @@
+module Chefspec
+  module Ohai
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: chefspec-ohai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Franklin Webber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Ohai plugins often go untested within the cookbooks that we create.
+  When an Ohai plugin fails it is often a trial-and-error process that requires us to redeploy it.
+  This gem provides additional helpers to RSpec to be used in conjunction with ChefSpec to test your plugins.
+email:
+- franklin@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chefspec-ohai.gemspec
+- lib/chefspec/ohai.rb
+- lib/chefspec/ohai/version.rb
+homepage: https://github.com/burtlo/chefspec-ohai
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides additional RSpec helpers to test Ohai plugins
+test_files: []