libis-workflow 2.0.24 → 2.0.25

data/spec/items.rb

@@ -1,3 +1,3 @@
-require_relative 'items/test_dir_item'
-require_relative 'items/test_file_item'
+require_relative 'items/test_dir_item'
+require_relative 'items/test_file_item'
 require_relative 'items/test_run'

data/spec/items/test_dir_item.rb

@@ -1,14 +1,14 @@
-require 'libis/workflow/dir_item'
-
-class TestDirItem < ::Libis::Workflow::DirItem
-
-  def name=(dir)
-    raise RuntimeError, "'#{dir}' is not a directory" unless File.directory? dir
-    super dir
-  end
-
-  def name
-    self.properties[:name] || super
-  end
-
+require 'libis/workflow/dir_item'
+
+class TestDirItem < ::Libis::Workflow::DirItem
+
+  def name=(dir)
+    raise RuntimeError, "'#{dir}' is not a directory" unless File.directory? dir
+    super dir
+  end
+
+  def name
+    self.properties[:name] || super
+  end
+
 end

data/spec/items/test_file_item.rb

@@ -1,17 +1,17 @@
-require 'libis/tools/checksum'
-
-require 'libis/workflow/file_item'
-
-class TestFileItem < ::Libis::Workflow::FileItem
-
-  def filename=(file)
-    raise RuntimeError, "'#{file}' is not a file" unless File.file? file
-    set_checksum :SHA256, ::Libis::Tools::Checksum.hexdigest(file, :SHA256)
-    super file
-  end
-
-  def name
-    self.properties[:name] || super
-  end
-
+require 'libis/tools/checksum'
+
+require 'libis/workflow/file_item'
+
+class TestFileItem < ::Libis::Workflow::FileItem
+
+  def filename=(file)
+    raise RuntimeError, "'#{file}' is not a file" unless File.file? file
+    set_checksum :SHA256, ::Libis::Tools::Checksum.hexdigest(file, :SHA256)
+    super file
+  end
+
+  def name
+    self.properties[:name] || super
+  end
+
 end

data/spec/items/test_run.rb

@@ -1,9 +1,9 @@
-require 'libis/workflow/run'
-
-require_relative 'test_dir_item'
-
-class TestRun < ::Libis::Workflow::Run
-
-  def name; 'TestRun'; end
-
+require 'libis/workflow/run'
+
+require_relative 'test_dir_item'
+
+class TestRun < ::Libis::Workflow::Run
+
+  def name; 'TestRun'; end
+
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
-require 'coveralls'
-Coveralls.wear!
-
-require 'bundler/setup'
-Bundler.setup
-
-require 'rspec'
-require 'libis-workflow'
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec'
+require 'libis-workflow'

data/spec/task_spec.rb

@@ -1,16 +1,16 @@
-require_relative 'spec_helper'
-
-require 'libis/workflow/task'
-
-describe 'Task' do
-
-  it 'should create a default task' do
-
-    task = ::Libis::Workflow::Task.new nil
-
-    expect(task.parent).to eq nil
-    expect(task.name).to eq 'Task'
-
-  end
-
+require_relative 'spec_helper'
+
+require 'libis/workflow/task'
+
+describe 'Task' do
+
+  it 'should create a default task' do
+
+    task = ::Libis::Workflow::Task.new nil
+
+    expect(task.parent).to eq nil
+    expect(task.name).to eq 'Task'
+
+  end
+
 end

data/spec/tasks/camelize_name.rb

@@ -1,12 +1,12 @@
-require 'backports/rails/string'
-
-require 'libis/workflow'
-
-class CamelizeName < ::Libis::Workflow::Task
-
-  def process(item)
-    return unless (item.is_a?(TestFileItem) || item.is_a?(TestDirItem))
-    item.properties[:name] = item.name.camelize
-  end
-
-end
+require 'backports/rails/string'
+
+require 'libis/workflow'
+
+class CamelizeName < ::Libis::Workflow::Task
+
+  def process(item)
+    return unless (item.is_a?(TestFileItem) || item.is_a?(TestDirItem))
+    item.properties[:name] = item.name.camelize
+  end
+
+end

data/spec/tasks/checksum_tester.rb

