tengine_job 0.6.9

data/lib/tengine/job/signal.rb

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job'
+
+class Tengine::Job::Signal
+
+  class Error < StandardError
+  end
+
+  attr_reader :paths, :reservations, :event
+
+  # @attribute 受け渡しのためにデータを一時的に保持する属性。
+  # 現時点ではジョブのrunからackを返す際にPIDを保持するために使用します。
+  attr_accessor :data
+
+  # start.job.job.tengineイベントによって
+  # ジョブは :ready -> :starting -> :running に遷移するが、
+  # 一度のroot_jobnet.update_with_lock では :starting が保存されないので、
+  # 2回のroot_jobnet.update_with_lock に分けることができるようにするための
+  # 処理を記憶しておく属性です
+  attr_accessor :callback
+
+  def initialize(event)
+    @event = event
+    reset
+  end
+
+  def reset
+    @paths = []
+    @reservations = []
+    @data = nil
+    @callback = nil
+  end
+
+  def execution
+    @execution ||= Tengine::Job::Execution.find(event[:execution_id])
+  end
+
+  def leave(obj, action = :transmit)
+    @paths << obj
+    begin
+      if obj.is_a?(Tengine::Job::Edge)
+        obj.destination.send(action, self)
+      elsif obj.is_a?(Tengine::Job::Vertex)
+        obj.next_edges.each do |edge|
+          with_paths_backup{ edge.send(action, self) }
+        end
+      else
+        raise Tengine::Job::Signal::Error, "leaving unsupported object: #{obj.inspect}"
+      end
+    rescue Tengine::Job::Signal::Error => e
+      puts "[#{e.class.name}] #{e.message}\nsignal.paths: #{@paths.inspect}"
+      raise e
+    end
+  end
+
+  def with_paths_backup
+    paths_backup = @paths.dup
+    begin
+      yield if block_given?
+    ensure
+      @paths = paths_backup
+    end
+  end
+
+  class Reservation
+    attr_reader :source, :event_type_name, :options
+    def initialize(source, event_type_name, options = {})
+      @source, @event_type_name = source, event_type_name
+      @options  = options
+      @options[:source_name] ||= source.name_as_resource
+    end
+
+    def fire_args
+      [@event_type_name, @options]
+    end
+  end
+
+  def fire(source, event_type_name, properties = {}, options = {})
+    case source
+    when Tengine::Job::Execution then
+      properties[:execution_id] ||= source.id.to_s
+      properties[:root_jobnet_id] ||= source.root_jobnet.id.to_s
+      properties[:root_jobnet_name_path] ||= source.root_jobnet.name_path
+      properties[:target_jobnet_id] ||= source.root_jobnet.id.to_s
+      properties[:target_jobnet_name_path] ||= source.root_jobnet.name_path
+    else
+      properties[:execution_id] ||= self.execution.id.to_s
+      properties[:root_jobnet_id] ||= source.root.id.to_s
+      properties[:root_jobnet_name_path] ||= source.root.name_path
+    end
+    # デバッグ用
+    # properties[:target_jobnet_name] = source.root.vertex(properties[:target_jobnet_id]).name_path
+    options ||= {}
+    options[:properties] = properties
+    properties.each do |key, value|
+      if value.is_a?(BSON::ObjectId)
+        properties[key] = value.to_s
+      end
+    end
+    @reservations << Reservation.new(source, event_type_name, options)
+  end
+
+  module Transmittable
+    # includeするモジュールは以下のメソッドを定義しなければならない
+    def transmit(signal); raise NotImplementedError; end
+    def activate(signal); raise NotImplementedError; end
+
+    def complete_origin_edge(signal, options = {})
+      origin_edge = signal.paths.last
+      origin_edge ||= prev_edges.first
+      begin
+        return if options[:except_closed] && origin_edge.closed?
+        origin_edge.complete(signal)
+      rescue Exception => e
+        puts "[#{e.class.name}] #{e.message}\nsignal.paths: #{@paths.inspect}"
+        raise e
+      end
+    end
+  end
+
+end

data/lib/tengine/job/start.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job'
+
+# ジョブネットの始端を表すVertex。特に状態は持たない。
+class Tengine::Job::Start < Tengine::Job::Vertex
+
+  # https://cacoo.com/diagrams/hdLgrzYsTBBpV3Wj#D26C1
+  def transmit(signal)
+    activate(signal)
+  end
+
+  def activate(signal)
+    signal.leave(self)
+  end
+
+  def reset(signal)
+    signal.leave(self, :reset)
+  end
+
+end

data/lib/tengine/job/stoppable.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job'
+require 'selectable_attr'
+
+# ジョブ／ジョブネットを実行する際の情報に関するモジュール
+# Tengine::Job::JobnetActual, Tengine::Job::JobnetTemplateがこのモジュールをincludeします
+module Tengine::Job::Stoppable
+  extend ActiveSupport::Concern
+
+  included do
+    field :stopped_at , :type => DateTime # 停止時刻。停止を開始した時刻です。
+    field :stop_reason, :type => String   # 停止理由。手動以外での停止ならば停止した理由が設定されます。
+  end
+
+end

data/lib/tengine/job/vertex.rb

@@ -0,0 +1,172 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job'
+
+# Edgeとともにジョブネットを構成するグラフの「頂点」を表すモデル
+# 自身がツリー構造を
+class Tengine::Job::Vertex
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Tengine::Job::Signal::Transmittable
+  include Tengine::Job::NamePath
+
+  self.cyclic = true
+  with_options(:class_name => self.name, :cyclic => true) do |c|
+    c.embedded_in :parent  , :inverse_of => :children
+    c.embeds_many :children, :inverse_of => :parent
+  end
+
+#   def short_inspect
+#     "#<%%%-30s id: %s>" % [self.class.name, self.id.to_s]
+#   end
+#   alias_method :long_inspect, :inspect
+#   alias_method :inspect, :short_inspect
+
+  class VertexValidations < Mongoid::Errors::Validations
+    def translate(key, options)
+      ::I18n.translate(
+        "#{Mongoid::Errors::MongoidError::BASE_KEY}.validations",
+        {:errors => Tengine::Job::Vertex.flatten_errors(document).to_a.join(', ')})
+    end
+  end
+
+
+  class << self
+    def flatten_errors(vertex, dest = nil)
+      dest ||= []
+      children_errors = vertex.errors.messages.delete(:children)
+      edges_errors = vertex.errors.messages.delete(:edges)
+      vertex.errors.full_messages.each{|msg| dest << "#{vertex.name_path} #{msg}"}
+      vertex.children.each{|child| flatten_errors(child, dest)}
+      if vertex.respond_to?(:edges)
+        vertex.edges.each do|edge|
+          edge.errors.full_messages.each{|msg| dest << "#{edge.name_for_message} #{msg}"}
+        end
+      end
+      dest
+    end
+
+    def raise_flatten_errors
+      yield if block_given?
+    rescue Mongoid::Errors::Validations => e
+      raise VertexValidations, e.document
+    end
+
+    def create!(*args, &block)
+      raise_flatten_errors{ super(*args, &block) }
+    end
+  end
+
+  def save!(*args)
+    self.class.raise_flatten_errors{ super(*args) }
+  end
+  def update_attributes!(*args)
+    self.class.raise_flatten_errors{ super(*args) }
+  end
+
+
+
+  def previous_edges
+    return nil unless parent
+    parent.edges.select{|edge| edge.destination_id == self.id}
+  end
+  alias_method :prev_edges, :previous_edges
+
+  def next_edges
+    return nil unless parent
+    parent.edges.select{|edge| edge.origin_id == self.id}
+  end
+
+  def root
+    (parent = self.parent) ? parent.root : self
+  end
+
+  def ancestors
+    if parent = self.parent
+      parent.ancestors + [parent]
+    else
+      []
+    end
+  end
+
+  def ancestors_until_expansion
+    if (parent = self.parent) && !self.was_expansion?
+      parent.ancestors_until_expansion + [parent]
+    else
+      []
+    end
+  end
+
+  IGNORED_FIELD_NAMES = ["_type", "_id"].freeze
+
+  def actual_class; self.class; end
+  def generating_attrs
+    field_names = self.class.fields.keys - IGNORED_FIELD_NAMES
+    field_names.inject({}){|d, name| d[name] = send(name); d }
+  end
+  def generating_children; self.children; end
+  def generating_edges; respond_to?(:edges) ? self.edges : []; end
+
+  def generate(klass = actual_class)
+    result = klass.new(generating_attrs)
+    src_to_generated = {}
+    generating_children.each do |child|
+      generated = child.generate
+      src_to_generated[child.id] = generated.id
+      result.children << generated
+    end
+    generating_edges.each do |edge|
+      generated = edge.class.new
+      generated.origin_id = src_to_generated[edge.origin_id]
+      generated.destination_id = src_to_generated[edge.destination_id]
+      result.edges << generated
+    end
+    result
+  end
+
+  def accept_visitor(visitor)
+    visitor.visit(self)
+  end
+
+  class AnyVisitor
+    def initialize(&block)
+      @block = block
+    end
+    def visit(vertex)
+      if result = @block.call(vertex)
+        return result
+      end
+      vertex.children.each do |child|
+        if result = child.accept_visitor(self)
+          return result
+        end
+      end
+      return nil
+    end
+  end
+
+  class AllVisitor
+    def initialize(&block)
+      @block = block
+    end
+
+    def visit(vertex)
+      @block.call(vertex)
+      vertex.children.each do |child|
+        child.accept_visitor(self)
+      end
+    end
+  end
+
+  class AllVisitorWithEdge < AllVisitor
+    def visit(obj)
+      if obj.respond_to?(:children)
+        super(obj)
+      else
+        @block.call(obj)
+      end
+      return unless obj.respond_to?(:edges)
+      obj.edges.each{|edge| edge.accept_visitor(self)}
+    end
+  end
+
+end

