bane 0.4.0 → 1.0.0

data/test/bane/arguments_parser_test.rb

@@ -1,76 +0,0 @@
-require_relative '../test_helper'
-
-class ArgumentsParserTest < Test::Unit::TestCase
-  include Bane
-
-  # Parsing arguments (uses the isolated ArgumentsParser object)
-
-  def test_parses_the_port
-    config = parse(["3000", IRRELEVANT_BEHAVIOR])
-    assert_equal 3000, config.port
-  end
-
-  def test_parses_the_behaviors
-    config = parse([IRRELEVANT_PORT, 'NeverRespond', 'EchoResponse'])
-    assert_equal ['NeverRespond', 'EchoResponse'], config.behaviors
-  end
-
-  def test_host_defaults_to_localhost_if_not_specified
-    config = parse([IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR])
-    assert_equal '127.0.0.1', config.host
-  end
-
-  def test_dash_l_option_sets_listen_host_to_localhost
-    assert_parses_host(Behaviors::Servers::LOCALHOST, ['-l', IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR])
-  end
-
-  def test_listen_on_localhost_sets_listen_host_to_localhost
-    assert_parses_host(Behaviors::Servers::LOCALHOST, ['--listen-on-localhost', IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR])
-  end
-
-  def test_dash_a_option_sets_listen_host_to_all_interfaces
-    assert_parses_host(Behaviors::Servers::ALL_INTERFACES, ['-a', IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR])
-  end
-
-  def test_listen_on_all_hosts_option_sets_listen_host_to_all_interfaces
-    assert_parses_host(Behaviors::Servers::ALL_INTERFACES, ['--listen-on-all-hosts', IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR])
-  end
-
-  def test_usage_message_includes_known_makeables_in_alphabetical_order
-    usage = ArgumentsParser.new(['makeable2', 'makeable1']).usage
-    assert_match /makeable1/i, usage, 'Should have included all known makeables'
-    assert_match /makeable2/i, usage, 'Should have included all known makeables'
-    assert_match /makeable1\W+makeable2/i, usage, 'Should have been in alphabetical order'
-  end
-
-  def test_no_arguments_fail_with
-    assert_invalid_arguments_fail_matching_message([], /missing arguments/i)
-  end
-
-  def test_non_integer_port_fails_with_error_message
-    assert_invalid_arguments_fail_matching_message(['text_instead_of_an_integer'], /Invalid Port Number/i)
-  end
-
-  def test_invalid_option_fails_with_error_message
-    assert_invalid_arguments_fail_matching_message(['--unknown-option', IRRELEVANT_PORT], /Invalid Option/i)
-  end
-
-  def parse(arguments)
-    ArgumentsParser.new(["makeable1", "makeable2"]).parse(arguments)
-  end
-
-  def assert_parses_host(expected_host, arguments)
-    config = parse(arguments)
-    assert_equal expected_host, config.host
-  end
-
-  def assert_invalid_arguments_fail_matching_message(arguments, message_matcher)
-    begin
-      parse(arguments)
-      flunk "Should have thrown an error"
-    rescue ConfigurationError => ce
-      assert_match message_matcher, ce.message
-    end
-  end
-
-end

data/test/bane/bane_test.rb

@@ -1,12 +0,0 @@
-require_relative '../test_helper'
-
-class BaneTest < Test::Unit::TestCase
-
-  def test_includes_responders_and_servers_in_all_makeables
-    all_names = Bane.find_makeables.keys
-
-    assert all_names.include?('NeverRespond'), "Expected 'NeverRespond' responder to be in #{all_names}"
-    assert all_names.include?('TimeoutInListenQueue'), "Expected 'TimeoutInListenQueue' server to be in #{all_names}"
-  end
-
-end

data/test/bane/behaviors/responders/close_after_pause_test.rb

@@ -1,30 +0,0 @@
-require_relative '../../../test_helper'
-require 'mocha/setup'
-
-class CloseAfterPauseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sleeps_30_seconds_by_default
-    server = CloseAfterPause.new
-    server.expects(:sleep).with(30)
-
-    query_server(server)
-  end
-
-  def test_sleeps_specified_number_of_seconds
-    server = CloseAfterPause.new(duration: 1)
-    server.expects(:sleep).with(1)
-
-    query_server(server)
-  end
-
-  def test_sends_nothing
-    server = CloseAfterPause.new
-    server.stubs(:sleep)
-
-    query_server(server)
-  end
-
-end

