vagrant-rspec-ci 0.0.1

data/README.md

@@ -0,0 +1,97 @@
+# vagrant-rspec-ci
+
+**vagrant-rspec-ci** is a Vagrant plugin for running integration tests against
+your VMs, and produces jUnit formatted reports for consumption by your CI server 
+(travis and Jenkins and both can consume this). 
+
+It is based on a fork of Michael Paul Thomas Conigliaro's vagrant-test plugin, with
+some (very) breaking changes to make it rpsec-specific and integrate better with ci_reporter
+(the jUnit report formatter).  I also removed the internal side of testing, as we didn't 
+want to alter the test subject (by installing rspec internally in the VM, for example)
+
+## Installation (Vagrant v1.0.x)
+
+    vagrant gem install vagrant-rspec-ci
+
+## Configuration
+
+The following options can be used within the `Vagrant::Config.run` block of
+your Vagrantfile:
+
+<table>
+  <tr>
+    <th>Option</th>
+    <th>Description</th>
+    <th>Default value</th>
+  </tr>
+  <tr>
+    <td>config.rspec.enable_ci_reporter</td>
+    <td>Boolean - whether to use ci_reporter to format rspec results as jUnit reports.</td>
+    <td>true</td>
+  </tr>
+  <tr>
+    <td>config.rspec.suppress_ci_stdout</td>
+    <td>ci_reporter improperly registers as a formatter, writes to files, but leaves the doc formatter in place.  This makes for very noisy output.  Set to true (default) to send all STDOUT formatter output from rspec to /dev/null ; set to false when diagnosing a problem, or if you like noise.</td>
+    <td>true</td>
+  </tr>
+
+  <tr>
+    <td>config.rspec.dirs</td>
+    <td>Array of directories (relative to vagrant project root) to be used as a search path for external tests.</td>
+    <td>['combined/spec_ext", "spec"]</td>
+  </tr>
+  <tr>
+    <td>config.rspec.tests</td>
+    <td>List of tests (filenames or globs, expanded in the dirs paths) to be run outside the VM</td>
+    <td>[ '*ext_spec.rb' ]</td>
+  </tr>
+  <tr>
+    <td>config.rspec.rspec_bin_path</td>
+    <td>Path to rspec command, on VM host</td>
+    <td>"rspec"</td>
+  </tr>
+  <tr>
+    <td>config.rspec.reports_dir</td>
+    <td>If ci_reporter is enabled, path to write the jUnit XML reports.  Relative to vagrant project dir.</td>
+    <td>"rspec_reports"</td>
+  </tr>
+
+## Usage
+
+    vagrant rspec [vm-name]
+
+## Change Log
+
+### 0.0.1 (2013-04-09)
+
+* Forked from v0.1.2 of vagrant-test
+
+## License
+
+Copyright (C) 2013 Clinton Wolfe
+
+Copyright (C) 2012 Michael Paul Thomas Conigliaro
+
+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.
+
+## Credits
+
+* [Clinton Wolfe](http://ccwolfe.com): Derivative author of vagrant-rspec-ci
+
+* [Michael Paul Thomas Conigliaro](http://conigliaro.org): Original author of vagrant-test

data/lib/vagrant-rspec-ci.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+
+require "vagrant"
+require "vagrant/util/subprocess"
+require "vagrant-rspec-ci/config"
+require "vagrant-rspec-ci/command"
+
+
+
+require "pry-debugger"
+
+module VagrantRspecCI
+
+  NAME            = "vagrant-rspec-ci"
+  VERSION         = "0.0.1"
+  AUTHOR          = "Clinton Wolfe"
+  AUTHOR_EMAIL    = "clintoncwolfe [at] gmail [dot] com"
+  DESCRIPTION     = "vagrant-rspec-ci is a Vagrant plugin for running tests against your VMs, derived from vagrant-test"
+  URL             = "http://github.com/clintoncwolfe/vagrant-rspec-ci"
+
+  V_ROOT          = "/vagrant"
+
+
+  DEFAULT_RSPEC_BIN_PATH  = "rspec"
+  DEFAULT_REPORTS_DIR     = "rspec_reports"
+  DEFAULT_DIRS            = [ "combined/spec_ext", "spec" ]
+  DEFAULT_TESTS           = [ "*spec.rb" ]
+
+
+end
+
+Vagrant.config_keys.register(:rspec) { VagrantRspecCI::Config }
+Vagrant.commands.register(:rspec) { VagrantRspecCI::Command }

data/lib/vagrant-rspec-ci/command.rb

@@ -0,0 +1,93 @@
+module VagrantRspecCI
+
+  class Command < Vagrant::Command::Base
+
+    def execute
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: vagrant rpsec [vm-name]"
+      end
+
+      argv = parse_options(opts)
+      return if !argv
+
+      with_target_vms(argv[0]) do |vm|
+        vm.env.action_runner.run(Vagrant::Action::General::Validate, {:vm=>vm, :ui=>vm.ui})
+
+        if !vm.created? || vm.state != :running
+          vm.ui.error("VM not running. Not running tests.")        
+        else
+         
+          tests = expand_test_list(vm.config.rspec)
+          cmd = rspec_command(vm)
+          tests.each do |testfile|
+            vm.ui.info("Running rspec test: #{testfile}")
+            cmd = "#{cmd} #{testfile}"
+            @logger.debug("Command: #{cmd}")
+            system({ "CI_REPORTS" => vm.config.rspec.reports_dir } , cmd)
+            result = $?
+            # rspec exits 0 if all passed, 1 if some failed - and system gives nil if there was a problem starting the process
+            if result.nil? then
+              vm.ui.error "Unable to execute rspec command: #{$!} \n #{cmd}"
+            elsif result.exitstatus == 1 then
+              vm.ui.warn "Rspec test #{testfile} has at least one failure - see report output for details"
+            elsif result.exitstatus == 0 then
+              vm.ui.success "Rspec test #{testfile} passed"
+            else 
+              vm.ui.error "Unrecognized exit code from rspec: #{result.exitstatus}\nfor:#{cmd}"
+            end
+          end
+
+          if tests.empty?
+            vm.ui.info("No rspec tests found.")
+          end
+
+        end
+      end
+    end
+
+    private
+    def expand_test_list (rspec_config) 
+      tests = rspec_config.tests.map { |filespec|
+        rspec_config.dirs.find_all { |dir| File.directory?(dir) }.map { |dir|          
+          Dir.glob(File.join(dir, filespec))
+        }
+      }.flatten.uniq
+    end
+
+    def rspec_command (vm)
+      # Use gemset provided by Vagrant
+      # Cribbed from https://github.com/mitchellh/vagrant/blob/1-0-stable/lib/vagrant/command/gem.rb
+      ENV['GEM_HOME'] = vm.env.gems_path.to_s
+      ::Gem.clear_paths
+
+      use_cir = vm.config.rspec.enable_ci_reporter
+
+      # Find ci_reporter rspec hook
+      if use_cir then
+        ci_hook_candidates = ::Gem.find_files('ci/reporter/rake/rspec_loader')
+        
+        # TODO - bad assumption here, but if we find more than one, let's assume we can sort them and use the latest version.
+        ci_hook_path = (ci_hook_candidates.sort)[-1]
+
+        unless ci_hook_path then
+          raise "Could not find ci_reporter rspec hook - I expect ci_reporter to be installed as a gem under vagrant!"
+        end
+      end
+
+      # Find rspec
+      # TODO - even when you install it as a vagrant gem, it is not present in ::Gem.bindir :(
+      # Cross fingers?
+      rspec_path = vm.config.rspec.rspec_bin_path
+
+      cmd = ""
+      cmd << rspec_path
+      cmd << (use_cir ? " --require " + ci_hook_path + " --format CI::Reporter::RSpec" : "")
+      cmd << (use_cir && vm.config.rspec.suppress_ci_stdout ? " -o /dev/null " : "")
+      cmd << vm.config.rspec.dirs.map{ |d| " -I #{d}" }.join('')
+
+      cmd
+    end
+
+  end
+
+end

data/lib/vagrant-rspec-ci/config.rb

@@ -0,0 +1,58 @@
+module VagrantRspecCI
+
+  class Config < Vagrant::Config::Base
+
+    attr_writer :enable_ci_reporter, 
+    :suppress_ci_stdout,
+    :rspec_bin_path,
+    :reports_dir,
+    :dirs,
+    :tests
+
+    def enable_ci_reporter
+      @enable_ci_reporter.nil? ? true : @enable_ci_reporter
+    end
+
+    def suppress_ci_stdout
+      @suppress_ci_stdout.nil? ? true : @suppress_ci_stdout
+    end
+
+    def rspec_bin_path
+      @rpsec_bin_path || DEFAULT_RSPEC_BIN_PATH
+    end
+
+    def reports_dir
+      @reports_dir || DEFAULT_REPORTS_DIR
+    end
+
+    def dirs
+      @dirs || DEFAULT_DIRS
+    end
+
+    def tests
+      @tests || DEFAULT_TESTS
+    end
+
+    def validate(env, errors)
+
+      [
+       :dirs,
+       :tests,
+      ].each do |thing_sym|
+        # Each of these should be an array or enumerable.
+        value = self.send(thing_sym)
+        unless value.respond_to?(:each) then
+          errors.add("config.rspec.#{thing_sym} should be an array")
+          return
+        end
+      end
+       
+      # Must find at least one of the directory defaults
+      edir = self.dirs.find {|d| File.directory?(d) }
+      errors.add("No test directory found - candidates: #{self.dirs.join(',')}") unless edir
+
+    end
+
+  end
+
+end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require "vagrant-rspec-ci"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-rspec-ci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Clinton Wolfe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 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.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: vagrant-rspec-ci is a Vagrant plugin for running tests against your VMs,
+  derived from vagrant-test
+email: clintoncwolfe [at] gmail [dot] com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/vagrant_init.rb
+- lib/vagrant-rspec-ci/command.rb
+- lib/vagrant-rspec-ci/config.rb
+- lib/vagrant-rspec-ci.rb
+homepage: http://github.com/clintoncwolfe/vagrant-rspec-ci
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: vagrant-rspec-ci
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: vagrant-rspec-ci is a Vagrant plugin for running tests against your VMs,
+  derived from vagrant-test
+test_files: []