libis-workflow 2.0.beta.8 → 2.0.beta.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5de50bdbec1831269e20c93de425558b98664b3
-  data.tar.gz: de4304d9f1ba4728cb77fdf7803a21e3108ec2bb
+  metadata.gz: 33d4917463c7c17ee5cd775275ccfe09c00a9360
+  data.tar.gz: f22d17de924236c69fefad0958257209d6cd94e2
 SHA512:
-  metadata.gz: fb92583480199f480507dbabd8978507b331e666916771dc957807785cfe8ac5b2250fad4c5798497ca056dcbd3733bcbccc471df740eea318559c4994cbdcef
-  data.tar.gz: 7306f086712430b41121fda993b110c1dd39d6aa94a63b0e0629d7b8fc12733f2b9f516c9c8b6b3fbc8879e145da186bdf2a7574c8e09f8ea0cd9f694357fceb
+  metadata.gz: 85837ac165f1e2d720ff6ca7d4386576b653eb592ff2bf721708253ce9549bc97df7a0d90003427c1e670a9bf66992f8151279bdc86c002f1021e65bc6135842
+  data.tar.gz: 59415cf0503c7821d3ee363760ba686114d1258bb142b5aa1cda68d03dcb8dab1a7076374fb9d1bc1bf75c99844424fe7f87543e03f0a4d2ebba4c2db34c260b

data/lib/libis/workflow/base/run.rb

@@ -48,7 +48,7 @@ module Libis
           self.status = :STARTED
 
           self.tasks.each do |task|
-            next if self.failed? and not task.options[:always_run]
+            next if self.failed? and not task.parameter(:always_run)
             task.run self
           end
 

data/lib/libis/workflow/task.rb

@@ -15,8 +15,9 @@ module Libis
       include ::Libis::Workflow::Base::Logger
       include ::Libis::Tools::ParameterContainer
 
-      attr_accessor :parent, :name, :options, :workitem, :tasks
+      attr_accessor :parent, :name, :workitem, :tasks
 
+      parameter quiet: false, description: 'Prevemt generating log output.'
       parameter abort_on_error: false, description: 'Stop all tasks when an error occurs.'
       parameter always_run: false, description: 'Run this task, even if the item failed a previous task.'
       parameter subitems: false, description: 'Do not process the given item, but only the subitems.'
@@ -40,9 +41,9 @@ module Libis
 
         check_item_type WorkItem, item
 
-        return if item.failed? unless options[:always_run]
+        return if item.failed? unless parameter(:always_run)
 
-        if options[:subitems]
+        if parameter(:subitems)
             log_started item
             run_subitems item
             log_done(item) unless item.failed?
@@ -64,7 +65,7 @@ module Libis
 
           pre_process item
           process_item item
-          post_process item
+          post_process workitem
 
         rescue WorkflowError => e
           error e.message
@@ -93,10 +94,11 @@ module Libis
       def apply_options(opts)
         o = opts[self.name] || opts[self.names.join('/')]
 
+
         default_values.each do |name,_|
           next unless o.key?(name)
           parameter = get_parameter_definition name
-          self.options[name] = parameter.parse(o[name])
+          self.parameter(name, parameter.parse(o[name]))
         end if o and o.is_a? Hash
 
         self.tasks.each do |task|
@@ -123,8 +125,8 @@ module Libis
 
       def process_item(item)
         process item
-        run_subitems(item) if options[:recursive]
-        run_subtasks item
+        run_subitems(workitem) if parameter(:recursive)
+        run_subtasks workitem
       end
 
       def process(item)
@@ -168,7 +170,7 @@ module Libis
           run_item item
           if item.failed?
             failed += 1
-            if options[:abort_on_error]
+            if parameter(:abort_on_error)
               error 'Aborting ...', parent_item
               raise WorkflowAbort.new "Aborting: task #{name} failed on #{item}"
             end
@@ -193,7 +195,7 @@ module Libis
           debug 'Running subtask (%d/%d): %s', item, i+1, tasks.count, task.name
           task.run item
           if item.failed?
-            if task.options[:abort_on_error]
+            if task.parameter(:abort_on_error)
               error 'Aborting ...'
               raise WorkflowAbort.new "Aborting: task #{task.name} failed on #{item}"
             end
@@ -204,12 +206,11 @@ module Libis
 
       def configure(cfg)
         self.name = cfg[:name] || (cfg[:class] || self.class).to_s.split('::').last
-        self.options =
-            default_values.merge(
-                cfg[:options] || {}
-            ).merge(
-                cfg.reject { |k, _| [:options].include? k.to_sym }
-            ).symbolize_keys!
+        default_values.merge(
+            cfg[:options] || {}
+        ).merge(
+            cfg.reject { |k, _| [:options].include? k.to_sym }
+        ).symbolize_keys!.each { |k,v| parameter(k, v) }
       end
 
       def to_status(text)
@@ -232,13 +233,13 @@ module Libis
 
       def subtasks(item = nil)
         self.tasks.map do |task|