data/test/bane/behaviors/responders/close_immediately_test.rb

@@ -1,14 +0,0 @@
-require_relative '../../../test_helper'
-
-class CloseImmediatelyTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_no_response
-    query_server(CloseImmediately.new)
-
-    assert_empty_response
-  end
-
-end

data/test/bane/behaviors/responders/deluge_response_test.rb

@@ -1,20 +0,0 @@
-require_relative '../../../test_helper'
-
-class DelugeResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_one_million_bytes_by_default
-    query_server(DelugeResponse.new)
-
-    assert_response_length 1_000_000
-  end
-
-  def test_sends_the_specified_number_of_bytes
-    query_server(DelugeResponse.new(length: 1))
-
-    assert_response_length 1
-  end
-
-end

data/test/bane/behaviors/responders/echo_response_test.rb

@@ -1,16 +0,0 @@
-require_relative '../../../test_helper'
-
-class EchoResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_returns_received_characters
-    fake_connection.will_send("Hello, echo!")
-
-    query_server(EchoResponse.new)
-
-    assert_equal "Hello, echo!", response
-  end
-
-end

data/test/bane/behaviors/responders/fixed_response_test.rb

@@ -1,14 +0,0 @@
-require_relative '../../../test_helper'
-
-class FixedResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_the_specified_message
-    query_server(FixedResponse.new(message: "Test Message"))
-
-    assert_equal "Test Message", response
-  end
-
-end

data/test/bane/behaviors/responders/for_each_line_test.rb

@@ -1,29 +0,0 @@
-require_relative '../../../test_helper'
-require 'mocha/setup'
-
-class ForEachLineTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_reads_a_line_before_responding_with_parent_behavior
-    server = SayHelloForEachLineBehavior.new
-
-    fake_connection.will_send "irrelevant\n"
-
-    query_server(server)
-    assert_equal "Hello", response
-
-    assert fake_connection.read_all_queries?
-  end
-
-  class SayHelloBehavior
-    def serve(io)
-      io.write('Hello')
-    end
-  end
-
-  class SayHelloForEachLineBehavior < SayHelloBehavior
-    include Bane::Behaviors::Responders::ForEachLine
-  end
-end

data/test/bane/behaviors/responders/http_refuse_all_credentials_test.rb

@@ -1,18 +0,0 @@
-require_relative '../../../test_helper'
-
-class HttpRefuseAllCredentialsTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_401_response_code
-    fake_connection.will_send("GET /some/irrelevant/path HTTP/1.1")
-
-    server = HttpRefuseAllCredentials.new
-    query_server(server)
-
-    assert fake_connection.read_all_queries?, "Should have read the HTTP query before sending response"
-    assert_match /HTTP\/1.1 401 Unauthorized/, response, 'Should have responded with the 401 response code'
-  end
-
-end

data/test/bane/behaviors/responders/never_respond_test.rb

@@ -1,31 +0,0 @@
-require_relative '../../../test_helper'
-
-class NeverRespondTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-  include ServerTestHelpers
-
-  LONG_MESSAGE = 'x'*(1024*5)
-
-  def test_does_not_send_a_response
-    server = NeverRespond.new
-
-    query_server(server)
-    assert_empty_response
-  end
-
-  def test_disconnects_after_client_closes_connection
-    run_server(Bane::Behaviors::Servers::ResponderServer.new(0, NeverRespond.new)) do |server|
-      client = TCPSocket.new('localhost', server.port)
-      sleep 3
-      client.write LONG_MESSAGE
-      client.close
-
-      sleep 0.1
-
-      assert_equal 0, server.connections
-    end
-  end
-
-end

data/test/bane/behaviors/responders/newline_response_test.rb

@@ -1,14 +0,0 @@
-require_relative '../../../test_helper'
-
-class NewlineResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_only_a_newline_character
-    query_server(NewlineResponse.new)
-
-    assert_equal "\n", response
-  end
-
-end

data/test/bane/behaviors/responders/random_response_test.rb

@@ -1,15 +0,0 @@
-require_relative '../../../test_helper'
-
-class RandomResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_sends_a_nonempty_response
-    query_server(RandomResponse.new)
-
-    assert (!response.empty?), "Should have served a nonempty response"
-  end
-
-end
-

