dtr 0.0.4 → 1.0.0

data/lib/dtr/test_unit/testrunnermediator_injection.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2007-2008 Li Xiao <iam@li-xiao.com>
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit/testcase'
+require 'test/unit/testsuite'
+
+module DTR
+  module TestUnit
+    module TestRunnerMediatorInjection
+      class SuiteWrapper
+        def initialize(suite)
+          @suite = suite
+        end
+
+        def run(result, &block)
+          @suite.run(result, &block)
+          WorkerClub.instance.graceful_shutdown
+        end
+
+        def size
+          @suite.size
+        end
+      end
+
+      def self.included(base)
+        base.send(:include, Master)
+        base.alias_method_chain :create_result, :thread_safe
+        base.alias_method_chain :run_suite, :dtr_injection
+        #have to use class_eval for adding it back after removed reject_dtr method
+        base.class_eval do
+          def self.reject_dtr
+            remove_method :run_suite
+            alias_method :run_suite, :run_suite_without_dtr_injection
+            remove_method :run_suite_without_dtr_injection
+
+            remove_method :create_result
+            alias_method :create_result, :create_result_without_thread_safe
+            remove_method :create_result_without_thread_safe
+
+            (class << self; self; end;).send :remove_method, :reject_dtr
+          end
+        end
+      end
+
+      def create_result_with_thread_safe
+        ThreadSafeTestResult.new(create_result_without_thread_safe)
+      end
+
+      def run_suite_with_dtr_injection
+        DTR.logger('dtr_master_process.log')
+        # inject testcase&testsuite as late as possible, for it's too easy to be hacked in ruby world
+        Test::Unit::TestCase.send(:include, TestUnit::TestCaseInjection)
+        Test::Unit::TestSuite.send(:include, TestUnit::TestSuiteInjection)
+        @suite = SuiteWrapper.new(@suite.proxy)
+        with_dtr_master do
+          run_suite_without_dtr_injection
+        end
+      end
+    end
+  end
+end

