stalk_climber 0.0.6 → 0.1.0

data/test/unit/job_test.rb

@@ -1,196 +1,289 @@
 require 'test_helper'
-require 'json'
 
-class Job < Test::Unit::TestCase
+class Job < StalkClimber::TestCase
 
-  def setup
+  setup do
     @connection = StalkClimber::Connection.new('localhost:11300')
     @job = seed_jobs(1).first
   end
 
 
-  def test_body_performs_peek_and_parses_json
-    body = {'test' => true}.to_json
+  context 'beaneater integration' do
 
-    @job.connection.expects(:transmit).returns({
-      :body => body,
-    })
-    assert_equal body, @job.body
+    should 'derive from Beaneater::Job' do
+      assert_kind_of Beaneater::Job, @job
+    end
 
-    @job.connection.expects(:transmit).never
-    assert_equal body, @job.body
   end
 
 
-  def test_connection_stored_with_instance
-    assert @job.instance_variable_get(:@connection)
-    assert @job.connection
-  end
+  context '#body' do
 
+    should 'perform peek and set/return body' do
+      body = "test #{Time.now.to_i}"
 
-  def test_delete
-    assert @job.delete
-    assert_raise Beaneater::NotFoundError do
-      @connection.transmit("peek #{@job.id}")
+      @job.connection.expects(:transmit).returns({
+        :body => body,
+      })
+      assert_equal body, @job.body
+
+      @job.connection.expects(:transmit).never
+      assert_equal body, @job.body
     end
-    refute @job.instance_variable_get(:@body)
-    refute @job.instance_variable_get(:@stats)
-    assert_equal 'DELETED', @job.instance_variable_get(:@status)
+
   end
 
 
-  def test_exists?
-    assert @job.exists?
+  context '#connection' do
+
+    should 'set connection instance variable to connection' do
+      assert @job.instance_variable_get(:@connection)
+      assert @job.connection
+    end
 
-    @job.delete
-    refute @job.exists?
   end
 
 
-  def test_initialize_with_peek_response
-    job = StalkClimber::Job.new(@connection.transmit("peek #{@job.id}"))
-    @connection.expects(:transmit).never
-    assert_equal @connection, job.connection
-    assert_equal @job.id, job.id
-    assert_equal 'FOUND', job.instance_variable_get(:@status)
-    assert_equal('{}', job.body)
-    refute job.instance_variable_get(:@stats)
-  end
+  context '#delete' do
 
+    should 'delete the job' do
+      assert_equal 'DELETED', @job.delete[:status]
+      assert_raises Beaneater::NotFoundError do
+        @connection.transmit("peek #{@job.id}")
+      end
+      refute @job.instance_variable_get(:@body)
+      refute @job.instance_variable_get(:@stats)
+      assert_equal 'DELETED', @job.instance_variable_get(:@status)
+    end
+
+
+    should 'not clear job instance variables if delete fails' do
+      client = Beaneater::Connection.new('localhost:11300')
+      tube_name = SecureRandom.uuid
+      client.transmit("use #{tube_name}")
+      client.transmit("watch #{tube_name}")
+      client.transmit('ignore default')
+      job = client.transmit(StalkClimber::Connection::PROBE_TRANSMISSION)
+      @job = StalkClimber::Job.new(@connection.transmit("stats-job #{job[:id]}"))
+      client.transmit('reserve')
+      assert_raises Beaneater::NotFoundError do
+        @job.delete
+      end
+      assert @job.instance_variable_get(:@stats), 'Expected stats instance variable to still exist after failed deletion'
+      client.transmit("delete #{job[:id]}")
+    end
 
-  def test_initialize_with_put_response
-    @connection.expects(:transmit).never
-    assert @job.id
-    assert_equal @connection, @job.connection
-    assert_equal 'INSERTED', @job.instance_variable_get(:@status)
-    refute @job.instance_variable_get(:@body)
-    refute @job.instance_variable_get(:@stats)
   end
 
 
-  def test_initialize_with_stats_response
-    job = StalkClimber::Job.new(@connection.transmit("stats-job #{@job.id}"))
-    @connection.expects(:transmit).never
-    assert_equal @job.id, job.id
-    assert_equal @connection, job.connection
-    assert_equal 'OK', job.instance_variable_get(:@status)
-    assert job.stats
-    assert job.instance_variable_get(:@stats)
-    refute job.instance_variable_get(:@body)
-    StalkClimber::Job::STATS_ATTRIBUTES.each do |method_name|
-      assert job.send(method_name)
+  context '#exists?' do
+
+
+    should 'verify the job exists' do
+      assert @job.exists?
+
+      @job.delete
+      refute @job.exists?
     end