-          ((item || self.workitem).failed? and not task.options[:always_run]) ? nil : task
+          ((item || self.workitem).failed? and not task.parameter(:always_run)) ? nil : task
         end.compact
       end
 
       def subitems(item = nil)
         items = (item || workitem).items
-        return items if self.options[:always_run]
+        return items if self.parameter(:always_run)
         items.reject { |i| i.failed? }
       end
 

data/lib/libis/workflow/tasks/analyzer.rb

@@ -8,14 +8,14 @@ module Libis
 
       class Analyzer < Task
 
-        def default_options
-          { quiet: true, always_run: true }
-        end
+        parameter quiet: true
+        parameter always_run: true
 
         def run(item)
 
           item.properties[:ingest_failed] = item.failed?
 
+          item.summary = {}
           item.log_history.each do |log|
             level = log[:severity]
             item.summary[level] ||= 0
@@ -30,6 +30,13 @@ module Libis
             end
           end
 
+        rescue Exception => ex
+
+          puts 'Failed to analyze item: %s - %s' % [item.class, item.name]
+          puts 'Exception: %s' % ex.message
+
+        ensure
+
           item.save
 
         end

data/lib/libis/workflow/version.rb

@@ -2,6 +2,6 @@
 
 module Libis
   module Workflow
-    VERSION = '2.0.beta.8' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
+    VERSION = '2.0.beta.9' unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
   end
-end
+end

data/spec/task_spec.rb

@@ -10,7 +10,7 @@ describe 'Task' do
 
     expect(task.parent).to eq nil
     expect(task.name).to eq 'Task'
-    expect(task.options[:abort_on_error]).to eq false
+    expect(task.parameter(:abort_on_error)).to eq false
 
   end
 

data/spec/tasks/checksum_tester.rb

@@ -13,7 +13,7 @@ class ChecksumTester < ::Libis::Workflow::Task
   def process(item)
     return unless item.is_a? TestFileItem
 
-    checksum_type = options[:checksum_type]
+    checksum_type = parameter(:checksum_type)
 
     if checksum_type.nil?
       ::Libis::Tools::Checksum::CHECKSUM_TYPES.each do |x|

data/spec/tasks/collect_files.rb

@@ -14,7 +14,7 @@ class CollectFiles < ::Libis::Workflow::Task
 
   def process(item)
     if item.is_a? TestRun
-      add_item(item, options[:location])
+      add_item(item, parameter(:location))
     elsif item.is_a? TestDirItem
       collect_files(item, item.fullpath)
     end
@@ -22,11 +22,11 @@ class CollectFiles < ::Libis::Workflow::Task
 
   def collect_files(item, dir)
     glob_string = dir
-    glob_string = File.join(glob_string, '**') if options[:subdirs]
+    glob_string = File.join(glob_string, '**') if parameter(:subdirs)
     glob_string = File.join(glob_string, '*')
 
     Dir.glob(glob_string).select do |x|
-      options[:selection] && !options[:selection].empty? ? x =~ Regexp.new(options[:selection]) : true
+      parameter(:selection) && !parameter(:selection).empty? ? x =~ Regexp.new(parameter(:selection)) : true
     end.sort.each do |file|
       next if %w'. ..'.include? file
       add_item(item, file)

data/spec/workflow_spec.rb

@@ -4,24 +4,22 @@ require 'stringio'
 
 describe 'TestWorkflow' do
 
-  DIRNAME = File.absolute_path(File.join(File.dirname(__FILE__), 'items'))
+  let(:dirname) { File.absolute_path(File.join(File.dirname(__FILE__), 'items')) }
 
-  before :all do
-
-    puts DIRNAME
-
-    @logoutput = StringIO.new
+  let(:logoutput) { StringIO.new }
 