data/test/bane/behaviors/responders/slow_response_test.rb

@@ -1,21 +0,0 @@
-require_relative '../../../test_helper'
-require 'mocha/setup'
-
-class SlowResponseTest < Test::Unit::TestCase
-
-  include Bane::Behaviors::Responders
-  include BehaviorTestHelpers
-
-  def test_pauses_between_sending_each_character
-    message = "Hi!"
-    delay = 0.5
-
-    server = SlowResponse.new(pause_duration: delay, message: message)
-    server.expects(:sleep).with(delay).at_least(message.length)
-
-    query_server(server)
-
-    assert_equal message, response
-  end
-
-end

data/test/bane/behaviors/servers/responder_server_test.rb

@@ -1,77 +0,0 @@
-require_relative '../../../test_helper'
-require 'mocha/setup'
-
-class ResponderServerTest < Test::Unit::TestCase
-  include LaunchableRoleTests
-
-  include Bane
-  include Bane::Behaviors::Servers
-  
-  IRRELEVANT_IO_STREAM = nil
-  IRRELEVANT_OPTIONS = {}
-  IRRELEVANT_HOST = '1.1.1.1'
-
-  def setup
-    @object = ResponderServer.new(IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR)
-  end
-
-  def test_initializes_server_on_specified_port
-    server = ResponderServer.new(6000, IRRELEVANT_BEHAVIOR)
-    assert_equal 6000, server.port
-  end
-
-  def test_initializes_server_on_specified_hostname
-    server = ResponderServer.new(IRRELEVANT_PORT, IRRELEVANT_BEHAVIOR, 'hostname')
-    assert_equal 'hostname', server.host
-  end
-
-  def test_delegates_serve_call_to_responder
-    io = mock
-    responder = mock
-    server = ResponderServer.new(IRRELEVANT_PORT, responder)
-
-    responder.expects(:serve).with(io)
-
-    server.serve(io)
-  end
-
-  def test_connection_log_messages_use_short_behavior_name_to_shorten_log_messages
-    [:connecting, :disconnecting].each do |method|
-      assert_log_message_uses_short_behavior_name_for(method) do |server|
-        server.send(method, stub_everything(peeraddr: [127, 0, 0, 1]))
-      end
-    end
-  end
-
-  def test_start_stop_log_messages_use_short_behavior_name_to_shorten_log_messages
-    [:starting, :stopping].each do |method|
-      assert_log_message_uses_short_behavior_name_for(method) do |server|
-        server.send(method)
-      end
-    end
-  end
-
-  def assert_log_message_uses_short_behavior_name_for(method)
-    logger = StringIO.new
-    server = ResponderServer.new(IRRELEVANT_PORT, Bane::Behaviors::Responders::SampleForTesting.new)
-    server.stdlog = logger
-    
-    yield server
-
-    assert_match /SampleForTesting/, logger.string, "Log for #{method} should contain class short name"
-    assert_no_match /Behaviors::Responders::SampleForTesting/, logger.string, "Log for #{method} should not contain expanded module name"
-  end
-
-end
-
-module Bane
-  module Behaviors
-    module Responders
-      class SampleForTesting
-        def serve(io)
-          io.puts('Hello')
-        end
-      end
-    end
-  end
-end

data/test/bane/behaviors/servers/timeout_in_listen_queue_test.rb

@@ -1,23 +0,0 @@
-require_relative '../../../test_helper'
-require 'socket'
-
-class TimeoutInListenQueueTest < Test::Unit::TestCase
-
-  include LaunchableRoleTests
-  include ServerTestHelpers
-
-  def setup
-    @object = Bane::Behaviors::Servers::TimeoutInListenQueue.make(IRRELEVANT_PORT, Bane::Behaviors::Servers::LOCALHOST)
-  end
-
-  def test_never_connects
-    run_server(Bane::Behaviors::Servers::TimeoutInListenQueue.make(port, Bane::Behaviors::Servers::LOCALHOST)) do
-      assert_raise(Errno::ECONNREFUSED) { TCPSocket.new('localhost', port) }
-    end
-  end
-
-  def port
-    4001
-  end
-
-end

data/test/bane/command_line_configuration_test.rb