data/lib/dtr/test_unit/thread_safe_test_result.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2007-2008 Li Xiao <iam@li-xiao.com>
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module DTR
+  module TestUnit
+    class ThreadSafeTestResult
+      include DRbUndumped
+
+      def initialize(rs)
+        @mutex = Mutex.new
+        @rs = rs
+      end
+
+      def to_s
+        @mutex.synchronize do
+          @rs.to_s
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        @mutex.synchronize do
+          @rs.send(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/dtr/test_unit/worker_club.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2007-2008 Li Xiao <iam@li-xiao.com>
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'singleton'
+
+module DTR
+  module TestUnit
+    class WorkerClub
+      include Singleton
+
+      DEFAULT_RUN_TEST_TIMEOUT = 60 #seconds
+
+      def start_thread(drb_runner, remote_runner)
+        thread = Thread.new(drb_runner, remote_runner) do |local, remote|
+          local.run_test_on(remote)
+        end
+        thread[:started_on] = Time.now
+        workers.add(thread)
+      end
+
+      # Performs a wait on all the currently running threads and kills any that take
+      # too long. It waits by ENV['RUN_TEST_TIMEOUT'] || 60 seconds
+      def graceful_shutdown
+        while reap_dead_workers("shutdown") > 0
+          DTR.info {"Waiting for #{workers.list.length} threads to finish, could take #{timeout} seconds."}
+          sleep timeout / 60
+        end
+      end
+
+      private
+      def timeout
+        (ENV['RUN_TEST_TIMEOUT'] || DEFAULT_RUN_TEST_TIMEOUT).to_i
+      end
+
+      def workers
+        @workers ||= ThreadGroup.new
+      end
+
+      # Used internally to kill off any worker threads that have taken too long
+      # to complete processing. It returns the count of workers still active
+      # after the reap is done. It only runs if there are workers to reap.
+      def reap_dead_workers(reason='unknown')
+        if workers.list.length > 0
+          DTR.info {"Reaping #{workers.list.length} threads because of '#{reason}'"}
+          error_msg = "#{Time.now}: WorkerClub timed out this thread: #{reason}"
+          mark = Time.now
+          workers.list.each do |worker|
+            worker[:started_on] = Time.now if not worker[:started_on]
+
+            if mark - worker[:started_on] > timeout
+              DTR.info {"Thread #{worker.inspect} is too old, killing."}
+              worker.raise(TimeoutError.new(error_msg))
+            end
+          end
+        end
+
+        return workers.list.length
+      end
+    end
+  end
+end

data/lib/dtr/test_unit_injection.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2008 Li Xiao
+# Copyright (c) 2007-2008 Li Xiao <iam@li-xiao.com>
 # 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'dtr/service_provider'
 require 'dtr/test_unit'
 $argv_dup = ARGV.dup.delete_if{|f| f.include?('dtr/test_unit_injection')}
 

data/test/acceptance/agent_working_env_test.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+include DTR::AgentHelper
+
+class AgentWorkingEnvTest < Test::Unit::TestCase
+  include DTR::Service::WorkingEnv
+  def setup
+    #start_agents first for test files loaded would be copied into sub processes
+    start_agents
+  end
+
+  def teardown
+    stop_agents
+  end
+
+  def test_run_2_project_should_be_independence
+    assert_fork_process_exits_ok do
+      $argv_dup = ['an_error_test_case.rb']
+
+      suite = Test::Unit::TestSuite.new('test_run_2_project_should_be_independence 1')
+      suite << AnErrorTestCase.suite
+
+      @result = runit(suite)
+
+      assert_false @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 1, @result.error_count
+    end
+
+    assert_fork_process_exits_ok do
+      Dir.chdir("another_project") do
+        $argv_dup = ['passed_test_case.rb']
+        require 'passed_test_case'
+        suite = Test::Unit::TestSuite.new('test_run_2_project_should_be_independence 2')
+        suite << PassedTestCase.suite
+
+        @result = runit(suite)
+
+        assert @result.passed?
+        assert_equal 1, @result.run_count
+        assert_equal 0, @result.failure_count
+        assert_equal 0, @result.error_count
+      end
+    end
+  end
+
+  def test_run_same_project_twice_should_be_independence
+    assert_fork_process_exits_ok do
+      Dir.chdir("another_project") do
+        $argv_dup = ['passed_test_case.rb']
+        require 'passed_test_case'
+        suite = Test::Unit::TestSuite.new('test_run_same_project_twice_should_be_independence 1')
+        suite << PassedTestCase.suite
+
+        @result = runit(suite)
+
+        assert @result.passed?
+        assert_equal 1, @result.run_count
+        assert_equal 0, @result.failure_count
+        assert_equal 0, @result.error_count
+      end
+    end
+
+    assert_fork_process_exits_ok do
+      Dir.chdir("another_project") do
+        FileUtils.cp("./../an_error_test_case.rb", '.')
+        begin
+          $argv_dup = ['an_error_test_case.rb']
+          require 'an_error_test_case'
+          suite = Test::Unit::TestSuite.new('test_run_same_project_twice_should_be_independence 2')
+          suite << AnErrorTestCase.suite
+
+          @result = runit(suite)
+
+          assert_false @result.passed?
+          assert_equal 1, @result.run_count
+          assert_equal 0, @result.failure_count
+          assert_equal 1, @result.error_count
+        ensure
+          FileUtils.rm_f('an_error_test_case.rb')
+        end
+      end
+    end
+  end
+end

data/test/acceptance/dtr_package_task_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'fileutils'
+
+class DTRPackageTaskTest < Test::Unit::TestCase
+  def test_package
+    testdata_dir = File.expand_path(File.dirname(__FILE__) + '/../../testdata')
+    Dir.chdir(testdata_dir) do
+      %x[rake --rakefile package_task_test_rakefile dtr_package]
+      assert File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/a_test_case2.rb")
+      assert File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/lib/lib_test_case.rb")
+      assert File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/is_required_by_a_test.rb")
+
+      assert File.exists?(testdata_dir + "/dtr_pkg/codebase-dump.zip")
+
+      %x[rake --rakefile package_task_test_rakefile dtr_clobber_package]
+
+      assert !File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/a_test_case2.rb")
+      assert !File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/lib/lib_test_case.rb")
+      assert !File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/is_required_by_a_test.rb")
+
+      assert !File.exists?(testdata_dir + "/dtr_pkg/codebase-dump.zip")
+    end
+  ensure
+    FileUtils.rm_rf(testdata_dir + "/dtr_pkg") rescue nil
+  end
+
+  def test_should_not_include_dtr_pkg_dir
+    testdata_dir = File.expand_path(File.dirname(__FILE__) + '/../../testdata')
+    Dir.chdir(testdata_dir) do
+      %x[rake dtr_repackage]
+      assert !File.exists?(testdata_dir + "/dtr_pkg/codebase-dump/dtr_pkg")
+    end
+  ensure
+    FileUtils.rm_rf(testdata_dir + "/dtr_pkg") rescue nil
+  end
+end

data/test/acceptance/general_test.rb

@@ -0,0 +1,331 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+include DTR::AgentHelper
+
+class GeneralTest < Test::Unit::TestCase
+  
+  def setup
+    start_agents
+  end
+
+  def teardown
+    stop_agents
+  end
+
+  def test_run_test_passed
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb', 'a_test_case2.rb', 'a_file_system_test_case.rb']
+      suite = Test::Unit::TestSuite.new('run_test_passed')
+      suite << ATestCase.suite
+      suite << ATestCase2.suite
+      suite << AFileSystemTestCase.suite
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 3, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_test_failed
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb', 'a_failed_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_test_failed')
+      suite << ATestCase.suite
+      suite << AFailedTestCase.suite
+      @result = runit(suite)
+
+      assert !@result.passed?
+      assert_equal 2, @result.run_count
+      assert_equal 1, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_test_error
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb', 'an_error_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_test_error')
+      suite << ATestCase.suite
+      suite << AnErrorTestCase.suite
+
+      @result = runit(suite)
+
+      assert_false @result.passed?
+      assert_equal 2, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 1, @result.error_count
+    end
+  end
+
+  def test_run_suite_should_be_independence
+    assert_fork_process_exits_ok do
+      $argv_dup = ['an_error_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_suite_should_be_independence 1')
+      suite << AnErrorTestCase.suite
+
+      @result = runit(suite)
+
+      assert_false @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 1, @result.error_count
+    end
+
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_suite_should_be_independence 2')
+      suite << ATestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_should_ignore_environment_file_not_exists
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb', 'test_file_not_exists.rb']
+      suite = Test::Unit::TestSuite.new('test_run_test_file_not_exist')
+      suite << ATestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_empty_test_suite_and_no_test_files_in_environment
+    assert_fork_process_exits_ok do
+      $argv_dup = []
+      suite = Test::Unit::TestSuite.new('test_run_without_test_files')
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 0, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_empty_test_suite_should_not_crash_agent
+    assert_fork_process_exits_ok do
+      $argv_dup = []
+      suite = Test::Unit::TestSuite.new('test_run_empty_test_suite_should_not_crash_agent')
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 0, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_empty_test_suite_should_not_crash_agent')
+      suite << ATestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_empty_test_suite_and_test_files_not_exist_in_environment
+    assert_fork_process_exits_ok do
+      $argv_dup = ['test_file_not_exists.rb']
+      suite = Test::Unit::TestSuite.new('test_run_empty_test_suite_and_test_files_not_exist_in_environment')
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 0, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_run_test_specified_by_load_path
+    assert_fork_process_exits_ok do
+      lib_path = File.expand_path(File.dirname(__FILE__) + '/../../testdata/lib')
+      $LOAD_PATH.unshift lib_path
+      require 'lib_test_case'
+      $argv_dup = ['lib_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_run_test_specified_by_load_path')
+      suite << LibTestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_message_of_errors_and_failures_should_include_runner_host_name
+    assert_fork_process_exits_ok do
+      $argv_dup = ['scenario_test_case.rb']
+      suite = Test::Unit::TestSuite.new('test_should_wrapper_errors_by_dtr_remote_exception')
+      suite << ScenarioTestCase.suite
+
+      @result = runit(suite)
+
+      assert !@result.passed?
+      assert_equal 8, @result.run_count
+      assert_equal 3, @result.failure_count
+      assert_equal 4, @result.error_count
+
+      @result.errors.each do |e|
+        assert e.message.include?("from #{Socket.gethostname}")
+      end
+      @result.failures.each do |e|
+        assert e.message.include?("from #{Socket.gethostname}")
+      end
+    end
+  end
+
+  def test_setup_agent_env_from_master_process
+    assert_fork_process_exits_ok do
+      $argv_dup = ['setup_agent_env_test_case.rb']
+      suite = Test::Unit::TestSuite.new('setup_agent_env_from_master_process')
+      suite << SetupAgentEnvTestCase.suite
+      ENV['DTR_AGENT_ENV_SETUP_CMD'] = 'touch /tmp/test_setup_agent_env_from_master_process'
+
+      @result = runit(suite)
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  ensure
+    File.delete('/tmp/test_setup_agent_env_from_master_process') rescue nil
+  end
+
+  def test_multi_dtr_tasks_should_be_queued_and_processed_one_by_one
+    testdata_dir = File.expand_path(File.dirname(__FILE__) + "/../../testdata/")
+    process_assertion = Proc.new do |master_dir|
+      FileUtils.cp_r testdata_dir, master_dir
+      begin
+        Dir.chdir(master_dir) do
+          $argv_dup = ['a_test_case.rb', 'a_test_case2.rb', 'a_file_system_test_case.rb']
+          setup_test_env
+          suite = Test::Unit::TestSuite.new('run_test_passed')
+          suite << ATestCase.suite
+          suite << ATestCase2.suite
+          suite << AFileSystemTestCase.suite
+          with_agent_helper_group do
+            result = runit(suite)
+            assert result.passed?
+            assert_equal 3, result.run_count
+          end
+        end
+      ensure
+        FileUtils.rm_rf master_dir
+      end
+    end
+
+    @test_processes = []
+    4.times do |index|
+      @test_processes << Process.fork do
+        process_assertion.call("#{testdata_dir}_copy#{index}")
+      end
+    end
+
+    Process.waitpid @test_processes[0]
+    assert_equal 0, $?.exitstatus
+    Process.waitpid @test_processes[1]
+    assert_equal 0, $?.exitstatus
+    Process.waitpid @test_processes[2]
+    assert_equal 0, $?.exitstatus
+    Process.waitpid @test_processes[3]
+    assert_equal 0, $?.exitstatus
+  ensure
+    @test_processes.each do |pid|
+      DTR.kill_process pid
+    end
+  end
+
+  def test_run_test_case_hacked_run_method
+    assert_fork_process_exits_ok do
+      require 'hacked_run_method_test_case'
+
+      $argv_dup = ['hacked_run_method_test_case.rb']
+      suite = Test::Unit::TestSuite.new('run_test_case_hacked_run_method')
+      suite << HackedRunMethodTestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_should_not_break_heartbeat_of_master_process_when_run_with_a_test_case_sleep_long_time
+    assert_fork_process_exits_ok do
+      DTR.configuration.master_heartbeat_interval = 1
+      DTR.configuration.follower_listen_heartbeat_timeout = 2
+
+      require 'sleep_3_secs_test_case'
+
+      $argv_dup = ['sleep_3_secs_test_case.rb']
+      suite = Test::Unit::TestSuite.new('run_test_case_sleep_3_secs')
+      suite << Sleep3SecsTestCase.suite
+
+      @result = runit(suite)
+
+      assert @result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 0, @result.error_count
+    end
+  end
+
+  def test_should_add_meaningful_error_when_runner_get_a_unknown_test
+    assert_fork_process_exits_ok do
+      $argv_dup = ['a_failed_test_case.rb']
+      suite = Test::Unit::TestSuite.new('should_add_meaningful_error_when_runner_get_a_unknown_test')
+      suite << ATestCase.suite
+
+      @result = runit(suite)
+
+      assert !@result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 1, @result.error_count
+      assert_equal "DTR::RemoteError: DTR::Agent::UnknownTestError from #{Socket.gethostname}: No such test loaded: ATestCase", @result.errors.first.message
+    end
+  end
+
+  def test_run_test_timeout
+    assert_fork_process_exits_ok do
+      require 'sleep_3_secs_test_case'
+      $argv_dup = ['sleep_3_secs_test_case.rb']
+      suite = Test::Unit::TestSuite.new('run_test_case_sleep_3_secs')
+      suite << Sleep3SecsTestCase.suite
+
+      ENV['RUN_TEST_TIMEOUT'] = '1'
+      @result = runit(suite)
+
+      assert !@result.passed?
+      assert_equal 1, @result.run_count
+      assert_equal 0, @result.failure_count
+      assert_equal 1, @result.error_count
+      assert @result.errors.first.message.include?('Timeout')
+    end
+  end
+end