cpee-logging-xes-yaml 1.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da7a05239a1da8c1c5385237edd86c5e416d5890547fd887fa58afcec6964e0f
-  data.tar.gz: 4af562158950e42d15f8ae2cc109849785601f1f8a13b75714f8f4769f8de584
+  metadata.gz: d2a0520ca3fb6ff780ca51eebf84811e8c9fd4df9a111fed58b09ebe63ac747f
+  data.tar.gz: 4aa2bb2e70e7944cb41155983dc39651b599ee263c7e2c8d2176b1fa40586741
 SHA512:
-  metadata.gz: a05b38fe0f0e2626130393e87d210c9fbe2312583dd1aa9c56953696cbed4d31a59a6989c2e8bab050dac150ef2fefbf87c6dfef6662a245333da5cb9222bcb7
-  data.tar.gz: c79d798d6a1aa42e4731a8feb637a49027811d7a7509bb47c0ae1af5b2dc1c6b2cf67f8af100e78715fe4506ba9ab92cb6939f54691991dca40ba6e8f1e8d2c0
+  metadata.gz: 7e403723fe26acf2b0588db4ecb18e7577cbb57572b2ca38224e0c8bdec7b753ef366142b1b9ae599921c15ab53e8d73cb36d822af2b112054249538cd3781b7
+  data.tar.gz: e681120976fbe6308dafbc824eb0fc5787219f071666fe10291d27f98318bed20c584aab4a408f4a23811f4411f08192f4a955ca0ca4f20ccc500628abb1afba

data/README.md

@@ -20,7 +20,7 @@ or many of the following yaml keys:
  :log_dir: /var/log/cpee
 ```
 
-To connec the cpee to the log, one of two things can be done: (1) add a handler to
+To connect the cpee to the log, one of two things can be done: (1) add a handler to
 a testset/template:
 
 ```xml
@@ -31,6 +31,8 @@ a testset/template:
       <events topic="endpoints">change</events>
       <events topic="attributes">change</events>
       <events topic="task">instantiation</events>
+      <events topic="description">change</events>
+      <events topic="state">change</events>
     </handler>
   </handlers>
 ```
@@ -46,7 +48,7 @@ Riddl::Server.new(CPEE::SERVER, options) do
 end.loop!
 ```
 
-to the server (or alternatively to a log.conf with :notification_init
+to the server (or alternatively to a cpee.conf with :notification_init
 beeing a top-level yaml key). Then add a subscription file to
 notifications/logging/subscription.xml
 
@@ -66,6 +68,12 @@ notifications/logging/subscription.xml
   <topic id="attributes">
     <event>change</event>
   </topic>
+  <topic id="description">
+    <event>change</event>
+  </topic>
+  <topic id="state">
+    <event>change</event>
+  </topic>
   <topic id="task">
     <event>instantiation</event>
   </topic>

data/cpee-logging-xes-yaml.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee-logging-xes-yaml"
-  s.version          = "1.0"
+  s.version          = "1.0.4"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0"
   s.summary          = "Logging for the cloud process execution engine (cpee.org)"
@@ -15,12 +15,12 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>=2.4.0'
 
-  s.authors          = ['Juergen eTM Mangler']
+  s.authors          = ['Juergen eTM Mangler','Florian Stertz']
 
   s.email            = 'juergen.mangler@gmail.com'
   s.homepage         = 'http://cpee.org/'
 
   s.add_runtime_dependency 'riddl', '~> 0.99'
   s.add_runtime_dependency 'json', '~> 2.1'
-  s.add_runtime_dependency 'cpee', '~> 1', '>= 1.5'
+  s.add_runtime_dependency 'cpee', '~> 2.1', '>= 2.1.4'
 end

data/lib/cpee-logging-xes-yaml/logging.rb

@@ -61,6 +61,8 @@ module CPEE
             event["lifecycle:transition"] = "start"
         end
         event["cpee:lifecycle:transition"] = "#{topic}/#{event_name}"
+        event["cpee:state"] = content['state'] if content['state']
+        event["cpee:description"] = content['dslx'] if content['dslx']
         data_send = ((parameters["arguments"].nil? ? [] : parameters["arguments"]) rescue [])
         event["data"] = {"data_send" => data_send} unless data_send.empty?
         if content['changed']&.any?

data/tools/cpee-logging-xes-yaml

@@ -4,15 +4,18 @@ require 'rubygems'
 require 'optparse'
 require 'fileutils'
 require 'xml/smart'
+require 'yaml'
+require 'typhoeus'
+require 'stringio'
 
-def wrap(s, width=78, indent=18)
+def wrap(s, width=78, indent=18, extra_indent=4)
 	lines = []
 	line, s = s[0..indent-2], s[indent..-1]
   s.split(/\n/).each do |ss|
     ss.split(/[ \t]+/).each do |word|
       if line.size + word.size >= width
         lines << line
-        line = (" " * (indent)) + word
+        line = (" " * (indent + extra_indent)) + word
       else
         line << " " << word
       end
@@ -23,27 +26,88 @@ def wrap(s, width=78, indent=18)
 	return lines.join "\n"
 end
 
+def follow(fname,io,copy,deep=0)
+  if copy
+    File.write(File.basename(fname,'.xes.yaml') + '.xes.yaml',io.read)
+    io.rewind
+  end
+  YAML.load_stream(io) do |e|
+    if name = e.dig('log','trace','cpee:name')
+      puts " " * deep + name + " (#{File.basename(fname,'.xes.yaml')}) - #{e.dig('log','trace','concept:name')}"
+    end
+    if e.dig('event','concept:endpoint') == 'https://centurio.work/flow/start/url/' && e.dig('event','cpee:lifecycle:transition') == 'task/instantiation'
+      base = e.dig('event','data','data_receiver')
+      val = base.dig('CPEE-INSTANCE') rescue nil
+      if val.nil?
+        val = File.basename(base)
+      end
+      uuid = base.dig('CPEE-INSTANCE-UUID') rescue nil
+      unless uuid
+        res = Typhoeus.get(File.join('https://centurio.work/flow/engine/',val,'/properties/values/attributes/uuid/'))
+        if res.success?
+          uuid = XML::Smart.string(res.body).find('string(/*)')
+        end
+      end
+      react File.dirname(fname) + "/#{uuid}.xes.yaml",copy,deep + 2
+    end
+  end
+end
+
+def react(name,copy=false,deep=0)
+  if name.nil?
+    help
+  elsif name =~ /^https?:\/\//
+    res = Typhoeus.get(name)
+    if res.success?
+      file = Tempfile.new('sic')
+      file.write(res.body)
+      file.rewind
+      follow name, file, copy, deep
+      file.close
+      file.unlink
+    end
+  elsif File.exists? name
+    follow name, File.open(name), copy, deep
+  else
+    help
+  end
+end
+
+exname = File.basename($0)
+
 ARGV.options { |opt|
   opt.summary_indent = ' ' * 2
   opt.summary_width = 15
-  opt.banner = "Usage:\n#{opt.summary_indent}#{File.basename($0)} [DIR]\n"
+  opt.banner = "Usage:\n#{opt.summary_indent}#{exname} new [DIR] | view [URI] | copy [URI]\n"
   opt.on("Options:")
   opt.on("--help", "-h", "This text") { puts opt; exit }
 	opt.on("")
-  opt.on(wrap("[DIR]        scaffolds a sample logging service. Add a handler to a cpee instance to experience the pleasure."))
+  opt.on(wrap("new [DIR]         scaffolds a sample logging service. Add a handler to a cpee instance to experience the pleasure.",78,18,0))
+	opt.on("")
+  opt.on(wrap("view [DIR]        view the dependencies between processes and subprocesses.\nWorks for local and remote logs. Examples:\n#{exname} view https://cpee.org/log/123.xes.yaml\n#{exname} view https://cpee.org/log/a.xes.yaml > index.txt\n#{exname} view ~/log/logs/456.xes.yaml"))
+	opt.on("")
+  opt.on(wrap("copy [DIR]        copy dependent processes and subprocesses to the current\ndirectory. Works for local and remote logs. Examples:\n#{exname} copy https://cpee.org/log/123.xes.yaml\n#{exname} copy ~/log/logs/456.xes.yaml"))
   opt.parse!
 }
-if (ARGV.length != 1)
+if (ARGV.length != 2)
   puts ARGV.options
   exit
 else
-  p1 = ARGV[0]
+  command = ARGV[0]
+  dir = ARGV[1]
 end
 
-if !File.exists?(p1)
-  FileUtils.cp_r(File.join(curpath,'..','server'),p1)
-  FileUtils.mkdir(File.join(p1,'logs')) rescue nil
-
+if command == 'new'
+  if !File.exists?(dir)
+    FileUtils.cp_r(File.join(curpath,'..','server'),dir)
+    FileUtils.mkdir(File.join(dir,'logs')) rescue nil
+  else
+    puts 'Directory already exists.'
+  end
+elsif command == 'view'
+  react dir, false
+elsif command == 'copy'
+  react dir, true
 else
-  puts 'Directory already exists.'
+  puts ARGV.options
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cpee-logging-xes-yaml
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.4
 platform: ruby
 authors:
 - Juergen eTM Mangler
-autorequire: 
+- Florian Stertz
+autorequire:
 bindir: tools
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riddl
@@ -44,20 +45,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.1.4
 description: see http://cpee.org
 email: juergen.mangler@gmail.com
 executables:
@@ -76,12 +77,11 @@ files:
 - lib/cpee-logging-xes-yaml/template.xes_yaml
 - server/log
 - tools/cpee-logging-xes-yaml
-- tools/sic.rb
 homepage: http://cpee.org/
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Logging for the cloud process execution engine (cpee.org)
 test_files: []

data/tools/sic.rb

@@ -1,64 +0,0 @@
-#!/usr/bin/ruby
-require 'yaml'
-require 'typhoeus'
-require 'stringio'
-require 'xml/smart'
-
-def follow(fname,io,deep=0)
-  if ARGV[1] == 'copy'
-    File.write(File.basename(fname,'.xes.yaml') + '.xes.yaml',io.read)
-    io.rewind
-  end
-  YAML.load_stream(io) do |e|
-    if name = e.dig('log','trace','cpee:name')
-      puts " " * deep + name + " (#{File.basename(fname,'.xes.yaml')}) - #{e.dig('log','trace','concept:name')}"
-    end
-    if e.dig('event','concept:endpoint') == 'https://centurio.work/flow/start/url/' && e.dig('event','cpee:lifecycle:transition') == 'task/instantiation'
-      base = e.dig('event','data','data_receiver')
-      val = base.dig('CPEE-INSTANCE') rescue nil
-      if val.nil?
-        val = File.basename(base)
-      end
-      uuid = base.dig('CPEE-INSTANCE-UUID') rescue nil
-      unless uuid
-        res = Typhoeus.get(File.join('https://centurio.work/flow/engine/',val,'/properties/values/attributes/uuid/'))
-        if res.success?
-          uuid = XML::Smart.string(res.body).find('string(/*)')
-        end
-      end
-      react File.dirname(fname) + "/#{uuid}.xes.yaml",deep + 2
-    end
-  end
-end
-
-def react(name,deep=0)
-  if name.nil?
-    help
-  elsif name =~ /^https?:\/\//
-    res = Typhoeus.get(name)
-    if res.success?
-      file = Tempfile.new('sic')
-      file.write(res.body)
-      file.rewind
-      follow name, file, deep
-      file.close
-      file.unlink
-    end
-  elsif File.exists? name
-    follow name, File.open(name), deep
-  else
-    help
-  end
-end
-
-def help
-  puts 'Views or copies log file trees to current directory.'
-  puts
-  puts '  View: sic.rb https://centurio.work/log/865916c6-2b18-4e9d-81d4-0fab0df248f4.xes.yaml'
-  puts '  Copy: sic.rb https://centurio.work/log/865916c6-2b18-4e9d-81d4-0fab0df248f4.xes.yaml copy'
-  puts '  Copy: sic.rb ~/Projects/cpee/log/logs/865916c6-2b18-4e9d-81d4-0fab0df248f4.xes.yaml copy'
-  puts '  View: sic.rb 865916c6-2b18-4e9d-81d4-0fab0df248f4.xes.yaml'
-  true
-end
-
-react(ARGV[0]) || help