@@ -1,82 +0,0 @@
-require_relative '../test_helper'
-require 'mocha/setup'
-
-class CommandLineConfigurationTest < Test::Unit::TestCase
-  include Bane
-
-  # Creation tests (uses a cluster of objects starting at the top-level CommandLineConfiguration)
-
-  def test_creates_specified_makeable_on_given_port
-    behaviors = process arguments: [3000, 'ThingA'],
-                       configuration: { 'ThingA' => SimpleMaker.new('ThingA'),
-                                        'ThingB' => SimpleMaker.new('ThingB') }
-    assert_equal 1, behaviors.size, "Wrong number of behaviors, got #{behaviors}"
-    assert_makeable_created(behaviors.first, port: 3000, name: 'ThingA')
-  end
-
-  def test_creates_multiple_makeables_on_increasing_ports
-    behaviors = process arguments: [4000, 'ThingA', 'ThingB'],
-                       configuration: {'ThingA' => SimpleMaker.new('ThingA'),
-                                       'ThingB' => SimpleMaker.new('ThingB') }
-
-    assert_equal 2, behaviors.size, "Wrong number of behaviors, got #{behaviors}"
-    assert_makeable_created(behaviors.first, port: 4000, name: 'ThingA')
-    assert_makeable_created(behaviors.last, port: 4000 + 1, name: 'ThingB')
-  end
-
-  def test_creates_all_known_makeables_in_alphabetical_order_if_only_port_specified
-    behaviors = process arguments: [4000],
-                       configuration: { 'ThingB' => SimpleMaker.new('ThingB'),
-                                        'ThingC' => SimpleMaker.new('ThingC'),
-                                        'ThingA' => SimpleMaker.new('ThingA') }
-
-    assert_equal 3, behaviors.size, "Wrong number of behaviors created, got #{behaviors}"
-    assert_equal 'ThingA', behaviors[0].name
-    assert_equal 'ThingB', behaviors[1].name
-    assert_equal 'ThingC', behaviors[2].name
-  end
-
-  def process(options)
-    arguments = options.fetch(:arguments)
-    makeables = options.fetch(:configuration)
-    CommandLineConfiguration.new(makeables).process(arguments) { |errors| raise errors }
-  end
-
-  def assert_makeable_created(behaviors, parameters)
-    assert_equal parameters.fetch(:port), behaviors.port
-    assert_equal parameters.fetch(:name), behaviors.name
-  end
-
-  class SimpleMaker
-    attr_reader :name, :port, :host
-    def initialize(name)
-      @name = name
-    end
-
-    def make(port, host)
-      @port = port
-      @host = host
-      self
-    end
-  end
-
-  # Failure tests (uses a cluster of objects starting at the top-level CommandLineConfiguration)
-
-  def test_unknown_behavior_fails_with_message
-    assert_invalid_arguments_fail_matching_message([IRRELEVANT_PORT, 'AnUnknownBehavior'], /Unknown Behavior/i)
-  end
-
-  def test_invalid_option_fails_with_error_message
-    assert_invalid_arguments_fail_matching_message(['--unknown-option', IRRELEVANT_PORT], /Invalid Option/i)
-  end
-
-  def assert_invalid_arguments_fail_matching_message(arguments, message_matcher)
-    block_called = false
-    CommandLineConfiguration.new({}).process(arguments) do |error_message|
-      block_called = true
-      assert_match message_matcher, error_message
-    end
-    assert block_called, "Expected invalid arguments to invoke the failure block"
-  end
-
-end

data/test/bane/extensions_test.rb

@@ -1,17 +0,0 @@
-require_relative '../test_helper'
-
-class ExtensionsTest < Test::Unit::TestCase
-  def test_unqualified_name_removes_module_path
-    assert_equal 'String', String.unqualified_name
-    assert_equal 'NestedClass', TopModule::NestedClass.unqualified_name
-    assert_equal 'DoublyNestedClass', TopModule::NestedModule::DoublyNestedClass.unqualified_name
-  end
-end
-
-module TopModule
-  class NestedClass; end
-
-  module NestedModule
-    class DoublyNestedClass; end
-  end
-end

data/test/bane/fake_connection_test.rb

