xli-dtr 0.0.4

data/CHANGES

@@ -0,0 +1,16 @@
+= DTR Changelog
+
+== release 0.0.4
+* added timeout for running test more stable
+  the default timeout is 60 sec, can be changed by environment variable 'RUN_TEST_TIMEOUT'
+* output master process log into different log file with runners
+
+
+== release 0.0.3
+* more stable and maintainable
+* added monitor command for monitoring the server status
+* provided development build grid example
+
+== release 0.0.2
+* changed to rinda service model
+

data/LICENSE.TXT

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

data/README

@@ -0,0 +1,291 @@
+= DTR -- Distributed Test Runner
+
+Supporting DTR version: 0.0.x
+
+This package contains DTR, a distributed test runner program for decreasing 
+time of running ruby tests, only supporting Test::Unit ruby testing framework 
+right now.
+
+DTR has the following features:
+
+* Run tests in mutli processes or on distributed machines.
+
+* Hot plug distributed runner agents.
+
+* Runtime injection, all tests run in same environment.
+
+DTR works in three parts: DTR Server, Runner Agent and DTR Master.
+
+* DTR Server is a Rinda Server which allows DRb services and clients to automatically find each other without knowing where they live.
+
+* Runner Agent is a DRb service hosting on distributed machines to run tests. For using 'fork' to create runner process, Runner Agent can't run on Windows directly.
+
+* DTR Master is the process finding runner service to run tests and collect test results. It works by loading 'dtr/test_unit_injection.rb' with all test files.
+
+DTR doesn't synchronize codebase, so you need to consider using synchronize tools 
+(e.g. rsync(http://samba.anu.edu.au/rsync/)) or distributed version control system
+(e.g. mercurial(http://www.selenic.com/mercurial/wiki/)) to synchronize project 
+files between machines. The distributed version control system Mercurial is cool for
+synchronizing codebase between machines, see the example "Setup a development build 
+grid".
+
+== Download
+
+The latest version of DTR can be found at
+
+* http://github.com/xli/dtr/tree/master
+
+== Installation
+
+=== Normal Installation
+
+You can install DTR with the following command.
+
+  % ruby install.rb
+
+from its distribution directory.
+
+=== GEM Installation
+
+Download and install DTR with the following.
+
+   gem install --remote dtr
+
+=== Running the DTR Test Suite
+
+If you wish to run the unit and functional tests that come with DTR:
+
+* CD into the top project directory of dtr.
+* Type the following:
+
+   rake # You need a version of rake installed
+
+== Simple Example
+
+Once installed, you can run DTR server anywhere:
+
+  % dtr -s
+  
+If you are running Runner Agent on remote machine, please specify the DTR server machine ip:
+
+  % dtr -s --server_address dtr_server_ip
+
+After server started, you can run DTR runner agent at your project directory as follows:
+
+  % dtr --server_address dtr_server_ip -r runner_name
+
+Type "dtr --help" for an up-to-date option summary.
+Invoking <tt>dtr</tt> without any options causes dtr to show help too.
+
+Most of time your project test suite need setup environment before run tests, you
+can set setup command by option '--setup', for example:
+
+  % dtr --server_address dtr_server_ip -r runner1 --setup "rake db:test:prepare"
+  
+At last, you need to add 'dtr/test_unit_injection.rb' into test_files of your test 
+task in your Rakefile, and for load it, you also need add dtr lib path:
+  
+  require 'dtr'
+
+  DTR.broadcast_list = ['dtr server ip']
+  
+  Rake::TestTask.new(:dtr_tests) do |t|
+    t.libs << DTR.lib_path
+    t.test_files = FileList['dtr/test_unit_injection.rb', 'test/*test.rb']
+    t.warning = false
+    t.verbose = false
+  end
+
+In the case above we changed dtr broadcast list for listening remote dtr server.
+And you also can use *DTR.port = 1234* to change the port listening. These two
+options would be cached in the directory running the test or any other dtr processes
+(e.g. dtr runner agent or dtr server).
+
+== Run tests in multi-processes on one machine
+
+For running Runner in multi-processes, you need install gem 'daemons'.
+The following is the test task example in the rake file:
+
+  require 'dtr/raketasks'
+
+  DTR::MPTask.new :test do |t|
+    t.test_files = FileList['test/*test.rb']
+    t.processes = 2 #default is 2
+  end
+
+== Setup a development build grid 
+
+This example is a build grid shared within developers to run unit tests 
+before commit code. We'll use Mercurial to synchronize code between Runner 
+Agent machines and developer machine.
+
+=== Background
+
+Suppose I am a developer working on a rails project pet_store checked out 
+at '~/pet_store'. I have a MacBook called M1 and another 2 Mac-minis called 
+M2 and M3. My plan is distributing tests running on M1 to M2 and M3 before 
+commit code. M3 also will be DTR Server. All machines are accessable in 
+local network and IPs are M1_IP, M2_IP and M3_IP. Mercurial and DTR are 
+installed on all machines. And for running dtr runner agent in daemons mode, 
+you need install gem daemons. The test environment will be running on Mysql. 
+All machines are installed Mysql accessed by the following database.yml 
+configuration:
+
+    development:
+      database: pet_store_development
+      adapter: mysql
+      username: root
+      password:
+      host: localhost
+    test:
+      database: pet_store_test
+      adapter: mysql
+      username: root
+      password:
+      host: localhost
+
+=== DTR Server
+
+* Start DTR Server on M3: dtr -s -a M3_IP. 
+
+=== Setup Mercurial repository on M1
+
+* Init Mercurial repository in '~/pet_store' directory: hg init
+* Edit .hgignore file to ignore files don't need while running tests. In this example, we will ignore files: db/schema.rb, .dtr_env_pstore, dtr_runners.pid and dtr_server*; and directories: public, tmp and log.
+* Commit .hgignore and then commit code into Mercurial repository.
+* Start 'hg serve' in '~/pet_store', the default port would be 8000. We'll use the default port in this example.
+* We'll clone the repository to M2 and M3 later.
+
+=== Build Script
+
+* Add an environment variable on all machines: export DEV_BUILD_SERVER=M3_IP
+* Add an environment variable on development machine M1: export DTR_MASTER_ENV=http: //M1_IP:8000/pet_store. The environment variable DTR_MASTER_ENV would be copied to all DTR Runner Agent for sharing information between DTR Master machine and DTR Runner Agents.
+* Create a rake file at '~/pet_store' directory called: dtr_tasks.rake
+    
+    DEV_BUILD_SERVER = ENV['DEV_BUILD_SERVER']
+    DEV_REPOSITORY_URL = ENV['DTR_MASTER_ENV']
+    
+    task :dtr => ['hg:check', 'dtr:uf']
+    
+    namespace :hg do
+      task :reinit do
+        Dir.glob("*").each do |f|
+          #remove all files except files start with 'dtr_' including dtr runner pid file and current file dtr_tasks.rake
+          next if f =~ /^dtr_/  
+          FileUtils.rm_rf(f)
+        end
+        FileUtils.rm_rf(".hg")
+        FileUtils.rm_rf(".hgignore")
+        puts %x[hg init]
+        puts %x[hg pull -u -y #{DEV_REPOSITORY_URL}]
+        puts %x[mkdir tmp]
+        puts %x[mkdir log]
+      end
+      task :check do
+        http = Net::HTTP.new("localhost", "8000")
+        begin
+          http.get("/")
+        rescue Exception
+          raise "Mercurial server is not running!"
+        end
+        
+        raise "Please commit changes into Mercurial repository" if %x[hg st] =~ /.+/
+      end
+    end
+    
+    namespace :dtr do
+      task :runner_agent do
+        puts %x[dtr -R;dtr -r runner -a '#{DEV_BUILD_SERVER}' -i 'rake --rakefile dtr_tasks.rake hg:reinit;rake db:migrate db:test:prepare' -D]
+      end
+
+      require 'dtr'
+
+      DTR.broadcast_list = [DEV_BUILD_SERVER]
+      
+      DTR::MPTask.new(:uf) do |t|
+        t.libs << "test"
+        t.test_files = FileList['test/unit/**/*test.rb', 'test/functional/**/*test.rb']
+        t.processes = ENV['P'] || 1
+        t.runner_options = "-a '#{DEV_BUILD_SERVER}' -i 'rake db:migrate db:test:prepare'"
+        t.start_server = false
+        t.verbose = false
+      end
+    end
+
+* The script above can re-init Mercurial repository. Runner Agent will run the 'hg:reinit' task before start Runner(see the 'runner_agent' task in the script above), so that Runner Agent can support any developer's codebase to run tests.
+* Commit dtr_tasks.rake into Mercurial repository.
+
+=== Runner Agent
+
+* Clone repository from M1 to M2 in home directory: hg clone http: //M1_IP:8000/pet_store
+* Start runner agent in the directory ~/pet_store on M2: rake --rakefile dtr_tasks.rake dtr:runner_agent
+* Start runner agent on M3 same with above.
+
+=== Run DTR Master on M1
+
+* Commit all changes into Mercurial
+* rake --rakefile dtr_tasks.rake dtr
+* After you started the DTR Master, you can type the following to monitor the DTR Server status: dtr -a $DEV_BUILD_SERVER -m
+* For output into console, open the debug option: dtr -a $DEV_BUILD_SERVER -d -m
+
+== Credits
+
+[<b>Josh Price</b>] For fixing tests packer in release 0.0.1.
+
+[<b>Wang Pengchao</b>] For sharing lots of ideas.
+
+[<b>Barrow H Kwan</b>] For patch of specifying DTR server port.
+
+[<b>Mingle team</b>(http://studios.thoughtworks.com/mingle-project-intelligence)] For making all these happen.
+
+== License
+
+DTR is available under an Apache License Version 2.
+
+== Support
+
+Feel free to submit commits or feature requests.  If you send a patch,
+remember to update the corresponding unit tests.  If fact, I prefer
+new feature to be submitted in the form of new unit tests.
+
+For other information, feel free to contact mailto:iam@li-xiao.com.
+
+== Usage
+
+DTR client is invoked from the command line using:
+
+   % dtr [<em>options</em> ...]
+
+=== Options are:
+
+  -p, --port PORT                  Port number DTR will listen to. Default is 3344.
+  -r runner1_name,runner2_name     Start DTR test runner agent with unique runner names.
+  -a, --server_address ADDRESS     Specify dtr server address, domain name or ip address, e.g. 192.168.0.1. Default is 'localhost'.
+  -i, --setup COMMAND              Set command for initializing test runner test environment, e.g. 'rake db:test:prepare'. Default is do nothing.
+  -m, --monitor                    Monitor the status of the dtr rinda server, e.g. dtr -a 10.11.1.2 -m
+  -c, --clean_server               Clean server environment, shutdown all runners registered.
+  -b, --be_silent                  Only show error messages
+  -s, --server                     Start DTR service server. There must be a DTR server running.
+  -D, --daemon                     Start server/runners in daemon mode. Gem 'daemons' must be installed
+  -S, --stop_server                Stop server run in daemon mode.
+  -R, --stop_runners               Stop runners run in daemon mode.
+  -d, --debug                      output debug log
+  -v, --version                    Show version
+  -h, --help                       Show this help doc
+
+Type "dtr --help" for an up-to-date option summary.
+
+= Other stuff
+
+Author::  Li Xiao <iam@li-xiao.com>
+Requires:: Ruby 1.8.5 or later
+License::  Copyright 2007-2008 by Li Xiao.
+           Released under an Apache License 2.  See the LICENSE file
+           included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.