maestro_plugin 0.0.7 → 0.0.11

data/.gitignore

@@ -1,4 +1,5 @@
 *.rbc
+.idea
 .bundle
 .config
 coverage
@@ -10,3 +11,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.6.8

data/lib/maestro_plugin/maestro_worker.rb

@@ -1,7 +1,21 @@
 require 'json'
 
-module Maestro
+module MaestroDev
+  module Plugin
+    # General plugin problem.  A plugin can raise errors of this type and have the 'message' portion of the error
+    # automatically logged, and have the plugin-response set to the same (message) and have the execution end
+    class PluginError < StandardError
+    end
 
+    # Configuration error detected - usually as a result of the validation method determining bad/invalid data.
+    # This is treated same as PluginError for now... but maybe one day it'll get wings and fly, so only raise
+    # this error if the plugin cannot execute the task owing to poor parameters.
+    class ConfigError < PluginError
+    end
+  end
+end
+
+module Maestro
 
   # Helper Class for Maestro Plugins written in Ruby. The lifecycle of the plugin
   # starts with a call to the main entry point perform called by the Maestro agent, all the
@@ -9,7 +23,6 @@ module Maestro
   # run_callbacks which can be customized by specifying an on_complete_handler_method, or on_complete_handler_block.
   #
   class MaestroWorker
-
     # Workitem constants
     CONTEXT_OUTPUTS_META = '__context_outputs__'
     OUTPUT_META = '__output__'
@@ -87,17 +100,29 @@ module Maestro
     def perform(action, workitem)
       @action, @workitem = action, workitem
       send(action)
+      write_output('') # Triggers any remaining buffered output to be sent
       run_callbacks
-    rescue => e
+    rescue MaestroDev::Plugin::PluginError => e
+      # Ensure error is written to output file
+      write_output(e.message)
+      set_error(e.message)
+    rescue Exception => e
+      msg = "Unexpected error executing task: #{e.class} #{e}"
+      write_output(msg)
+      Maestro.log.warn("#{msg} " + e.backtrace.join("\n"))
+
+      # Let user-supplied exception handler do its thing
       handle_exception(e)
+      set_error(msg)
+    ensure
+      return @workitem
     end
 
+    # Fire supplied exception handlers if supplied, otherwise do nothing
     def handle_exception(e)
-      raise e if self.class.exception_handler_method.nil? && self.class.exception_handler_block.nil?
-
       if self.class.exception_handler_method
         send(self.class.exception_handler_method, e)
-      else
+      elsif self.class.exception_handler_block
         self.class.exception_handler_block.call(e, self)
       end
     end

data/lib/maestro_plugin/version.rb

@@ -1,5 +1,5 @@
 module Maestro
   module Plugin
-    VERSION = '0.0.7'
+    VERSION = '0.0.11'
   end
 end

data/spec/maestro_worker_spec.rb

@@ -165,4 +165,48 @@ describe Maestro::MaestroWorker do
     end
 
   end
+
+  describe 'Errors' do
+    class ErrorTestWorker < Maestro::MaestroWorker
+      def configerror_test
+        raise MaestroDev::Plugin::ConfigError, 'Bad Config - what are you feeding me?'
+      end
+
+      def pluginerror_test
+        raise MaestroDev::Plugin::PluginError, 'PluginError - I had a problem'
+      end
+
+      def error_test
+        raise Exception, 'noooo'
+      end
+    end
+
+    before :each do
+      @worker = ErrorTestWorker.new
+    end
+
+    it 'should handle a ConfigError for bad config' do
+      workitem = {'fields' => {}}
+
+      @worker.perform(:configerror_test, workitem)
+      workitem['fields']['__error__'].should include('Bad Config')
+      workitem['__output__'].should include('Bad Config')
+    end
+
+    it 'should handle a PluginError' do
+      workitem = {'fields' => {}}
+
+      @worker.perform(:pluginerror_test, workitem)
+      workitem['fields']['__error__'].should include('PluginError - I had a problem')
+      workitem['__output__'].should include('PluginError - I had a problem')
+    end
+
+    it 'should handle an unexpected Error' do
+      workitem = {'fields' => {}}
+
+      @worker.perform(:error_test, workitem)
+      workitem['fields']['__error__'].should include('Unexpected error executing task: Exception noooo')
+      workitem['__output__'].should include('Unexpected error executing task: Exception noooo')
+    end
+  end
 end

