furnish 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d4afd9cd6de61bdd854e6d2f7a1a6872752f6f4
-  data.tar.gz: 170882525003c0f981bd530c237eb6ff49833ce6
+  metadata.gz: 59696ae50785a0a803ebe6797e627c43230c6cfd
+  data.tar.gz: 3847e7e726cb5bd4a5791d5fb17e5fd00eae52ea
 SHA512:
-  metadata.gz: 654feec56dab6dcdad88a5b5778188fa53930482000a88d0c67d98ed91b7cb6118ec30b6064ffb647e7a2a9a8b0e8c0ee6e91f7fc98d876188cf3fb8c8974445
-  data.tar.gz: 5e3047a0556417cb61853a560cd7efa9c4cb75def76c9aa2a6585063a25092b3b90e00c60be2a5e61d22019f59642645575cde00b251d8029897cec2c11bcc26
+  metadata.gz: 231a68d0bb0550efd3c87d337a8f1cf0419bf9af577cfc649a3e6ace96dcb17a3a1fbcd08a578b7577d605f72c5c559a3a4c8c8e6b1bc6f8b3750e321222dc59
+  data.tar.gz: cfba9a6a29dbdbae88f561812309739cd8738c45f71618fbff262fefd7f0bb40ac682fddc6d9d46d1f5b03f9aaf32583490130623bc7ead743f6de8289b77389

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.1.2 (04/27/2013)
+  * Logger changes:
+    * Fixed: Certain situations with if_debug and the IO proxy would result in
+      surprising behavior with stdio.
+    * with_tag is a new call to prefix log messages in a block with a tag.
+    * redirect is a new call to temporarily redirect I/O in the logger.
+    * Furnish::Provisioners::API now includes the logger mixin by default.
+  * Provisioner properties now use strings instead of symbols -- resolves a
+    potential memory exhaustion issue.
+  * Failed provisions no longer log the failure twice.
+  * Furnish::Protocol#accepts_from_any? is a predicate to reflect the value as
+    true or false.
 # 0.1.1 (04/16/2013)
   * #wait_for would spin forever if something got flagged as needing recovery
     (threaded scheduler only). Now raises the first item's exception if
@@ -9,6 +21,7 @@
     * #teardown_group is aliased to #d and #down
   * New API: Furnish::Scheduler#groups can be used to more easily get at
     provisioner groups the scheduler knows about.
+
 # 0.1.0 (04/09/2013)
   * Furnish requires 1.9.3 or greater -- always has been the case, now rubygems enforces that for us.
   * Runtime performance increased significantly. No hard numbers, but test
@@ -45,6 +58,7 @@
     * `<<` is now an alias for `schedule_provisioner_group`
     * `s` and `sched` are now aliases for `schedule_provision`
   * Probably some other shit I don't remember now.
+
 # 0.0.4 (03/25/2013)
   * Support for FURNISH_DEBUG environment variable for test suites.
   * Ruby 2.0.0-p0 Compatibility Fixes

data/furnish.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'palsy', '~> 0.0.4'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'minitest', '~> 4.5.0'
+  gem.add_development_dependency 'minitest', '~> 4.7'
   gem.add_development_dependency 'guard-minitest'
   gem.add_development_dependency 'guard-rake', '~> 0.0.8'
   gem.add_development_dependency 'rdoc', '~> 4'

data/lib/furnish/logger.rb

@@ -45,11 +45,21 @@ module Furnish
     # with the standard logger object set as Furnish.logger.
     #
     module Mixins
-      #
+      # :method: if_debug
       # Delegates to Furnish::Logger#if_debug.
-      #
-      def if_debug(*args, &block)
-        Furnish.logger.if_debug(*args, &block)
+
+      # :method: redirect
+      # Delegates to Furnish::Logger#redirect.
+
+      # :method: with_tag
+      # Delegates to Furnish::Logger#with_tag.
+
+      %w[if_debug redirect with_tag].each do |meth|
+        module_eval <<-EOF
+          def #{meth}(*args, &block)
+            Furnish.logger.#{meth}(*args, &block)
+          end
+        EOF
       end
     end
 
@@ -62,7 +72,12 @@ module Furnish
     # The IO object. Probably best to not mess with this attribute directly,
     # most methods will be proxied to it.
     #
