buildem 0.0.3 → 0.0.4

data/.autotest

@@ -0,0 +1,13 @@
+require 'autotest/growl'
+require 'autotest/fsevent'
+
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}  
+  at.add_exception %r{^./tmp}  
+  at.clear_mappings         
+  at.add_mapping(%r{^lib/buildem/.*\.rb$}) {|f, _|
+    item = f.split("/").last.gsub(".rb","")
+    Dir["spec/unit/#{item}_spec.rb"]
+  }
+  nil
+}

data/EXAMPLES.md

@@ -0,0 +1,34 @@
+Worker configuration, and unordered tasks
+-----------------------------------------
+
+	$configuration.workers = 2
+	
+	run "initialize.sh"
+	run "clean.sh"
+	
+	unorderd do
+	  queued_run "job1.sh"
+	  queued_run "job2.sh"
+	  queued_run "job3.sh"
+	  run "some_task_in_the_middle_of_queue.sh" # this will block all of the queued_run calls after this
+	  queued_run "job4.sh"
+	  queued_run "job5.sh"
+	  queued_run "job6.sh"
+	end
+	
+	run "do_something_at_the_end.sh"
+This example will execute job 1 - 3 in any order two at a time, hit some\_task\_in\_the\_middle\_of\_queue run that wait for it to complete and then continue executing job 4 - 6 two at a time.
+	
+---	
+	
+	
+Worker configuration, and unordered tasks with options
+------------------------------------------------------
+	
+	run "initialize.sh"
+	run "clean.sh", :retry_amount => 10  # The default exitstatus for commands is 0, when specifying retry amount of 10 if the run command does not return 0 it will retry up to 10 times.
+	run "do_something_at_the_end.sh", {:retry_amount => 10, :retry_condition => 99}  # Same as above, but is considered successful if the exitstatus is 99 due to the supplied retry_condition.
+	run "danger_danger_danger", :quit_on_error => false # If a task has explosive behavior (It causes an exception) :quit_on_error => false can be supplied as an option to continue execution 
+														# regardless of problems.
+	
+These options can be applied to both queued_run, and run jobs.

data/Gemfile

@@ -2,3 +2,10 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in buildem.gemspec
 gemspec
+
+group :test do
+	gem "rspec"
+	gem "autotest"
+	gem "autotest-growl"
+	gem "autotest-fsevent"
+end

data/README.md

@@ -0,0 +1,54 @@
+Build'em quick, Build'em right
+==============================
+
+Build'em is a small little script parser that is intended for large build systems.
+Build'em is still very young :) so be careful using it.  Input is always welcome and if there is a feature that you just half to have i'd probably do it.
+
+
+Features:
+---------
+	
+Execution:
+Scripts go in a plain text file, I use my\_very\_important\_task.buildem
+and then simply call buildem my\_very\_important\_task.buildem
+	
+* Build'em supports sequential tasks (tasks that go in order)
+	
+Example:
+	run "./task.sh"
+	run "./another.sh" #another.sh waits for task.sh to complete
+
+* Build'em supports a work queue, what does this mean?
+This means that you can run tasks concurrently, easily.
+
+Example:
+
+	unorderd do
+		queued_run "./some_task.sh"
+		queued_run "./some_task1.sh"  # All of these items will be executed at the same time
+		queued_run "./some_task2.sh"
+	end
+   
+*IMPORTANT*  All queued\_run tasks must be inside of an unorderd block if you want them to run at the same time. If you use run for a task, it will block to complete.
+That being said you can inject ordered tasks in the middle of unorderd tasks by using run instead of using qeueued_run if you wish to.
+
+* Configuration
+To set the worker amount for unorderd tasks before the unorderd block do $configuration.workers = 10 to get 10 nano-bots working for you.
+
+Example:
+
+	$configuration.workers = 5
+	unorderd do
+		....
+	end
+	
+This will give you 5 nano-bots for your unordered tasks
+
+
+optional run and queued_run options
+--------------------------
+* :retry\_amount    (Integer that specifies that you want to retry the execution of the provided command. Default is 1 execution.)
+* :retry\_condition (Integer, regular expression, or string that specifies what a good execution is. Default is 0 if not specified.)
+* :quit\_on\_error  (Boolean that specifies if build'em should quit when an exception happens executing the provided command. Default is true)
+
+

data/lib/buildem/base.rb

@@ -3,6 +3,16 @@ require 'buildem'
 require 'fileutils'
 include FileUtils
 
+module Kernel
+  def exitstatus
+    $?
+  end
+  
+  def run_command(cmd) 
+    `#{cmd}`
+  end
+end
+
 def windows?
   return java.lang.System.get_property("os.name")[/windows/i] if RUBY_PLATFORM == "java"
   return RUBY_PLATFORM[/mswin/]

data/lib/buildem/condition_matcher.rb

@@ -0,0 +1,15 @@
+class BuildEm::ConditionMatcher
+  def match(return_code, output, condition)
+    case condition
+    when Regexp
+      return false unless output =~ condition
+    when String
+      return false unless output == condition
+    when Fixnum
+      return false unless return_code == condition
+    else
+      raise "unsupported type for condition"
+    end
+    return true
+  end
+end

data/lib/buildem/executor.rb

@@ -1,11 +1,14 @@
 require "buildem/base"
+require "buildem/condition_matcher"
 
 class BuildEm::Executor
   
   attr_accessor :argz
   
-  def initialize(args)
+  def initialize(args, kernel=Kernel, matcher=BuildEm::ConditionMatcher.new)
+    @kernel = kernel
     @argz ||= args
+    @matcher = matcher
   end
   
   def name
@@ -13,17 +16,32 @@ class BuildEm::Executor
   end
   
   def run
-    # queued_run "publish.sh", :output => "publish_output.out", :errors => "publish_errors.out"
+    optz = argz[1]
+    quit_on_error = (optz[:quit_on_error].nil?  ? true : optz[:quit_on_error])
+    retry_amount  = (optz[:retry_amount].nil?    ? 1 : optz[:retry_amount])
+    condition     = (optz[:retry_condition].nil? ? 0 : optz[:retry_condition])
+    executions    = 0
     begin
-      puts `#{argz[0]} #{redirect_standard_err_and_out}`
+      puts "retrying command [#{argz[0]}]" if executions > 0
+      executions += 1
+      @comamnd_output     = @kernel.run_command("#{argz[0]}")
+      @command_exitstatus = @kernel.exitstatus
+      match = @matcher.match(@command_exitstatus, @comamnd_output, condition)
+      puts @comamnd_output if match
+      return @command_exitstatus if match
     rescue Exception => e
-      puts e
-    end
+      if quit_on_error
+        raise e
+      else
+        #put to output log or specified log
+      end
+    end while executions < retry_amount
+    @command_exitstatus
   end
   
   private
   
-  def redirect_standard_err_and_out
+  def redirect_standard_error_and_out
     ""
   end
   

data/lib/buildem/runner.rb

@@ -15,10 +15,10 @@ module Kernel
     end
     $pool.start
     $pool.shutdown
+    puts "Finished #{$jobs.size} unordered jobs"
   end
   
   def queued_run(command, optz = {})
-    optz = {:foo => "bar", :moo => "cow"}
     $jobs << BuildEm::Executor.new([command,optz])
   end
   
@@ -31,10 +31,13 @@ class BuildEm::Runner
   $jobs = []
   def self.start
     if ARGV.size == 1
-      puts "running #{ARGV[0]}"
-      $configuration = BuildEm::Configuration.new
-      load ARGV[0]
-      puts "finished #{ARGV[0]}"
+      begin
+        puts "running #{ARGV[0]}"
+        $configuration = BuildEm::Configuration.new
+        load ARGV[0]
+      ensure
+        puts "finished #{ARGV[0]}"
+      end
     else
       puts usage
     end

data/lib/buildem/version.rb

@@ -1,3 +1,3 @@
 class BuildEm
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/helper.rb

@@ -5,6 +5,8 @@ require 'rspec'
 
 $SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
 
+require "bundler/setup"
+
 def require_files filename
   filename.each do |file|
     require "#{$SPEC_ROOT}/../lib/buildem/#{file}"
@@ -24,8 +26,17 @@ RSpec.configure do |config|
     begin
       yield
     rescue Exception => e
-      e.class.should == clazz
-      return
+      case clazz
+      when String
+        e.message.should == clazz
+        return
+      when Regexp
+        e.message.should =~ clazz
+        return
+      else
+        e.class.should   == clazz
+        return
+      end
     end
     fail "Did not throw an exception like intended"
   end

data/spec/unit/condition_matcher_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__)+"/../helper.rb")
+require_files "condition_matcher"
+
+describe BuildEm::ConditionMatcher, "match" do
+  
+  before :each do
+    @matcher = BuildEm::ConditionMatcher.new
+  end
+  
+  # match(return_code, output, condition)
+  
+  it "raises an exception when an unsupported condition is supplied" do
+    unsupported_type = 1.00
+    expecting_exception("unsupported type for condition") { @matcher.match(0,"foo", unsupported_type) } 
+  end
+  
+  describe "output with string matching" do
+    it "returns true when it finds a match" do
+      @matcher.match(0,"foo", "foo").should == true
+    end 
+    it "returns true when it can not find a match" do
+      @matcher.match(0,"foo", "bar").should == false
+    end
+  end
+  
+  describe "output with regexp matching" do
+    it "returns true when it finds a match" do
+      @matcher.match(0,"very complex output", /\w+\s+complex\s+\w+/).should == true
+    end
+    it "returns true when it can not find a match" do
+      @matcher.match(0,"more [complex] output", /\w+\s+complex\s+\w+/).should == false
+    end
+  end
+
+  describe "return code matching" do
+    it "returns true when it finds a match" do
+      @matcher.match(0,"SUCCESS", 0).should == true
+    end
+    it "returns true when it can not find a match" do
+       @matcher.match(0,"FAILURE", 1).should == false
+    end
+  end
+  
+end

