tlb-core 0.3.2

data/README.markdown

@@ -0,0 +1,46 @@
+## Using tlb.rb:
+
+__tlb.rb__ uses [tlb](https://github.com/test-load-balancer/tlb "TLB") under the hood. It runs a sub-process which talks to the actual tlb-server(or equivallent) to balance and post run-feedback.
+Balancer process is actually an HTTP server which listen to a certain TCP port so tlb-ruby library can talk to it. 
+This is controlled by an environment variable named *'TLB_BALANCER_PORT'*, which can be set to any port number(integer between 1024 to 65535) that is guaranteed to remain un-bound while the build runs.
+
+In addition to this extra environment variable, the usual TLB environment variable setup is required(so the balancer knows things like what partitioning algorithm to use or the type of server it has to talk to etc). 
+Detailed documentation of TLB environment variable configuration is available at [http://test-load-balancer.github.com](http://test-load-balancer.github.com "Tlb Documentation")
+
+__tlb.rb__ supports RSpec(1.x and 2.x), Cucumber and Test::Unit, which are the most widely used testing frameworks in the Ruby world. 
+
+__tlb.rb__ is fully compatible with both Ruby 1.9 and 1.8 across __MRI__ and __JRuby__. However, 1.9 support will be available only version 0.3.2 onwards.
+
+We test __tlb.rb__ on MRI and JRuby, however it should work with other flavours of Ruby(like REE) as well.
+
+## Getting tlb.rb:
+
+__RSpec2__ support(both __1.9__ and __1.8__):
+    $ gem install tlb-rspec2
+
+__Cucumber__ support(both __1.9__ and __1.8__):
+    $ gem install tlb-cucumber
+
+__RSpec1__ support(both __1.9__ and __1.8__):
+    $ gem install tlb-rspec1
+
+__Test::Unit__ support on Ruby __1.9__:(available 0.3.2 onwards)
+    $ gem install tlb-testunit19
+
+__Test::Unit__ support on Ruby __1.8__:(available 0.3.2 onwards)
+    $ gem install tlb-testunit18
+    
+If a version older than 0.3.2, please use 
+    $ gem install tlb-testunit
+for Test::Unit support.
+    
+## Setting it up for your project
+
+Please refer documentation on [http://test-load-balancer.github.com/](http://test-load-balancer.github.com/ "TLB Website") for detailed setup instructions. 
+
+Documentation also explains TLB concepts and customization options in fair amount of detail. We highly recomend going through the TLB documentation.
+
+## Want a feature? Found a bug? 
+
+Post it at [Issue Tracker](http://code.google.com/p/tlb/issues/list "Issue Tracker").
+  

data/core/lib/tasks/tlb.rake

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'tlb'
+
+namespace :tlb do
+  task :start do
+    Tlb.start_server
+    at_exit do
+      $stderr.write "terminating tlb server\n"
+      Tlb.stop_server
+    end
+  end
+end
+

data/core/lib/tlb.rb

@@ -0,0 +1,243 @@
+require 'rubygems'
+require 'open4'
+require 'net/http'
+require 'timeout'
+
+module Tlb
+  TLB_OUT_FILE = 'TLB_OUT_FILE'
+  TLB_ERR_FILE = 'TLB_ERR_FILE'
+  TLB_APP = 'TLB_APP'
+  DEFAULT_TLB_BALANCER_STARTUP_TIME = '120'
+
+  module Balancer
+    TLB_BALANCER_PORT = 'TLB_BALANCER_PORT'
+    BALANCE_PATH = '/balance'
+    SUITE_TIME_REPORTING_PATH = '/suite_time'
+    SUITE_RESULT_REPORTING_PATH = '/suite_result'
+
+    def self.host
+      'localhost'
+    end
+
+    def self.port
+      ENV[TLB_BALANCER_PORT] || '8019'
+    end
+
+    def self.send path, data
+      Net::HTTP.start(host, port) do |h|
+        res = h.post(path, data)
+        res.value
+        res.body
+      end
+    end
+
+    def self.get path
+      Net::HTTP.get_response(host, path, port).body
+    end
+
+    def self.running?
+      get("/control/status") == "RUNNING"
+    rescue
+      false
+    end
+
+    def self.terminate
+      get("/control/suicide")
+    end
+
+    def self.wait_for_start
+      loop do
+        begin
+          break if running?
+        rescue
+          #ignore
+        end
+      end
+    end
+  end
+
+  module RSpec
+  end
+
+  module TestUnit
+  end
+
+  def self.relative_file_path file_name
+    abs_file_name = File.expand_path(file_name)
+    rel_file_name = abs_file_name.sub(/^#{Dir.pwd}/, '.')
+  end
+
+  def self.relative_file_paths file_names
+    file_names.map { |file_name| relative_file_path(file_name) }
+  end
+
+  def self.balance_and_order file_set
+    ensure_server_running
+    Balancer.send(Balancer::BALANCE_PATH, file_set.join("\n")).split("\n")
+  end
+
+  def self.suite_result suite_name, result
+    ensure_server_running
+    Balancer.send(Balancer::SUITE_RESULT_REPORTING_PATH, "#{suite_name}: #{result}")
+  end
+
+  def self.suite_time suite_name, mills
+    ensure_server_running
+    Balancer.send(Balancer::SUITE_TIME_REPORTING_PATH, "#{suite_name}: #{mills}")
+  end
+
+  def self.fail_as_balancer_is_not_running
+    raise "Balancer server must be started before tests are run."
+  end
+
+  def self.ensure_server_running
+    server_running? || fail_as_balancer_is_not_running
+  end
+
+  def self.server_running?
+    Balancer.running?
+  end
+
+  def self.root_dir
+    File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  end
+
+  def self.tlb_jar
+    File.expand_path(Dir.glob(File.join(root_dir, "tlb-alien*")).first)
+  end
+
+  def self.server_command
+    "java -jar #{tlb_jar}"
+  end
+
+  def self.can_fork?
+    RUBY_PLATFORM != 'java'
+  end
+
+  class BalancerProcess
+    class StreamPumper
+      def initialize stream, file
+        @stream, @file = stream, file
+        @thd = Thread.new { pump }
+      end
+
+      def pump
+        loop do
+          data_available? && flush_stream
+          Thread.current[:stop_pumping] && break
+          sleep 0.1
+        end
+      end
+
+      def flush_stream
+        File.open(ENV[@file], 'a') do |h|
+          h.write(read)
+        end
+      end
+
+      def stop_pumping!
+        @thd[:stop_pumping] = true
+        @thd.join
+      end
+    end
+
+    def initialize server_command
+      pumper_type, out, err  = start(server_command)
+      @out_pumper = pumper_type.new(out, TLB_OUT_FILE)
+      @err_pumper = pumper_type.new(err, TLB_ERR_FILE)
+    end
+
+    def stop_pumping
+      @out_pumper.stop_pumping!
+      @err_pumper.stop_pumping!
+    end
+
+    def die
+      Balancer.terminate
+      stop_pumping
+    end
+  end
+
+  class ForkBalancerProcess < BalancerProcess
+    def start server_command
+      @pid, input, out, err = Open4.popen4(server_command)
+      unless (out)
+        raise "out was nil"
+      end
+      return Class.new(StreamPumper) do
+        def data_available?
+          not @stream.eof?
+        end
+
+        def read
+          @stream.read
+        end
+      end, out, err
+    end
+
+    def die
+      super
+      @pid = nil
+      Process.wait
+    end
+  end
+
+  class JavaBalancerProcess < BalancerProcess
+    def start server_command
+      require 'java'
+      pb = java.lang.ProcessBuilder.new(server_command.split)
+      ENV.each do |key, val|
+        pb.environment[key] = val
+      end
+      @process = pb.start()
+      return Class.new(StreamPumper) do
+        def data_available?
+          @stream.ready
+        end
+
+        def read
+          @stream.read_line
+        end
+
+        def stop_pumping!
+          super
+          @stream.close
+        end
+      end, buf_reader(@process.input_stream), buf_reader(@process.error_stream)
+    end
+
+    def buf_reader stream
+      java.io.BufferedReader.new(java.io.InputStreamReader.new(stream))
+    end
+
+    def die
+      super
+      @process.destroy
+      @process.waitFor
+      @process = nil
+    end
+  end
+
+  def self.balancer_process_type
+    can_fork? ? ForkBalancerProcess : JavaBalancerProcess
+  end
+
+  def self.max_startup_time
+    (ENV['TLB_BALANCER_STARTUP_MAXTIME'] || DEFAULT_TLB_BALANCER_STARTUP_TIME).to_i
+  end
+
+  def self.start_server
+    Timeout::timeout(max_startup_time) do
+      ENV[TLB_APP] = 'tlb.balancer.BalancerInitializer'
+      bal_klass = balancer_process_type
+      @balancer_process = bal_klass.new(server_command)
+      Balancer.wait_for_start
+    end
+  rescue Timeout::Error => e
+    raise "TLB server failed to start in 2 seconds. This usually happens when TLB configuration(environment variables) is incorrect. Please check your environment variable configuration."
+  end
+
+  def self.stop_server
+    @balancer_process.die
+  end
+end

data/core/lib/tlb/run_data.rb

@@ -0,0 +1,55 @@
+require 'tlb'
+
+module Tlb::RunData
+  class Suite < Struct.new(:identity, :start_time, :end_time, :failed)
+    MILLS_PER_SEC = 1000
+
+    def initialize(identity, start_time)
+      super(identity, start_time, start_time, false)
+    end
+
+    def run_time
+      ((end_time - start_time)*MILLS_PER_SEC).to_i
+    end
+
+    def for_id? new_identity
+      identity == new_identity
+    end
+
+    def report_to_tlb
+      Tlb.suite_time(identity, run_time)
+      Tlb.suite_result(identity, failed)
+    end
+  end
+
+  def suite_started identity
+    unless (suites.last && suites.last.for_id?(identity))
+      suites << Tlb::RunData::Suite.new(identity, Time.now)
+    end
+  end
+
+  def update_suite_data identity
+    if (suite = suites.last) #stupid framework :: retarded fix (this is necessary since rspec-1[don't know if rspec-2 is as stupid too] creates example_proxies for every example it runs, as though its an independent spec-group)
+      suite.end_time = Time.now
+      block_given? && yield(suite)
+    end
+  end
+
+  def update_suite_failed identity
+    update_suite_data(identity) do |suite|
+      suite.failed = true
+    end
+  end
+
+  def report_all_suite_data
+    suites.each do |suite_time|
+      suite_time.report_to_tlb
+    end
+  end
+
+  private
+
+  def suites
+    @suites ||= []
+  end
+end

data/core/lib/tlb/util.rb

@@ -0,0 +1,15 @@
+require 'tlb'
+
+module Tlb::Util
+  def self.quote_path *fragments
+    single_quote(File.expand_path(File.join(*fragments)))
+  end
+
+  def self.single_quote str
+    "'#{escape_quote(str)}'"
+  end
+
+  def self.escape_quote str
+    str.gsub(/'/, "\\'")
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: tlb-core
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Janmejay Singh
+- Pavan KS
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+description: |
+  TLB-Ruby base library that provides common test-load-balancing infrastructure for Ruby testing tools. Core in itself is framework agnostic. It exposes APIs that allow any framework specific libraries to load-balance.
+
+email: singh.janmejay@gmail.com;itspanzi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- core/lib/tasks/tlb.rake
+- core/lib/tlb.rb
+- core/lib/tlb/run_data.rb
+- core/lib/tlb/util.rb
+- ./core/tlb-alien-0.3.2.jar
+- README.markdown
+homepage: http://github.com/test-load-balancer/tlb.rb
+licenses: []
+
+post_install_message: |
+  =========================================================================
+  Documentation: Detailed configuration documentation can be found at http://test-load-balancer.github.com. Documentation section in this website hosts documentation for every public release.
+  
+  -------------------------------------------------------------------------
+  TLB Setup: You'll need a TLB-Server in your network that is reachable over the network from the machines you use to execute your project's test-suite. Please refer the TLB documentation for details.
+  
+  -------------------------------------------------------------------------
+  Note: Core is just the base library that implements common infrastructure for test-load-balancing in Ruby and is completely testing-framework agnostic. It exposes APIs that allow other ruby libraries to load-balance tests. You'll need to install one of the testing-framework specific libraries to make use of it.
+  
+  =========================================================================
+
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- core/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: tlb-rb
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: tlb-core-0.3.2
+test_files: []
+