@@ -1,34 +0,0 @@
-require_relative '../test_helper'
-
-class FakeConnectionTest < Test::Unit::TestCase
-
-  def setup
-    @fake_connection = FakeConnection.new
-  end
-
-  def test_fake_connection_returns_nil_if_no_commands_to_read
-    assert_nil @fake_connection.gets
-  end
-
-  def test_fake_connection_reports_when_one_command_set_and_read
-    @fake_connection.will_send("Command #1")
-
-    @fake_connection.gets
-
-    assert @fake_connection.read_all_queries?, "Should have read all queries"
-  end
-
-  def test_fake_connection_reports_when_all_commands_read
-    @fake_connection.will_send("Command #1")
-    @fake_connection.will_send("Command #2")
-
-    @fake_connection.gets
-
-    assert !@fake_connection.read_all_queries?, "Did not read all queries yet"
-
-    @fake_connection.gets
-
-    assert @fake_connection.read_all_queries?, "Should have read all queries"
-  end
-
-end

data/test/bane/launchable_role_tests.rb

@@ -1,20 +0,0 @@
-module LaunchableRoleTests
-
-  # Verify the contract required for Launcher
-
-  def test_responds_to_start
-    assert_respond_to(@object, :start)
-  end
-
-  def test_responds_to_stop
-    assert_respond_to(@object, :stop)
-  end
-
-  def test_responds_to_join
-    assert_respond_to(@object, :join)
-  end
-
-  def test_responds_to_stdlog
-    assert_respond_to(@object, :stdlog=)
-  end
-end

data/test/bane/naive_http_response_test.rb

@@ -1,69 +0,0 @@
-require_relative '../test_helper'
-
-class NaiveHttpResponseTest < Test::Unit::TestCase
-
-  IRRELEVANT_RESPONSE_CODE = "999"
-  IRRELEVANT_RESPONSE_DESCRIPTION = "Irrelevant description"
-  IRRELEVANT_CONTENT_TYPE = "irrelevant content type"
-  IRRELEVANT_BODY = "irrelevant body"
-
-  def test_should_send_http_format_string
-    response = response_for("200", "OK", IRRELEVANT_CONTENT_TYPE, IRRELEVANT_BODY)
-    assert_equal "HTTP/1.1 200 OK\r\n", response.lines.first, "First line should be HTTP status"
-  end
-
-  def test_should_include_date
-    assert_match /Date: .*/, any_response, 'Should have included a Date header'
-  end
-
-  def test_should_set_content_type
-    response = response_for(IRRELEVANT_RESPONSE_CODE,
-                            IRRELEVANT_RESPONSE_DESCRIPTION,
-                            "text/xml",
-                            IRRELEVANT_BODY)
-    assert_match /Content-Type: text\/xml/, response, 'Should have included content type'
-  end
-
-  def test_should_set_content_length_as_length_of_body_in_bytes
-    message = "Hello, there!"
-    response = response_for(IRRELEVANT_RESPONSE_CODE,
-                            IRRELEVANT_RESPONSE_DESCRIPTION,
-                            IRRELEVANT_CONTENT_TYPE,
-                            message)
-
-    assert_match /Content-Length: #{message.length}/, response, 'Should have included content length'
-  end
-
-  def test_should_include_newline_between_headers_and_body
-    message = "This is some body content."
-    response = response_for(IRRELEVANT_RESPONSE_CODE,
-                            IRRELEVANT_RESPONSE_DESCRIPTION,
-                            IRRELEVANT_CONTENT_TYPE,
-                            message)
-
-    response_lines = response.lines.to_a
-    index_of_body_start = response_lines.index(message)
-    line_before_body = response_lines[index_of_body_start - 1]
-    assert line_before_body.strip.empty?, "Should have had blank line before the body"
-  end
-
-  def test_should_include_the_body_at_the_end_of_the_response
-    message = "This is some body content."
-    response = response_for(IRRELEVANT_RESPONSE_CODE,
-                            IRRELEVANT_RESPONSE_DESCRIPTION,
-                            IRRELEVANT_CONTENT_TYPE,
-                            message)
-    assert_match /#{message}$/, response, "Should have ended the response with the body content"
-  end
-
-  private
-
-  def response_for(response_code, response_description, content_type, body)
-    NaiveHttpResponse.new(response_code, response_description, content_type, body).to_s
-  end
-
-  def any_response
-    response_for(IRRELEVANT_RESPONSE_CODE, IRRELEVANT_RESPONSE_DESCRIPTION, IRRELEVANT_CONTENT_TYPE, IRRELEVANT_BODY)
-  end
-
-end