beanstalk_integration_tests 0.0.1

data/lib/beanstalk_integration_tests/tests.rb

@@ -0,0 +1,4 @@
+require File.expand_path('../../beanstalk_integration_tests', __FILE__)
+Dir.glob(File.expand_path('../**/*_test.rb', __FILE__)).each do |test_file|
+  require test_file
+end

data/lib/beanstalk_integration_tests/touch_test.rb

@@ -0,0 +1,118 @@
+require 'beanstalk_integration_tests/test_helper'
+
+class TouchTest < BeanstalkIntegrationTest
+
+  context 'touch with reserved job' do
+
+    should 'reset job time-left to job ttr' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      do_setup(5)
+      sleep 1
+      assert_equal(@ttr - 2, client.transmit("stats-job #{@reserved_id}")[:body]['time-left'])
+      client.transmit("touch #{@reserved_id}")
+      assert_equal(@ttr - 1, client.transmit("stats-job #{@reserved_id}")[:body]['time-left'])
+      assert_equal(initial_cmd_touch + 1, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+      client.transmit("delete #{@reserved_id}")
+    end
+
+
+    should 'prevent timeout from occuring' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      do_setup(1)
+      # Allow initial timeout period to expire quickly
+      3.times do
+        sleep 0.5
+        client.transmit("touch #{@reserved_id}")
+      end
+      job_stats = client.transmit("stats-job #{@reserved_id}")[:body]
+      client.transmit("delete #{@reserved_id}")
+      assert_equal('reserved', job_stats['state'])
+      assert_equal(0, job_stats['timeouts'])
+      assert_equal(initial_cmd_touch + 3, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+    end
+
+
+    should 'not allow touching jobs reserved by other clients' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      do_setup(10)
+      sleep 1
+      initial_time_left = client.transmit("stats-job #{@reserved_id}")[:body]['time-left']
+      assert_raises(Beaneater::NotFoundError, 'Expected touching a job reserved by another client to return NOT_FOUND') do
+        build_client.transmit("touch #{@reserved_id}")
+      end
+      assert(initial_time_left >= client.transmit("stats-job #{@reserved_id}")[:body]['time-left'], 'Expected time-left to be less after failed touch')
+      client.transmit("delete #{@reserved_id}")
+      assert_equal(initial_cmd_touch + 1, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+    end
+
+
+    should 'not allow touching jobs that are not reserved' do
+      stats = client.transmit('stats')[:body]
+      initial_cmd_touch = stats['cmd-touch']
+      initial_job_timeouts = stats['job-timeouts']
+      do_setup(1)
+      sleep 1
+      assert_raises(Beaneater::NotFoundError, 'Expected touching an unreserved job to return NOT_FOUND') do
+        build_client.transmit("touch #{@reserved_id}")
+      end
+      assert_equal(1, client.transmit("stats-job #{@reserved_id}")[:body]['timeouts'], 'Expected job timeouts to be incremented')
+      client.transmit("delete #{@reserved_id}")
+      stats = client.transmit('stats')[:body]
+      assert_equal(initial_cmd_touch + 1, stats['cmd-touch'], 'Expected cmd-touch to be incremented')
+      assert_equal(initial_job_timeouts + 1, stats['job-timeouts'], 'Expected job-timeouts to be incremented')
+    end
+
+
+    should 'ignore trailing space, arguments, and chars' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      do_setup(10)
+      [' ', ' and ignore these arguments', '_and_ignore_these_letters'].each do |trailer|
+        sleep 1
+        time_left = client.transmit("stats-job #{@reserved_id}")[:body]['time-left']
+        client.transmit("touch #{@reserved_id}#{trailer}")
+        assert(client.transmit("stats-job #{@reserved_id}")[:body]['time-left'] > time_left, 'Expected time-left to be greater after touch')
+      end
+      client.transmit("delete #{@reserved_id}")
+      assert_equal(initial_cmd_touch + 3, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+    end
+
+  end
+
+
+  context 'touch not requiring reserved job' do
+
+    should 'return UNKNOWN_COMMAND if no space after command' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      assert_raises(Beaneater::UnknownCommandError, 'Expected touch with no following space to return UNKNOWN_COMMAND') do
+        build_client.transmit('touch')
+      end
+      assert_equal(initial_cmd_touch, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be unchanged')
+    end
+
+
+    should 'return NOT_FOUND if non-integer or null job_id provided' do
+      initial_cmd_touch = client.transmit('stats')[:body]['cmd-touch']
+      assert_raises(Beaneater::NotFoundError, 'Expected touch with no job_id to return NOT_FOUND') do
+        build_client.transmit('touch ')
+      end
+      assert_equal(initial_cmd_touch + 1, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+      assert_raises(Beaneater::NotFoundError, 'Expected touch with no job_id to return NOT_FOUND') do
+        build_client.transmit('touch x')
+      end
+      assert_equal(initial_cmd_touch + 2, client.transmit('stats')[:body]['cmd-touch'], 'Expected cmd-touch to be incremented')
+    end
+
+  end
+
+  def do_setup(ttr = 5)
+    message = uuid
+    @ttr = ttr
+    client.transmit("watch #{tube_name}")
+    client.transmit("use #{tube_name}")
+    client.transmit("put 0 0 #{@ttr} #{message.bytesize}\r\n#{message}")
+    timeout(1) do
+      @reserved_id = client.transmit('reserve')[:id]
+    end
+  end
+
+end

data/lib/beanstalk_integration_tests/use_test.rb

@@ -0,0 +1,118 @@
+require 'beanstalk_integration_tests/test_helper'
+
+class UseTest < BeanstalkIntegrationTest
+
+  context 'use' do
+
+    should 'use the default tube by default' do
+      assert_equal 'default', client.transmit('list-tube-used')[:id]
+    end
+
+
+    should 'create and use the tube supplied' do
+      response = client.transmit("use #{tube_name}")
+      assert_equal 'USING', response[:status]
+      assert_equal tube_name, response[:id]
+      assert_equal(tube_name, client.transmit('list-tube-used')[:id], 'Expected list-tube-used to match used tube name')
+      assert(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected used tube to be included in list-tubes')
+    end
+
+
+    should 'increment/decrement the current-using counter on the tube stats' do
+      client.transmit("use #{tube_name}")
+      initial_using_count = client.transmit("stats-tube #{tube_name}")[:body]['current-using'].to_i
+      assert_equal 1, initial_using_count
+      other_client = build_client
+      other_client.transmit("use #{tube_name}")
+      assert_equal initial_using_count + 1, client.transmit("stats-tube #{tube_name}")[:body]['current-using'].to_i
+      other_client.transmit("use #{uuid}")
+      assert_equal initial_using_count, client.transmit("stats-tube #{tube_name}")[:body]['current-using'].to_i
+    end
+
+
+    should 'increment the current-tubes and cmd-use counters on the server stats' do
+      stats = client.transmit('stats')[:body]
+      initial_use_count = stats['cmd-use'].to_i
+      initial_tube_count = stats['current-tubes'].to_i
+      client.transmit("use #{tube_name}")
+      stats = client.transmit('stats')[:body]
+      assert_equal initial_use_count + 1, stats['cmd-use'].to_i
+      assert_equal initial_tube_count + 1, stats['current-tubes'].to_i
+    end
+
+
+    should 'be able to handle tube name of maximum length' do
+      name = 'x' * 200
+      response = client.transmit("use #{name}")
+      assert_equal 'USING', response[:status]
+      assert_equal name, response[:id]
+    end
+
+
+    should 'return BAD_FORMAT if tube name > 200 bytes' do
+      initital_cmd_use = client.transmit('stats')[:body]['cmd-use']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("use #{'x' * 201}")
+      end
+      assert_equal(initital_cmd_use, client.transmit('stats')[:body]['cmd-use'], 'Expected cmd-use to be unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if line has a trailing space' do
+      initital_cmd_use = client.transmit('stats')[:body]['cmd-use']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("use #{tube_name} ")
+      end
+      assert_equal(initital_cmd_use, client.transmit('stats')[:body]['cmd-use'], 'Expected cmd-use to be unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if tube name includes invalid characters or starts with hyphen' do
+      initital_cmd_use = client.transmit('stats')[:body]['cmd-use']
+      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('use -starts-with-hyphen')
+      end
+      assert_equal(initital_cmd_use, client.transmit('stats')[:body]['cmd-use'], 'Expected cmd-use 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("use name_with_#{bad_char}_in_it")
+        end
+      end
+      assert_equal(initital_cmd_use, client.transmit('stats')[:body]['cmd-use'], 'Expected cmd-use to be unchanged')
+    end
+
+
+    should 'delete tubes that are not watched and are no longer used' do
+      client.transmit("use #{tube_name}")
+      tube_stats = client.transmit("stats-tube #{tube_name}")
+      assert_equal 1, tube_stats[:body]['current-using']
+      assert_equal 0, tube_stats[:body]['current-watching']
+      client.transmit("use #{generate_tube_name}")
+      assert_raises(Beaneater::NotFoundError, 'Expected unused tube to be deleted') do
+        client.transmit("stats-tube #{tube_name}")
+      end
+      refute(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected unused tube to not be included in list-tubes')
+    end
+
+
+    should 'delete tubes that are not watched and are no longer used even if paused' do
+      client.transmit("use #{tube_name}")
+      tube_stats = client.transmit("stats-tube #{tube_name}")
+      assert_equal 1, tube_stats[:body]['current-using']
+      assert_equal 0, tube_stats[:body]['current-watching']
+      client.transmit("pause-tube #{tube_name} 120")
+      client.transmit("use #{generate_tube_name}")
+      assert_raises(Beaneater::NotFoundError, 'Expected unused tube to be deleted') do
+        client.transmit("stats-tube #{tube_name}")
+      end
+      refute(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected unused tube to not be included in list-tubes')
+    end
+
+  end
+
+end

data/lib/beanstalk_integration_tests/version.rb

@@ -0,0 +1,3 @@
+module BeanstalkIntegrationTests
+  VERSION = '0.0.1'
+end

data/lib/beanstalk_integration_tests/watch_test.rb

@@ -0,0 +1,128 @@
+require 'beanstalk_integration_tests/test_helper'
+
+class WatchTest < BeanstalkIntegrationTest
+
+  context 'watch' do
+
+    should 'watch the default tube by default' do
+      assert client.transmit('list-tubes-watched')[:body].include?('default')
+    end
+
+
+    should 'create and watch the tube supplied and return the incremented count of tubes watched' do
+      assert_equal 1, client.transmit('list-tubes-watched')[:body].length
+      response = client.transmit("watch #{tube_name}")
+      assert_equal 'WATCHING', response[:status]
+      tubes_watched = client.transmit('list-tubes-watched')[:body]
+      assert_equal tubes_watched.length, response[:id].to_i
+      assert tubes_watched.include?(tube_name)
+      assert(client.transmit('list-tubes-watched')[:body].include?(tube_name), 'Expected watched tube to be included in list-tubes-watched')
+      assert(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected watched tube to be included in list-tubes')
+    end
+
+
+    should 'increment the number of watchers on the tubes stats' do
+      client.transmit("watch #{tube_name}")
+      assert_equal 1, client.transmit("stats-tube #{tube_name}")[:body]['current-watching']
+    end
+
+
+    should 'increment the current-tubes and cmd-watch counters on the server stats' do
+      stats = client.transmit('stats')[:body]
+      initial_use_count = stats['cmd-watch'].to_i
+      initial_tube_count = stats['current-tubes'].to_i
+      client.transmit("watch #{tube_name}")
+      stats = client.transmit('stats')[:body]
+      assert_equal initial_use_count + 1, stats['cmd-watch'].to_i
+      assert_equal initial_tube_count + 1, stats['current-tubes'].to_i
+    end
+
+
+    should 'not increment count of tubes watched if tube already watched' do
+      initial_cmd_watch = client.transmit('stats')[:body]['cmd-watch']
+      assert_equal 1, client.transmit('list-tubes-watched')[:body].length
+      response = client.transmit("watch #{tube_name}")
+      assert_equal 2, client.transmit('list-tubes-watched')[:body].length
+      response = client.transmit("watch #{tube_name}")
+      assert_equal 2, client.transmit('list-tubes-watched')[:body].length
+      assert_equal(initial_cmd_watch + 2, client.transmit('stats')[:body]['cmd-watch'], 'Expected cmd-watch to be incremented')
+    end
+
+
+    should 'return BAD_FORMAT if line has a trailing space' do
+      initital_cmd_use = client.transmit('stats')[:body]['cmd-watch']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("watch #{tube_name} ")
+      end
+      assert_equal(initital_cmd_use, client.transmit('stats')[:body]['cmd-watch'], 'Expected cmd-watch to be unchanged')
+    end
+
+
+    should 'be able to handle tube name of maximum length' do
+      response = client.transmit("watch #{'x' * 200}")
+      assert_equal 'WATCHING', response[:status]
+      assert_equal '2', response[:id]
+    end
+
+
+    should 'return BAD_FORMAT if tube name > 200 bytes' do
+      initial_cmd_watch = client.transmit('stats')[:body]['cmd-watch']
+      assert_raises Beaneater::BadFormatError do
+        client.transmit("watch #{'x' * 201}")
+      end
+      # Extra long command leaves client in weird place
+      assert_equal(initial_cmd_watch, build_client.transmit('stats')[:body]['cmd-watch'], 'Expected cmd-watch to remain unchanged')
+    end
+
+
+    should 'return BAD_FORMAT if tube name includes invalid characters or starts with hyphen' do
+      initial_cmd_watch = client.transmit('stats')[:body]['cmd-watch']
+      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('watch -starts-with-hyphen')
+      end
+      assert_equal(initial_cmd_watch, client.transmit('stats')[:body]['cmd-watch'], 'Expected cmd-watch to remain unchanged')
+
+      bad_chars.each do |bad_char|
+        assert_raises(Beaneater::BadFormatError, "Expected tube name with char #{bad_char} to be invalid") do
+          client.transmit("watch name_with_#{bad_char}_in_it")
+        end
+      end
+      assert_equal(initial_cmd_watch, client.transmit('stats')[:body]['cmd-watch'], 'Expected cmd-watch to remain unchanged')
+    end
+
+
+    should 'delete tubes that are not being used and are no longer watched' do
+      client.transmit("watch #{tube_name}")
+      tube_stats = client.transmit("stats-tube #{tube_name}")
+      assert_equal 1, tube_stats[:body]['current-watching']
+      assert_equal 0, tube_stats[:body]['current-using']
+      client.transmit("watch #{generate_tube_name}")
+      client.transmit("ignore #{tube_name}")
+      assert_raises(Beaneater::NotFoundError, 'Expected unwatched tube to be deleted') do
+        client.transmit("stats-tube #{tube_name}")
+      end
+      refute(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected unwatched tube to not be included in list-tubes')
+    end
+
+
+    should 'delete tubes that are not being used and are no longer watched even if paused' do
+      client.transmit("watch #{tube_name}")
+      tube_stats = client.transmit("stats-tube #{tube_name}")
+      assert_equal 1, tube_stats[:body]['current-watching']
+      assert_equal 0, tube_stats[:body]['current-using']
+      client.transmit("watch #{generate_tube_name}")
+      client.transmit("pause-tube #{tube_name} 120")
+      client.transmit("ignore #{tube_name}")
+      assert_raises(Beaneater::NotFoundError, 'Expected unwatched tube to be deleted') do
+        client.transmit("stats-tube #{tube_name}")
+      end
+      refute(client.transmit('list-tubes')[:body].include?(tube_name), 'Expected unwatched tube to not be included in list-tubes')
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: beanstalk_integration_tests
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Danny Guinther
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration tests for testing adherence to the beanstalkd protocol
+email:
+- dannyguinther@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- beanstalk_integration_tests.gemspec
+- lib/beanstalk_integration_tests.rb
+- lib/beanstalk_integration_tests/bury_test.rb
+- lib/beanstalk_integration_tests/delete_test.rb
+- lib/beanstalk_integration_tests/ignore_test.rb
+- lib/beanstalk_integration_tests/kick_job_test.rb
+- lib/beanstalk_integration_tests/kick_test.rb
+- lib/beanstalk_integration_tests/list_tube_used_test.rb
+- lib/beanstalk_integration_tests/list_tubes_test.rb
+- lib/beanstalk_integration_tests/list_tubes_watched_test.rb
+- lib/beanstalk_integration_tests/pause_tube_test.rb
+- lib/beanstalk_integration_tests/peek_test.rb
+- lib/beanstalk_integration_tests/put_test.rb
+- lib/beanstalk_integration_tests/quit_test.rb
+- lib/beanstalk_integration_tests/release_test.rb
+- lib/beanstalk_integration_tests/reserve_test.rb
+- lib/beanstalk_integration_tests/stats_job_test.rb
+- lib/beanstalk_integration_tests/stats_test.rb
+- lib/beanstalk_integration_tests/stats_tube_test.rb
+- lib/beanstalk_integration_tests/test_helper.rb
+- lib/beanstalk_integration_tests/tests.rb
+- lib/beanstalk_integration_tests/touch_test.rb
+- lib/beanstalk_integration_tests/use_test.rb
+- lib/beanstalk_integration_tests/version.rb
+- lib/beanstalk_integration_tests/watch_test.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Beanstalk protocol integration tests
+test_files: []
+has_rdoc: