bane 0.1.1 → 1.0.0

data/lib/bane/behaviors/servers/exported.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bane
+  module Behaviors
+    module Servers
+
+      EXPORTED = [TimeoutInListenQueue]
+
+      # Listen only on localhost
+      LOCALHOST = '127.0.0.1'
+
+      # Deprecated - use LOCALHOST - Listen only on localhost
+      DEFAULT_HOST = LOCALHOST
+
+      # Listen on all interfaces
+      ALL_INTERFACES = '0.0.0.0'
+
+    end
+  end
+end

data/lib/bane/behaviors/servers/responder_server.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'gserver'
+
+module Bane
+  module Behaviors
+    module Servers
+
+      class ResponderServer < GServer
+
+        def initialize(port, behavior, host = Servers::LOCALHOST)
+          super(port, host)
+          @behavior = behavior
+          self.audit = true
+        end
+
+        def serve(io)
+          @behavior.serve(io)
+        end
+
+        def to_s
+          "<Bane::BehaviorServer: port=#{@port}, behavior=#{@behavior.class}>"
+        end
+
+        protected
+
+        alias_method :original_log, :log
+
+        def log(message)
+          original_log("#{@behavior.class.unqualified_name} #{@host}:#{@port} #{message}")
+        end
+
+        def connecting(client)
+          addr = client.peeraddr
+          log("client:#{addr[1]} #{addr[2]}<#{addr[3]}> connect")
+        end
+
+        def disconnecting(client_port)
+          log("client:#{client_port} disconnect")
+        end
+
+        def starting
+          log('start')
+        end
+
+        def stopping
+          log('stop')
+        end
+      end
+    end
+  end
+end

data/lib/bane/behaviors/servers/timeout_in_listen_queue.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module Bane
+  module Behaviors
+    module Servers
+
+      class TimeoutInListenQueue
+
+        def initialize(port, host = Servers::LOCALHOST)
+          @port = port
+          @host = host
+          self.stdlog= $stderr
+        end
+
+        def start
+          @server = Socket.new(:INET, :STREAM)
+          address = Socket.sockaddr_in(port, host)
+          @server.bind(address) # Note that we never call listen
+
+          log 'started'
+        end
+
+        def join
+          sleep
+        end
+
+        def stop
+          @server.close
+          log 'stopped'
+        end
+
+        def stdlog=(logger)
+          @logger = logger
+        end
+
+        def self.make(port, host)
+          new(port, host)
+        end
+
+        private
+
+        attr_reader :host, :port, :logger
+
+        def log(message)
+          logger.puts "[#{Time.new.ctime}] #{self.class.unqualified_name} #{host}:#{port} #{message}"
+        end
+      end
+
+    end
+  end
+end

data/lib/bane/command_line_configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Bane
+
+  def self.find_makeables
+    Hash[Bane::Behaviors::Responders::EXPORTED.map { |responder| [responder.unqualified_name, ResponderMaker.new(responder)] }]
+    .merge(Hash[Bane::Behaviors::Servers::EXPORTED.map { |server| [server.unqualified_name, server] }])
+  end
+
+  class CommandLineConfiguration
+
+    def initialize(makeables)
+      @behavior_maker = BehaviorMaker.new(makeables)
+      @arguments_parser = ArgumentsParser.new(makeables.keys)
+    end
+
+    def process(args, &error_policy)
+      arguments = @arguments_parser.parse(args)
+      create(arguments.behaviors, arguments.port, arguments.host)
+    rescue ConfigurationError => ce
+      error_policy.call([ce.message, @arguments_parser.usage].join("\n"))
+    end
+
+    private
+
+    def create(behaviors, port, host)
+      if behaviors.any?
+        @behavior_maker.create(behaviors, port, host)
+      else
+        @behavior_maker.create_all(port, host)
+      end
+    rescue UnknownBehaviorError => ube
+      raise ConfigurationError, ube.message
+    end
+
+  end
+
+  class ConfigurationError < RuntimeError;
+  end
+
+end

data/lib/bane/extensions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+unless Class.respond_to?(:unqualified_name)
+  class Class
+    def unqualified_name
+      self.name.split("::").last
+    end
+  end
+end

data/lib/bane/launcher.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module Bane
 
   class Launcher
 
-    def initialize(configurations, logger = $stderr)
-      @configuration = configurations
-      @logger = logger
-      @running_servers = []
+    def initialize(servers, logger = $stderr)
+      @servers = servers
+      @servers.each { |server| server.stdlog = logger }
     end
 
     def start
-      @running_servers = @configuration.start(@logger)
+      @servers.each { |server| server.start }
     end
 
     def join
-      @running_servers.each { |server| server.join }
+      @servers.each { |server| server.join }
     end
 
     def stop
-      @running_servers.each { |server| server.stop }
+      @servers.each { |server| server.stop }
     end
 
   end
-
+  
 end

data/lib/bane/naive_http_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NaiveHttpResponse
 
   CRLF        = "\r\n"

data/lib/bane/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bane
+  VERSION = '1.0.0'
+end

data/lib/bane.rb

