jenkins-plugin-runtime 0.1.21 → 0.1.22

data/lib/jenkins/listeners/run_listener.rb

@@ -0,0 +1,55 @@
+module Jenkins::Listeners
+  # Receive notification of build events.
+  #
+  # Include this module in your class in order to receive callbacks
+  # when builds are started, completed, deleted, etc...
+  #
+  # To receive a callback, override the method with the same name as
+  # the event. E.g.
+  #
+  #     class MyRunListener
+  #       include Jenkins::Listeners::RunListener
+  #
+  #       def started(build, listener)
+  #         puts "build.inspect started!"
+  #       end
+  #     end
+  #
+  module RunListener
+    extend Jenkins::Plugin::Behavior
+
+    implemented do |cls|
+      Jenkins.plugin.register_extension RunListenerProxy.new(Jenkins.plugin, cls.new)
+    end
+
+    # Called when a build is started (i.e. it was in the queue, and will now start running
+    # on an executor)
+    #
+    # @param [Jenkins::Model::Build] the started build
+    # @param [Jenkins::Model::TaskListener] the task listener for this build
+    def started(build, listener)
+    end
+
+    # Called after a build is completed.
+    #
+    # @param [Jenkins::Model::Build] the completed build
+    # @param [Jenkins::Model::TaskListener] the task listener for this build
+    def completed(build, listener)
+    end
+
+    # Called after a build is finalized.
+    #
+    # At this point, all the records related to a build is written down to the disk. As such,
+    # task Listener is no longer available. This happens later than {#completed}.
+    #
+    # @param [Jenkins::Model::Build] the finalized build
+    def finalized(build)
+    end
+
+    # Called right before a build is going to be deleted.
+    #
+    # @param [Jenkins::Model::Build] The build.
+    def deleted(build)
+    end
+  end
+end

data/lib/jenkins/listeners/run_listener_proxy.rb

@@ -0,0 +1,25 @@
+module Jenkins::Listeners
+  class RunListenerProxy < Java.hudson.model.listeners.RunListener
+    include Jenkins::Plugin::Proxy
+
+    def initialize(plugin, object)
+      super(plugin, object, Java.hudson.model.AbstractBuild.java_class)
+    end
+
+    def onStarted(run, listener)
+      @object.started(run, listener)
+    end
+
+    def onCompleted(run, listener)
+      @object.completed(run, listener)
+    end
+
+    def onFinalized(run)
+      @object.finalized(run)
+    end
+
+    def onDeleted(run)
+      @object.deleted(run)
+    end
+  end
+end

data/lib/jenkins/plugin/runtime.rb

@@ -17,3 +17,5 @@ require 'jenkins/slaves/cloud'
 require 'jenkins/tasks/builder'
 require 'jenkins/tasks/build_wrapper'
 require 'jenkins/launcher'
+require 'jenkins/listeners/run_listener'
+require 'jenkins/listeners/run_listener_proxy'

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

@@ -1,7 +1,7 @@
 module Jenkins
   class Plugin
     module Runtime
-      VERSION = "0.1.21"
+      VERSION = "0.1.22"
     end
   end
 end

data/spec/jenkins/listeners/run_listener_proxy_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'rspec-spies'
+
+describe Jenkins::Listeners::RunListenerProxy do
+  before do
+    @listener = mock(Jenkins::Listeners::RunListener)
+    @proxy = Jenkins::Listeners::RunListenerProxy.new(mock(Jenkins::Plugin, :name => 'test-plugin'), @listener)
+    @build = mock(Jenkins::Model::Build)
+    @console = mock(Jenkins::Model::Listener)
+  end
+
+  describe "when started" do
+    before do
+      @listener.stub(:started)
+      @proxy.onStarted(@build, @console)
+    end
+    it 'invokes the started callback' do
+      @listener.should have_received(:started).with(@build, @console)
+    end
+  end
+
+  describe 'when completed' do
+    before do
+      @listener.stub(:completed)
+      @proxy.onCompleted(@build, @console)
+    end
+    it 'invokes the completed callback' do
+      @listener.should have_received(:completed).with(@build, @console)
+    end
+  end
+
+  describe 'when finalized' do
+    before do
+      @listener.stub(:finalized)
+      @proxy.onFinalized(@build)
+    end
+    it 'invokes the finalized callback' do
+      @listener.should have_received(:finalized).with(@build)
+    end
+  end
+
+  describe 'when deleted' do
+    before do
+      @listener.stub(:deleted)
+      @proxy.onDeleted(@build)
+    end
+    it 'invokes the deleted callback' do
+      @listener.should have_received(:deleted).with(@build)
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: jenkins-plugin-runtime
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors: 
   - Charles Lowell
@@ -99,6 +99,8 @@ files:
   - lib/jenkins/cli/command_proxy.rb
   - lib/jenkins/filepath.rb
   - lib/jenkins/launcher.rb
+  - lib/jenkins/listeners/run_listener.rb
+  - lib/jenkins/listeners/run_listener_proxy.rb
   - lib/jenkins/model.rb
   - lib/jenkins/model/action.rb
   - lib/jenkins/model/build.rb
@@ -131,6 +133,7 @@ files:
   - spec/jenkins/cli/command_spec.rb
   - spec/jenkins/filepath_spec.rb
   - spec/jenkins/launcher_spec.rb
+  - spec/jenkins/listeners/run_listener_proxy_spec.rb
   - spec/jenkins/model/action_spec.rb
   - spec/jenkins/model/build_spec.rb
   - spec/jenkins/model/describable_spec.rb
@@ -184,6 +187,7 @@ test_files:
   - spec/jenkins/cli/command_spec.rb
   - spec/jenkins/filepath_spec.rb
   - spec/jenkins/launcher_spec.rb
+  - spec/jenkins/listeners/run_listener_proxy_spec.rb
   - spec/jenkins/model/action_spec.rb
   - spec/jenkins/model/build_spec.rb
   - spec/jenkins/model/describable_spec.rb