cpee 1.4.7 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8951441080b5f80bddb04e068c31ef1e0d9be56cc5ed075031be42704d3b05bd
-  data.tar.gz: 8b40820c7c5b5590b8a0d5602c8764d3a87c99eefb80fc5d5b1ab9fc6c8e7896
+SHA1:
+  metadata.gz: 416188034ef7c0020c76c14841e2aab9556634ae
+  data.tar.gz: d2ceda09e62188498ee0e565733007bcd90397f2
 SHA512:
-  metadata.gz: b423e36aeeab7ad83bd312879296125eeb6761cedc3807fa78f3bc42a3c78f1f6605f7cb3ee0ba616e42d7af0fd5b34d1313bb114f13fb602189d2ee21625e7c
-  data.tar.gz: 10ad5f072da46f65b584b2e5d25f04b045dd597b9dbfe27065bec13df184c6f2cd99998cbe480859b3ea8f930be7fc3186206ea83ada4544a92f49002e2c9cc5
+  metadata.gz: a0fb17d5cbcad12b931b0cb378f9d50092792bdd8c98808f07540e8fabf4a6515e8462d39eea1408eb4efd7534443cfae12d95b6afce16f41c712f1739eb1aa9
+  data.tar.gz: 4d91c2f7a529aa8f5b44a11a6003bf817f16decc39dc4a7709262f4e04c6a1be8b495a7632733564388d312ed7accc8d4dcc1f5e9539b4d3625e2f922c9786b4

data/cpee.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee"
-  s.version          = "1.4.7"
+  s.version          = "1.4.8"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0"
   s.summary          = "Preliminary release of cloud process execution engine (cpee). If you just need workflow execution, without a rest/xmpp service exposing it, then use WEEL"

data/lib/cpee/controller.rb

@@ -22,7 +22,7 @@ require ::File.dirname(__FILE__) + '/empty_workflow'
 
 module CPEE
 
-  class ValueHelper
+  class ValueHelper #{{{
     def self::generate(value)
       if [String, Integer, Float, TrueClass, FalseClass, Date].include? value.class
         value.to_s
@@ -49,7 +49,32 @@ module CPEE
           end
       end
     end
-  end
+  end #}}}
+
+  class AttributesHelper #{{{
+    def translate(__attributes__,__dataelements__,__endpoints__)
+      @data       = WEEL::ReadHash.new(__dataelements__)
+      @endpoints  = WEEL::ReadHash.new(__endpoints__)
+      @attributes = WEEL::ReadHash.new(__attributes__)
+      __attributes__.transform_values do |v|
+        v.gsub(/(!(attributes|data|endpoints)\.[\w_]+)/) do |m|
+          eval(m[1..-1])
+        end
+      end
+    end
+
+    def data
+      @data
+    end
+
+    def endpoints
+      @endpoints
+    end
+
+    def attributes
+      @attributes
+    end
+  end #}}}
 
   class Controller
 
@@ -63,6 +88,7 @@ module CPEE
       @callbacks = {}
       @positions = []
       @attributes = {}
+      @attributes_helper = AttributesHelper.new
       @thread = nil
       @mutex = Mutex.new
       @opts = opts
@@ -138,6 +164,10 @@ module CPEE
       x.class == String ? x : x.pretty_inspect
     end
 
+    def attributes_translated
+      @attributes_helper.translate(attributes,dataelements,endpoints)
+    end
+
     def host
       @opts[:host]
     end
@@ -145,7 +175,7 @@ module CPEE
       @opts[:url]
     end
     def instance_url
-      "#{@opts[:url]}/#{@id}"
+      File.join(@opts[:url].to_s,@id.to_s)
     end
     def base
       base_url
@@ -153,6 +183,12 @@ module CPEE
     def instance
       instance_url
     end
+    def endpoints
+      @instance.endpoints
+    end
+    def dataelements
+      @instance.data
+    end
 
     def sim # {{{
       @thread.join if !@thread.nil? && @thread.alive?
@@ -191,9 +227,6 @@ module CPEE
     def finalize_if_finished
       if @instance.state == :finished
         @instance = nil
-        @notifications.subscriptions.keys.each do |key|
-          unserialize_notifications!(:del,key)
-        end
       end
     end
 
@@ -316,7 +349,7 @@ module CPEE
     def unserialize_attributes! #{{{
       @attributes = {}
       @properties.data.find("/p:properties/p:attributes/p:*").map do |ele|
-        @attributes[ele.qname.name] = ele.text
+        @attributes[ele.qname.name.to_sym] = ele.text
       end
       uuid = @properties.data.find("/p:properties/p:attributes/p:uuid")
       if uuid.empty? || uuid.length != 1 || @properties.data.find("/p:properties/p:attributes/p:uuid[.=\"#{@uuid}\"]").empty?
@@ -515,6 +548,7 @@ module CPEE
 
     def notify(what,content={})# {{{
       item = @events[what]
+
       if item
         item.each do |ke,ur|
           Thread.new(ke,ur) do |key,url|

data/lib/cpee/handler_properties.rb

@@ -1,13 +1,13 @@
 # This file is part of CPEE.
-# 
+#
 # CPEE is free software: you can redistribute it and/or modify it under the terms
 # of the GNU General Public License as published by the Free Software Foundation,
 # either version 3 of the License, or (at your option) any later version.
-# 
+#
 # CPEE is distributed in the hope that it will be useful, but WITHOUT ANY
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 # PARTICULAR PURPOSE.  See the GNU General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License along with
 # CPEE (file COPYING in the main directory).  If not, see
 # <http://www.gnu.org/licenses/>.
@@ -25,19 +25,19 @@ class PropertiesHandler < Riddl::Utils::Properties::HandlerBase
         end
       when 'endpoints'
         @data.unserialize_endpoints!
-        @data.notify('endpoints/change', :instance => @data.instance)
+        @data.notify('endpoints/change', :label => 'external', :instance => @data.instance, :instance_name => @data.info, :instance_uuid => @data.uuid, :changed => @data.endpoints.keys, :values => @data.endpoints)
       when 'dataelements'
         @data.unserialize_dataelements!
-        @data.notify('dataelements/change', :instance => @data.instance)
+        @data.notify('dataelements/change', :label => 'external', :instance => @data.instance, :instance_name => @data.info, :instance_uuid => @data.uuid, :changed => @data.dataelements.keys, :values => @data.dataelements)
       when 'attributes'
         @data.unserialize_attributes!
-        @data.notify('attributes/change', :instance => @data.instance)
-      when 'positions'  
+        @data.notify('attributes/change', :label => 'external', :instance => @data.instance, :instance_name => @data.info, :instance_uuid => @data.uuid, :changed => @data.attributes.keys, :values => @data.attributes)
+      when 'positions'
         @data.unserialize_positions!
         @data.notify('position/change', :instance => @data.instance)
-      when 'transformation'  
+      when 'transformation'
         @data.notify('transformation/change', :instance => @data.instance)
-      when 'state'  
+      when 'state'
         @data.unserialize_state!
       else
         nil

data/lib/cpee/instantiation.rb

@@ -24,7 +24,7 @@ module CPEE
     SERVER = File.expand_path(__dir__ + '/../instantiation.xml')
 
     module Helpers #{{{
-      def load_testset(tdoc,cpee) #{{{
+      def load_testset(tdoc,cpee,name=nil) #{{{
         ins = -1
         XML::Smart.string(tdoc) do |doc|
           doc.register_namespace 'desc', 'http://cpee.org/ns/description/1.0'
@@ -32,6 +32,12 @@ module CPEE
 
           srv = Riddl::Client.new(cpee, cpee + "?riddl-description")
           res = srv.resource("/")
+          if name
+            doc.find("/testset/attributes/prop:info").each do |e|
+              e.text = name
+            end
+          end
+
           status, response = res.post Riddl::Parameter::Simple.new("info",doc.find("string(/testset/attributes/prop:info)"))
 
           if status == 200
@@ -129,19 +135,19 @@ module CPEE
 
       def response
         cpee = @a[0]
-        status, res = Riddl::Client.new(@p[1].value).get
+        status, res = Riddl::Client.new(@p[2].value).get
         tdoc = if status >= 200 && status < 300
           res[0].value.read
         else
           (@status = 500) && return
         end
 
-        if (instance = load_testset(tdoc,cpee)) == -1
+        if (instance = load_testset(tdoc,cpee,@p[0].value)) == -1
           @status = 500
         else
-          handle_data cpee, instance, @p[2]&.value
-          handle_waiting cpee, instance, @p[0].value
-          handle_starting cpee, instance, @p[0].value
+          handle_data cpee, instance, @p[3]&.value
+          handle_waiting cpee, instance, @p[1].value
+          handle_starting cpee, instance, @p[1].value
           return Riddl::Parameter::Simple.new("url",cpee + instance)
         end
       end

data/lib/instantiation.xml

@@ -18,6 +18,7 @@
     </optional>
   </message>
   <message name="url">
+    <parameter name="info" type="string"/>
     <parameter name="behavior" type="string">
       <choice>
         <value>fork_ready</value>

