timberline 0.1.2

data/test/partial_minispec.rb

@@ -0,0 +1,229 @@
+## This is code stolen from the definition file for Minitest::Spec. We really
+# like everything about Minitest::Spec except for the expectations part, so we
+# are stealing it and using it here. Shamelessly. 
+#
+# This code may go out of date in future versions of Ruby, so we should keep an
+# eye on that. But that's better than reinventing the wheel.
+
+module Kernel # :nodoc:
+  ##
+  # Describe a series of expectations for a given target +desc+.
+  #
+  # TODO: find good tutorial url.
+  #
+  # Defines a test class subclassing from either MiniTest::Spec or
+  # from the surrounding describe's class. The surrounding class may
+  # subclass MiniTest::Spec manually in order to easily share code:
+  #
+  #     class MySpec < MiniTest::Spec
+  #       # ... shared code ...
+  #     end
+  #
+  #     class TestStuff < MySpec
+  #       it "does stuff" do
+  #         # shared code available here
+  #       end
+  #       describe "inner stuff" do
+  #         it "still does stuff" do
+  #           # ...and here
+  #         end
+  #       end
+  #     end
+
+  def describe desc, additional_desc = nil, &block # :doc:
+    stack = MiniTest::Spec.describe_stack
+    name  = [stack.last, desc, additional_desc].compact.join("::")
+    sclas = stack.last || if Class === self && self < MiniTest::Spec then
+                            self
+                          else
+                            MiniTest::Spec.spec_type desc
+                          end
+
+    cls = sclas.create name, desc
+
+    stack.push cls
+    cls.class_eval(&block)
+    stack.pop
+    cls
+  end
+  private :describe
+end
+
+##
+# MiniTest::Spec -- The faster, better, less-magical spec framework!
+#
+# For a list of expectations, see MiniTest::Expectations.
+
+class MiniTest::Spec < MiniTest::Unit::TestCase
+  ##
+  # Contains pairs of matchers and Spec classes to be used to
+  # calculate the superclass of a top-level describe. This allows for
+  # automatically customizable spec types.
+  #
+  # See: register_spec_type and spec_type
+
+  TYPES = [[//, MiniTest::Spec]]
+
+  ##
+  # Register a new type of spec that matches the spec's description.
+  # This method can take either a Regexp and a spec class or a spec
+  # class and a block that takes the description and returns true if
+  # it matches.
+  #
+  # Eg:
+  #
+  #     register_spec_type(/Controller$/, MiniTest::Spec::Rails)
+  #
+  # or:
+  #
+  #     register_spec_type(MiniTest::Spec::RailsModel) do |desc|
+  #       desc.superclass == ActiveRecord::Base
+  #     end
+
+  def self.register_spec_type(*args, &block)
+    if block then
+      matcher, klass = block, args.first
+    else
+      matcher, klass = *args
+    end
+    TYPES.unshift [matcher, klass]
+  end
+
+  ##
+  # Figure out the spec class to use based on a spec's description. Eg:
+  #
+  #     spec_type("BlahController") # => MiniTest::Spec::Rails
+
+  def self.spec_type desc
+    TYPES.find { |matcher, klass|
+      if matcher.respond_to? :call then
+        matcher.call desc
+      else
+        matcher === desc.to_s
+      end
+    }.last
+  end
+
+  @@describe_stack = []
+  def self.describe_stack # :nodoc:
+    @@describe_stack
+  end
+
+  ##
+  # Returns the children of this spec.
+
+  def self.children
+    @children ||= []
+  end
+
+  def self.nuke_test_methods! # :nodoc:
+    self.public_instance_methods.grep(/^test_/).each do |name|
+      self.send :undef_method, name
+    end
+  end
+
+  ##
+  # Define a 'before' action. Inherits the way normal methods should.
+  #
+  # NOTE: +type+ is ignored and is only there to make porting easier.
+  #
+  # Equivalent to MiniTest::Unit::TestCase#setup.
+
+  def self.before type = :each, &block
+    raise "unsupported before type: #{type}" unless type == :each
+
+    add_setup_hook {|tc| tc.instance_eval(&block) }
+  end
+
+  ##
+  # Define an 'after' action. Inherits the way normal methods should.
+  #
+  # NOTE: +type+ is ignored and is only there to make porting easier.
+  #
+  # Equivalent to MiniTest::Unit::TestCase#teardown.
+
+  def self.after type = :each, &block
+    raise "unsupported after type: #{type}" unless type == :each
+
+    add_teardown_hook {|tc| tc.instance_eval(&block) }
+  end
+
+  ##
+  # Define an expectation with name +desc+. Name gets morphed to a
+  # proper test method name. For some freakish reason, people who
+  # write specs don't like class inheritence, so this goes way out of
+  # its way to make sure that expectations aren't inherited.
+  #
+  # This is also aliased to #specify and doesn't require a +desc+ arg.
+  #
+  # Hint: If you _do_ want inheritence, use minitest/unit. You can mix
+  # and match between assertions and expectations as much as you want.
+
+  def self.it desc = "anonymous", &block
+    block ||= proc { skip "(no tests defined)" }
+
+    @specs ||= 0
+    @specs += 1
+
+    name = "test_%04d_%s" % [ @specs, desc.gsub(/\W+/, '_').downcase ]
+
+    define_method name, &block
+
+    self.children.each do |mod|
+      mod.send :undef_method, name if mod.public_method_defined? name
+    end
+  end
+
+  ##
+  # Essentially, define an accessor for +name+ with +block+.
+  #
+  # Why use let instead of def? I honestly don't know.
+
+  def self.let name, &block
+    define_method name do
+      @_memoized ||= {}
+      @_memoized.fetch(name) { |k| @_memoized[k] = instance_eval(&block) }
+    end
+  end
+
+  ##
+  # Another lazy man's accessor generator. Made even more lazy by
+  # setting the name for you to +subject+.
+
+  def self.subject &block
+    let :subject, &block
+  end
+
+  def self.create name, desc # :nodoc:
+    cls = Class.new(self) do
+      @name = name
+      @desc = desc
+
+      nuke_test_methods!
+    end
+
+    children << cls
+
+    cls
+  end
+
+  def self.to_s # :nodoc:
+    defined?(@name) ? @name : super
+  end
+
+  # :stopdoc:
+  def after_setup
+    run_setup_hooks
+  end
+
+  def before_teardown
+    run_teardown_hooks
+  end
+
+  class << self
+    attr_reader :desc
+    alias :specify :it
+    alias :name :to_s
+  end
+  # :startdoc:
+end

data/test/test_config.yaml

@@ -0,0 +1,6 @@
+host: localhost
+port: 12345
+timeout: 10
+password: foo
+database: 3
+namespace: treecurve

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+
+require 'partial_minispec'
+
+# include the gem
+require 'timberline'
+
+# Use database 15 for testing, so we don't risk overwriting any data that's
+# actually useful
+def clear_test_db
+  Timberline.config do |c|
+    c.database = 15
+  end
+  Timberline.redis.flushdb
+end

data/test/unit/test_config.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+describe Timberline::Config do
+  describe "Without any preset YAML configs" do
+    before do
+      @config = Timberline::Config.new
+    end
+
+    it "builds a proper config hash for Redis" do
+      @logger = Logger.new STDERR
+
+      @config.host = "localhost"
+      @config.port = 12345
+      @config.timeout = 10
+      @config.password = "foo"
+      @config.database = 3
+      @config.logger = @logger
+
+      config = @config.redis_config
+
+      assert_equal "localhost", config[:host]
+      assert_equal 12345, config[:port]
+      assert_equal 10, config[:timeout]
+      assert_equal "foo", config[:password]
+      assert_equal 3, config[:db]
+      assert_equal @logger, config[:logger]
+
+    end
+
+    it "reads configuration from a YAML config file" do
+      base_dir = File.dirname(File.path(__FILE__))
+      yaml_file = File.join(base_dir, "..", "test_config.yaml")
+      @config.load_from_yaml(yaml_file)
+      assert_equal "localhost", @config.host
+      assert_equal 12345, @config.port
+      assert_equal 10, @config.timeout
+      assert_equal "foo", @config.password
+      assert_equal 3, @config.database
+      assert_equal "treecurve", @config.namespace
+    end
+  end
+
+  describe "when in a Rails app without a config file" do
+    before do
+      RAILS_ROOT = File.join(File.dirname(File.path(__FILE__)), "..", "gibberish")
+      @config = Timberline::Config.new
+    end
+
+    after do
+      Object.send(:remove_const, :RAILS_ROOT)
+    end
+
+    it "should load successfully without any configs." do
+      ["database","host","port","timeout","password","logger","namespace"].each do |setting|
+        assert_equal nil, @config.instance_variable_get("@#{setting}")
+      end
+    end
+  end
+
+  describe "when in a Rails app with a config file" do
+    before do
+      RAILS_ROOT = File.join(File.dirname(File.path(__FILE__)), "..", "fake_rails")
+      @config = Timberline::Config.new
+    end
+
+    after do
+      Object.send(:remove_const, :RAILS_ROOT)
+    end
+
+    it "should load the config/timberline.yaml file" do
+      assert_equal "localhost", @config.host
+      assert_equal 12345, @config.port
+      assert_equal 10, @config.timeout
+      assert_equal "foo", @config.password
+      assert_equal 3, @config.database
+      assert_equal "treecurve", @config.namespace
+    end
+  end
+
+  describe "when TIMBERLINE_YAML is defined" do
+    before do
+      TIMBERLINE_YAML = File.join(File.dirname(File.path(__FILE__)), "..", "test_config.yaml")
+      @config = Timberline::Config.new
+    end
+
+    after do
+      Object.send(:remove_const, :TIMBERLINE_YAML)
+    end
+
+    it "should load the specified yaml file" do
+      assert_equal "localhost", @config.host
+      assert_equal 12345, @config.port
+      assert_equal 10, @config.timeout
+      assert_equal "foo", @config.password
+      assert_equal 3, @config.database
+      assert_equal "treecurve", @config.namespace
+    end
+  end
+
+  describe "when TIMBERLINE_YAML is defined, but doesn't exist" do
+    before do
+      TIMBERLINE_YAML = File.join(File.dirname(File.path(__FILE__)), "..", "fake_config.yaml")
+    end
+
+    after do
+      Object.send(:remove_const, :TIMBERLINE_YAML)
+    end
+
+    it "should raise an exception" do
+      assert_raises RuntimeError do 
+        @config = Timberline::Config.new
+      end
+    end
+  end
+end

data/test/unit/test_envelope.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'date'
+
+describe Timberline::Envelope do
+  before do
+    @envelope = Timberline::Envelope.new
+  end
+
+  describe "newly instantiated" do
+    it "raises a MissingContentException when to_s is called because the contents are nil" do
+      assert_raises Timberline::MissingContentException do
+        @envelope.to_s
+      end
+    end
+
+    it "has an empty hash for metadata" do
+      assert_equal({}, @envelope.metadata)
+    end
+
+    it "allows for the reading of attributes via method_missing magic" do
+      @envelope.metadata["original_queue"] = "test_queue"
+      assert_equal "test_queue", @envelope.original_queue
+    end
+
+    it "allows for the setting of attributes via method_missing magic" do
+      @envelope.original_queue = "test_queue"
+      assert_equal "test_queue", @envelope.metadata["original_queue"]
+    end
+  end
+
+  describe "with contents" do
+    before do
+      @envelope.contents = "Test data"
+    end
+
+    it "returns a JSON string when to_s is called" do
+      json_string = @envelope.to_s
+      json_data = JSON.parse(json_string)
+      assert_equal "Test data", json_data["contents"]
+    end
+
+    it "only includes a 'contents' parameter by default" do
+      json_string = @envelope.to_s
+      json_data = JSON.parse(json_string)
+      assert_equal 1, json_data.keys.size
+    end
+
+    it "also includes metadata, if provided" do
+      time = DateTime.now
+      time_s = DateTime.now.to_s
+      @envelope.first_posted = time
+      @envelope.origin_queue = "test_queue"
+
+      json_string = @envelope.to_s
+      json_data = JSON.parse(json_string)
+      assert_equal "test_queue", json_data["origin_queue"]
+      assert_equal time_s, json_data["first_posted"]
+    end
+
+    it "parses itself back correctly using from_json" do
+      json_string = @envelope.to_s
+      new_envelope = Timberline::Envelope.from_json(json_string)
+      assert_equal @envelope.contents, new_envelope.contents
+      assert_equal @envelope.metadata, new_envelope.metadata
+    end
+  end
+end

data/test/unit/test_queue.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+describe Timberline::Queue do
+  describe "newly instantiated" do
+    before do
+      clear_test_db
+      @queue = Timberline::Queue.new("test_queue")
+    end
+
+    it "saves the passed-in string as its queue name" do
+      assert_equal "test_queue", @queue.queue_name
+    end
+
+    it "has a length of 0" do
+      assert_equal 0, @queue.length
+    end
+
+    it "has a default read_timeout of 0" do
+      assert_equal 0, @queue.read_timeout
+    end
+
+    it "responds nil to a pop request after the read_timeout occurs" do
+      # Let's set the read_timeout to 1 in order for this test to return
+      @queue.instance_variable_set("@read_timeout", 1)
+      assert_equal nil, @queue.pop
+    end
+
+    it "puts an item on the queue when that item is pushed" do
+      test_item = "Test Queue Item"
+      assert_equal 1, @queue.push(test_item)
+    end
+
+    it "wraps an item in an envelope when that item is pushed" do
+      test_item = "Test Queue Item"
+      assert_equal 1, @queue.push(test_item)
+      data = @queue.pop
+      assert_kind_of Timberline::Envelope, data
+      assert_equal test_item, data.contents
+    end
+
+    it "doesn't wrap an envelope that gets pushed in another envelope" do
+      test_item = "Test Queue Item"
+      env = Timberline::Envelope.new
+      env.contents = test_item
+      assert_equal 1, @queue.push(env)
+      data = @queue.pop
+      assert_kind_of Timberline::Envelope, data
+      assert_equal test_item, data.contents
+    end
+  end
+
+  describe "with one item" do
+    before do
+      clear_test_db
+      @test_item = "Test Queue Item"
+      @queue = Timberline::Queue.new("test_queue")
+      @queue.push(@test_item)
+    end
+
+    it "has a length of 1" do
+      assert_equal 1, @queue.length
+    end
+
+    it "responds to pop with the one item" do
+      assert_equal @test_item, @queue.pop.contents
+    end
+
+    it "responds nil to a second pop" do
+      # Let's set the read_timeout to 1 in order for this test to return
+      @queue.instance_variable_set("@read_timeout", 1)
+      assert_equal @test_item, @queue.pop.contents
+      assert_equal nil, @queue.pop
+    end
+  end
+end

data/test/unit/test_queue_manager.rb

@@ -0,0 +1,154 @@
+require 'test_helper'
+
+describe Timberline::QueueManager do
+  describe "newly instantiated" do
+    before do
+      clear_test_db
+      @qm = Timberline::QueueManager.new
+    end
+
+    it "has an empty queue list" do
+      assert_equal 0, @qm.queue_list.size
+    end
+
+    it "instantiates an error_queue" do
+      assert_kind_of Timberline::Queue, @qm.error_queue
+      assert_equal "timberline_errors", @qm.error_queue.queue_name
+    end
+
+    it "creates a new queue when asked if it doesn't exist" do
+      queue = @qm.queue("test_queue")
+      assert_kind_of Timberline::Queue, queue
+      assert_equal 1, @qm.queue_list.size
+      assert_equal queue, @qm.queue_list["test_queue"]
+    end
+
+    it "doesn't create a new queue if a queue by the same name already exists" do
+      queue = @qm.queue("test_queue")
+      new_queue = @qm.queue("test_queue")
+      assert_equal queue, new_queue
+      assert_equal 1, @qm.queue_list.size
+    end
+
+    it "creates a new queue as necessary when 'push' is called and pushes the item" do
+      @qm.push("test_queue", "Howdy kids.")
+      assert_equal 1, @qm.queue_list.size
+      queue = @qm.queue("test_queue")
+      assert_equal 1, queue.length
+      assert_equal "Howdy kids.", queue.pop.contents
+    end
+
+    it "uses any passed-in metadata to push when building the envelope" do
+      @qm.push("test_queue", "Howdy kids.", { :special_notes => "Super-awesome."})
+      queue = @qm.queue("test_queue")
+      assert_equal 1, queue.length
+      data = queue.pop
+      assert_equal "Howdy kids.", data.contents
+      assert_equal "Super-awesome.", data.special_notes
+    end
+
+    it "includes some default information in the metadata" do
+      @qm.push("test_queue", "Howdy kids.")
+      queue = @qm.queue("test_queue")
+      data = queue.pop
+      assert_equal "Howdy kids.", data.contents
+      assert_kind_of DateTime, DateTime.parse(data.submitted_at)
+      assert_equal "test_queue", data.origin_queue
+      assert_equal 0, data.retries
+      assert_equal 1, data.job_id
+    end
+
+    it "allows you to retry a job that has failed" do
+      @qm.push("test_queue", "Howdy kids.")
+      queue = @qm.queue("test_queue")
+      data = queue.pop
+
+      assert_equal 0, queue.length
+      
+      @qm.retry_job(data)
+
+      assert_equal 1, queue.length
+
+      data = queue.pop
+      assert_equal 1, data.retries
+      assert_kind_of DateTime, DateTime.parse(data.last_tried_at)
+    end
+
+    it "will continue retrying until we pass the max retries (defaults to 5)" do
+      @qm.push("test_queue", "Howdy kids.")
+      queue = @qm.queue("test_queue")
+      data = queue.pop
+
+      5.times do |i|
+        @qm.retry_job(data)
+        assert_equal 1, queue.length
+        data = queue.pop
+        assert_equal i + 1, data.retries
+      end
+
+      @qm.retry_job(data)
+      assert_equal 0, queue.length
+      assert_equal 1, @qm.error_queue.length
+    end
+
+    it "will allow you to directly error out a job" do
+      @qm.push("test_queue", "Howdy kids.")
+      queue = @qm.queue("test_queue")
+      data = queue.pop
+
+      @qm.error_job(data)
+      assert_equal 1, @qm.error_queue.length
+      data = @qm.error_queue.pop
+      assert_kind_of DateTime, DateTime.parse(data.fatal_error_at)
+    end
+
+    it "will allow you to watch a queue" do
+      @qm.push("test_queue", "Howdy kids.")
+      
+      assert_raises RuntimeError do
+        @qm.watch "test_queue" do |job|
+          if "Howdy kids." == job.contents
+            raise "This works."
+          end
+        end
+      end
+
+      assert_equal 0, @qm.queue("test_queue").length
+    end
+
+    it "will allow you to retry from a queue watcher" do
+      @qm.push("test_queue", "Howdy kids.")
+
+      assert_raises RuntimeError do
+        @qm.watch "test_queue" do |job|
+          if "Howdy kids." == job.contents
+            retry_job job
+            raise "Job retried."
+          end
+        end
+      end
+
+      assert_equal 1, @qm.queue("test_queue").length
+      data = @qm.queue("test_queue").pop
+      assert_equal 1, data.retries
+    end
+
+    it "will allow you to error from a queue watcher" do
+      @qm.push("test_queue", "Howdy kids.")
+
+      assert_raises RuntimeError do
+        @qm.watch "test_queue" do |job|
+          if "Howdy kids." == job.contents
+            error_job job
+            raise "Job errored."
+          end
+        end
+      end
+
+      assert_equal 1, @qm.error_queue.length
+      data = @qm.error_queue.pop
+      assert_kind_of DateTime, DateTime.parse(data.fatal_error_at)
+    end
+  end
+
+end