bane 0.1.0 → 0.1.1

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2010, Daniel J. Wellman
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,95 @@
+# Bane
+
+Bane is a test harness used to test your application's interaction with other servers.  It is based upon the material from Michael Nygard's ["Release It!"](http://www.pragprog.com/titles/mnee/release-it) book as described in the "Test Harness" chapter.
+
+## Setup
+
+Bane is available as a gem.  Install it with
+
+  `sudo gem install bane`
+
+Note that Bane installs an executable, `bane`.  Simply invoke `bane` with no arguments to get a usage description.
+
+## Usage
+
+Bane is designed with a few usage scenarios in mind:
+
+1. Quick start with a specific behavior from the command line.  If your application talks to another server on a given port, you can start Bane from the command line by specifying the desired port and a name of server behavior.  For example, if your server talks to a third-party server on port 8080, you could start the "Never Respond" behavior on port 8080 to observe how your application behaves.
+
+   Example:  `$ bane 8080 NeverRespond`
+
+2. Quick start with multiple specific behaviors from the command line.  This will start each behavior on consecutive ports.
+
+   Example:  `$ bane 8080 NeverRespond CloseImmediately`
+
+3. Quick start with all known behaviors from the command line.  This also starts each behavior on a consecutive port, starting from the supplied starting port.  If you just want a general purpose test harness to run, and you can easily control the ports that your application talks to, you can start Bane up with a base port number and it will start all its known behaviors.  This way you can leave Bane running and tweak your application to talk to each of the various behaviors.
+
+   Example: `$ bane 3000`
+
+4. Advanced Configuration using Ruby.  If you want to modify some of the defaults used in the included behaviors, you can initialize Bane with a Hash of port numbers, behavior names, and configuration parameters.  For example, you might want to specify a response for the FixedResponse behavior:
+
+   Example:
+
+        require 'bane'
+
+        include Bane
+        include Behaviors
+
+        launcher = Launcher.new(Configuration(
+                3000 => {:behavior => FixedResponse, :message => "Shall we play a game?"},
+              )
+        )
+        launcher.start
+        launcher.join
+
+   See `examples/specify_behavior_options.rb` for another example.  For a list of options supported by the
+   basic behaviors, see the source for the behaviors in `Bane::Behaviors` at `lib/bane/behaviors.rb`.
+
+## Background
+
+See the "Test Harness" chapter from "Release It!" to read about the inspiration of Bane.
+
+The following behaviors are currently supported in Bane, with the name of the behavior after the description in parenthesis.
+Note that these are simple protocol-independent socket behaviors:
+
+* The connection can be established, but the remote end never sends a byte of data (NeverRespond)
+* The service can send one byte of the response every thirty seconds (SlowResponse)
+* The server establishes a connection but sends a random reply (RandomResponse)
+* The server accepts a connection and then drops it immediately (CloseImmediately)
+* The service can send megabytes when kilobytes are expected. (rough approximation with the DelugeReponse)
+* The service can refuse all authentication credentials. (HttpRefuseAllCredentials)
+
+The following behaviors are not yet supported; they require the configuration of an HTTP server.
+See the implementation of HttpRefuseAllCredentials for a simple example of an HTTP behavior.
+
+* The service can accept a request, send response headers (supposing HTTP), and never send the response body.
+* The service can send a response of HTML instead of the expected XML.
+
+The following behaviors are not yet supported. These require the ability to manipulate
+TCP packets at a low level; which may require a C or C++ extension.
+
+* The connection can be refused.
+* The request can sit in a listen queue until the caller times out.
+* The remote end can reply with a SYN/ACK and then never send any data.
+* The remote end can send nothing but RESET packets.
+* The remote end can report a full receive window and never drain the data.
+* The connection can be established, but packets could be lost causing retransmit delays
+* The connection can be established, but the remote end never acknowledges receiving a packet, causing endless retransmits
+
+## Design
+
+Bane Behaviors are simple objects which implement the Strategy pattern.  This makes them
+simple to unit test and allows them to be independent of the underlying server implementation.
+Bane currently serves all Behaviors using Ruby's built-in GServer, which provides a simple
+multi-threaded TCP server.  Behaviors currently:
+
+* Accept an IO stream used to read from or send a response.
+* Accept a hash of configuration options to allow overriding of default behavior parameters.
+* Provide a meaningful name to appear in the Bane log.  This is especially helpful if your application
+  under test dies and you'd like to identify which behavior killed it.
+
+To enable support of different types of behaviors such as HTTP responses or low-level TCP packet
+munging, a different base server instead of GServer may be required.  In that case, it should
+be possible to change how Behaviors are associated with a server, perhaps by making
+Behaviors extend a server base class.
+

data/Rakefile

@@ -1,8 +1,60 @@
-require 'rake/testtask'
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bane"
+    gem.summary = "A test harness for socket connections based upon ideas from Michael Nygard's 'Release It!'"
+    gem.description = <<-END
+      Bane is a test harness used to test your application's interaction with
+      other servers. It is based upon the material from Michael Nygard's "Release
+      It!" book as described in the "Test Harness" chapter.
+    END
+    gem.authors = ["Daniel Wellman"]
+    gem.email = "dan@danielwellman.com"
+    gem.homepage = "http://github.com/danielwellman/bane"
+    gem.files = FileList[ 'lib/**/*', 'bin/*', 'test/**/*', 'examples/*',
+      'Rakefile' ]
+    gem.add_development_dependency('mocha', '>= 0.9.8')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
 
+require 'rake/testtask'
 desc "Run all tests"
 Rake::TestTask.new do |test|
   test.libs << 'test'
   test.test_files =  FileList['test/**/*_test.rb']
   test.verbose    =  true
-end
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bane #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/bane/compatibility.rb

@@ -18,3 +18,19 @@ class String
     alias_method :lines, :to_a
   end
 end
+
+# Copied from ActiveSupport
+unless :to_proc.respond_to?(:to_proc)
+  class Symbol
+    # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
+    #
+    #   # The same as people.collect { |p| p.name }
+    #   people.collect(&:name)
+    #
+    #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
+    #   people.select(&:manager?).collect(&:salary)
+    def to_proc
+      Proc.new { |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bane
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Daniel Wellman
@@ -9,28 +15,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-16 00:00:00 -04:00
-default_executable: 
+date: 2010-05-28 00:00:00 -04:00
+default_executable: bane
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
         version: 0.9.8
-    version: 
-description: "    Bane is a test harness used to test your application's interaction with \n    other servers. It is based upon the material from Michael Nygard's \"Release\n    It!\" book as described in the \"Test Harness\" chapter.\n"
+  type: :development
+  version_requirements: *id001
+description: "      Bane is a test harness used to test your application's interaction with\n      other servers. It is based upon the material from Michael Nygard's \"Release\n      It!\" book as described in the \"Test Harness\" chapter.\n"
 email: dan@danielwellman.com
 executables: 
 - bane
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
+- README.md
 - TODO
 files: 
+- Rakefile
+- bin/bane
+- examples/simple_port_and_class_as_constant.rb
+- examples/simple_port_and_class_as_string.rb
+- examples/specify_behavior_options.rb
+- examples/specify_ports.rb
+- lib/bane.rb
 - lib/bane/behaviors.rb
 - lib/bane/compatibility.rb
 - lib/bane/configuration.rb
@@ -39,8 +60,6 @@ files:
 - lib/bane/launcher.rb
 - lib/bane/naive_http_response.rb
 - lib/bane/service_registry.rb
-- lib/bane.rb
-- bin/bane
 - test/bane/behaviors_test.rb
 - test/bane/configuration_parser_test.rb
 - test/bane/configuration_test.rb
@@ -50,39 +69,54 @@ files:
 - test/bane/naive_http_response_test.rb
 - test/bane/service_registry_test.rb
 - test/test_helper.rb
-- examples/simple_port_and_class_as_constant.rb
-- examples/simple_port_and_class_as_string.rb
-- examples/specify_behavior_options.rb
-- examples/specify_ports.rb
-- Rakefile
+- LICENSE
+- README.md
 - TODO
 has_rdoc: true
 homepage: http://github.com/danielwellman/bane
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A test harness for socket connections based upon ideas from Michael Nygard's 'Release It!'
-test_files: []
-
+test_files: 
+- test/bane/behaviors_test.rb
+- test/bane/configuration_parser_test.rb
+- test/bane/configuration_test.rb
+- test/bane/delegating_gserver_test.rb
+- test/bane/integration_test.rb
+- test/bane/launcher_test.rb
+- test/bane/naive_http_response_test.rb
+- test/bane/service_registry_test.rb
+- test/test_helper.rb
+- examples/simple_port_and_class_as_constant.rb
+- examples/simple_port_and_class_as_string.rb
+- examples/specify_behavior_options.rb
+- examples/specify_ports.rb