fauxhai 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# ohai makes this file
+1

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@fauxhai"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.3 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Seth Vargo and CustomInk, LCC
+
+MIT License
+
+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,159 @@
+Fauxhai
+=======
+Fauxhai is a gem for mocking out [ohai](https://github.com/opscode/ohai) data in your chef testing. Fauxhai is community supported, so we need **your help** to populate our dataset. Here's an example for testing my "awesome_cookbook" on Ubuntu:
+
+**Fauxhai is still in alpha stages and should not be considered stable! Pull Requests and feedback are welcome :)**
+
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04')
+  end
+
+  it 'should install awesome' do
+    @runner = ChefSpec::ChefRunner.new.converge('tmpreaper::default')
+    @runner.should install_package 'awesome'
+  end
+end
+```
+
+Alternatively, you can pull "real" ohai data from an existing server:
+
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.fetch(host:'server01.example.com')
+  end
+
+  it 'should install awesome' do
+    @runner = ChefSpec::ChefRunner.new.converge('tmpreaper::default')
+    @runner.should install_package 'awesome'
+  end
+end
+```
+
+Fauxhai supports [ChefSpec](https://github.com/acrmp/chefspec) and [rspec-chef](https://github.com/calavera/rspec-chef). In order to prevent polluting the README, only ChefSpec examples will be provided. However, there is an extensive README for each testing framework in the [examples](https://github.com/customink/fauxhai/tree/master/examples) directory.
+
+Important Note
+--------------
+Fauxhai ships with a command line tool - `fauxhai`. This is **not** the same as Fauxhai.mock. Running `fauxhai` on a machine effectively runs `ohai`, but then sanitizes the data, removing/replacing things like:
+
+- users
+- ssh keys
+- usernames in paths
+- sensitive system information
+
+`fauxhai` should only be used by developers wishing to submit a new json file.
+
+Usage
+-----
+Fauxhai provides a bunch of default attributes so that you don't need to mock out your entire infastructure to write a simple test. That being said, not all configurations will suit your needs. Because of that, Fauxhai provides two ways to configure your mocks:
+
+### Overriding
+`Fauxhai.mock` will also accept a block with override attributes that are merged with all the default attributes. For example, the default Ubutnu 12.04 mock uses `Ruby 1.9.3`. Maybe your system is using `ree`, and you want to verify that the cookbooks work with that data as well:
+
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+
+  it 'should install awesome' do
+    @runner = ChefSpec::ChefRunner.new.converge('tmpreaper::default')
+    @runner.should install_package 'awesome'
+  end
+end
+```
+
+The `node` block variable allows you to set any Ohai attribute on the mock that you want. This provides an easy way to manage your environments. If you find that you are overridding attributes like OS or platform, you should see the section on Contributing.
+
+### Fetching
+Alternatively, if you do not want to mock the data, Fauxhai provides a `fetch` mechanism for collecting "real" ohai data from a remote server or local file. Maybe you want to test against the fully-replicated environment for a front-facing server in your pool. Just pass in the `url` option instead of a `platform`:
+
+The `fetch` method supports all the same options as the Net-SSH command, such as `:user`, `:password`, `:key_file`, etc.
+
+The `fetch` method will cache the JSON file in a temporary path on your local machine. Similar to gems like VCR, this allows fauxhai to use the cached copy, making your test suite run faster. You can optionally force a cache miss by passing the `:force_cache_miss => true` option to the `fetch` initializer. **Because this is real data, there may be a security concern. Secure your laptop accordingly.**
+
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.fetch(host:'server01.example.com')
+  end
+
+  it 'should install awesome' do
+    @runner = ChefSpec::ChefRunner.new.converge('tmpreaper::default')
+    @runner.should install_package 'awesome'
+  end
+end
+```
+
+This will ssh into the machine (you must have authorization to run `sudo ohai` on that machine), download a copy of the ohai output, and optionally cache that data inside the test directory (speeding up future tests).
+
+### Overriding + Fetching
+As you might expect, you can combine overriding and fetching like so:
+
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.fetch(host:'server01.example.com') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+
+  it 'should install awesome' do
+    @runner = ChefSpec::ChefRunner.new.converge('tmpreaper::default')
+    @runner.should install_package 'awesome'
+  end
+end
+```
+
+Contributing
+------------
+Fauxhai is community-maintained and updated. Aside from the initial files, all of the ohai system mocks have been created by the community. If you have a system that you think would benefit the community, here's how you get it into [fauxhai](https://github.com/customink/fauxhai):
+
+1. Build a system to your liking (on a virtual machine, for example)
+2. Install chef, ohai, and fauxhai
+3. Run the following at the command line:
+
+        sudo fauxhai
+
+4. This will create a file `/tmp/fauxhai.json`
+5. Copy the contents of this file to your local development machine (using scp or sftp, for example)
+6. Clone and `bundle` this repo:
+
+        git clone git@github.com:customink/fauxhai.git
+        cd fauxhai
+        bundle
+
+7. Create a new branch named `add_[platform]_[version]` (e.g. `add_ubuntu_12_04`) without dashes and dots replaced with underscores. Be sure to use the official version number, not a package name (e.g. '12_04', not 'precise') if avaliable:
+
+        Ubuntu Precise, 12.04       add_ubuntu_12_04
+        Ubuntu Lucid, 11.5          add_ubuntu_11_5
+        OSX Lion, 10.7.4            add_osx_10_7_4
+        Windows XP                  add_windows_xp
+
+    **Q:** Is there a reason for this super-specific naming convention?
+    **A:** No, but it helps in tracking problems and analyzing pull requests. Ultimately it just ensures your pull request is merged as quickly as possible.
+
+8. Create a new json file in `fauxhai/[os]/[version].json` (e.g. `fauxhai/ubuntu/12_04.json`)
+9. Copy-paste the contents of the file from `Step 4` into this file and save
+10. Verify the installation was successful by doing the following:
+
+        irb -rubygems -rfauxhai
+        Fauxhai.mock('[os]', '[version') # e.g. Fauxhai.mock('ubuntu', '12.04')
+
+    As long as that does not throw an error, you're good to go!
+
+11. Submit a pull request on github

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/bin/fauxhai

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '../../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'fauxhai'
+require 'fauxhai/runner'
+
+args = ARGV.dup
+ARGV.clear
+
+Fauxhai::Runner.new(args)

data/examples/chefspec.md

@@ -0,0 +1,68 @@
+Fauxhai ChefSpec Examples
+=========================
+
+Mocking a Box
+-------------
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04')
+  end
+end
+```
+
+Mocking a Box with a Custom Ruby Version
+----------------------------------------
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+end
+```
+
+Mocking a Box with Custom Hostname
+----------------------------------
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04') do |node|
+      node['hostname'] = 'server01.example.com'
+    end
+  end
+end
+```
+
+Fetching a Remote Box
+---------------------
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.fetch(host:'server01.example.com')
+  end
+end
+```
+
+Fetching a Remote Box with custom Ruby Version
+----------------------------------------------
+```ruby
+require 'chefspec'
+
+describe 'awesome_cookbook::default' do
+  before do
+    Fauxhai.fetch(host:'server01.example.com') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+end
+```

data/examples/rspec-chef.md

@@ -0,0 +1,62 @@
+Fauxhai Rspec-Chef Examples
+===========================
+
+Mocking a Box
+-------------
+```ruby
+describe 'foo::bar' do
+  let(:json_attributes) { Fauxhai.mock(platform:'ubuntu', version:'12.04') }
+end
+```
+
+Or as a default
+```ruby
+# spec/spec_helper.rb
+RSpec.configure do |c|
+  c.json_attributes = Fauxhai.mock(platform:'ubuntu', version:'12.04')
+end
+```
+
+Mocking a Box with a Custom Ruby Version
+----------------------------------------
+```ruby
+describe 'foo::bar' do
+  let(:json_attributes) do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+end
+```
+
+Mocking a Box with Custom Hostname
+----------------------------------
+```ruby
+describe 'foo::bar' do
+  let(:json_attributes) do
+    Fauxhai.mock(platform:'ubuntu', version:'12.04') do |node|
+      node['hostname'] = 'server01.example.com'
+    end
+  end
+end
+```
+
+Fetching a Remote Box
+---------------------
+```ruby
+describe 'foo::bar' do
+  let(:json_attributes) { Fauxhai.fetch(host:'server01.example.com' }
+end
+```
+
+Fetching a Remote Box with custom Ruby Version
+----------------------------------------------
+```ruby
+describe 'foo::bar' do
+  let(:json_attributes) do
+    Fauxhai.fetch(host:'server01.example.com') do |node|
+      node['languages']['ruby']['version'] = 'ree'
+    end
+  end
+end
+```

data/fauxhai.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.version       = '0.0.1'
+  gem.authors       = ['Seth Vargo']
+  gem.email         = ['svargo@customink.com']
+  gem.description   = %q{Easily mock out ohai data}
+  gem.summary       = %q{Fauxhai provides an easy way to mock out your ohai data for testing with chefspec!}
+  gem.homepage      = 'https://github.com/customink/fauxhai'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'fauxhai'
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'chef'
+  gem.add_runtime_dependency 'net-ssh'
+end

data/lib/fauxhai.rb

@@ -0,0 +1,17 @@
+module Fauxhai
+  require 'fauxhai/exception'
+  require 'fauxhai/fetcher'
+  require 'fauxhai/mocker'
+
+  def self.root
+    @@root ||= File.expand_path('../../', __FILE__)
+  end
+
+  def self.mock(*args)
+    Fauxhai::Mocker.new(*args)
+  end
+
+  def self.fetch(*args)
+    Fauxhai::Fetcher.new(*args)
+  end
+end