jenkins-plugin-runtime 0.1.8 → 0.1.9

data/lib/jenkins/model/build.rb

@@ -2,11 +2,17 @@ require 'jenkins/filepath'
 
 module Jenkins
   module Model
+
     ##
     # Represents a single build. In general, you won't need this
     #
     class Build
 
+      # Raised to indicate that a build wrapper halted a build.
+      # Raising this does *not* set the build result to error.
+      class Halt < Exception; end
+
+
       # the Hudson::Model::AbstractBuild represented by this build
       attr_reader :native
 
@@ -18,6 +24,20 @@ module Jenkins
         FilePath.new(@native.getWorkspace())
       end
 
+      # Halt the current build, without setting the result to failure
+      #
+      # @param [String] reason the reason for your halt, optional.
+      def halt(reason = nil)
+        raise Halt, reason
+      end
+
+      # Abort the current build, causing a build failure.
+      #
+      # @param [String] reason the reason for your abort, optional.
+      def abort(reason = nil)
+        raise Java.hudson.AbortException.new(reason)
+      end
+
       def build_var
         @native.getBuildVariables()
       end

data/lib/jenkins/model/listener.rb

@@ -7,7 +7,7 @@ module Jenkins
     class Listener
 
       # the underlying hudson.model.TaskListener object
-      attr_reader :natvie
+      attr_reader :native
       attr_accessor :level
 
       def initialize(native = nil)

data/lib/jenkins/plugin/proxies/build_wrapper.rb

@@ -1,5 +1,6 @@
 
 require 'jenkins/tasks/build_wrapper'
+require 'jenkins/model/build'
 
 module Jenkins
   class Plugin
@@ -17,6 +18,8 @@ module Jenkins
           env = {}
           @object.setup(import(build), import(launcher), import(listener), env)
           EnvironmentWrapper.new(self, @plugin, @object, env)
+        rescue Jenkins::Model::Build::Halt
+            nil
         end
 
         def getDescriptor

data/lib/jenkins/plugin/runtime/version.rb

@@ -1,7 +1,7 @@
 module Jenkins
   class Plugin
     module Runtime
-      VERSION = "0.1.8"
+      VERSION = "0.1.9"
     end
   end
 end

data/lib/jenkins/tasks/build_wrapper.rb

@@ -3,7 +3,6 @@ require 'jenkins/model'
 
 module Jenkins
   module Tasks
-
     # Decorate a build with pre and post hooks.
     # {http://javadoc.jenkins-ci.org/hudson/tasks/BuildWrapper.html}
     class BuildWrapper
@@ -36,4 +35,4 @@ module Jenkins
       end
     end
   end
-end
+end

data/spec/jenkins/model/build_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 
 describe Jenkins::Model::Build do
+  include Jenkins::Model
 
   before :each do
     @native = mock("AbstractBuild")
-    @subject = Jenkins::Model::Build.new(@native)
+    @build = Jenkins::Model::Build.new(@native)
   end
 
   it "can be instantiated" do
@@ -15,16 +16,24 @@ describe Jenkins::Model::Build do
     fs = Jenkins::FilePath.new(nil)
     fs.should_receive(:getRemote).and_return(".")
     @native.should_receive(:getWorkspace).and_return(fs)
-    @subject.workspace.to_s.should == "."
+    @build.workspace.to_s.should == "."
   end
 
   it "returns build variables as Hash-like" do
     @native.should_receive(:getBuildVariables).and_return("FOO" => "BAR")
-    @subject.build_var.should == {"FOO" => "BAR"}
+    @build.build_var.should == {"FOO" => "BAR"}
   end
 
   it "returns environment variables as Hash-like" do
     @native.should_receive(:getEnvironment).with(nil).and_return("FOO" => "BAR")
-    @subject.env.should == {"FOO" => "BAR"}
+    @build.env.should == {"FOO" => "BAR"}
+  end
+
+  it "can halt" do
+    expect {@build.halt "stopping"}.should raise_error(Jenkins::Model::Build::Halt, "stopping")
+  end
+
+  it "can abort" do
+    expect {@build.abort "aborting"}.should raise_error(Java.hudson.AbortException, "aborting")
   end
 end

data/spec/jenkins/plugin/proxies/build_wrapper_spec.rb

@@ -22,4 +22,14 @@ describe Jenkins::Plugin::Proxies::BuildWrapper do
     @object.should_receive(:teardown).with(@build, @listener, env)
     environment.tearDown(@jBuild, @jListener)
   end
+
+  describe "halting behavior" do
+    before do
+      @object.stub(:setup).and_raise(Jenkins::Model::Build::Halt)
+    end
+
+    it "returns false if the build was halted explicitly" do
+      @wrapper.setUp(@jBuild, @jLauncher, @jListener).should be_nil
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: jenkins-plugin-runtime
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors: 
   - Charles Lowell
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-01 00:00:00 -05:00
+date: 2011-10-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency