libis-workflow-mongoid 2.0.beta.13-java

data/lib/libis/workflow/mongoid/worker.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'libis/workflow/worker'
+require 'sidekiq'
+
+module Libis
+  module Workflow
+    module Mongoid
+
+      class Worker < Libis::Workflow::Worker
+
+        def get_job(job_config)
+          job_name = job_config.delete(:name)
+          job = ::Libis::Workflow::Mongoid::Job.find(name: job_name).first
+          raise RuntimeError.new "Workflow #{job_name} not found" unless job.is_a? ::Libis::Workflow::Mongoid::Job
+          job
+        end
+
+      end
+    end
+  end
+end

data/lib/libis/workflow/mongoid/workflow.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'libis/workflow/base/workflow'
+require 'libis/workflow/mongoid/base'
+require 'libis/tools/config_file'
+require 'libis/tools/extend/hash'
+
+module Libis
+  module Workflow
+    module Mongoid
+
+      module Workflow
+
+        def self.included(klass)
+          klass.class_eval do
+            include ::Libis::Workflow::Base::Workflow
+            include ::Libis::Workflow::Mongoid::Base
+
+            store_in collection: 'workflow_definitions'
+
+            field :name, type: String
+            field :description, type: String
+            field :config, type: Hash, default: -> { Hash.new }
+
+            index({name: 1}, {unique: 1})
+
+            def klass.job_class(job_klass)
+              has_many :jobs, inverse_of: :workflow, class_name: job_klass.to_s,
+                       dependent: :destroy, autosave: true, order: :c_at.asc
+            end
+
+            def klass.load(file_or_hash)
+              config = Libis::Tools::ConfigFile.new
+              config << file_or_hash
+              return nil if config.empty?
+              workflow = self.new
+              workflow.configure(config.to_hash.key_strings_to_symbols(recursive: true))
+              workflow
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/libis/workflow/mongoid.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'libis-workflow'
+
+require_relative 'mongoid/version'
+
+module Libis
+  module Workflow
+    module Mongoid
+
+      autoload :Base, 'libis/workflow/mongoid/base'
+      autoload :Config, 'libis/workflow/mongoid/config'
+      autoload :LogEntry, 'libis/workflow/mongoid/log_entry'
+      autoload :Job, 'libis/workflow/mongoid/job'
+      autoload :Run, 'libis/workflow/mongoid/run'
+      autoload :WorkItem, 'libis/workflow/mongoid/work_item'
+      autoload :WorkItemBase, 'libis/workflow/mongoid/work_item_base'
+      autoload :Worker, 'libis/workflow/mongoid/worker'
+      autoload :Workflow, 'libis/workflow/mongoid/workflow'
+
+      def self.configure
+        yield ::Libis::Workflow::Mongoid::Config.instance
+      end
+
+    end
+
+  end
+end

data/lib/libis-workflow-mongoid.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'libis/workflow/mongoid'

data/libis-workflow-mongoid.gemspec

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'libis/workflow/mongoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'libis-workflow-mongoid'
+  spec.version = ::Libis::Workflow::Mongoid::VERSION
+  spec.date = Date.today.to_s
+
+  spec.summary = %q{Mongoid persistence for the LIBIS Workflow framework.}
+  spec.description = %q{Class implementations that use Mongoid storage for the LIBIS Workflow framework.}
+
+  spec.author = 'Kris Dekeyser'
+  spec.email = 'kris.dekeyser@libis.be'
+  spec.homepage = 'https://github.com/libis/workflow-mongoid'
+  spec.license = 'MIT'
+
+  spec.platform = Gem::Platform::JAVA if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+
+  spec.files = `git ls-files -z`.split("\0")
+  spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'libis-workflow', '~> 2.0.beta'
+
+  spec.add_runtime_dependency 'mongoid', '~> 5.0'
+  spec.add_runtime_dependency 'sidekiq'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+
+end

data/mongoid.yml

@@ -0,0 +1,127 @@
+# Mongoid Configuration for Travis CI
+# ===================================
+
+test:
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: workflow_test
+      # Provides the hosts the default client can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change the default write concern. (default = { w: 1 })
+        #write:
+        #  w: 1
+
+        # Change the default read preference. Valid options for mode are: :secondary,
+        # :secondary_preferred, :primary, :primary_preferred, :nearest
+        # (default: primary)
+        #read:
+        #  mode: :secondary_preferred
+
+        # The name of the user for authentication.
+        #user: 'user'
+
+        # The password of the user for authentication.
+        #password: 'password'
+
+        # The user's database roles.
+        #roles:
+        #  - 'dbOwner'
+
+        # Change the default authentication mechanism. Valid options are: :scram,
+        # :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
+        # on 2.4 and 2.6 is :plain)
+        #auth_mech: :scram
+
+        # The database or source to authenticate the user against. (default: admin)
+        #auth_source: admin
+
+        # Force a the driver cluster to behave in a certain manner instead of auto-
+        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
+        # when connecting to hidden members of a replica set.
+        #connect: :direct
+
+        # Changes the default time in seconds the server monitors refresh their status
+        # via ismaster commands. (default: 10)
+        #heartbeat_frequency: 10
+
+        # The time in seconds for selecting servers for a near read preference. (default: 5)
+        #local_threshold: 5
+
+        # The timeout in seconds for selecting a server for an operation. (default: 30)
+        #server_selection_timeout: 30
+
+        # The maximum number of connections in the connection pool. (default: 5)
+        #max_pool_size: 5
+
+        # The minimum number of connections in the connection pool. (default: 1)
+        #min_pool_size: 1
+
+        # The time to wait, in seconds, in the connection pool for a connection
+        # to be checked in before timing out. (default: 5)
+        #wait_queue_timeout: 5
+
+        # The time to wait to establish a connection before timing out, in seconds.
+        # (default: 5)
+        #connect_timeout: 5
+
+        # The timeout to wait to execute operations on a socket before raising an error.
+        # (default: 5)
+        #socket_timeout: 5
+
+        # The name of the replica set to connect to. Servers provided as seeds that do
+        # not belong to this replica set will be ignored.
+        #replica_set: my_replica_set
+
+        # Whether to connect to the servers via ssl. (default: false)
+        #ssl: true
+
+        # The certificate file used to identify the connection against MongoDB.
+        #ssl_cert: /path/to/my.cert
+
+        # The private keyfile used to identify the connection against MongoDB.
+        # Note that even if the key is stored in the same file as the certificate,
+        # both need to be explicitly specified.
+        #ssl_key: /path/to/my.key
+
+        # A passphrase for the private key.
+        #ssl_key_pass_phrase: password
+
+        # Whether or not to do peer certification validation. (default: false)
+        #ssl_verify: true
+
+        # The file containing a set of concatenated certification authority certifications
+        # used to validate certs passed from the other end of the connection.
+        #ssl_ca_cert: /path/to/ca.cert
+
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Includes the root model name in json serialization. (default: false)
+    #include_root_in_json: false
+
+    # Include the _type field in serialization. (default: false)
+    include_type_for_serialization: true
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    #preload_models: false
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    raise_not_found_error: false
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    scope_overwrite_exception: true
+
+    # Use Active Support's time zone in conversions. (default: true)
+    #use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    #use_utc: false

data/spec/db_env.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+export DB_HOST="kahana.mongohq.com:10053"
+export DB_HOST="localhost:27017"
+export DB_USER="test"
+export DB_PASS="abc123"

data/spec/db_start.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+cd `dirname $0`
+mkdir -p ./data/db
+/opt/mongodb/bin/mongod --dbpath ./data/db
+

data/spec/items/test_dir_item.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'libis/workflow'
+require_relative 'test_item'
+
+class TestDirItem < TestItem
+  include ::Libis::Workflow::Base::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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'libis-tools'
+require 'libis-workflow'
+
+require_relative 'test_item'
+
+class TestFileItem < TestItem
+  include ::Libis::Workflow::Base::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
+
+  def filesize
+    properties[:size]
+  end
+
+  def fixity_check(checksum)
+    properties[:checksum] == checksum
+  end
+
+end

data/spec/items/test_item.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'libis/workflow/mongoid/work_item'
+
+class TestItem
+  include Libis::Workflow::Mongoid::WorkItem
+  run_class 'TestRun'
+end

data/spec/items/test_run.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'libis-workflow-mongoid'
+
+class TestRun
+  include ::Libis::Workflow::Mongoid::Run
+
+  item_class 'TestItem'
+  job_class 'TestJob'
+
+  def name; 'TestRun'; end
+
+end

data/spec/items.rb

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

data/spec/spec_helper.rb

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

data/spec/tasks/camelize_name.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+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
+    item.save!
+  end
+
+end

data/spec/tasks/checksum_tester.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+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}
+  parameter checksum_file: nil, description: 'File with checksums of the files.'
+
+  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

@@ -0,0 +1,52 @@
+# encoding: utf-8
+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
+              error 'Bad file type encountered: %s', file
+              nil
+            end
+    unless child
+      return
+    end
+    child.filename = file
+    item << child
+  end
+
+end

data/spec/test_job.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'libis/workflow/mongoid/job'
+
+class TestJob
+  include ::Libis::Workflow::Mongoid::Job
+  run_class 'TestRun'
+  workflow_class 'TestWorkflow'
+end

data/spec/test_workflow.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'libis/workflow/mongoid/workflow'
+
+class TestWorkflow
+  include ::Libis::Workflow::Mongoid::Workflow
+  job_class 'TestJob'
+end