data/log/elasticsearch.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby
+require 'pp'
+require 'json'
+require 'yaml'
+require 'rubygems'
+require 'riddl/server'
+require 'riddl/utils/fileserve'
+require 'json'
+require 'time'
+
+require 'faraday'
+require 'elasticsearch'
+require 'logger'
+
+class Logging < Riddl::Implementation #{{{
+  def doc(topic,event_name,esc,template,instancenr,notification)
+    uuid = notification['instance_uuid']
+    return unless uuid
+
+    activity = notification['activity']
+    parameters = notification['parameters']
+    receiving = notification['received']
+
+    log = YAML::load(File.read(template))
+    log["log"]["trace"]["concept:name"] ||= instancenr.to_i
+    log["log"]["trace"]["cpee:name"] ||= notification['instance_name'] if notification["instance_name"]
+    log["log"]["trace"]["cpee:uuid"] ||= notification['instance_uuid'] if notification["instance_uuid"]
+    unless esc.indices.exists? index: 'trace'
+      esc.indices.create index: 'trace', body: {
+        "mappings" => {
+          "entry" => {
+            "properties" => {
+              "concept:name" => {
+                "type" => "integer"
+              },
+              "cpee:name" => {
+                "type" => "text"
+              },
+              "cpee:uuid": {
+                "type" => "text"
+              }
+            }
+          }
+        }
+      }
+    end
+
+    esc.index  index: 'trace', type: 'entry', id: log["log"]["trace"]["cpee:uuid"], body: log["log"]["trace"]
+    p notification['attributes']
+
+    event = {}
+    event["trace:id"] = instancenr
+    event["concept:name"] = notification["label"] if notification["label"]
+    if notification["endpoint"]
+      event["concept:endpoint"] = notification["endpoint"]
+    end
+    event["id:id"] = (activity.nil? || activity == "") ? 'external' : activity
+    event["cpee:uuid"] = notification['instance_uuid'] if notification["instance_uuid"]
+    case event_name
+      when 'receiving', 'change'
+        event["lifecycle:transition"] = "unknown"
+      when 'done'
+        event["lifecycle:transition"] = "complete"
+      else
+        event["lifecycle:transition"] = "start"
+    end
+    event["cpee:lifecycle:transition"] = "#{topic}/#{event_name}"
+    data_send = ((parameters["arguments"].nil? ? [] : parameters["arguments"]) rescue [])
+    event["list"] = {"data_send" => data_send} unless data_send.empty?
+    if notification['changed']&.any?
+      if event.has_key? "list"
+        event["list"]["data_changed"] ||= notification['changed']
+      else
+        event["list"] = {"data_changer" => notification['changed']}
+      end
+    end
+    if notification['values']&.any?
+      if event.has_key? "list"
+        event["list"]["data_values"] ||= notification['values']
+      else
+        event["list"] = {"data_values" => notification['values']}
+      end
+    end
+    if receiving&.any?
+      if event.has_key? "list"
+        event["list"]["data_received"] ||= receiving
+      else
+        event["list"] = {"data_receiver" => receiving}
+      end
+    end
+    event["time:timestamp"]= Time.now.iso8601
+
+    iname = "instance_" + notification['instance_name'].downcase.gsub(/[^a-z]/,'_')
+    esc.indices.create index: iname rescue nil
+    esc.index  index: iname, type: 'entry', body: event
+    nil
+  end
+
+  def response
+    topic        = @p[1].value
+    event_name   = @p[2].value
+    esc          = @a[0]
+    template     = @a[1]
+    instancenr   = @h['CPEE_INSTANCE'].split('/').last
+    notification = JSON.parse(@p[3].value)
+    doc topic, event_name, esc, template, instancenr, notification
+  end
+end #}}}
+
+Riddl::Server.new(File.join(__dir__,'/log.xml'), :host => 'localhost', :port => 9307) do
+  accessible_description true
+  cross_site_xhr true
+  @riddl_opts[:template] ||= File.join(__dir__,'template.xes_yaml')
+	@riddl_opts[:esc] = Elasticsearch::Client.new hosts: ['localhost:8400']
+
+
+  interface 'events' do
+	  run Logging, @riddl_opts[:esc], @riddl_opts[:template] if post 'event'
+  end
+end.loop!

data/log/logs/1/test

@@ -0,0 +1 @@
+test

data/log/xes_yaml.rb

@@ -26,10 +26,9 @@ class Logging < Riddl::Implementation #{{{
     event["concept:name"] = notification["label"] if notification["label"]
     if notification["endpoint"]
       event["concept:endpoint"] = notification["endpoint"]
-    else
-      event["concept:name"] = 'Script Task'
     end
-    event["id:id"] = activity
+    event["id:id"] = (activity.nil? || activity == "") ? 'external' : activity
+    event["cpee:uuid"] = notification['instance_uuid'] if notification["instance_uuid"]
     case event_name
       when 'receiving', 'change'
         event["lifecycle:transition"] = "unknown"
@@ -66,25 +65,9 @@ class Logging < Riddl::Implementation #{{{
     File.open(File.join(log_dir,uuid+'.xes.yaml'),'a') do |f|
       f << {'event' => event}.to_yaml
     end