data/spec/unit/executor_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__)+"/../helper.rb")
+require_files "executor"
+
+describe BuildEm::Executor, "run" do
+  
+  before :each do
+    @mock_kernel = mock(Kernel)
+    @matcher = mock(BuildEm::ConditionMatcher)
+  end
+
+  describe "runs with default options" do
+    
+    it "executes the provided command and quits if no retries supplied" do
+      command  = "pinky and the brain"
+      executor = BuildEm::Executor.new([command,{}], @mock_kernel)
+      run_and_exitstatus_with(command, "FAILURE", 8675308)
+      executor.run.should == 8675308
+    end
+    
+    it "raises an exception when something bad goes on" do
+      command  = "foo bar"
+      executor = BuildEm::Executor.new([command, {}], @mock_kernel)
+      @mock_kernel.should_receive("run_command").with(command).and_raise("KA BOOM")
+      expecting_exception("KA BOOM") { executor.run }
+    end
+    
+  end
+  
+  describe "runs command with options" do
+    
+    it "executes the provided command 10 times when condition is not met" do
+      command = "some really cool command"
+      executor = BuildEm::Executor.new([command, {:retry_amount => 10}], @mock_kernel)
+      10.times do
+        run_and_exitstatus_with(command, "FAILURE", -1)
+      end
+      executor.run.should == -1
+    end
+    
+    it "executes the provided command 3 times out of 10 when condition is met after 3 tries" do
+      command = "command_to_run"
+      executor = BuildEm::Executor.new([command, {:retry_amount => 10}], @mock_kernel)
+      2.times do
+        run_and_exitstatus_with(command, "FAILURE", -1)
+      end
+      run_and_exitstatus_with(command, "WINNER", 0)
+      executor.run.should == 0
+    end
+    
+    it "does not raise an exception when something bad goes on if :quit_on_error is false" do
+      argz = ["command_to_run", {:quit_on_error => false}]
+      executor = BuildEm::Executor.new(argz, @mock_kernel)
+      @mock_kernel.should_receive("run_command").with("command_to_run").and_raise("KA BOOM")
+      executor.run.should == nil
+    end
+    
+  end
+  
+  private
+  def run_and_exitstatus_with(command, output, exitstatus)
+    @mock_kernel.should_receive("run_command").with(command).and_return(output)
+    @mock_kernel.should_receive(:exitstatus).and_return(exitstatus)
+  end
+  
+  
+end