-    attr_reader   :io
+    attr_reader :io
+
+    #
+    # Optional tag. See #with_tag for an example.
+    #
+    attr_reader :tag
 
     #
     # Create a new Furnish::Logger. Takes an IO object and an Integer debug
@@ -89,17 +104,112 @@ module Furnish
     # if_debug is synchronized over the logger's mutex.
     #
     def if_debug(level=1, else_block=nil, &block)
-      run = lambda do
-        if debug_level >= level and block
-          io.instance_eval(&block)
-        elsif else_block
-          io.instance_eval(&else_block)
+      hijack_stdio do
+        begin
+          run = lambda do
+            if debug_level >= level and block
+              instance_eval(&block)
+            elsif else_block
+              instance_eval(&else_block)
+            end
+          end
+
+          @write_mutex.synchronize { run.call }
+        rescue ThreadError
+          run.call
         end
       end
+    end
 
-      @write_mutex.synchronize { run.call }
-    rescue ThreadError
-      run.call
+    #
+    # Makes stdio Furnish::Logger objects for the duration of the block. Used
+    # by #if_debug for the purposes of not breaking expectations.
+    #
+    def hijack_stdio
+      orig_stdout, orig_stderr = nil, nil
+
+      if io != $stdout
+        orig_stdout = $stdout
+        $stdout = self
+      end
+
+      if io != $stderr
+        orig_stderr = $stderr
+        $stderr = self
+      end
+
+      yield
+    ensure
+      $stdout = orig_stdout if orig_stdout
+      $stderr = orig_stderr if orig_stderr
+    end
+
+    #
+    # Temporarily redirects IO to a new IO object for the duration of the
+    # block. Example below:
+    #
+    #     Furnish.logger.redirect($stdout) do
+    #       Furnish.logger.if_debug do
+    #         puts "herp" # prints to stdout
+    #       end
+    #     end
+    #
+    #     # prints to original logger IO
+    #     Furnish.logger.puts "hi"
+    #
+    def redirect(new_io, &block)
+      tmp_io = @io
+      @io = new_io
+      yield
+      @io = tmp_io
+    end
+
+    #
+    # Prefixes all 'puts' calls with a string of text (a "tag") provided for
+    # the duration of the block.
+    #
+    # Example:
+    #
+    #
+    #     @logger.with_tag("hi") do
+    #       @logger.if_debug do
+    #         puts "hello" # "[hi] hello"
+    #       end
+    #     end
+    #
+    #     @logger.puts "hello" # "hello"
+    #
+    def with_tag(new_tag, &block)
+      @tag = new_tag
+      yield
+      @tag = nil
+    end
+
+    #
+    # Hacky puts method to handle tags.
+    #
+    def puts(*args)
+      if tag
+        io.print("[#{tag}] ")
+      end
+
+      method_missing(:puts, *args)
+    end
+
+    #
+    # Makes it possible to assign this to $stdout and $stderr.
+    #
+    def write(*args)
+      method_missing(:write, *args)
+    end
+
+    #
+    # Hacky close method that keeps us from closing stdio.
+    #
+    def close
+      # XXX StringIO apparently overrides respond_to_missing for #to_i but
+      #     doesn't implement #to_i
+      io.close unless io == $stdout or io == $stderr
     end
 
     #

data/lib/furnish/protocol.rb

@@ -139,6 +139,13 @@ module Furnish # :nodoc:
       @hash[:accepts_from_any] = val
     end
 
+    #
+    # Predicate for the value of #accepts_from_any.
+    #
+    def accepts_from_any?
+      !!@hash[:accepts_from_any]
+    end
+
     #
     # look up a rule set -- generally should not be used by consumers.
     #

data/lib/furnish/provisioner_group.rb

@@ -93,10 +93,6 @@ module Furnish
         startup_args = args
 
         unless args = this_prov.startup(startup_args)
-          if_debug do
-            puts "Could not provision #{this_prov}"
-          end
-
           set_recovery(this_prov, i, startup_args)
           raise "Could not provision #{this_prov}"
         end

data/lib/furnish/provisioners/api.rb

@@ -1,5 +1,6 @@
 require 'furnish/provisioner'
 require 'furnish/protocol'
+require 'furnish/logger'
 
 module Furnish # :nodoc:
   module Provisioner # :nodoc:
