tengine_job 1.1.0 → 1.2.0

data/lib/tengine/job/{jobnet → runtime}/state_transition.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-require 'tengine/job/jobnet'
+require 'tengine/job/runtime'
 
-module Tengine::Job::Jobnet::StateTransition
+module Tengine::Job::Runtime::StateTransition
 
   def self.included(mod)
     mod.extend(ClassMethods)
@@ -23,10 +23,12 @@ module Tengine::Job::Jobnet::StateTransition
         def #{method_name}(*args, &block)
           case self.phase_key
           when #{available_phase_keys.map(&:inspect).join(', ')} then
-            #{original_method}(*args, &block)
+            update_with_lock do
+              #{original_method}(*args, &block)
+            end
           #{ignore_case}
           else
-            raise Tengine::Job::Executable::PhaseError, "\#{name_path} \#{self.class.name}##{method_name} not available when the phase_key of \#{self.name_path.inspect} is \#{self.phase_key.inspect}"
+            raise Tengine::Job::Runtime::Executable::PhaseError, "\#{name_path} \#{self.class.name}##{method_name} not available when the phase_key of \#{self.name_path.inspect} is \#{self.phase_key.inspect}"
           end
         end
       EOS

data/lib/tengine/job/runtime/stoppable.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job/runtime'
+require 'selectable_attr'
+
+# ジョブ／ジョブネットを実行する際の情報に関するモジュール
+# Tengine::Job::Runtime::Jobnet, Tengine::Job::Template::Jobnetがこのモジュールをincludeします
+module Tengine::Job::Runtime::Stoppable
+  extend ActiveSupport::Concern
+
+  included do
+    field :stopped_at , :type => DateTime # 停止時刻。停止を開始した時刻です。
+    field :stop_reason, :type => String   # 停止理由。手動以外での停止ならば停止した理由が設定されます。
+  end
+
+  # https://www.pivotaltracker.com/story/show/23329935
+
+  def stop_reason= r
+    super
+    children.each do |i|
+      if i.respond_to?(:chained_box?) && i.chained_box?
+        i.stop_reason = r
+      end
+    end
+  end
+
+  def stopped_at= t
+    super
+    children.each do |i|
+      if i.respond_to?(:chained_box?) && i.chained_box?
+        i.stopped_at = t
+      end
+    end
+  end
+
+  def fire_stop_event(root_jobnet, options = Hash.new)
+    root_jobnet_id = root_jobnet.id.to_s
+    result = Tengine::Job::Runtime::Execution.create!(
+      options.merge(:root_jobnet_id => root_jobnet_id))
+    properties = {
+      :execution_id => result.id.to_s,
+      :root_jobnet_id => root_jobnet_id,
+      :stop_reason => "user_stop"
+    }
+
+    target_id = self.id.to_s
+    # if target.children.blank?
+    if script_executable?
+      event = :"stop.job.job.tengine"
+      properties[:target_job_id] = target_id
+      properties[:target_jobnet_id] = parent.id.to_s
+    else
+      event = :"stop.jobnet.job.tengine"
+      properties[:target_jobnet_id] = target_id
+    end
+
+    EM.run do
+      Tengine::Event.fire(event,
+        :source_name => name_as_resource,
+        :properties => properties)
+    end
+
+    return result
+  end
+end

data/lib/tengine/job/runtime/vertex.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job/runtime'
+
+# Edgeとともにジョブネットを構成するグラフの「頂点」を表すモデルです。
+# このクラスだけでツリー構造を作ることができますが、ほぼ抽象クラスであり実際には
+# 派生クラスのオブジェクトによってツリー構造が作られます。
+class Tengine::Job::Runtime::Vertex
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Tengine::Job::Structure::NamePath
+  include Tengine::Job::Structure::Tree
+  include Tengine::Job::Structure::Visitor::Accepter
+  include Tengine::Job::Runtime::Signal::Transmittable
+
+  field :child_index, type: Integer
+
+  # self.cyclic = true
+  with_options(class_name: self.name, foreign_key: "parent_id") do |c|
+    c.belongs_to :parent  , inverse_of: :children
+    c.has_many   :children, inverse_of: :parent , validate: false, order: {child_index: 1}
+  end
+
+  def template?; false; end
+  def runtime?; !template?; 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 ancestors_until_expansion
+    if parent = self.parent
+      parent.ancestors_until_expansion + [parent]
+    else
+      []
+    end
+  end
+
+  # Tengine::Job::Runtime::Vertexは構成されるツリーのルートを保存しても、embedでないので
+  # 各vertexをsaveしないと保存されないため、明示的に保存しています。
+  def save_descendants!
+    accept_visitor(Tengine::Job::Structure::Visitor::All.new{|v| v.save! })
+  end
+end