+
   end
 
 
-  def test_initialize_with_stats_attribute_methods_return_correct_values
-    stats_body = {
-      'age' => 3,
-      'buries' => 0,
-      'delay' => 0,
-      'id' => 4412,
-      'kicks' => 0,
-      'pri' => 4294967295,
-      'releases' => 0,
-      'reserves' => 0,
-      'state' => 'ready',
-      'time-left' => 0,
-      'timeouts' => 0,
-      'ttr'  => 300,
-      'tube' => 'default',
-    }
-    stats_response = {
-      :body => stats_body,
-      :connection => @connection,
-      :id => 149,
-      :status => 'OK',
-    }
-    job = StalkClimber::Job.new(stats_response)
-    StalkClimber::Job::STATS_ATTRIBUTES.each do |method_name|
-      assert_equal stats_body[method_name], job.send(method_name), "Expected #{stats_body[method_name.to_sym]} for #{method_name}, got #{job.send(method_name)}"
+  context '#initialize' do
+
+    should 'support initialization with peek response' do
+      job = StalkClimber::Job.new(@connection.transmit("peek #{@job.id}"))
+      @connection.expects(:transmit).never
+      assert_equal @connection, job.connection
+      assert_equal @job.id, job.id
+      assert_equal 'FOUND', job.instance_variable_get(:@status)
+      assert_equal('{}', job.body)
+      refute job.instance_variable_get(:@stats)
+    end
+
+
+    should 'support initialization with put response' do
+      @connection.expects(:transmit).never
+      assert @job.id
+      assert_equal @connection, @job.connection
+      assert_equal 'INSERTED', @job.instance_variable_get(:@status)
+      refute @job.instance_variable_get(:@body)
+      refute @job.instance_variable_get(:@stats)
+    end
+
+
+    should 'support initialization with stats response' do
+      job = StalkClimber::Job.new(@connection.transmit("stats-job #{@job.id}"))
+      @connection.expects(:transmit).never
+      assert_equal @job.id, job.id
+      assert_equal @connection, job.connection
+      assert_equal 'OK', job.instance_variable_get(:@status)
+      assert job.stats(false)
+      assert job.instance_variable_get(:@stats)
+      refute job.instance_variable_get(:@body)
+      StalkClimber::Job::CACHED_ATTRIBUTES.each do |method_name|
+        assert job.send(method_name)
+      end
+    end
+
+
+    should 'support initialization with reserve response' do
+      job = StalkClimber::Job.new(@connection.transmit('reserve'))
+      @connection.expects(:transmit).never
+      assert_equal @connection, job.connection
+      assert job.id
+      assert_equal 'RESERVED', job.instance_variable_get(:@status)
+      assert_equal('{}', job.body)
+      refute job.instance_variable_get(:@stats)
     end
+
+
+    should 'raise error if initialized with unknown response type' do
+      assert_raises RuntimeError do
+        StalkClimber::Job.new({:status => 'DELETED'})
+      end
+    end
+
   end
 
 
-  def test_initialize_with_unknown_status_raises_error
-    assert_raise RuntimeError do
-      StalkClimber::Job.new({:status => 'DELETED'})
+  context 'stats methods' do
+
+    should 'initialize stats attributes and attribute methods should return correct values' do
+      stats_body = {
+        'age' => 3,
+        'buries' => 0,
+        'delay' => 0,
+        'id' => 4412,
+        'kicks' => 0,
+        'pri' => 4294967295,
+        'releases' => 0,
+        'reserves' => 0,
+        'state' => 'ready',
+        'time-left' => 0,
+        'timeouts' => 0,
+        'ttr'  => 300,
+        'tube' => 'default',
+      }
+      stats_response = {
+        :body => stats_body,
+        :connection => @connection,
+        :id => 149,
+        :status => 'OK',
+      }
+      job = StalkClimber::Job.new(stats_response)
+      StalkClimber::Job::CACHED_ATTRIBUTES.each do |method_name|
+        assert_equal stats_body[method_name], job.send(method_name), "Expected #{stats_body[method_name]} for #{method_name}, got #{job.send(method_name)}"
+      end
+    end
+
+
+    should 'be able to force refresh of stats' do
+      initial_value = @job.age
+      @connection.expects(:transmit).returns({:body => {'age' => initial_value + 100}})
+      assert_equal initial_value + 100, @job.age(true)
+    end
+
+
+    should 'allow for not refreshing stats' do
+      initial_value = @job.age
+      @connection.expects(:transmit).never
+      assert_equal initial_value, @job.age(false)
     end