@@ -1,32 +1,32 @@
-require 'libis/tools/checksum'
-
-require 'libis/exceptions'
-require 'libis/workflow'
-
-class ChecksumTester < ::Libis::Workflow::Task
-
-  parameter checksum_type: nil,
-            description: 'Checksum type to use.',
-            constraint: ::Libis::Tools::Checksum::CHECKSUM_TYPES.map {|x| x.to_s}
-
-  def process(item)
-    return unless item.is_a? TestFileItem
-
-    checksum_type = parameter(:checksum_type)
-
-    if checksum_type.nil?
-      ::Libis::Tools::Checksum::CHECKSUM_TYPES.each do |x|
-        test_checksum(item, x) if item.checksum(x)
-      end
-    else
-      test_checksum(item, checksum_type)
-    end
-  end
-
-  def test_checksum(item, checksum_type)
-    checksum = ::Libis::Tools::Checksum.hexdigest(item.fullpath, checksum_type.to_sym)
-    return if item.checksum(checksum_type) == checksum
-    raise ::Libis::WorkflowError, "Checksum test #{checksum_type} failed for #{item.filepath}"
-  end
-
-end
+require 'libis/tools/checksum'
+
+require 'libis/exceptions'
+require 'libis/workflow'
+
+class ChecksumTester < ::Libis::Workflow::Task
+
+  parameter checksum_type: nil,
+            description: 'Checksum type to use.',
+            constraint: ::Libis::Tools::Checksum::CHECKSUM_TYPES.map {|x| x.to_s}
+
+  def process(item)
+    return unless item.is_a? TestFileItem
+
+    checksum_type = parameter(:checksum_type)
+
+    if checksum_type.nil?
+      ::Libis::Tools::Checksum::CHECKSUM_TYPES.each do |x|
+        test_checksum(item, x) if item.checksum(x)
+      end
+    else
+      test_checksum(item, checksum_type)
+    end
+  end
+
+  def test_checksum(item, checksum_type)
+    checksum = ::Libis::Tools::Checksum.hexdigest(item.fullpath, checksum_type.to_sym)
+    return if item.checksum(checksum_type) == checksum
+    raise ::Libis::WorkflowError, "Checksum test #{checksum_type} failed for #{item.filepath}"
+  end
+
+end

data/spec/tasks/collect_files.rb

@@ -1,47 +1,47 @@
-require 'libis/exceptions'
-
-require_relative '../items'
-
-class CollectFiles < ::Libis::Workflow::Task
-
-  parameter location: '.',
-            description: 'Dir location to start scanning for files.'
-  parameter subdirs: false,
-            description: 'Look for files in subdirs too.'
-  parameter selection: nil,
-            description: 'Only select files that match the given regular expression. Ignored if empty.'
-
-  def process(item)
-    if item.is_a? TestRun
-      add_item(item, parameter(:location))
-    elsif item.is_a? TestDirItem
-      collect_files(item, item.fullpath)
-    end
-  end
-
-  def collect_files(item, dir)
-    glob_string = dir
-    glob_string = File.join(glob_string, '**') if parameter(:subdirs)
-    glob_string = File.join(glob_string, '*')
-
-    Dir.glob(glob_string).select do |x|
-      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)
-    end
-  end
-
-  def add_item(item, file)
-    child = if File.file?(file)
-              TestFileItem.new
-            elsif File.directory?(file)
-              TestDirItem.new
-            else
-              Item.new
-            end
-    child.filename = file
-    item << child
-  end
-
-end
+require 'libis/exceptions'
+
+require_relative '../items'
+
+class CollectFiles < ::Libis::Workflow::Task
+
+  parameter location: '.',
+            description: 'Dir location to start scanning for files.'
+  parameter subdirs: false,
+            description: 'Look for files in subdirs too.'
+  parameter selection: nil,
+            description: 'Only select files that match the given regular expression. Ignored if empty.'
+
+  def process(item)
+    if item.is_a? TestRun
+      add_item(item, parameter(:location))
+    elsif item.is_a? TestDirItem
+      collect_files(item, item.fullpath)
+    end
+  end
+
+  def collect_files(item, dir)
+    glob_string = dir
+    glob_string = File.join(glob_string, '**') if parameter(:subdirs)
+    glob_string = File.join(glob_string, '*')
+
+    Dir.glob(glob_string).select do |x|
+      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)
+    end
+  end
+
+  def add_item(item, file)
+    child = if File.file?(file)
+              TestFileItem.new
+            elsif File.directory?(file)
+              TestDirItem.new
+            else
+              Item.new
+            end
+    child.filename = file
+    item << child
+  end
+
+end

data/spec/workflow_spec.rb