@@ -56,6 +57,8 @@ module Furnish # :nodoc:
     #
     class API
 
+      include Furnish::Logger::Mixins
+
       #
       # Ensures all properties are inherited by subclasses that inherit from API.
       #
@@ -126,7 +129,7 @@ module Furnish # :nodoc:
       #         { :description => "does a foo", :type => Integer }
       #
       def self.furnish_property(name, description="", type=Object)
-        name = name.to_sym unless name.kind_of?(Symbol)
+        name = name.to_s unless name.kind_of?(String)
 
         attr_accessor name
 
@@ -278,6 +281,7 @@ module Furnish # :nodoc:
         end
 
         args.each do |k, v|
+          k = k.to_s unless k.kind_of?(String)
           props = self.class.furnish_properties
 
           if props.has_key?(k)

data/lib/furnish/provisioners/dummy.rb

@@ -90,6 +90,15 @@ module Furnish
 
         yield
       end
+
+      #
+      # Test the mixin functionality
+      #
+      def make_log
+        if_debug do
+          puts "hello from Dummy"
+        end
+      end
     end
   end
 end

data/lib/furnish/version.rb

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

data/test/test_api.rb

@@ -21,12 +21,12 @@ class TestAPI < Furnish::TestCase
     assert_respond_to(@klass, :furnish_property)
 
     assert_kind_of(Hash, @klass.furnish_properties)
-    assert_includes(@klass.furnish_properties, :foo)
-    assert_includes(@klass.furnish_properties, :a_string)
-    refute_includes(@klass.furnish_properties, :bar)
-    assert_kind_of(Hash, @klass.furnish_properties[:foo])
-    assert_equal("does things with foo", @klass.furnish_properties[:foo][:description])
-    assert_equal(Integer, @klass.furnish_properties[:foo][:type])
+    assert_includes(@klass.furnish_properties, "foo")
+    assert_includes(@klass.furnish_properties, "a_string")
+    refute_includes(@klass.furnish_properties, "bar")
+    assert_kind_of(Hash, @klass.furnish_properties["foo"])
+    assert_equal("does things with foo", @klass.furnish_properties["foo"][:description])
+    assert_equal(Integer, @klass.furnish_properties["foo"][:type])
 
     obj = @klass.new(:foo => 1)
 

data/test/test_logger.rb

@@ -1,5 +1,6 @@
 require 'helper'
 require 'tempfile'
+require 'stringio'
 
 class TestLogger < Furnish::TestCase
   def setup
@@ -60,6 +61,51 @@ class TestLogger < Furnish::TestCase
     assert_equal("foo\nquux\nlevel2\n", read_logfile, "debug level is 2 and if_debug checking for 1")
   end
 
+  def test_redirect
+    @logger.debug_level = 3
+    io = StringIO.new('', 'w')
+    @logger.redirect(io) do
+      @logger.if_debug do
+        puts "herp"
+      end
+    end
+
+    @logger.if_debug do
+      puts "derp"
+    end
+
+    assert_equal("derp\n", read_logfile)
+    assert_equal("herp\n", io.string)
+  end
+
+  def test_with_tag
+    @logger.debug_level = 3
+    @logger.with_tag("fart") do
+      @logger.if_debug do
+        puts "hello"
+      end
+    end
+
+    @logger.if_debug do
+      puts "hello"
+    end
+
+    assert_equal("[fart] hello\nhello\n", read_logfile)
+  end
+
+  def test_api_has_logger
+    old_logger = Furnish.logger
+    io = StringIO.new('', 'w')
+    Furnish.logger = Furnish::Logger.new(io, 3)
+
+    d = Furnish::Provisioner::Dummy.new
+    d.make_log
+
+    assert_equal("hello from Dummy\n", io.string)
+  ensure
+    Furnish.logger = old_logger
+  end
+
   def teardown
     @logger.close
     @logger_file.unlink

data/test/test_protocol.rb

@@ -19,8 +19,10 @@ class TestProtocol < Furnish::TestCase
     end
 
     refute(proto[:accepts_from_any])
+    refute(proto.accepts_from_any?)
     proto.accepts_from_any(true)
     assert(proto[:accepts_from_any])
+    assert(proto.accepts_from_any?)
   end
 
   def test_configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furnish
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Erik Hollensbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: palsy
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A novel way to do virtual machine provisioning