kuroko 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.rvmrc
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cucumber-puppet.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matt House
+
+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,37 @@
+# Kuroko
+
+A cucumber plugin to facilitate integration testing of Puppet manifests using Vagrant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kuroko'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kuroko
+
+## Usage
+
+Require the library in your `features/support/env.rb`
+
+    require 'kuroko'
+
+Configure the library to point to a vagrant environment (ie. a directory containing a Vagrantfile) to test your puppet repositories against
+
+    Kuroko.configure do |config|
+      config.vagrant_root = File.expand_path(File.join(__FILE__, 'vagrant_root'))
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/kuroko.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matt House"]
+  gem.email         = ["matt@eightbitraptor.com"]
+  gem.description   = %q{Cucumber Plugin for testing Puppet manifests using Vagrant}
+  gem.summary       = %q{Cucumber Plugin for testing Puppet manifests using Vagrant}
+  gem.homepage      = ""
+
+  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          = "kuroko"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_dependency('vagrant')
+  gem.add_dependency('cucumber')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rake')
+end

data/lib/core_ext/cucumber/rb_language.rb

@@ -0,0 +1,12 @@
+module Cucumber
+  module RbSupport
+    class RbLanguage
+      alias_method :extend_world_original, :extend_world
+
+      def extend_world
+        @current_world.extend(Kuroko::VagrantSupport)
+        extend_world_original
+      end
+    end
+  end
+end

data/lib/kuroko.rb

@@ -0,0 +1,11 @@
+require 'vagrant'
+require "kuroko/errors"
+require "kuroko/configuration"
+require "kuroko/vagrant_support"
+require "core_ext/cucumber/rb_language"
+
+module Kuroko
+  def self.configure
+    yield(Configuration.instance)
+  end
+end

data/lib/kuroko/configuration.rb

@@ -0,0 +1,10 @@
+require 'singleton'
+
+module Kuroko
+  class Configuration
+    include Singleton
+
+    attr_accessor :vagrant_root
+  end
+end
+

data/lib/kuroko/errors.rb

@@ -0,0 +1,5 @@
+module Kuroko
+  class VagrantNotRunningException < RuntimeError; end
+  class VagrantSshCommandError < RuntimeError; end
+end
+

data/lib/kuroko/vagrant_support.rb

@@ -0,0 +1,64 @@
+module Kuroko
+  module VagrantSupport
+
+    at_exit {
+      if ENV['KEEP_RUNNING'] != "true"
+        new_env = Object.new.extend(self).send(:vagrant_env)
+        new_env.cli('destroy', '-f')
+      end
+    }
+
+    def vagrant_cli_command(command)
+      vagrant_env.cli(command)
+    end
+
+    def vagrant_sandbox_command(command, path=vagrant_root)
+      invoke_sandbox_command(command, path)
+    end
+
+    def run_vagrant_command(command, options={})
+      run_command(:execute, command, options)
+    end
+
+    def run_sudo_command(command, options={})
+      run_command(:sudo, command, options)
+    end
+
+    private
+
+    def vagrant_env
+      @vagrant ||= Vagrant::Environment.new(:cwd => vagrant_root)
+    end
+
+    def run_command(method, command, options)
+      if vagrant_env.primary_vm.state != :running
+        raise VagrantNotRunningException
+      end
+
+      code = vagrant_env.primary_vm.channel.send(method, command) do |type, data|
+        if !(options[:silent]) && ([:stdout, :stdout].include? type)
+          puts data
+        end
+      end
+
+      if !options[:no_verify] && code != 0
+        raise VagrantSshCommandError
+      end
+      code
+    end
+
+    def invoke_sandbox_command(command, path)
+      pwd = Dir.pwd
+      begin
+        Dir.chdir(path)
+        vagrant_env.cli('sandbox', command)
+      ensure
+        Dir.chdir(pwd)
+      end
+    end
+
+    def vagrant_root
+      @vagrant_root ||= Configuration.instance.vagrant_root
+    end
+  end
+end

data/spec/cucumber_core_ext_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'kuroko'
+
+describe "Monkeypatching Cucumber" do
+  subject{ Cucumber::RbSupport::RbLanguage.new }
+
+  it "extends the world with the VagrantSupport module" do
+    subject.extend_world
+
+    subject.current_world.class.ancestors.should include(Kuroko::VagrantSupport)
+  end
+end