data/spec/unit/version_spec.rb

@@ -3,6 +3,6 @@ require_files "version"
 
 describe BuildEm, "VERSION" do
   it "has the proper version number" do
-    BuildEm::VERSION.should == "0.0.3"
+    BuildEm::VERSION.should == "0.0.4"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: buildem
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeremy W. Rowe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-27 00:00:00 -04:00
+date: 2011-04-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,15 +58,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .autotest
 - .gitignore
-- EXAMPLE
+- EXAMPLES.md
 - Gemfile
-- README
+- README.md
 - Rakefile
 - bin/buildem
 - buildem.gemspec
 - lib/buildem.rb
 - lib/buildem/base.rb
+- lib/buildem/condition_matcher.rb
 - lib/buildem/configuration.rb
 - lib/buildem/executor.rb
 - lib/buildem/runner.rb
@@ -74,7 +76,9 @@ files:
 - lib/buildem/version.rb
 - spec/helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/condition_matcher_spec.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/executor_spec.rb
 - spec/unit/helper/examples/blank_file.buildem
 - spec/unit/helper/examples/everything.buildem
 - spec/unit/helper/examples/nonsequential.buildem
@@ -121,7 +125,9 @@ summary: A simple build script wrapper that allows for concurent tasks
 test_files: 
 - spec/helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/condition_matcher_spec.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/executor_spec.rb
 - spec/unit/helper/examples/blank_file.buildem
 - spec/unit/helper/examples/everything.buildem
 - spec/unit/helper/examples/nonsequential.buildem

data/EXAMPLE

@@ -1,16 +0,0 @@
-$configuration.workers = 2
-
-run "initialize.sh"
-run "clean.sh"
-
-unorderd do
-  queued_run "build.sh"
-  queued_run "checkin.sh"
-  queued_run "publish.sh"
-  run "some_task_in_the_middle_of_queue.sh" # this will block all of the queued_run calls after this
-  queued_run "build.sh"
-  queued_run "checkin.sh"
-  queued_run "publish.sh"
-end
-
-run "do_something_at_the_end.sh"

data/README

@@ -1,46 +0,0 @@
-Build'em quick, Build'em right
-
-Build'em is a small little script parser that is intended for large build systems.
-Build'em is still very young :) so be careful using it.  Input is always welcome and if there is a feature that you just half to have i'd probably do it.
-
-
-Features:
-	
-	Execution:
-		Scripts go in a plain text file, I use my_very_important_task.buildem
-		and then simply call buildem my_very_important_task.buildem
-	
-	1) Build'em supports sequential tasks (tasks that go in order)
-	
-		Example:
-			run "./task.sh"
-			run "./another.sh" #another.sh waits for task.sh to complete
-
-	2) Build'em supports a work queue, what does this mean?
-	   This means that you can run tasks concurrently, easily.
-	
-		Example:
-	
-		unorderd do
-			queued_run "./some_task.sh"
-			queued_run "./some_task1.sh"  # All of these items will be executed at the same time
-			queued_run "./some_task2.sh"
-		end 
-	   
-	
-	   *IMPORTANT*  All queued_run tasks must be inside of an unorderd block if you want them to run at the same time. If you use run for a task, it will block to complete.
-	   		That being said you can inject ordered tasks in the middle of unorderd tasks by using run instead of using qeueued_run if you wish to.
-	
-
-	3) Configuration
-	   To set the worker amount for unorderd tasks before the unorderd block do $configuration.workers = 10 to get 10 nano-bots working for you.
-	
-	 	Example:
-			$configuration.workers = 5
-			unorderd do
-				....
-			end
-		
-			This will give you 5 nano-bots for your unordered tasks
-
-