@@ -1,8 +1,23 @@
-require 'bane/compatibility'
-require 'bane/service_registry'
-require 'bane/behaviors'
+# frozen_string_literal: true
+
+require 'bane/extensions'
+require 'bane/behavior_maker'
+require 'bane/behaviors/responders/for_each_line'
+require 'bane/behaviors/responders/close_after_pause'
+require 'bane/behaviors/responders/close_immediately'
+require 'bane/behaviors/responders/deluge_response'
+require 'bane/behaviors/responders/echo_response'
+require 'bane/behaviors/responders/fixed_response'
+require 'bane/behaviors/responders/http_refuse_all_credentials'
+require 'bane/behaviors/responders/never_respond'
+require 'bane/behaviors/responders/newline_response'
+require 'bane/behaviors/responders/random_response'
+require 'bane/behaviors/responders/slow_response'
+require 'bane/behaviors/responders/exported'
+require 'bane/behaviors/servers/responder_server'
+require 'bane/behaviors/servers/timeout_in_listen_queue'
+require 'bane/behaviors/servers/exported'
 require 'bane/launcher'
-require 'bane/delegating_gserver'
-require 'bane/configuration'
-require 'bane/configuration_parser'
+require 'bane/arguments_parser'
+require 'bane/command_line_configuration'
 require 'bane/naive_http_response'

metadata

@@ -1,122 +1,124 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bane
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Daniel Wellman
-autorequire: 
+- Joe Leo
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2010-05-28 00:00:00 -04:00
-default_executable: bane
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mocha
+date: 2022-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
   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_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
   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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: gserver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: |
+  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.
+email:
+- dan@danielwellman.com
+executables:
 - bane
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- LICENSE
+- README.md
+- TODO
+files:
+- HISTORY.md
 - 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
-- lib/bane/configuration_parser.rb
-- lib/bane/delegating_gserver.rb
+- lib/bane/arguments_parser.rb
+- lib/bane/behavior_maker.rb
+- lib/bane/behaviors/responders/close_after_pause.rb
+- lib/bane/behaviors/responders/close_immediately.rb
+- lib/bane/behaviors/responders/deluge_response.rb
+- lib/bane/behaviors/responders/echo_response.rb
+- lib/bane/behaviors/responders/exported.rb
+- lib/bane/behaviors/responders/fixed_response.rb
+- lib/bane/behaviors/responders/for_each_line.rb
+- lib/bane/behaviors/responders/http_refuse_all_credentials.rb
+- lib/bane/behaviors/responders/never_respond.rb
+- lib/bane/behaviors/responders/newline_response.rb
+- lib/bane/behaviors/responders/random_response.rb
+- lib/bane/behaviors/responders/slow_response.rb
+- lib/bane/behaviors/servers/exported.rb
+- lib/bane/behaviors/servers/responder_server.rb
+- lib/bane/behaviors/servers/timeout_in_listen_queue.rb
+- lib/bane/command_line_configuration.rb
+- lib/bane/extensions.rb
 - lib/bane/launcher.rb
 - lib/bane/naive_http_response.rb
-- lib/bane/service_registry.rb
-- 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
-- LICENSE
-- README.md
-- TODO
-has_rdoc: true
-homepage: http://github.com/danielwellman/bane
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+- lib/bane/version.rb
+homepage: https://github.com/danielwellman/bane
+licenses:
+- BSD
+metadata:
+  source_code_uri: https://github.com/danielwellman/bane
+  changelog_uri: https://github.com/danielwellman/bane/blob/main/HISTORY.md
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-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/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
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A test harness for socket connections based upon ideas from Michael Nygard's
+  'Release It!'
+test_files: []

data/Rakefile

@@ -1,60 +0,0 @@
-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
-
-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/examples/simple_port_and_class_as_constant.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-
-launcher = Launcher.new(Configuration(3000, Behaviors::CloseImmediately, Behaviors::CloseAfterPause))
-launcher.start
-launcher.join
-# runs until interrupt...

data/examples/simple_port_and_class_as_string.rb

@@ -1,7 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-launcher = Bane::Launcher.new(Configuration(3000, "CloseImmediately"))
-launcher.start
-launcher.join
-# runs until interrupt...

data/examples/specify_behavior_options.rb

@@ -1,16 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-include Behaviors
-
-launcher = Launcher.new(Configuration(
-        10256 => {:behavior => CloseAfterPause, :duration => 3},
-        10593 => {:behavior => FixedResponse, :message => "Hey!"},
-        10689 => {:behavior => SlowResponse, :message => "Custom message", :pause_duration => 15},
-        11239 => CloseAfterPause # Use the defaults for this behavior, don't need a Hash
-      )
-)
-launcher.start
-launcher.join
-# runs until interrupt...

data/examples/specify_ports.rb

@@ -1,15 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'bane'
-
-include Bane
-include Behaviors
-
-launcher = Launcher.new(Configuration(
-        10256 => CloseAfterPause,
-        10689 => CloseAfterPause, # severs may be repeated
-        11999 => CloseImmediately
-      )
-)
-launcher.start
-launcher.join
-# runs until interrupt...