+
   end
 
 
-  def test_stats_attribute_method_can_force_refresh
-    initial_value = @job.age
-    @connection.expects(:transmit).returns({:body => {'age' => initial_value + 100}})
-    assert_equal initial_value + 100, @job.age(true)
+  context '#stats' do
+
+    should 'be able to force refresh' do
+      body = {
+        'age'=>3,
+        'buries'=>0,
+        'delay'=>0,
+        'kicks'=>0,
+        'id' => 4412,
+        'pri'=>4294967295,
+        'releases'=>0,
+        'reserves'=>0,
+        'state'=>'ready',
+        'time-left'=>0,
+        'timeouts'=>0,
+        'ttr'=>300,
+        'tube'=>'default',
+      }
+      stats_1 = {
+        :body => {},
+        :connection => @connection,
+        :id => 149,
+        :status => 'OK',
+      }
+      stats_2 = {
+        :body => body,
+        :connection => @connection,
+        :id => 149,
+        :status => 'OK',
+      }
+      @connection.expects(:transmit).twice.returns(stats_1, stats_2)
+      job = StalkClimber::Job.new(@connection.transmit("stats-job #{@job.id}"))
+      job.stats
+      StalkClimber::Job::CACHED_ATTRIBUTES.each do |method_name|
+        assert_equal body[method_name], job.send(method_name), "Expected #{body[method_name.to_sym]} for #{method_name}, got #{job.send(method_name)}"
+      end
+    end
+
+
+    should 'allow for not refreshing stats' do
+      stat = @job.stats
+      @job.connection.expects(:transmit).never
+      assert_equal stat, @job.stats(false)
+    end
+
   end
 
 
-  def test_stats_can_force_a_refresh
-    body = {
-      'age'=>3,
-      'buries'=>0,
-      'delay'=>0,
-      'kicks'=>0,
-      'id' => 4412,
-      'pri'=>4294967295,
-      'releases'=>0,
-      'reserves'=>0,
-      'state'=>'ready',
-      'time-left'=>0,
-      'timeouts'=>0,
-      'ttr'=>300,
-      'tube'=>'default',
-    }
-    stats_1 = {
-      :body => {},
-      :connection => @connection,
-      :id => 149,
-      :status => 'OK',
-    }
-    stats_2 = {
-      :body => body,
-      :connection => @connection,
-      :id => 149,
-      :status => 'OK',
-    }
-    @connection.expects(:transmit).twice.returns(stats_1, stats_2)
-    job = StalkClimber::Job.new(@connection.transmit("stats-job #{@job.id}"))
-    job.stats(:force_refresh)
-    StalkClimber::Job::STATS_ATTRIBUTES.each do |method_name|
-      assert_equal body[method_name], job.send(method_name), "Expected #{body[method_name.to_sym]} for #{method_name}, got #{job.send(method_name)}"
+  context '#to_h' do
+
+    should 'return the expected hash' do
+      job_body = "test #{Time.now.to_i}"
+      stats_body = {
+        'age' => 3,
+        'body' => job_body, # Will be ignored during job init
+        'buries' => 0,
+        'connection' => @connection, # Will be ignored during job init
+        'delay' => 0,
+        'id' => 4412,
+        'kicks' => 0,
+        'pri' => 4294967295,
+        'releases' => 0,
+        'reserves' => 0,
+        'state' => 'ready',
+        'time-left' => 0,
+        'timeouts' => 0,
+        'ttr'  => 300,
+        'tube' => 'default',
+      }
+      stats_response = {
+        :body => stats_body,
+        :connection => @connection,
+        :id => 149,
+        :status => 'OK',
+      }
+      job = StalkClimber::Job.new(stats_response)
+      job.instance_variable_set(:@body, job_body)
+      job.connection.expects(:transmit).once.returns(stats_response)
+      assert_equal stats_body, job.to_h
     end
