furnish 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+* 0.0.2 (03/20/2013)
+  * Extract Furnish::TestCase into gem for consumption by other gems that need to test against furnish.
+
+* 0.0.1 (02/23/2013)
+  * Initial release as extracted from chef-workflow.

data/README.md

@@ -41,7 +41,7 @@ Or install it yourself as:
 ```ruby
 Furnish.init("state.db")
 # set a logger if you want -- See Furnish::Logger for more info
-Furnish.logger = File.open('log', 'w')
+Furnish.logger = Furnish::Logger.new(File.open('log', 'w'))
 # start a scheduler and start spinning
 scheduler = Furnish::Scheduler.new
 scheduler.run # returns immediately

data/lib/furnish/test.rb

@@ -0,0 +1,99 @@
+require 'minitest/unit'
+require 'tempfile'
+require 'furnish'
+
+module Furnish
+  #
+  # Furnish::TestCase is a test harness for testing things with furnish, like
+  # provisioner libraries. It is intended to be consumed by other libraries.
+  #
+  # There are few others, such as SchedulerTestCase and
+  # RunningSchedulerTestCase which are tuned to specific scenarios, but inherit
+  # from this class.
+  #
+  # The basic case initializes furnish and the logger in a safe way in setup,
+  # and cleans up in teardown.
+  #
+  class TestCase < MiniTest::Unit::TestCase
+    def setup # :nodoc:
+      @tempfiles ||= []
+      file = Tempfile.new('furnish_db')
+      @tempfiles.push(file)
+      logfile = Tempfile.new('furnish_log')
+      @tempfiles.push(logfile)
+      Furnish.logger = Furnish::Logger.new(logfile, 3)
+      Furnish.init(file.path)
+      return file
+    end
+
+    def teardown # :nodoc:
+      Furnish.logger.close
+      Furnish.shutdown
+      @tempfiles.each do |file|
+        file.unlink
+      end
+    end
+  end
+
+  #
+  # SchedulerTestCase inherits from Furnish::TestCase and configures a threaded
+  # scheduler, but does not attempt to start it. It's intended to be a
+  # primitive for cases where you might create a number of schedulers.
+  #
+  # If the scheduler throws an exception for any reason, the test suite will
+  # abort.
+  #
+  # RunningSchedulerTestCase deals with managing a running scheduler for you.
+  #
+  class SchedulerTestCase < TestCase
+    ##
+    # Furnish::Scheduler object.
+    attr_reader :sched
+
+    def setup # :nodoc:
+      super
+      @sched = Furnish::Scheduler.new
+      @monitor = Thread.new { loop { @sched.running?; sleep 1 } }
+      @monitor.abort_on_exception = true
+    end
+
+    def teardown # :nodoc:
+      @monitor.kill rescue nil
+      super
+    end
+
+    ##
+    #
+    # Assert the named group is solved, as far as the scheduler's concerned.
+    #
+    def assert_solved(name)
+      assert_includes(sched.vm.solved, name, "#{name} is solved in the scheduler")
+    end
+
+    ##
+    #
+    # Refute the named group is solved, as far as the scheduler's concerned.
+    #
+    def refute_solved(name)
+      refute_includes(sched.vm.solved, name, "#{name} is solved in the scheduler")
+    end
+  end
+
+  ##
+  #
+  # Inherits from SchedulerTestCase and manages a running scheduler in
+  # conjunction with all the other features.
+  #
+  class RunningSchedulerTestCase < SchedulerTestCase
+    def setup # :nodoc:
+      super
+      @sched.run
+    end
+
+    def teardown # :nodoc:
+      @sched.stop
+      sleep 0.3 while @sched.running?
+      super
+    end
+  end
+end

data/lib/furnish/version.rb

@@ -1,4 +1,4 @@
 module Furnish
   # The current version of Furnish.
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/mt_cases.rb

@@ -1,4 +1,5 @@
 require 'furnish/provisioners/dummy'
+require 'furnish/test'
 
 Dummy = Furnish::Provisioner::Dummy unless defined? Dummy
 
@@ -31,44 +32,7 @@ class StopExceptionDummy < Dummy
 end
 
 module Furnish
-  class TestCase < MiniTest::Unit::TestCase
-    def setup
-      @tempfiles ||= []
-      file = Tempfile.new('furnish_db')
-      @tempfiles.push(file)
-      logfile = Tempfile.new('furnish_log')
-      @tempfiles.push(logfile)
-      Furnish.logger = Furnish::Logger.new(logfile, 3)
-      Furnish.init(file.path)
-      return file
-    end
-
-    def teardown
-      Furnish.logger.close
-      Furnish.shutdown
-      @tempfiles.each do |file|
-        file.unlink
-      end
-    end
-  end
-
-  class SchedulerTestCase < TestCase
-    attr_reader :sched
-
-    def setup
-      super
-      @sched = Furnish::Scheduler.new
-      @monitor = Thread.new { loop { @sched.running?; sleep 1 } }
-      @monitor.abort_on_exception = true
-    end
-
-    def teardown
-      @monitor.kill rescue nil
-      super
-    end
-  end
-
-  class RunningSchedulerTestCase < SchedulerTestCase
+  class RestartingSchedulerTestCase < SchedulerTestCase
     def teardown
       sched.stop
       super

data/test/test_scheduler_serial.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestSchedulerSerial < Furnish::RunningSchedulerTestCase
+class TestSchedulerSerial < Furnish::RestartingSchedulerTestCase
   def setup
     super
     sched.serial = true

data/test/test_scheduler_threaded.rb

@@ -14,7 +14,7 @@ class SleepyFailingDummy < SleepyDummy
   end
 end
 
-class TestSchedulerThreaded < Furnish::RunningSchedulerTestCase
+class TestSchedulerThreaded < Furnish::RestartingSchedulerTestCase
   def setup
     super
     sched.serial = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: furnish
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: palsy
@@ -147,6 +147,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -159,6 +160,7 @@ files:
 - lib/furnish/provisioner_group.rb
 - lib/furnish/provisioners/dummy.rb
 - lib/furnish/scheduler.rb
+- lib/furnish/test.rb
 - lib/furnish/version.rb
 - lib/furnish/vm.rb
 - test/helper.rb
@@ -182,18 +184,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 799210686028845944
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 799210686028845944
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25