data/spec/kuroko_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'kuroko'
+
+describe "configuring Cucumber Puppet" do
+  it "has a configuration api" do
+    Kuroko.should respond_to(:configure)
+  end
+
+  it 'yields the configuration instance to the block' do
+    Kuroko.configure do |c|
+      c.should == Kuroko::Configuration.instance
+    end
+  end
+
+  describe Kuroko::Configuration do
+    subject{ Kuroko::Configuration.instance }
+
+    it "is a singleton" do
+      subject.should == Kuroko::Configuration.instance
+    end
+
+    it 'stores the vagrant_root path' do
+      subject.vagrant_root = 'foobar'
+      subject.vagrant_root.should == 'foobar'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+
+# Stub out the Vagrant Environment so that we don't try and load VM's when
+# running the tests
+
+module Vagrant
+  class Environment
+    def initialize(args)
+      #NOOP
+    end
+
+    def cli(command, options=nil)
+      # NOOP
+    end
+  end
+end
+
+module Cucumber
+  module RbSupport
+    class RbLanguage
+      attr_reader :current_world
+
+      def extend_world
+        # NOOP
+      end
+    end
+  end
+end

data/spec/vagrant_support_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'kuroko'
+
+describe "VagrantSupport Module" do
+  subject{ Object.new.extend(Kuroko::VagrantSupport) }
+  let(:mock_env){ double('Environment', cli: nil) }
+
+  before do
+    subject.stub(:vagrant_env).and_return(mock_env)
+  end
+
+  describe "#vagrant_cli_command" do
+    it "passes the cli command on to the vagrant environment" do
+      mock_env.should_receive(:cli).with('foobar')
+
+      subject.vagrant_cli_command('foobar')
+    end
+  end
+
+  describe "#run_vagrant_sandbox_command" do
+    before do
+      Dir.stub(:chdir)
+    end
+
+    it "changes into the specified working directory" do
+      Dir.should_receive(:chdir).with('/tmp/path')
+
+      subject.vagrant_sandbox_command('dontcare', '/tmp/path')
+    end
+
+    it "runs the specified command against the vagrant env" do
+      mock_env.should_receive(:cli).with('sandbox', 'dontcare')
+
+      subject.vagrant_sandbox_command('dontcare', '/tmp/path')
+    end
+
+    it "changes back into the old working directory" do
+      Dir.should_receive(:chdir).with(Dir.pwd)
+
+      subject.vagrant_sandbox_command('dontcare', '/tmp/path')
+    end
+
+    it 'changes back to the old working dir even on a failure' do
+      Dir.should_receive(:chdir).with(Dir.pwd)
+      mock_env.stub(:cli){ raise "Boom!" }
+
+      expect{
+        subject.vagrant_sandbox_command('dontcare', '/tmp/path')
+      }.to raise_error
+    end
+  end
+
+  describe "#run_vagrant_command" do
+    before do
+      mock_env.stub_chain(:primary_vm, :state){ :running }
+    end
+
+    it "raises an error if the VM has crashed" do
+      mock_env.stub_chain(:primary_vm, :state){ :fucked }
+
+      expect{
+        subject.run_vagrant_command('hostname')
+      }.to raise_error(Kuroko::VagrantNotRunningException)
+    end
+
+    it "sets the vagrant command to execute" do
+      subject.should_receive(:run_command).with(:execute, 'hostname', {})
+      subject.run_vagrant_command('hostname')
+    end
+
+    it "passes through the options hash" do
+      subject.should_receive(:run_command).with(:execute,
+                                                'hostname',
+                                                {no_verify: true})
+      subject.run_vagrant_command('hostname', no_verify: true)
+    end
+
+    it "raises and exception if the ssh exit code is nonzero" do
+      mock_env.stub_chain(:primary_vm, :channel, :send){ 1 }
+
+      expect{
+        subject.run_vagrant_command('hostname')
+      }.to raise_error(Kuroko::VagrantSshCommandError)
+    end
+
+    it "doesn't check the exit status with no_verify" do
+      mock_env.stub_chain(:primary_vm, :channel, :send){ 1 }
+
+      expect{
+        subject.run_vagrant_command('hostname', no_verify: true)
+      }.to_not raise_error(Kuroko::VagrantSshCommandError)
+    end
+
+    describe "running commands with sudo" do
+      it "sets the vagrant command to sudo" do
+        subject.should_receive(:run_command).with(:sudo, 'hostname', {})
+        subject.run_sudo_command('hostname')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: kuroko
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt House
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cucumber Plugin for testing Puppet manifests using Vagrant
+email:
+- matt@eightbitraptor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kuroko.gemspec
+- lib/core_ext/cucumber/rb_language.rb
+- lib/kuroko.rb
+- lib/kuroko/configuration.rb
+- lib/kuroko/errors.rb
+- lib/kuroko/vagrant_support.rb
+- spec/cucumber_core_ext_spec.rb
+- spec/kuroko_spec.rb
+- spec/spec_helper.rb
+- spec/vagrant_support_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1966606780301347984
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1966606780301347984
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cucumber Plugin for testing Puppet manifests using Vagrant
+test_files:
+- spec/cucumber_core_ext_spec.rb
+- spec/kuroko_spec.rb
+- spec/spec_helper.rb
+- spec/vagrant_support_spec.rb