data/lib/tengine/job/structure.rb

@@ -0,0 +1,20 @@
+require 'tengine/job'
+
+module Tengine::Job::Structure
+  autoload :Category               , "tengine/job/structure/category"
+  autoload :NamePath               , "tengine/job/structure/name_path"
+  autoload :Tree                   , "tengine/job/structure/tree"
+
+  autoload :Visitor                , "tengine/job/structure/visitor"
+
+  autoload :EdgeBuilder            , "tengine/job/structure/edge_builder"
+
+  autoload :JobnetBuilder          , "tengine/job/structure/jobnet_builder"
+  autoload :JobnetFinder           , "tengine/job/structure/jobnet_finder"
+
+  autoload :ElementSelectorNotation, "tengine/job/structure/element_selector_notation"
+
+  class Error < StandardError
+  end
+
+end

data/lib/tengine/job/{category.rb → structure/category.rb}

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
-require 'tengine/job'
+require 'tengine/job/template'
 
 require 'yaml'
 require 'tengine/support/yaml_with_erb'
 
-class Tengine::Job::Category
+class Tengine::Job::Structure::Category
   include Mongoid::Document
   include Mongoid::Timestamps
   include Tengine::Core::FindByName
@@ -12,16 +12,20 @@ class Tengine::Job::Category
   field :name       , :type => String # カテゴリ名。ディレクトリ名を元に設定されるので、"/"などは使用不可。
   field :caption    , :type => String # カテゴリの表示名。各ディレクトリ名に対応する表示名。通常dictionary.ymlに定義する。
 
-  with_options(:class_name => "Tengine::Job::Category") do |c|
+  with_options(:class_name => self.name) do |c|
     c.belongs_to :parent, :inverse_of => :children, :index => true
     c.has_many   :children, :inverse_of => :parent, :order => [:name, :asc]
   end
 
+  # embeddedなDocumentをその外部のドキュメントから参照することはできないので、これはNG
+  # has_many :template_root_jobnets, class_name: "Tengine::Job::Template::RootJobnet", inverse_of: :category
+  has_many :runtime_root_jobnets , class_name: "Tengine::Job::Runtime::RootJobnet" , inverse_of: :category
+
   class << self
     def update_for(base_dir)
       root_dir = File.basename(base_dir)
       dic_dir_base = File.dirname(base_dir)
-      root_jobnets = Tengine::Job::RootJobnetTemplate.all
+      root_jobnets = Tengine::Job::Template::RootJobnet.all
       root_jobnets.each do |root_jobnet|
         dirs = File.dirname(root_jobnet.dsl_filepath || "").split('/') - ['.', '..']
         dirs.unshift(root_dir)
@@ -35,7 +39,7 @@ class Tengine::Job::Category
             hash = YAML.load_file(dic_path)
             caption = hash[dir]
           end