+
   end
 
-  def test_to_h_returns_expected_hash
-    job_body = "test #{Time.now.to_i}"
-    stats_body = {
-      'age' => 3,
-      'body' => job_body, # Will be ignored during job init
-      'buries' => 0,
-      :connection => @connection, # Will be ignored during job init
-      'delay' => 0,
-      'id' => 4412,
-      'kicks' => 0,
-      'pri' => 4294967295,
-      'releases' => 0,
-      'reserves' => 0,
-      'state' => 'ready',
-      'time-left' => 0,
-      'timeouts' => 0,
-      'ttr'  => 300,
-      'tube' => 'default',
-    }
-    stats_response = {
-      :body => stats_body,
-      :connection => @connection,
-      :id => 149,
-      :status => 'OK',
-    }
-    job = StalkClimber::Job.new(stats_response)
-    job.instance_variable_set(:@body, job_body)
-    expected_hash = Hash[stats_body.map { |k, v| [k.to_sym, v] }]
-    assert_equal expected_hash, job.to_h
+
+  context '#to_s' do
+
+    should 'return expected string representation of job' do
+      assert_equal "#<StalkClimber::Job id=#{@job.id} body=#{@job.body.inspect}>", @job.to_s
+    end
+
   end
 
 end

data/test/unit/jobs_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+
+class JobsTest < StalkClimber::TestCase
+
+  context '#each' do
+
+    setup do
+      @climber = StalkClimber::Climber.new(BEANSTALK_ADDRESSES)
+
+      @test_jobs = {}
+      @climber.connection_pool.connections.each do |connection|
+        @test_jobs[connection.address] = []
+        5.times.to_a.map! do
+            @test_jobs[connection.address] << StalkClimber::Job.new(connection.transmit(StalkClimber::Connection::PROBE_TRANSMISSION))
+        end
+      end
+    end
+
+
+    should 'cache jobs for later use' do
+      jobs = {}
+      @climber.jobs.each do |job|
+        jobs[job.connection.address] ||= {}
+        jobs[job.connection.address][job.id] = job
+      end
+
+      @climber.expects(:with_job).never
+      @climber.jobs.each do |job|
+        assert_equal jobs[job.connection.address][job.id], job
+      end
+
+      @climber.connection_pool.connections.each do |connection|
+        @test_jobs[connection.address].map(&:delete)
+      end
+    end
+
+
+    should 'allow breaking from enumeration' do
+      begin
+        count = 0
+        @climber.jobs.each do |job|
+          break if 2 == count += 1
+          assert(false, "Jobs#each did not break when expected") if count >= 3
+        end
+      rescue => e
+        assert(false, "Breaking from Jobs#each raised #{e.inspect}")
+      end
+    end
+
+  end
+
+
+  context '#each_threaded' do
+
+    should 'work correctly in non-break situations' do
+      climber = StalkClimber::Climber.new(BEANSTALK_ADDRESSES)
+      test_jobs = {}
+      climber.connection_pool.connections.each do |connection|
+        test_jobs[connection.address] = []
+        5.times.to_a.map! do
+            test_jobs[connection.address] << StalkClimber::Job.new(connection.transmit(StalkClimber::Connection::PROBE_TRANSMISSION))
+        end
+      end
+
+      climber.jobs.each_threaded do |job|
+        job
+      end
+
+      climber.connection_pool.connections.each do |connection|
+        test_jobs[connection.address].map(&:delete)
+      end
+    end
+
+  end
+
+
+  context 'enumberable contract' do
+
+    should 'function correctly as an enumerable' do
+      climber = StalkClimber::Climber.new(BEANSTALK_ADDRESSES)
+      test_jobs = {}
+      climber.connection_pool.connections.each do |connection|
+        test_jobs[connection.address] = []
+        5.times.to_a.map! do
+            test_jobs[connection.address] << StalkClimber::Job.new(connection.transmit(StalkClimber::Connection::PROBE_TRANSMISSION))
+        end
+      end
+
+      # verify enumeration can be short circuited
+      climber.jobs.any? do |job|
+        true
+      end
+
+      # test normal enumeration
+      climber.jobs.all? do |job|
+        job
+      end
+
+      climber.connection_pool.connections.each do |connection|
+        test_jobs[connection.address].map(&:delete)
+      end
+    end
+
+  end
+
+end