@@ -1,155 +1,155 @@
-require_relative 'spec_helper'
-
-require 'stringio'
-
-describe 'TestWorkflow' do
-
-  basedir = File.absolute_path File.join(File.dirname(__FILE__))
-  dirname = File.join(basedir, 'items')
-
-  before :each do
-
-    # noinspection RubyResolve
-    ::Libis::Workflow.configure do |cfg|
-      cfg.itemdir = dirname
-      cfg.taskdir = File.join(basedir, 'tasks')
-      cfg.workdir = File.join(basedir, 'work')
-      cfg.logger.appenders =
-          ::Logging::Appenders.string_io('StringIO', layout: ::Libis::Tools::Config.get_log_formatter)
-    end
-  end
-
-  let(:logoutput) { ::Libis::Workflow::Config.logger.appenders.first.sio }
-
-  let(:workflow) {
-    workflow = ::Libis::Workflow::Workflow.new
-    workflow.configure(
-        'name' => 'TestWorkflow',
-        'description' => 'Workflow for testing',
-        'tasks' => [
-            {'class' => 'CollectFiles', 'recursive' => true},
-            {
-                'name' => 'ProcessFiles', 'recursive' => false,
-                'tasks' => [
-                    {'class' => 'ChecksumTester', 'recursive' => true},
-                    {'class' => 'CamelizeName', 'recursive' => true}
-                ]
-            }
-        ],
-        'input' => {
-            'dirname' => {'default' => '.', 'propagate_to' => 'CollectFiles#location'},
-            'checksum_type' => {'default' => 'SHA1', 'propagate_to' => 'ChecksumTester'}
-        }
-    )
-    workflow
-  }
-
-  let(:job) {
-    job = ::Libis::Workflow::Job.new
-    job.configure(
-        'name' => 'TestJob',
-        'description' => 'Job for testing',
-        'workflow' => workflow,
-        'run_object' => 'TestRun',
-        'input' => {'dirname' => dirname, 'checksum_type' => 'SHA256'},
-    )
-    job
-  }
-
-  it 'should contain three tasks' do
-    expect(workflow.config['tasks'].size).to eq 2
-    expect(workflow.config['tasks'].first['class']).to eq 'CollectFiles'
-    expect(workflow.config['tasks'].last['name']).to eq 'ProcessFiles'
-  end
-
-  # noinspection RubyResolve
-  it 'should camelize the workitem name' do
-    run = job.execute
-    expect(run.options['CollectFiles']['location']).to eq dirname
-    expect(run.size).to eq 1
-    expect(run.items.size).to eq 1
-    expect(run.items.first.class).to eq TestDirItem
-    expect(run.items.first.size).to eq 3
-    expect(run.items.first.items.size).to eq 3
-    expect(run.items.first.first.class).to eq TestFileItem
-
-    expect(run.items.first.name).to eq 'Items'
-
-    run.items.first.each_with_index do |x, i|
-      expect(x.name).to eq %w'TestDirItem.rb TestFileItem.rb TestRun.rb'[i]
-    end
-  end
-
-  it 'should return expected debug output' do
-
-    sample_out = <<STR
- INFO -- Run - TestRun : Ingest run started.
- INFO -- Run - TestRun : Running subtask (1/2): CollectFiles
-DEBUG -- CollectFiles - TestRun : Processing subitem (1/1): items
-DEBUG -- CollectFiles - items : Processing subitem (1/3): test_dir_item.rb
-DEBUG -- CollectFiles - items : Processing subitem (2/3): test_file_item.rb
-DEBUG -- CollectFiles - items : Processing subitem (3/3): test_run.rb
-DEBUG -- CollectFiles - items : 3 of 3 subitems passed
-DEBUG -- CollectFiles - TestRun : 1 of 1 subitems passed
- INFO -- Run - TestRun : Running subtask (2/2): ProcessFiles
- INFO -- ProcessFiles - TestRun : Running subtask (1/2): ChecksumTester
-DEBUG -- ProcessFiles/ChecksumTester - TestRun : Processing subitem (1/1): items
-DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (1/3): test_dir_item.rb
-DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (2/3): test_file_item.rb
-DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (3/3): test_run.rb
-DEBUG -- ProcessFiles/ChecksumTester - items : 3 of 3 subitems passed
-DEBUG -- ProcessFiles/ChecksumTester - TestRun : 1 of 1 subitems passed
- INFO -- ProcessFiles - TestRun : Running subtask (2/2): CamelizeName
-DEBUG -- ProcessFiles/CamelizeName - TestRun : Processing subitem (1/1): items
-DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (1/3): test_dir_item.rb
-DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (2/3): test_file_item.rb
-DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (3/3): test_run.rb
-DEBUG -- ProcessFiles/CamelizeName - Items : 3 of 3 subitems passed
-DEBUG -- ProcessFiles/CamelizeName - TestRun : 1 of 1 subitems passed
- INFO -- ProcessFiles - TestRun : Done
- INFO -- Run - TestRun : Done
-STR
-    sample_out = sample_out.lines.to_a
-
-    run = job.execute
-    output = logoutput.string.lines.to_a
-
-    # puts output
-
-    expect(output.size).to eq sample_out.size
-    output.each_with_index do |o, i|
-      expect(o[/(?<=\] ).*/].strip).to eq sample_out[i].strip
-    end
-
-    expect(run.status_log.size).to eq 5
-    expect(run.items.first.status_log.size).to eq 3
-
-    [
-        {task: 'Run', status: :DONE, progress: 2, max: 2},
-        {task: 'CollectFiles', status: :DONE, progress: 1, max: 1},
-        {task: 'ProcessFiles', status: :DONE, progress: 2, max: 2},
-        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: 1, max: 1},
-        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: 1, max: 1},
-    ].each_with_index do |h, i|
-      h.keys.each { |key| expect(run.status_log[i][key.to_s]).to eq h[key] }
-    end
-
-    [
-        {task: 'CollectFiles', status: :DONE, progress: 3, max: 3},
-        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: 3, max: 3},
-        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: 3, max: 3},
-    ].each_with_index do |h, i|
-      h.keys.each { |key| expect(run.items.first.status_log[i][key.to_s]).to eq h[key] }
-    end
-
-    [
-        {task: 'CollectFiles', status: :DONE, progress: nil, max: nil},
-        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: nil, max: nil},
-        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: nil, max: nil},
-    ].each_with_index do |h, i|
-      h.keys.each { |key| expect(run.items.first.first.status_log[i][key.to_s]).to eq h[key] }
-    end
-
-  end
-
+require_relative 'spec_helper'
+
+require 'stringio'
+
+describe 'TestWorkflow' do
+
+  basedir = File.absolute_path File.join(File.dirname(__FILE__))
+  dirname = File.join(basedir, 'items')
+
+  before :each do
+
+    # noinspection RubyResolve
+    ::Libis::Workflow.configure do |cfg|
+      cfg.itemdir = dirname
+      cfg.taskdir = File.join(basedir, 'tasks')
+      cfg.workdir = File.join(basedir, 'work')
+      cfg.logger.appenders =
+          ::Logging::Appenders.string_io('StringIO', layout: ::Libis::Tools::Config.get_log_formatter)
+    end
+  end
+
+  let(:logoutput) { ::Libis::Workflow::Config.logger.appenders.first.sio }
+
+  let(:workflow) {
+    workflow = ::Libis::Workflow::Workflow.new
+    workflow.configure(
+        'name' => 'TestWorkflow',
+        'description' => 'Workflow for testing',
+        'tasks' => [
+            {'class' => 'CollectFiles', 'recursive' => true},
+            {
+                'name' => 'ProcessFiles', 'recursive' => false,
+                'tasks' => [
+                    {'class' => 'ChecksumTester', 'recursive' => true},
+                    {'class' => 'CamelizeName', 'recursive' => true}
+                ]
+            }
+        ],
+        'input' => {
+            'dirname' => {'default' => '.', 'propagate_to' => 'CollectFiles#location'},
+            'checksum_type' => {'default' => 'SHA1', 'propagate_to' => 'ChecksumTester'}
+        }
+    )
+    workflow
+  }
+
+  let(:job) {
+    job = ::Libis::Workflow::Job.new
+    job.configure(
+        'name' => 'TestJob',
+        'description' => 'Job for testing',
+        'workflow' => workflow,
+        'run_object' => 'TestRun',
+        'input' => {'dirname' => dirname, 'checksum_type' => 'SHA256'},
+    )
+    job
+  }
+
+  it 'should contain three tasks' do
+    expect(workflow.config['tasks'].size).to eq 2
+    expect(workflow.config['tasks'].first['class']).to eq 'CollectFiles'
+    expect(workflow.config['tasks'].last['name']).to eq 'ProcessFiles'
+  end
+
+  # noinspection RubyResolve
+  it 'should camelize the workitem name' do
+    run = job.execute
+    expect(run.options['CollectFiles']['location']).to eq dirname
+    expect(run.size).to eq 1
+    expect(run.items.size).to eq 1
+    expect(run.items.first.class).to eq TestDirItem
+    expect(run.items.first.size).to eq 3
+    expect(run.items.first.items.size).to eq 3
+    expect(run.items.first.first.class).to eq TestFileItem
+
+    expect(run.items.first.name).to eq 'Items'
+
+    run.items.first.each_with_index do |x, i|
+      expect(x.name).to eq %w'TestDirItem.rb TestFileItem.rb TestRun.rb'[i]
+    end
+  end
+
+  it 'should return expected debug output' do
+
+    sample_out = <<STR
+ INFO -- Run - TestRun : Ingest run started.
+ INFO -- Run - TestRun : Running subtask (1/2): CollectFiles
+DEBUG -- CollectFiles - TestRun : Processing subitem (1/1): items
+DEBUG -- CollectFiles - items : Processing subitem (1/3): test_dir_item.rb
+DEBUG -- CollectFiles - items : Processing subitem (2/3): test_file_item.rb
+DEBUG -- CollectFiles - items : Processing subitem (3/3): test_run.rb
+DEBUG -- CollectFiles - items : 3 of 3 subitems passed
+DEBUG -- CollectFiles - TestRun : 1 of 1 subitems passed
+ INFO -- Run - TestRun : Running subtask (2/2): ProcessFiles
+ INFO -- ProcessFiles - TestRun : Running subtask (1/2): ChecksumTester
+DEBUG -- ProcessFiles/ChecksumTester - TestRun : Processing subitem (1/1): items
+DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (1/3): test_dir_item.rb
+DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (2/3): test_file_item.rb
+DEBUG -- ProcessFiles/ChecksumTester - items : Processing subitem (3/3): test_run.rb
+DEBUG -- ProcessFiles/ChecksumTester - items : 3 of 3 subitems passed
+DEBUG -- ProcessFiles/ChecksumTester - TestRun : 1 of 1 subitems passed
+ INFO -- ProcessFiles - TestRun : Running subtask (2/2): CamelizeName
+DEBUG -- ProcessFiles/CamelizeName - TestRun : Processing subitem (1/1): items
+DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (1/3): test_dir_item.rb
+DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (2/3): test_file_item.rb
+DEBUG -- ProcessFiles/CamelizeName - Items : Processing subitem (3/3): test_run.rb
+DEBUG -- ProcessFiles/CamelizeName - Items : 3 of 3 subitems passed
+DEBUG -- ProcessFiles/CamelizeName - TestRun : 1 of 1 subitems passed
+ INFO -- ProcessFiles - TestRun : Done
+ INFO -- Run - TestRun : Done
+STR
+    sample_out = sample_out.lines.to_a
+
+    run = job.execute
+    output = logoutput.string.lines.to_a
+
+    # puts output
+
+    expect(output.size).to eq sample_out.size
+    output.each_with_index do |o, i|
+      expect(o[/(?<=\] ).*/].strip).to eq sample_out[i].strip
+    end
+
+    expect(run.status_log.size).to eq 5
+    expect(run.items.first.status_log.size).to eq 3
+
+    [
+        {task: 'Run', status: :DONE, progress: 2, max: 2},
+        {task: 'CollectFiles', status: :DONE, progress: 1, max: 1},
+        {task: 'ProcessFiles', status: :DONE, progress: 2, max: 2},
+        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: 1, max: 1},
+        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: 1, max: 1},
+    ].each_with_index do |h, i|
+      h.keys.each { |key| expect(run.status_log[i][key.to_s]).to eq h[key] }
+    end
+
+    [
+        {task: 'CollectFiles', status: :DONE, progress: 3, max: 3},
+        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: 3, max: 3},
+        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: 3, max: 3},
+    ].each_with_index do |h, i|
+      h.keys.each { |key| expect(run.items.first.status_log[i][key.to_s]).to eq h[key] }
+    end
+
+    [
+        {task: 'CollectFiles', status: :DONE, progress: nil, max: nil},
+        {task: 'ProcessFiles/ChecksumTester', status: :DONE, progress: nil, max: nil},
+        {task: 'ProcessFiles/CamelizeName', status: :DONE, progress: nil, max: nil},
+    ].each_with_index do |h, i|
+      h.keys.each { |key| expect(run.items.first.first.status_log[i][key.to_s]).to eq h[key] }
+    end
+
+  end
+
 end