tlb-testunit 0.1.1

data/.emacs_project

@@ -0,0 +1 @@
+(setq rspec-executable "rspec")

data/.gitignore

@@ -0,0 +1,4 @@
+TAGS
+tmp
+tlb_store
+tlb-all*.jar

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tlb"]
+	path = tlb
+	url = git://github.com/test-load-balancer/tlb.git

data/README.markdown

@@ -0,0 +1,33 @@
+## Using tlb_rb:
+
+tlb_rb uses [tlb](https://github.com/test-load-balancer/tlb "TLB") under the hood. It runs a sub-process(java process) which talks to the actual tlb-server(or equivallent) to balance and post run-feedback.
+Balancer process is actually an HTTP server which needs to listen to a certain TCP port so that tlb-ruby implementation 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 what server to talk to). 
+Detailed documentation of TLB environment variable configuration is available at [https://github.com/test-load-balancer/tlb/wiki/Configuration-Variables](https://github.com/test-load-balancer/tlb/wiki/Configuration-Variables "Tlb config reference")
+
+As of now, rspec is the only test framework that tlb_rb supports. We plan to add support for other ruby-testing-frameworks soon.
+
+## Setting it up for your project
+
+Please refer the [sample_projects](http://github.com/test-load-balancer/sample_projects "Tlb setup examples") to see the details of how to set it up.
+
+Usually, something equivallent of this in one of your Rake files should suffice:
+
+    PATH_TO_TLB = File.join(RAILS_ROOT, 'vendor', 'plugins', 'tlb_rb', 'lib', 'tlb')
+    require PATH_TO_TLB
+    require File.join(PATH_TO_TLB, 'spec_task')
+  
+    Tlb::SpecTask.new(:balanced_specs) do |t|
+      t.spec_files = FileList['spec/**/*_spec.rb']
+      t.spec_opts << "--require #{PATH_TO_TLB},#{File.join(PATH_TO_TLB, 'spec_formatter')} --format 'Tlb::SpecFormatter:/dev/null' --format nested"
+    end
+  
+    desc "load balanced spec"
+    task :run_balanced => ['tlb:start', :balanced_specs]
+  
+Where run_balanced is the task you invoke at the top-level(invoked externally).
+
+## RSpec version compatibility
+  The branch '__master__' is __RSpec-2.x__ compatible. If you use __RSpec-1__(i.e. __1.3.x__ etc, please use branch named '__rspec-1__'. If you come across any bugs with eiher RSpec-2 or 1 support, please post it as an bug on the issue tracker on github project page.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rspec/core/rake_task'
+require 'rake/testtask'
+
+task :test => ['test:rspec', 'test:test_unit']
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:rspec) do |t|
+    t.pattern = 'tests/**/*_spec.rb'
+  end
+
+  Rake::TestTask.new(:test_unit) do |t|
+    t.test_files = FileList['tests/**/*_test.rb']
+  end
+end
+
+task :build_tlb do
+  Dir.glob("tlb-all*.jar").each { |jar| FileUtils.rm(jar) }
+  sh 'ant -f tlb/build.xml package'
+  Dir.glob('tlb/target/tlb-all*').each { |file| FileUtils.copy(file, ".") }
+end
+
+task :package do
+  `gem build tlb-rspec2.gemspec`
+  `gem build tlb-testunit.gemspec`
+end

data/gem_common.rb

@@ -0,0 +1,56 @@
+BASE_DIR = File.dirname(__FILE__)
+LIB_TLB = File.join(BASE_DIR, "lib", "tlb")
+TEST_DIR = File.join(BASE_DIR, "tests")
+TAG_VERSION = `git describe --abbrev=0`.gsub(/^v/, '')
+CODE_VERSION = `git describe --always`
+AUTHORS = ["Janmejay Singh", "Pavan KS"]
+EMAIL = "singh.janmejay@gmail.com;itspanzi@gmail.com"
+HOME_PAGE = "http://github.com/test-load-balancer/tlb_rb"
+SUMMARY = "#{$name}-#{CODE_VERSION}"
+DESC = <<END
+TLB ruby implementation base, which provides support for load balancing tests written in #{$framework}.
+TLB_rb test suite is not bundled, please check http://github.com/test-load-balancer/tlb_rb for tests.
+Detailed configuration documentation can be found at https://github.com/test-load-balancer/tlb/wiki.
+END
+POST_INSTALL_MESSAGE = <<END
+-------------------------------------------------------------------------
+Documentation: Detailed configuration documentation can be found at https://github.com/test-load-balancer/tlb/wiki.
+-----------------------------
+Example: https://github.com/test-load-balancer/sample_projects has examples projects and shell script to demonstrate a typical build(by starting a local tlb server, and executing two partitions locally). While partitions in these examples execute one after another, in an actual CI/pre-checkin build, they will actually run parallely on different machines.
+Its a good idea to play with the environment variables values being used in these shell-scripts to understand how they affect TLB's behaviour. You may want to check https://github.com/test-load-balancer/tlb/wiki/Configuration-Variables, which documents each variable and its effect.
+-----------------------------
+Issue tracker: Please report bugs/enhancements/feature-requests at http://code.google.com/p/tlb/issues/list. Github, Rubyforge or any other issue trackers are not monitored or updated.
+-------------------------------------------------------------------------
+END
+RUBYFORGE_PROJECT = "tlb-rb"
+RUBYGEMS_VERSION = "1.3.7"
+
+def files *exclude_dirs
+  files = `git ls-files`.split("\n")
+  files += Dir.glob(File.join(File.dirname(__FILE__), "*.jar")).map { |path| File.basename(path) }
+  exclude_dirs.inject(files) { |files, dir| files - `git ls-files #{dir}`.split("\n") }
+end
+
+
+def configure_tlb s
+  s.name        = $name
+  s.version     = TAG_VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = AUTHORS
+  s.email       = EMAIL
+  s.homepage    = HOME_PAGE
+  s.summary     = SUMMARY
+  s.description = DESC
+
+  s.rubyforge_project = RUBYFORGE_PROJECT
+  s.rubygems_version = RUBYGEMS_VERSION
+
+  s.post_install_message = POST_INSTALL_MESSAGE
+
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+
+  s.add_runtime_dependency 'open4', '>= 1.0.1'
+  s.add_runtime_dependency 'rake'
+end

data/lib/tasks/tlb.rake

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '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/lib/tlb/run_data.rb

@@ -0,0 +1,53 @@
+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/lib/tlb/test_unit/mediator_inflection.rb

@@ -0,0 +1,27 @@
+require 'tlb/test_unit/test_splitter'
+require 'tlb/test_unit/test_observer'
+require 'test/unit/ui/testrunnermediator'
+
+module Tlb::TestUnit::MediatorInflection
+  def self.included base
+    base.send(:alias_method, :run_suite_without_tlb, :run_suite)
+    base.send(:remove_method, :run_suite)
+    base.send(:include, InstanceMethods)
+
+    base.send(:include, Tlb::TestUnit::TestSplitter)
+    base.send(:include, Tlb::TestUnit::TestObserver)
+  end
+
+  module InstanceMethods
+    def run_suite
+      register_observers
+      prune_suite
+      run_suite_without_tlb
+    end
+  end
+
+end
+
+Test::Unit::UI::TestRunnerMediator.class_eval do
+  include Tlb::TestUnit::MediatorInflection
+end

data/lib/tlb/test_unit/test_observer.rb

@@ -0,0 +1,36 @@
+require 'tlb/run_data'
+
+module Tlb::TestUnit::TestObserver
+  class TestUnitRunData
+    include Tlb::RunData
+
+    def suite_failed(failure)
+      update_suite_failed(suite_name_for(failure.test_name))
+    end
+
+    def suite_name_for(test_name)
+      test_name.scan(/\((.+)\)$/).flatten.first
+    end
+  end
+  
+  def register_observers
+    run_data = TestUnitRunData.new
+    
+    add_listener(Test::Unit::TestResult::FAULT) do |fault|
+      run_data.suite_failed(fault)
+    end
+
+    add_listener(Test::Unit::UI::TestRunnerMediator::FINISHED) do |*elapsed_time|
+      run_data.report_all_suite_data
+    end
+
+    add_listener(Test::Unit::TestSuite::STARTED) do |suite_name|
+      run_data.suite_started(suite_name)
+    end
+
+
+    add_listener(Test::Unit::TestSuite::FINISHED) do |suite_name|
+      run_data.update_suite_data(suite_name)
+    end
+  end
+end

data/lib/tlb/test_unit/test_splitter.rb

@@ -0,0 +1,8 @@
+module Tlb::TestUnit::TestSplitter
+  def prune_suite
+    name_suite_map = @suite.tests.inject({}) { |map, test| map[test.name] = test; map }
+    names_to_run = Tlb.balance_and_order(@suite.tests.map { |test| test.name })
+    tests_to_run = names_to_run.inject([]) { |tests, name| tests << name_suite_map[name]; tests }
+    @suite.instance_variable_set('@tests', tests_to_run)
+  end
+end

data/lib/tlb/test_unit/test_task.rb

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+class Tlb::TestUnit::TestTask < Rake::TestTask
+  def initialize *args
+    super do |this|
+      this.ruby_opts.unshift " -r#{File.join('tlb', 'test_unit', 'mediator_inflection')} "
+      this.ruby_opts.unshift " -r#{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tlb'))} "
+      yield this if block_given?
+    end
+  end
+end

data/lib/tlb.rb

@@ -0,0 +1,142 @@
+require 'rubygems'
+require 'open4'
+require 'net/http'
+
+TLB_RB_LIB = File.expand_path(File.dirname(__FILE__))
+unless $LOAD_PATH.include? TLB_RB_LIB
+  $LOAD_PATH << TLB_RB_LIB
+end
+
+module Tlb
+  TLB_OUT_FILE = 'TLB_OUT_FILE'
+  TLB_ERR_FILE = 'TLB_ERR_FILE'
+  TLB_APP = 'TLB_APP'
+
+  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]
+    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.wait_for_start
+      loop do
+        begin
+          TCPSocket.new(host, port)
+          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.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-all*")).first)
+  end
+
+  def self.server_command
+    "java -jar #{tlb_jar}"
+  end
+
+  def self.write_to_file file_var, clob
+    File.open(ENV[file_var], 'a') do |h|
+      h.write(clob)
+    end
+  end
+
+  def self.start_server
+    ENV[TLB_APP] = 'com.github.tlb.balancer.BalancerInitializer'
+    @pid, input, out, err = Open4.popen4(server_command)
+    @out_pumper = stream_pumper_for(out, TLB_OUT_FILE)
+    @err_pumper = stream_pumper_for(err, TLB_ERR_FILE)
+    Balancer.wait_for_start
+  end
+
+  def self.stream_pumper_for stream, dump_file
+    Thread.new do
+      loop do
+        stream.eof? || write_to_file(dump_file, stream.read)
+        Thread.current[:stop_pumping] && break
+        sleep 1
+      end
+    end
+  end
+
+  def self.stop_server
+    Process.kill(Signal.list["TERM"], @pid)
+    @pid = nil
+    @out_pumper[:stop_pumping] = true
+    @err_pumper[:stop_pumping] = true
+    @out_pumper.join
+    @err_pumper.join
+    Process.wait
+  end
+end

data/tlb-rspec2.gemspec

@@ -0,0 +1,11 @@
+$name="tlb-rspec2"
+$framework='rspec-2.x'
+require File.join(File.dirname(__FILE__), 'gem_common')
+
+Gem::Specification.new do |s|
+  configure_tlb(s)
+
+  s.files            = files('tests', File.join('lib', 'tlb', 'test_unit'))
+
+  s.add_runtime_dependency 'rspec', '>= 2.3.0'
+end

data/tlb-testunit.gemspec

@@ -0,0 +1,9 @@
+$name="tlb-testunit"
+$framework='test::unit'
+require File.join(File.dirname(__FILE__), 'gem_common')
+
+Gem::Specification.new do |s|
+  configure_tlb(s)
+
+  s.files            = files('tests', File.join('lib', 'tlb', 'rspec'))
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: tlb-testunit
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Janmejay Singh
+- Pavan KS
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-22 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: |
+  TLB ruby implementation base, which provides support for load balancing tests written in test::unit.
+  TLB_rb test suite is not bundled, please check http://github.com/test-load-balancer/tlb_rb for tests.
+  Detailed configuration documentation can be found at https://github.com/test-load-balancer/tlb/wiki.
+
+email: singh.janmejay@gmail.com;itspanzi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .emacs_project
+- .gitignore
+- .gitmodules
+- README.markdown
+- Rakefile
+- gem_common.rb
+- lib/tasks/tlb.rake
+- lib/tlb.rb
+- lib/tlb/run_data.rb
+- lib/tlb/test_unit/mediator_inflection.rb
+- lib/tlb/test_unit/test_observer.rb
+- lib/tlb/test_unit/test_splitter.rb
+- lib/tlb/test_unit/test_task.rb
+- tlb-rspec2.gemspec
+- tlb-testunit.gemspec
+- tlb-all-gv0.2-9-g1f1a4aa.jar
+has_rdoc: true
+homepage: http://github.com/test-load-balancer/tlb_rb
+licenses: []
+
+post_install_message: |
+  -------------------------------------------------------------------------
+  Documentation: Detailed configuration documentation can be found at https://github.com/test-load-balancer/tlb/wiki.
+  -----------------------------
+  Example: https://github.com/test-load-balancer/sample_projects has examples projects and shell script to demonstrate a typical build(by starting a local tlb server, and executing two partitions locally). While partitions in these examples execute one after another, in an actual CI/pre-checkin build, they will actually run parallely on different machines.
+  Its a good idea to play with the environment variables values being used in these shell-scripts to understand how they affect TLB's behaviour. You may want to check https://github.com/test-load-balancer/tlb/wiki/Configuration-Variables, which documents each variable and its effect.
+  -----------------------------
+  Issue tracker: Please report bugs/enhancements/feature-requests at http://code.google.com/p/tlb/issues/list. Github, Rubyforge or any other issue trackers are not monitored or updated.
+  -------------------------------------------------------------------------
+
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tlb-rb
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: tlb-testunit-0.1.1
+test_files: []
+