rvm-tester 1.0.0 → 1.1.0

data/README.md

@@ -4,10 +4,26 @@ Runs tests across Ruby installations in RVM using concurrent worker processes.
 This library does not sandbox installations, and requires that you have already
 installed the necessary Ruby installations under RVM.
 
+This project is heavily inspired by [Travis-CI](http://travis-ci.org), but is meant
+to provide a more lightweight interface that can be run on your development machine
+or a dedicated server. Because there is no VM sandboxing, you can also have more
+control over your test environments, as well as your Ruby versions. Note that rvm-tester
+is not meant as a replacement to Travis-CI, but rather to be used in parallel with
+the service for extra coverage in different environments that might not be supported.
+In other words, this tool is *not* a CI, but it can be used to perform useful local
+debugging of tests under multiple Ruby environments.
+
 ## Installing
 
 In addition to installing this library with `gem install rvm-tester`, you will also need
-to setup
+to setup RVM with the proper Ruby installations. RVM documentation can help with this,
+but a simple command to install 1.8.7 would be:
+
+    $ rvm install 1.8.7
+
+rvm-tester also works with Bundler and Travis-CI meta-data files to setup your
+tests. See the Integration section below for more information on setting up
+your environment with these tools.
 
 ## Usage
 
@@ -22,6 +38,7 @@ require 'rvm-tester'
 RVM::Tester::TesterTask.new(:suite) do |t|
   t.rubies = %w(1.8.6 1.8.7 1.9.2 1.9.3) # which versions to test (required!)
   t.bundle_install = true                # updates Gemfile.lock, default is true
+  t.use_travis = true                    # looks for Rubies in .travis.yml (on by default)
   t.command = "bundle exec rake test"    # runs plain "rake" by default
   t.env = {"VERBOSE" => "1"}             # set any ENV vars
   t.num_workers = 5                      # defaults to 3
@@ -29,7 +46,29 @@ RVM::Tester::TesterTask.new(:suite) do |t|
 end
 ```
 
-And simply run the task with `rake suite`.
+And simply run the task with `rake suite`. The output will look something
+like (output with `verbose=false`):
+
+```plain
+Installing Bundler and dependencies on 1.8.6,1.8.7,1.9.2,1.9.3...
+Tests passed in 1.9.3 (1527 examples, 0 failures, 18.92sec)
+Tests failed in 1.9.2 (1527 examples, 5 failures, 20.29sec)
+Tests passed in 1.8.6 (1527 examples, 0 failures, 20.26sec)
+Tests passed in 1.8.7 (1527 examples, 0 failures, 20.72sec)
+
+Output for 1.9.2 (pid 11241 exit 1, cmd=rvm 1.9.2 do bundle exec rake test):
+[SOME FAILING TEST OUTPUT HERE]
+```
+
+The Rake task also creates a task named "suite:deps" (or the task name + :deps)
+to perform only the `bundle update` portion of the task. This allows you to
+disable the automatic `bundle_install` setting, which can significantly
+speed up the time to run tests, while still enabling you to manually run the
+updater across all of your Ruby installations with the simple command:
+
+```sh
+$ rake suite:deps
+```
 
 ### Runner Class
 
@@ -42,12 +81,33 @@ runner = RVM::Tester::Runner.new(:rubies => %w(rbx 1.9.3), :verbose => true)
 runner.run
 ```
 
+## Integration
+
+### Bundler
+
+If you have a Gemfile and use the "bundle_install" setting in RVM tester (on by
+default), rvm-tester will also install the gem dependencies for your project before
+running the tests. If you do not use Bundler, you will have to make sure that each
+environment has the correct gems installed prior to testing. You can do this with
+the following command:
+
+    $ rvm all do gem install gem1 gem2 gem3 ...
+
+Where "gem1 gem2 gem3 ..." are the dependencies needed by your project.
+
+### Travis-CI
+
+rvm-tester can automatically detect a `.travis.yml` file in your project and
+use it to detect Ruby versions and commands to execute. Note that currently,
+only the "rvm", "script" and "env" fields are used from the configuration file.
+If you do not want to use the `.travis.yml` file, set `use_travis = false`.
+
 ## Dependencies
 
-This library depends on [RVM](http://rvm.beginrescueend.com) to control
+This library depends on [RVM](http://rvm.io) to control
 Ruby installations and [mob_spawner](http://github.com/lsegal/mob_spawner) to
 spawn worker processes.
 
 ## License & Copyright
 
-MobSpawner is licensed under the MIT license, © 2012 Loren Segal
+RVM Tester is licensed under the MIT license, © 2012 Loren Segal

data/lib/rvm-tester.rb

@@ -4,7 +4,7 @@ require 'mob_spawner'
 
 module RVM
   module Tester
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
 
     class TesterTask < ::Rake::TaskLib
       def initialize(name = :suite)
@@ -12,6 +12,8 @@ module RVM
         yield(runner) if block_given?
         desc "Runs tests across RVM Rubies: #{runner.rubies.join(",")}"
         task(name) { exit runner.run }
+        desc "Installs dependencies in Gemfile using Bundler for #{name}"
+        task("#{name}:deps") { runner.use_gemfile }
       end
     end
 
@@ -22,6 +24,7 @@ module RVM
       attr_accessor :command
       attr_accessor :verbose
       attr_accessor :bundle_install
+      attr_accessor :use_travis
 
       def initialize(opts = {})
         super()
@@ -31,7 +34,9 @@ module RVM
         self.rubies = []
         self.verbose = false
         self.bundle_install = true
+        self.use_travis = true
         opts.each {|k,v| meth = "#{k}="; send(meth, v) if respond_to?(meth) }
+        load_travis_opts if use_travis
       end
 
       def run
@@ -42,7 +47,6 @@ module RVM
           MobSpawner::Command.new(
             :command => "rvm #{ruby} do #{command}",
             :env => env, :data => {:ruby => ruby, :time => nil})
-          
         end
         spawner = MobSpawner.new
         spawner.commands = commands
@@ -100,6 +104,21 @@ module RVM
         puts "Done."
       end
 
+      def load_travis_opts
+        return unless File.file?(".travis.yml")
+        debug "Loading options from .travis.yml file"
+        require 'yaml'
+        yaml = YAML.load_file(".travis.yml")
+        self.rubies = yaml['rvm'] if yaml['rvm']
+        self.command = yaml['script'] if yaml['script']
+        [yaml['env']].flatten.compact.each do |envvar|
+          envvar.split(/\s+/).each do |subvar|
+            key, value = *subvar.split("=")
+            self.env[key] = value
+          end
+        end
+      end
+
       def debug(info)
         return unless verbose
         puts(info)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvm-tester
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000 -04:00
+date: 2012-05-10 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70254285984200 !ruby/object:Gem::Requirement
+  requirement: &70300117114540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70254285984200
+  version_requirements: *70300117114540
 - !ruby/object:Gem::Dependency
   name: mob_spawner
-  requirement: &70254285983500 !ruby/object:Gem::Requirement
+  requirement: &70300117113320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70254285983500
+  version_requirements: *70300117113320
 description: 
 email: lsegal@soen.ca
 executables: []