beanstalk_integration_tests 0.0.1

data/lib/beanstalk_integration_tests/stats_job_test.rb

@@ -0,0 +1,116 @@
+require 'beanstalk_integration_tests/test_helper'
+
+class StatsJobTest < BeanstalkIntegrationTest
+
+  context 'stats-job' do
+
+    setup do
+      client.transmit("use #{tube_name}")
+    end
+
+
+    should 'return stats for the specified job with all expected keys' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+      response = client.transmit("stats-job #{job_id}")
+      assert_equal 'OK', response[:status]
+      job_stats = response[:body]
+      expected_keys = %w[
+        id tube state pri age delay ttr time-left file reserves timeouts
+        releases buries kicks
+      ]
+      assert_equal expected_keys, job_stats.keys
+      assert_nil job_stats.values.compact!, 'Expected job stats to have no nil values'
+      assert_equal(initial_cmd_stats_job + 1, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be incremented')
+    end
+
+    # Some stats are tested elsewhere:
+    #
+    # :id => See below
+    # :tube => PutTest
+    # :state => PutTest, BuryTest, ReleaseTest
+    # :pri => PutTest, BuryTest, ReleaseTest
+    # :age => See below
+    # :time-left => PutTest, TouchTest
+    # :file => NOT TESTED (except for presence)
+    # :reserves => ReserveTest
+    # :timeouts => TouchTest
+    # :releases => ReleaseTest
+    # :buries => BuryTest
+    # :kicks => KickTest, KickJobTest
+    #
+    # For those that aren't...
+
+    should 'return correct id' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      assert_equal(job_id.to_i, client.transmit("stats-job #{job_id}")[:body]['id'], 'Expected job-stats[id] to return correct job id')
+    end
+
+
+    should 'return correct age' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      initial_job_age = client.transmit("stats-job #{job_id}")[:body]['age']
+      sleep 1
+      assert_equal(initial_job_age + 1, client.transmit("stats-job #{job_id}")[:body]['age'], 'Expected job-stats[age] to return incremented job age')
+    end
+
+
+    should 'return NOT_FOUND if the job has never existed' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+      assert_raises(Beaneater::NotFoundError, 'Expected job-stats for non-existent job to return NOT_FOUND') do
+        client.transmit("stats-job #{job_id.to_i + 1}")
+      end
+      assert_equal(initial_cmd_stats_job + 1, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be incremented')
+    end
+
+
+    should 'return NOT_FOUND if the job is deleted' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      client.transmit("delete #{job_id}")
+      initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+      assert_raises(Beaneater::NotFoundError, 'Expected job-stats for deleted job to return NOT_FOUND') do
+        client.transmit("stats-job #{job_id}")
+      end
+      assert_equal(initial_cmd_stats_job + 1, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be incremented')
+    end
+
+
+    should 'return BAD_FORMAT without trailing space' do
+      initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+      assert_raises(Beaneater::BadFormatError, 'Expected job-stats without space to return BAD_FORMAT') do
+        client.transmit('stats-job')
+      end
+      assert_equal(initial_cmd_stats_job, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be unchanged')
+    end
+
+
+    should 'return NOT_FOUND if job id is null, negative, or non-integer' do
+      ['', -5, 'foo'].each do |job_id|
+        initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+        assert_raises(Beaneater::NotFoundError, 'Expected job-stats for invalid job id to return NOT_FOUND') do
+          client.transmit("stats-job #{job_id}")
+        end
+        assert_equal(initial_cmd_stats_job + 1, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be incremented')
+      end
+    end
+
+
+    should 'ignore trailing space, arguments, and chars' do
+      message = uuid
+      job_id = client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")[:id]
+      [' ', ' and ignore these arguments', '_and_ignore_these_letters'].each do |trailer|
+        initial_cmd_stats_job = client.transmit('stats')[:body]['cmd-stats-job']
+        client.transmit("stats-job #{job_id}#{trailer}")
+        assert_equal(initial_cmd_stats_job + 1, client.transmit('stats')[:body]['cmd-stats-job'], 'Expected cmd-stats-job to be incremented')
+      end
+    end
+
+  end
+
+end

data/lib/beanstalk_integration_tests/stats_test.rb

@@ -0,0 +1,130 @@
+require 'beanstalk_integration_tests/test_helper'
+require 'socket'
+require 'English'
+
+class StatsTest < BeanstalkIntegrationTest
+
+  context 'stats' do
+
+    should 'return server stats with expected keys' do
+      expected_keys = %w[
+        current-jobs-urgent current-jobs-ready current-jobs-reserved current-jobs-delayed
+        current-jobs-buried cmd-put cmd-peek cmd-peek-ready cmd-peek-delayed cmd-peek-buried cmd-reserve
+        cmd-reserve-with-timeout cmd-delete cmd-release cmd-use cmd-watch cmd-ignore cmd-bury cmd-kick
+        cmd-touch cmd-stats cmd-stats-job cmd-stats-tube cmd-list-tubes cmd-list-tube-used
+        cmd-list-tubes-watched cmd-pause-tube job-timeouts total-jobs max-job-size current-tubes
+        current-connections current-producers current-workers current-waiting total-connections pid
+        version rusage-utime rusage-stime uptime binlog-oldest-index binlog-current-index
+        binlog-records-migrated binlog-records-written binlog-max-size id hostname
+      ]
+      initial_cmd_stats = client.transmit('stats')[:body]['cmd-stats']
+      response = client.transmit('stats')
+      assert_equal 'OK', response[:status]
+      assert_equal expected_keys, response[:body].keys
+      assert_nil response[:body].values.compact!, 'Expected stats to include no nil values'
+      assert_equal(initial_cmd_stats + 1, response[:body]['cmd-stats'], 'Expected cmd-stats to be incremented')
+    end
+
+    # Some stats are tested elsewhere:
+    #
+    # :current-jobs-urgent => PutTest, ReleaseTest
+    # :current-jobs-ready => PutTest, ReleaseTest
+    # :current-jobs-reserved => ReserveTest, ReleaseTest
+    # :current-jobs-delayed => KickTest, PutTest, ReleaseTest
+    # :current-jobs-buried => BuryTest, KickTest
+    # :total-jobs => PutTest
+    # :cmd-put => PutTest
+    # :cmd-peek => PeekTest
+    # :cmd-peek-ready => PeekTest
+    # :cmd-peek-delayed => PeekTest
+    # :cmd-peek-buried => PeekTest
+    # :cmd-reserve => ReserveTest
+    # :cmd-use => UseTest
+    # :cmd-watch => WatchTest
+    # :cmd-ignore => IgnoreTest
+    # :cmd-delete => DeleteTest
+    # :cmd-release => ReleaseTest
+    # :cmd-bury => BuryTest
+    # :cmd-kick => KickTest
+    # :cmd-stats => See above/below
+    # :cmd-stats-job => StatsJobTest
+    # :cmd-stats-tube => StatsTubeTest
+    # :cmd-list-tubes => ListTubesTest
+    # :cmd-list-tube-used => ListTubeUsedTest
+    # :cmd-list-tubes-watched => ListTubesWatchedTest
+    # :cmd-pause-tube => PauseTubeTest
+    # :job-timeouts => TouchTest
+    # :total-jobs => PutTest
+    # :max-job-size => PutTest (Tests retrieval directly, indiectly tests value set correctly)
+    # :current-tube => UseTest, Watch Test
+    # :current-connections => See below
+    # :current-producers => PutTest
+    # :current-workers => ReserveTest
+    # :current-waiting => ReserveTest
+    # :total-connections => See below
+    # :pid => See below
+    # :version => NOT TESTED only tested for presence
+    # :rusage-utime => NOT TESTED only tested for presence
+    # :rusage-stime => NOT TESTED only tested for presence
+    # :uptime => See below
+    # :binlog-oldest-index => NOT TESTED only tested for presence
+    # :binlog-current-index => NOT TESTED only tested for presence
+    # :binlog-max-size => NOT TESTED only tested for presence
+    # :binlog-records-written => NOT TESTED only tested for presence
+    # :binlog-records-written => NOT TESTED only tested for presence
+    # :id => NOT TESTED only tested for presence
+    # :hostname => See below
+    #
+    # For those that aren't...
+
+
+    should 'return correct hostname' do
+      # This test assume tests and beanstalk are being run on same host
+      assert_equal Socket.gethostname, client.transmit('stats')[:body]['hostname']
+    end
+
+
+    should 'return correct uptime' do
+      initial_uptime = client.transmit('stats')[:body]['uptime']
+      sleep 1
+      updated_uptime = client.transmit('stats')[:body]['uptime']
+      assert(updated_uptime > initial_uptime, 'Expected uptime to to be incremented')
+    end
+
+
+    should 'return correct pid' do
+      %x[which pgrep]
+      skip('pgrep is required to determine possible pids') unless $CHILD_STATUS.success?
+      pids = %x[pgrep -f beanstalk].split
+
+      stats = client.transmit('stats')[:body]
+      assert(pids.include?(stats['pid'].to_s), 'Expected pids for processes with beanstalk in title to include beanstalk pid')
+    end
+
+
+    should 'return correct count of current-connections and total-connections' do
+      stats = client.transmit('stats')[:body]
+      initial_current_connections = stats['current-connections']
+      initial_total_connections = stats['total-connections']
+      other_client = build_client
+      stats = client.transmit('stats')[:body]
+      assert_equal(initial_current_connections + 1, stats['current-connections'], 'Expected current-connections to be incremented')
+      assert_equal(initial_total_connections + 1, stats['total-connections'], 'Expected total-connections to be incremented')
+      other_client.close
+      assert_equal(stats['current-connections'] - 1, client.transmit('stats')[:body]['current-connections'], 'Expected current-connections to be decremented')
+    end
+
+
+    should 'return BAD_FORMAT with any trailing characters' do
+      initial_cmd_stats = client.transmit('stats')[:body]['cmd-stats']
+      [' ', ' foo'].each do |trailer|
+        assert_raises(Beaneater::BadFormatError, 'Expected stats with any trailing characters to return BAD_FORMAT') do
+          client.transmit("stats#{trailer}")
+        end
+      end
+      assert_equal(initial_cmd_stats + 1, client.transmit('stats')[:body]['cmd-stats'], 'Expected cmd-stats to be unchanged')
+    end
+
+  end
+
+end

data/lib/beanstalk_integration_tests/stats_tube_test.rb

@@ -0,0 +1,141 @@
+require 'beanstalk_integration_tests/test_helper'
+
+class StatsTubeTest < BeanstalkIntegrationTest
+
+  context 'stats-tube' do
+
+    setup do
+      client.transmit("use #{tube_name}")
+    end
+
+
+    should 'return stats for the specified tube with all expected keys' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      response = client.transmit("stats-tube #{tube_name}")
+      assert_equal 'OK', response[:status]
+      tube_stats = response[:body]
+      expected_keys = %w[
+        name current-jobs-urgent current-jobs-ready current-jobs-reserved current-jobs-delayed
+        current-jobs-buried total-jobs current-using current-watching current-waiting cmd-delete
+        cmd-pause-tube pause pause-time-left
+      ]
+      assert_equal expected_keys, tube_stats.keys
+      assert_nil tube_stats.values.compact!, 'Expected tube stats to have no nil values'
+      assert_equal(initial_cmd_stats_tube + 1, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be incremented')
+    end
+
+
+    # Some stats are tested elsewhere:
+    #
+    # :name => See below
+    # :current-jobs-urgent => PutTest, ReleaseTest
+    # :current-jobs-ready => PutTest, ReleaseTest
+    # :current-jobs-reserved => ReserveTest, ReleaseTest
+    # :current-jobs-delayed => KickTest, PutTest, ReleaseTest
+    # :current-jobs-buried => BuryTest, KickTest
+    # :total-jobs => PutTest
+    # :current-using => UseTest
+    # :current-waiting => ReserveTest
+    # :current-watching => IgnoreTest, UseTest, WatchTest
+    # :pause => PauseTubeTest
+    # :cmd-delete => DeleteTest
+    # :cmd-pause-tube => PauseTubeTest
+    # :pause-time-left => PauseTubeTest
+    #
+    # For those that aren't...
+
+
+    should 'return expected tube name' do
+      assert_equal(tube_name, client.transmit("stats-tube #{tube_name}")[:body]['name'], 'Expected stats-tube to return correct tube name')
+    end
+
+
+    should 'return NOT_FOUND if the tube has never existed' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises(Beaneater::NotFoundError, 'Expected tube-stats for non-existent tube to return NOT_FOUND') do
+        client.transmit("stats-tube #{uuid}")
+      end
+      assert_equal(initial_cmd_stats_tube + 1, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be incremented')
+    end
+
+
+    should 'return NOT_FOUND if the tube is deleted' do
+      client.transmit('use default')
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises(Beaneater::NotFoundError, 'Expected tube-stats for deleted tube to return NOT_FOUND') do
+        client.transmit("stats-tube #{tube_name}")
+      end
+      assert_equal(initial_cmd_stats_tube + 1, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be incremented')
+    end
+
+
+    should 'return BAD_FORMAT without trailing space' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises(Beaneater::BadFormatError, 'Expected tube-stats without space to return BAD_FORMAT') do
+        client.transmit('stats-tube')
+      end
+      assert_equal(initial_cmd_stats_tube, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if tube name is null' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises(Beaneater::BadFormatError, 'Expected tube-stats with null tube name to return BAD_FORMAT') do
+        client.transmit('stats-tube ')
+      end
+      assert_equal(initial_cmd_stats_tube, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+    end
+
+
+    should 'be able to handle tube name of maximum length' do
+      name = 'x' * 200
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      client.transmit("watch #{name}")
+      response = client.transmit("stats-tube #{name}")
+      assert_equal 'OK', response[:status]
+      assert_equal name, response[:body]['name']
+      assert_equal(initial_cmd_stats_tube + 1, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be incremented')
+    end
+
+
+    should 'return BAD_FORMAT if tube name > 200 bytes' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("stats-tube #{'x' * 201}")
+      end
+      # Get stats with other client because long tube name leaves client in weird state
+      assert_equal(initial_cmd_stats_tube, build_client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if line has a trailing space' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("stats-tube #{tube_name} ")
+      end
+      assert_equal(initial_cmd_stats_tube, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if tube name includes invalid characters or starts with hyphen' do
+      initial_cmd_stats_tube = client.transmit('stats')[:body]['cmd-stats-tube']
+      valid_chars = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a + %w[- + / ; . $ _ ( )] + [' ']
+      # Beanstalk hangs on char 13
+      bad_chars = (0..12).to_a.concat((14..255).to_a).to_a.map!(&:chr) - valid_chars
+
+      assert_raises(Beaneater::BadFormatError, 'Expected tube name starting with hyphen to be invalid') do
+        client.transmit('stats-tube -starts-with-hyphen')
+      end
+      assert_equal(initial_cmd_stats_tube, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+
+      bad_chars.each do |bad_char|
+        assert_raises(Beaneater::BadFormatError, "Expected tube name with char #{bad_char} to be invalid") do
+          client.transmit("stats-tube name_with_#{bad_char}_in_it")
+        end
+      end
+      assert_equal(initial_cmd_stats_tube, client.transmit('stats')[:body]['cmd-stats-tube'], 'Expected cmd-stats-tube to be unchanged')
+    end
+
+  end
+
+end

data/lib/beanstalk_integration_tests/test_helper.rb

@@ -0,0 +1,88 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'minitest/autorun'
+require 'minitest/should'
+
+require 'securerandom'
+
+require 'beaneater'
+
+
+class BeanstalkIntegrationTest < MiniTest::Should::TestCase
+
+  class << self
+
+    def address(custom_address = '0.0.0.0')
+      return @address ||= custom_address
+    end
+
+  end
+
+  setup do
+    puts "#{self.class}::#{self.__name__}" if ENV['VERBOSE']
+  end
+
+  teardown do
+    cleanup_tubes
+    @clients.each do |client|
+      client.close unless client.connection.nil?
+    end
+  end
+
+  def address
+    return self.class.address
+  end
+
+  def build_client
+    new_client = Beaneater::Connection.new(address)
+    @clients << new_client
+    return new_client
+  end
+
+  def cleanup_tubes
+    @pool = Beaneater::Pool.new([address])
+    @tubes.each do |tube_name|
+      @pool.tubes.find(tube_name).clear
+    end
+    @pool.close
+    @tubes.clear
+  end
+
+  def client
+    @client ||= build_client
+  end
+
+  def create_buried_jobs(buried_count = 5)
+    job_ids = []
+    buried_count.times do
+      message = uuid
+      client.transmit("put 0 0 120 #{message.bytesize}\r\n#{message}")
+      timeout(1) do
+        job_ids << client.transmit('reserve')[:id]
+      end
+      client.transmit("bury #{job_ids.last} 0")
+    end
+    return job_ids
+  end
+
+  def initialize(*)
+    @tubes = []
+    @clients = []
+    super
+  end
+
+  def generate_tube_name
+    tube = uuid
+    @tubes << tube
+    return tube
+  end
+
+  def tube_name
+    return @tube_name ||= generate_tube_name
+  end
+
+  def uuid
+    SecureRandom.uuid
+  end
+
+end