-          category = Tengine::Job::Category.find_or_create_by(
+          category = self.find_or_create_by(
             :name => dir,
             :caption => caption || dir,
             :parent_id => last_category ? last_category.id : nil)

data/lib/tengine/job/{jobnet/builder.rb → structure/edge_builder.rb}

@@ -1,15 +1,19 @@
 # -*- coding: utf-8 -*-
+require 'tengine/job/structure'
+
 require 'tsort'
 
-class Tengine::Job::Jobnet::Builder
+class Tengine::Job::Structure::EdgeBuilder
   include TSort
 
-  def initialize(client, boot_job_names, redirections)
+  def initialize(client, boot_job_names, redirections, options = {})
     @client, @boot_job_names, @redirections = client, boot_job_names, redirections.dup
     @graph = Hash.new do |h, k| h[k] = Array.new end
     @redirections.each do |(x, y)|
       @graph[x] << y
     end
+    @fork_class = options[:fork_class]
+    @join_class = options[:join_class]
   end
 
   def children; @client.children; end
@@ -20,7 +24,7 @@ class Tengine::Job::Jobnet::Builder
   def process
     tsort
   rescue TSort::Cyclic
-    raise Tengine::Job::DslError, "circular dependency found in jobnet ``#{@client.name}''"
+    raise Tengine::Job::Structure::Error, "circular dependency found in jobnet ``#{@client.name}''"
   else
     build_start_edges
     build_edge_by_redirections
@@ -46,7 +50,7 @@ class Tengine::Job::Jobnet::Builder
     when 1 then
       new_edge(start, child_by_name(@boot_job_names.first))
     else
-      fork = Tengine::Job::Fork.new
+      fork = @fork_class.new
       children << fork
       new_edge(start, fork)
       @boot_job_names.each do |boot_job_name|
@@ -87,7 +91,7 @@ class Tengine::Job::Jobnet::Builder
   def build_forks_and_edges
     @fork_origin_to_fork = {}
     @fork_origins.each do |fork_origin|
-      children << fork = Tengine::Job::Fork.new
+      children << fork = @fork_class.new
       @fork_origin_to_fork[fork_origin] = fork
       new_edge(child_by_name(fork_origin), fork)
       @redirections.dup.
@@ -101,7 +105,7 @@ class Tengine::Job::Jobnet::Builder
   def build_joins_and_edges
     @join_destination_to_join = {}
     @join_destinations.each do |join_destination|
-      children << join = Tengine::Job::Join.new
+      children << join = @join_class.new
       @join_destination_to_join[join_destination] = join
       @redirections.dup.
         delete_if{|r| @fork_to_join.include?(r)}.
@@ -132,7 +136,7 @@ class Tengine::Job::Jobnet::Builder
     when 0 then raise "Must be a bug!!!"
     when 1 then new_edge(child_by_name(end_points.first), _end)
     else
-      join = Tengine::Job::Join.new
+      join = @join_class.new
       children << join
       end_points.each{|point| new_edge(child_by_name(point), join)}
       new_edge(join, _end)

data/lib/tengine/job/{element_selector_notation.rb → structure/element_selector_notation.rb}

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require 'tengine/job'
+require 'tengine/job/structure'
 
 # # Tengine Jobnet Element Selector Notation
 # Tengineジョブネット要素セレクタ記法
@@ -60,7 +60,7 @@ require 'tengine/job'
 #
 #
 
-module Tengine::Job::ElementSelectorNotation
+module Tengine::Job::Structure::ElementSelectorNotation
 
   class NotFound < Tengine::Errors::NotFound
     attr_reader :jobnet, :notation
@@ -73,6 +73,9 @@ module Tengine::Job::ElementSelectorNotation
     end
   end
 
+  def base_module
+    self.template? ? Tengine::Job::Template : Tengine::Job::Runtime
+  end
 
   NAME_PART = /[A-Za-z_][\w\-]*/.freeze
   NAME_PATH_PART = /[A-Za-z_\/][\w\-\/]*/.freeze
@@ -81,7 +84,7 @@ module Tengine::Job::ElementSelectorNotation
   # 例外をraiseさせたい場合は element!メソッドを使ってください。
   def element(notation)
     direction, current_path = *notation.split(/@/, 2)
-    return vertex_by_name_path(direction) if current_path.nil? && Tengine::Job::NamePath.absolute?(direction)
+    return vertex_by_name_path(direction) if current_path.nil? && Tengine::Job::Structure::NamePath.absolute?(direction)
     current = current_path ? vertex_by_name_path(current_path) : self
     raise "#{current_path.inspect} not found" unless current
     case direction
@@ -99,10 +102,10 @@ module Tengine::Job::ElementSelectorNotation
       job2 = current.child_by_name($2)
       job1.next_edges.detect{|edge| edge.destination_id == job2.id}
     when /^(fork|join)!(#{NAME_PART})~(#{NAME_PART})$/ then
-      klass = Tengine::Job.const_get($1.capitalize)
+      klass = base_module.const_get($1.capitalize)
       job1 = current.child_by_name($2)
       job2 = current.child_by_name($3)
-      paths = PathFinder.new(job1, job2).process
+      paths = PathFinder.new(self, job1, job2).process
       paths.each do |path|
         path.each do |element|
           return element if element.is_a?(klass)
@@ -111,12 +114,12 @@ module Tengine::Job::ElementSelectorNotation
     when /^fork~join!(#{NAME_PART})~(#{NAME_PART})$/ then
       job1 = current.child_by_name($1)
       job2 = current.child_by_name($2)
-      paths = PathFinder.new(job1, job2).process
+      paths = PathFinder.new(self, job1, job2).process
       paths.each do |path|
         path.each do |element|
-          if element.is_a?(Tengine::Job::Edge)
-            if element.origin.is_a?(Tengine::Job::Fork) &&
-                element.destination.is_a?(Tengine::Job::Join)
+          if element.is_a?(base_module.const_get(:Edge))
+            if element.origin.is_a?(base_module.const_get(:Fork)) &&
+                element.destination.is_a?(base_module.const_get(:Join))
               return element
             end
           end
@@ -136,7 +139,8 @@ module Tengine::Job::ElementSelectorNotation
   end
 
   class PathFinder
-    def initialize(origin, dest)
+    def initialize(client, origin, dest)
+      @client = client
       @origin, @dest = origin, dest
     end
 
@@ -149,7 +153,7 @@ module Tengine::Job::ElementSelectorNotation
 
     def visit(element)
       @current_route << element
-      if element.is_a?(Tengine::Job::Edge)
+      if element.is_a?(@client.base_module.const_get(:Edge))
         element.destination.accept_visitor(self)
       else
         @routes << @current_route.dup

data/lib/tengine/job/structure/jobnet_builder.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+require 'tengine/job/structure'
+
+module Tengine::Job::Structure::JobnetBuilder
+
+  def start_vertex
+    self.children.detect{|child| child.is_a?(self.class.start_vertex_class)}
+  end
+
+  def end_vertex
+    self.children.detect{|child| child.is_a?(self.class.end_vertex_class)}
+  end
+
+  def finally_vertex
+    self.children.detect{|child| child.is_a?(self.class.jobnet_class) && (child.jobnet_type_key == :finally)}
+  end
+  alias_method :finally_jobnet, :finally_vertex
+
+  def with_start
+    self.children << self.class.start_vertex_class.new
+    self
+  end
+
+  def prepare_end
+    if self.children.last.is_a?(self.class.end_vertex_class)
+      _end = self.children.last
+      yield(_end) if block_given?
+    else
+      _end = self.class.end_vertex_class.new
+      yield(_end) if block_given?
+      self.children << _end
+    end
+    _end
+  end
+
+  def child_by_name(str)
+    case str
+    when '..'      then parent
+    when '.'       then self
+    when 'start'   then start_vertex
+    when 'end'     then end_vertex
+    when 'finally' then finally_vertex
+    else
+      self.children.detect{|c| c.respond_to?(:name) && (c.name == str)}
+    end
+  end
+
+  def build_edges(auto_sequence, boot_job_names, redirections)
+    if self.children.length == 1 # 最初に追加したStartだけなら。
+      self.children.delete_all
+      return
+    end
+    if auto_sequence || boot_job_names.empty?
+      prepare_end
+      build_sequencial_edges
+    else
+      edge_builder = Tengine::Job::Structure::EdgeBuilder.new(self, boot_job_names, redirections,
+        fork_class: self.class.fork_class,
+        join_class: self.class.join_class
+      )
+      edge_builder.process
+    end
+  end
+
+  def build_sequencial_edges
+    self.edges.clear
+    current = nil
+    self.children.each do |child|
+      next if child.is_a?(self.class.jobnet_class) && !!child.jobnet_type_entry[:alternative]
+      if current
+        edge = self.new_edge(current, child)
+        yield(edge) if block_given?
+      end
+      current = child
+    end
+  end
+
+  def new_edge(origin, destination)
+    origin_id = origin.is_a?(self.class.vertex_class) ? origin.id : origin
+    destination_id = destination.is_a?(self.class.vertex_class) ? destination.id : destination
+    edges.new(:origin_id => origin_id, :destination_id => destination_id)
+  end
+end

data/lib/tengine/job/structure/jobnet_finder.rb

@@ -0,0 +1,60 @@
+require 'tengine/job/structure'
+
+module Tengine::Job::Structure::JobnetFinder
+
+  def find_descendant_edge(edge_id)
+    edge_id = String(edge_id)
+    visitor = Tengine::Job::Structure::Visitor::Any.new do |vertex|
+      if vertex.respond_to?(:edges)
+        vertex.edges.detect{|edge| edge.id.to_s == edge_id}
+      else
+        nil
+      end
+    end
+    visitor.visit(self)
+  end
+  alias_method :edge, :find_descendant_edge
+
+  def find_descendant(vertex_id)
+    vertex_id = String(vertex_id)
+    return nil if vertex_id == self.id.to_s
+    vertex(vertex_id)
+  end
+
+  def vertex(vertex_id)
+    vertex_id = String(vertex_id)
+    return self if vertex_id == self.id.to_s
+    visitor = Tengine::Job::Structure::Visitor::Any.new{|v| vertex_id == v.id.to_s ? v : nil }
+    visitor.visit(self)
+  end
+
+  def find_descendant_by_name_path(name_path)
+    return nil if name_path == self.name_path
+    vertex_by_name_path(name_path)
+  end
+
+  def vertex_by_name_path(name_path)
+    Tengine::Job::Structure::NamePath.absolute?(name_path) ?
+      root.vertex_by_absolute_name_path(name_path) :
+      vertex_by_relative_name_path(name_path)
+  end
+
+  def vertex_by_absolute_name_path(name_path)
+    return self if name_path.to_s == self.name_path
+    visitor = Tengine::Job::Structure::Visitor::Any.new do |vertex|
+      if name_path == (vertex.respond_to?(:name_path) ? vertex.name_path : nil)
+        vertex
+      else
+        nil
+      end
+    end
+    visitor.visit(self)
+  end
+
+  def vertex_by_relative_name_path(name_path)
+    head, tail = *name_path.split(Tengine::Job::Structure::NamePath::SEPARATOR, 2)
+    child = child_by_name(head)
+    tail ? child.vertex_by_relative_name_path(tail) : child
+  end
+
+end