metadata

@@ -1,158 +1,144 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: maestro_plugin
-version: !ruby/object:Gem::Version
-  version: 0.0.7
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.11
 platform: ruby
-authors:
-- Etienne Pelletier
-autorequire:
+authors: 
+  - Etienne Pelletier
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: logging
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: json
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.6
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.6
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: jruby-openssl
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-  prerelease: false
-  type: :development
+
+date: 2013-07-26 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: logging
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 1.8.0
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rubyzip
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 0.9.8
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: json
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.4.6
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "1.3"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id005
+  - !ruby/object:Gem::Dependency 
+    name: jruby-openssl
+    prerelease: false
+    requirement: &id006 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id006
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id007 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 2.13.0
+    type: :development
+    version_requirements: *id007
 description: A ruby library to help with the creation of Maestro plugins
-email:
-- epelletier@maestrodev.com
+email: 
+  - epelletier@maestrodev.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- .gitignore
-- .rvmrc
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
-- lib/maestro_plugin.rb
-- lib/maestro_plugin/logging.rb
-- lib/maestro_plugin/maestro_worker.rb
-- lib/maestro_plugin/version.rb
-- maestro_plugin.gemspec
-- spec/maestro_worker_spec.rb
-- spec/spec_helper.rb
+
+files: 
+  - .gitignore
+  - .ruby-version
+  - Gemfile
+  - LICENSE.txt
+  - README.md
+  - Rakefile
+  - lib/maestro_plugin.rb
+  - lib/maestro_plugin/logging.rb
+  - lib/maestro_plugin/maestro_worker.rb
+  - lib/maestro_plugin/version.rb
+  - maestro_plugin.gemspec
+  - spec/maestro_worker_spec.rb
+  - spec/spec_helper.rb
 homepage: https://github.com/maestrodev/maestro-ruby-plugin
-licenses:
-- Apache 2.0
-metadata: {}
-post_install_message:
+licenses: 
+  - Apache 2.0
+post_install_message: 
 rdoc_options: []
-require_paths:
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
-rubyforge_project:
-rubygems_version: 2.0.3
-signing_key:
-specification_version: 4
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
 summary: Maestro ruby plugin
-test_files:
-- spec/maestro_worker_spec.rb
-- spec/spec_helper.rb
+test_files: 
+  - spec/maestro_worker_spec.rb
+  - spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 0c64c1f3c1a915362afd09ce40a43df33640cd5b
-  data.tar.gz: 302738027d98269a9f9f63eefe215e8d535d663f
-SHA512:
-  metadata.gz: 1536a2ff8c81e70b12865d6deca13095d9b3af6eca2e2c9828ad72b5db7c9c537b2adc6fa8fde4111490fd7fc06275c8a64d1c371fd709ce33fb77bcb0bf9f21
-  data.tar.gz: 0c7685ec929c3e0fd798dc867f6bdb65a632881b49b4daf4e72dee45f4ad5e8f2e2b96105c7c703e91d5b148413106205852df90f4cab9cc72bd720e70e968c2

data/.rvmrc

@@ -1 +0,0 @@
-rvm use jruby-1.6.8

data/Gemfile.lock

@@ -1,43 +0,0 @@
-PATH
-  remote: .
-  specs:
-    maestro_plugin (0.0.6)
-      json (>= 1.4.6)
-      logging (= 1.8.0)
-      rubyzip (= 0.9.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    bouncy-castle-java (1.5.0147)
-    diff-lcs (1.2.1)
-    jruby-openssl (0.8.7)
-      bouncy-castle-java (>= 1.5.0147)
-    json (1.8.0)
-    json (1.8.0-java)
-    little-plugger (1.1.3)
-    logging (1.8.0)
-      little-plugger (>= 1.1.3)
-      multi_json (>= 1.3.6)
-    multi_json (1.7.3)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.0)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    rubyzip (0.9.8)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  jruby-openssl
-  maestro_plugin!
-  rake
-  rspec (~> 2.13.0)