data/lib/tengine_job.rb

@@ -0,0 +1,3 @@
+require 'tengine_core'
+require 'tengine/job'
+Tengine.plugins.add(Tengine::Job)

data/spec/fixtures/rjn_0001_simple_jobnet_builder.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path('test_credential_fixture', File.dirname(__FILE__))
+require File.expand_path('test_server_fixture', File.dirname(__FILE__))
+
+# 以下のジョブネットについてテンプレートジョブネットや
+# 実行用ジョブネットを扱うフィクスチャ生成のためのクラスです。
+#
+# in [rjn0001]
+# (S1) --e1-->(j11)--e2-->(j12)--e3-->(E1)
+
+class Rjn0001SimpleJobnetBuilder < JobnetFixtureBuilder
+  include TestCredentialFixture
+  include TestServerFixture
+
+  DSL = <<-EOS
+    jobnet("rjn0001", :server_name => "test_server1", :credential_name => "test_credential1") do
+      auto_sequence
+      job("j11", "job_test j11")
+      job("j12", "job_test j12")
+    end
+  EOS
+
+  def create(options = {})
+    root = new_root_jobnet("rjn0001", {
+        :server_name => test_server1.name, 
+        :credential_name => test_credential1.name
+      }.update(options || { }))
+    root.children << Tengine::Job::Start.new
+    root.children << new_script("j11", :script => "job_test j11")
+    root.children << new_script("j12", :script => "job_test j12")
+    root.prepare_end
+    root.build_sequencial_edges
+    root.save!
+    self[:S1] = root.children[0]
+    self[:E1] = root.children[3]
+    self[:e1] = root.edges[0]
+    self[:e2] = root.edges[1]
+    self[:e3] = root.edges[2]
+    root
+  end
+end

data/spec/fixtures/rjn_0002_simple_parallel_jobnet_builder.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# 以下のジョブネットについてテンプレートジョブネットや
+# 実行用ジョブネットを扱うフィクスチャ生成のためのクラスです。
+#
+# in [rjn0002]
+#              |--e2-->(j11)--e4-->|
+# (S1)--e1-->[F1]                [J1]--e6-->(E1)
+#              |--e3-->(j12)--e5-->|
+
+class Rjn0002SimpleParallelJobnetBuilder < JobnetFixtureBuilder
+  include TestCredentialFixture
+  include TestServerFixture
+
+  DSL = <<-EOS
+    jobnet("rjn0002", :server_name => "test_server1", :credential_name => "test_credential1") do
+      boot_jobs("j11", "j12")
+      job("j11", "job_test j11")
+      job("j12", "job_test j12")
+    end
+  EOS
+
+  def create(options = {})
+    root = new_root_jobnet("rjn0002", {
+        :server_name => test_server1.name,
+        :credential_name => test_credential1.name
+      }.update(options || { }))
+    root.children << new_start
+    root.children << new_fork
+    root.children << new_script("j11", :script => "job_test j11")
+    root.children << new_script("j12", :script => "job_test j12")
+    root.children << new_join
+    root.children << new_end
+    root.edges << new_edge(:S1, :F1)
+    root.edges << new_edge(:F1, :j11)
+    root.edges << new_edge(:F1, :j12)
+    root.edges << new_edge(:j11, :J1)
+    root.edges << new_edge(:j12, :J1)
+    root.edges << new_edge(:J1, :E1)
+    root.save!
+    root
+  end
+end

data/spec/fixtures/rjn_0003_fork_join_jobnet_builder.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+# 以下のジョブネットについてテンプレートジョブネットや
+# 実行用ジョブネットを扱うフィクスチャ生成のためのクラスです。
+#
+# in [rjn0003]
+#                                                |--e7-->(j14)--e11-->(j16)--e14--->|
+#              |--e2-->(j11)--e4-->(j13)--e6-->[F2]                                 |
+# (S1)--e1-->[F1]                                |--e8-->[J1]--e12-->(j17)--e15-->[J2]--e16-->(E2)
+#              |                                 |--e9-->[J1]                       |
+#              |--e3-->(j12)------e5---------->[F3]                                 |
+#                                                |--e10---->(j15)---e13------------>|
+class Rjn0003ForkJoinJobnetBuilder < JobnetFixtureBuilder
+  DSL = <<-EOS
+    jobnet("rjn0003") do
+      boot_jobs("j11", "j12")
+      job("j11", "job_test j11", :to => "j13")
+      job("j12", "job_test j12", :to => ["j15", "j17"])
+      job("j13", "job_test j13", :to => ["j14", "j17"])
+      job("j14", "job_test j14", :to => "j16")
+      job("j15", "job_test j15")
+      job("j16", "job_test j16")
+      job("j17", "job_test j17")
+    end
+  EOS
+
+  def create(options = {})
+    root = new_root_jobnet("rjn0003")
+    root.children << new_start
+    root.children << new_fork # F1
+    root.children << new_script("j11", :script => "job_test j11")
+    root.children << new_script("j12", :script => "job_test j12")
+    root.children << new_script("j13", :script => "job_test j13")
+    root.children << new_fork # F2
+    root.children << new_fork # F3
+    root.children << new_join # J1
+    root.children << new_script("j14", :script => "job_test j14")
+    root.children << new_script("j15", :script => "job_test j15")
+    root.children << new_script("j16", :script => "job_test j16")
+    root.children << new_script("j17", :script => "job_test j17")
+    root.children << new_join # J2
+    root.children << new_end
+    root.edges << new_edge(:S1 , :F1 ) # e1
+    root.edges << new_edge(:F1 , :j11) # e2
+    root.edges << new_edge(:F1 , :j12) # e3
+    root.edges << new_edge(:j11, :j13) # e4
+    root.edges << new_edge(:j12, :F3 ) # e5
+    root.edges << new_edge(:j13, :F2 ) # e6
+    root.edges << new_edge(:F2 , :j14) # e7
+    root.edges << new_edge(:F2 , :J1 ) # e8
+    root.edges << new_edge(:F3 , :J1 ) # e9
+    root.edges << new_edge(:F3 , :j15) # e10
+    root.edges << new_edge(:j14, :j16) # e11
+    root.edges << new_edge(:J1 , :j17) # e12
+    root.edges << new_edge(:j15 ,:J2 ) # e13
+    root.edges << new_edge(:j16 ,:J2 ) # e14
+    root.edges << new_edge(:j17 ,:J2 ) # e15
+    root.edges << new_edge(:J2 , :E1 ) # e16
+    root.save!
+    root
+  end
+end