+    nil
   end
 
-	def rec_unjson(value,list,key)
-		case value
-			when Array then
-				li = list.add 'list', :key => key
-				value.each_with_index do |v,k|
-					rec_unjson(v,li,k)
-				end
-			when Hash then
-				li = list.add 'list', :key => key
-				value.each do |k,v|
-					rec_unjson(v,li,k)
-				end
-			else
-				list.add 'string', :key => key, :value => value
-		end
-	end
-
   def response
     topic        = @p[1].value
     event_name   = @p[2].value

data/server/handlerwrappers/default.rb

@@ -46,7 +46,7 @@ class DefaultHandlerWrapper < WEEL::HandlerWrapperBase
 
   def activity_handle(passthrough, parameters) # {{{
     @label = parameters[:label]
-    @controller.notify("activity/calling", :instance => @controller.instance, :instance_uuid => @controller.uuid, :label => @label, :instance_name => @controller.info, :activity => @handler_position, :passthrough => passthrough, :endpoint => @handler_endpoint, :parameters => parameters, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+    @controller.notify("activity/calling", :instance => @controller.instance, :instance_uuid => @controller.uuid, :label => @label, :instance_name => @controller.info, :activity => @handler_position, :passthrough => passthrough, :endpoint => @handler_endpoint, :parameters => parameters, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
     if passthrough.nil?
       params = []
       callback = Digest::MD5.hexdigest(Kernel::rand().to_s)
@@ -65,7 +65,7 @@ class DefaultHandlerWrapper < WEEL::HandlerWrapperBase
       params << Riddl::Header.new("CPEE-ACTIVITY",@handler_position)
       params << Riddl::Header.new("CPEE-LABEL",parameters[:label]||'')
       @controller.attributes.each do |key,value|
-        params << Riddl::Header.new("CPEE-ATTR-#{key.gsub(/_/,'-')}",value)
+        params << Riddl::Header.new("CPEE-ATTR-#{key.to_s.gsub(/_/,'-')}",value)
       end
 
       type = parameters[:method] || 'post'
@@ -107,28 +107,28 @@ class DefaultHandlerWrapper < WEEL::HandlerWrapperBase
   end # }}}
 
   def inform_activity_done # {{{
-    @controller.notify("activity/done", :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+    @controller.notify("activity/done", :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
   end # }}}
   def inform_activity_manipulate # {{{
-    @controller.notify("activity/manipulating", :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+    @controller.notify("activity/manipulating", :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
   end # }}}
   def inform_activity_failed(err) # {{{
     puts err.message
     puts err.backtrace
-    @controller.notify("activity/failed", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :message => err.message, :line => err.backtrace[0].match(/(.*?):(\d+):/)[2], :where => err.backtrace[0].match(/(.*?):(\d+):/)[1], :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+    @controller.notify("activity/failed", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :message => err.message, :line => err.backtrace[0].match(/(.*?):(\d+):/)[2], :where => err.backtrace[0].match(/(.*?):(\d+):/)[1], :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
   end # }}}
   def inform_manipulate_change(status,changed_dataelements,changed_endpoints,dataelements,endpoints) # {{{
     unless status.nil?
       @controller.serialize_status!
-      @controller.notify("status/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :id => status.id, :message => status.message)
+      @controller.notify("status/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :id => status.id, :message => status.message, :attributes => @controller.attributes_translated)
     end
     unless changed_dataelements.nil?
       @controller.serialize_dataelements!
-      @controller.notify("dataelements/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_dataelements, :values => dataelements)
+      @controller.notify("dataelements/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_dataelements, :values => dataelements, :attributes => @controller.attributes_translated)
     end
     unless changed_endpoints.nil?
       @controller.serialize_endpoints!
-      @controller.notify("endpoints/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_endpoints, :values => endpoints)
+      @controller.notify("endpoints/change", :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_endpoints, :values => endpoints, :attributes => @controller.attributes_translated)
     end
   end # }}}
 
@@ -197,12 +197,12 @@ class DefaultHandlerWrapper < WEEL::HandlerWrapperBase
   end
 
   def callback(result=nil,options={})
-    @controller.notify("activity/receiving", :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :received => structurize_result(result), :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+    @controller.notify("activity/receiving", :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :received => structurize_result(result), :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
     result = simplify_result(result)
     if options['CPEE_UPDATE']
       @handler_returnValue = result
       if options['CPEE_UPDATE_STATUS']
-        @controller.notify("activity/status", :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :status => options['CPEE_UPDATE_STATUS'], :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
+        @controller.notify("activity/status", :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :status => options['CPEE_UPDATE_STATUS'], :time=>Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
       end
       @handler_continue.continue WEEL::Signal::Again
     else