+  let(:workflow) {
+    # noinspection RubyResolve
     ::Libis::Workflow.configure do |cfg|
       cfg.itemdir = File.join(File.dirname(__FILE__), 'items')
       cfg.taskdir = File.join(File.dirname(__FILE__), 'tasks')
       cfg.workdir = File.join(File.dirname(__FILE__), 'work')
-      cfg.logger = Logger.new @logoutput
+      cfg.logger = Logger.new logoutput
       cfg.logger.level = Logger::DEBUG
     end
 
-    @workflow = ::Libis::Workflow::Workflow.new
-    @workflow.configure(
+    workflow = ::Libis::Workflow::Workflow.new
+    workflow.configure(
         name: 'TestWorkflow',
         description: 'Workflow for testing',
         tasks: [
@@ -42,33 +40,30 @@ describe 'TestWorkflow' do
             checksum_type: {default: 'SHA1', propagate_to: 'ChecksumTester'}
         }
     )
+    workflow
+  }
 
-    # noinspection RubyStringKeysInHashInspection
-    @run = @workflow.run(dirname: DIRNAME, checksum_type: 'SHA256')
-    puts @logoutput.string
-
-  end
+  let!(:run) {
+    workflow.run(dirname: dirname, checksum_type: 'SHA256')
+  }
 
   it 'should contain three tasks' do
-
-    expect(@workflow.config[:tasks].size).to eq 3
-    expect(@workflow.config[:tasks].first[:class]).to eq 'CollectFiles'
-    expect(@workflow.config[:tasks].last[:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
-
+    expect(workflow.config[:tasks].size).to eq 3
+    expect(workflow.config[:tasks].first[:class]).to eq 'CollectFiles'
+    expect(workflow.config[:tasks].last[:class]).to eq '::Libis::Workflow::Tasks::Analyzer'
   end
 
   # noinspection RubyResolve
   it 'should camelize the workitem name' do
+    expect(run.options[:dirname]).to eq dirname
+    expect(run.items.count).to eq 1
+    expect(run.items.first.class).to eq TestDirItem
+    expect(run.items.first.count).to eq 3
+    expect(run.items.first.first.class).to eq TestFileItem
 
-    expect(@run.options[:dirname]).to eq DIRNAME
-    expect(@run.items.count).to eq 1
-    expect(@run.items.first.class).to eq TestDirItem
-    expect(@run.items.first.count).to eq 3
-    expect(@run.items.first.first.class).to eq TestFileItem
-
-    expect(@run.items.first.name).to eq 'Items'
+    expect(run.items.first.name).to eq 'Items'
 
-    @run.items.first.each_with_index do |x, i|
+    run.items.first.each_with_index do |x, i|
       expect(x.name).to eq %w'TestDirItem.rb TestFileItem.rb TestRun.rb'[i]
     end
   end
@@ -126,19 +121,18 @@ DEBUG -- ProcessFiles - TestRun : 1 of 1 subitems passed
 DEBUG -- ProcessFiles - TestRun : Completed
 STR
     sample_out = sample_out.lines.to_a
-    output = @logoutput.string.lines.to_a
+    output = logoutput.string.lines.to_a
 
-    puts output.join '\n'
     expect(sample_out.count).to eq output.count
     output.each_with_index do |o, i|
       expect(o[/(?<=\] ).*/]).to eq sample_out[i].strip
     end
 
-    expect(@run.summary['DEBUG']).to eq 48
-    expect(@run.log_history.count).to eq 8
-    expect(@run.status_log.count).to eq 6
-    expect(@run.items.first.log_history.count).to eq 22
-    expect(@run.items.first.status_log.count).to eq 8
+    expect(run.summary['DEBUG']).to eq 48
+    expect(run.log_history.count).to eq 8
+    expect(run.status_log.count).to eq 6
+    expect(run.items.first.log_history.count).to eq 22
+    expect(run.items.first.status_log.count).to eq 8
 
     [
         {tasklist: nil, text: :STARTED},
@@ -148,7 +142,7 @@ STR
         {tasklist: %w'ProcessFiles', text: :Done},
         {tasklist: nil, :text => :DONE},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.status_log[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.status_log[i][key]).to eq h[key] }
     end
 
     [
@@ -161,7 +155,7 @@ STR
         {tasklist: %w'ProcessFiles CamelizeName', text: :Done},
         {tasklist: %w'ProcessFiles', text: :Done},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.items.first.status_log[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.items.first.status_log[i][key]).to eq h[key] }
     end
 
     [
@@ -172,7 +166,7 @@ STR
         {tasklist: %w'ProcessFiles CamelizeName', text: :Started},
         {tasklist: %w'ProcessFiles CamelizeName', text: :Done},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.items.first.first.status_log[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.items.first.first.status_log[i][key]).to eq h[key] }
     end
 
     [
@@ -185,7 +179,7 @@ STR
         {severity: 'DEBUG', task: 'ProcessFiles', id: 0, message: '1 of 1 subitems passed'},
         {severity: 'DEBUG', task: 'ProcessFiles', id: 0, message: 'Completed'},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.log_history[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.log_history[i][key]).to eq h[key] }
     end
 
     [
@@ -212,7 +206,7 @@ STR
         {severity: 'DEBUG', task: 'ProcessFiles/CamelizeName', id: 0, message: 'Completed'},
         {severity: 'DEBUG', task: 'ProcessFiles', id: 0, message: 'Completed'},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.items.first.log_history[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.items.first.log_history[i][key]).to eq h[key] }
     end
 
     [
@@ -223,7 +217,7 @@ STR
         {severity: 'DEBUG', task: 'ProcessFiles/CamelizeName', id: 0, message: 'Started'},
         {severity: 'DEBUG', task: 'ProcessFiles/CamelizeName', id: 0, message: 'Completed'},
     ].each_with_index do |h, i|
-      h.keys.each { |key| expect(@run.items.first.first.log_history[i][key]).to eq h[key] }
+      h.keys.each { |key| expect(run.items.first.first.log_history[i][key]).to eq h[key] }
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-workflow
 version: !ruby/object:Gem::Version
-  version: 2.0.beta.8
+  version: 2.0.beta.9
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler