omf_rc_shm 0.1.7 → 0.1.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODIxMDgzNTk2ZmViYzBlNDViZDVhNTBlZTIwN2NlODQ2ZWI0ZWRmMw==
+    MmNiYWI3NTM2N2I0ZGRiMDNhZDc2MTY2ODM2MzM5ZTQ0YjgxMDBlMA==
   data.tar.gz: !binary |-
-    MmJiMDE0Yzk0MTA0Mzc1ZjM2NzhhMzM2YjJhZGI2NjI5ZjMxYTM5Yg==
+    MWMzN2M1OWQyNzJlOGE3NGNmNDVhMWI1YWE5NWM1NGU4YmU4MWM3Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    M2ZmNzI5MjNjZDM3MDI2NjhhNWNjMjE0ZmI3OTBhODU2NDJmNDFjNDcwOTZi
-    YTQxOWM4MDMxNzQ4Mjk1NjA5ZTgxYzQwNzIwNGY4YjVhOWFmMWM0ODIxNGQz
-    ZDVlZDAwYTc4N2RlMmFhYWJjMWI0NjlkM2YxNTQ1OWVlODMyZmE=
+    ZmY2ZjdhZjhmNTVlNTg0Y2QzMzVjZTFiMGY3NDBmODY3MTk3N2Y4NzNjMjU4
+    ZWMwZmIxYTQzZjU4ODkyNTI4OGZmZmZlMGJhMmFiNDJiZjMxYWE2MDMwMDBj
+    YmUxYWU0M2E3OGFhZTQ3MjM4ZDgyODBmNjc1ZWNhZjVkMDFhNDQ=
   data.tar.gz: !binary |-
-    YmIzNmI4ZTc4ODMyMDEwNmI5YjJiMTA1ZWJjMGFhNzUwM2I2OTExNmY3MWQz
-    YzgxMWM3MDQyMDlkY2IxOThhYjMxZTQ1ZjhkYzUwYzlmMDllZWI2NGJhYjBh
-    M2Q5NWE0NmY3YWNhMWFiYjNiNTk1NTU2NDE5YzhlZDFmN2I2MWQ=
+    MWQ4NjJhYzU5ODBjNDE4MWVkNjQ1NDRlNmM2NDBjMDdlNDM0NDlhOTY1YTQ1
+    OTFhYTg3YWZmODYwNDIxYmI5NWQ4OTNkZjZiNmNhOTljNmRjM2Q5MDk3ODRk
+    ZTM3OGE2YzYzMWIxN2M2OTMyMjk3Yjg4YTlkNDhlMmY0MDJmMWI=

data/README.md

@@ -1,80 +1,91 @@
 # OmfRcShm
 
-An extension to OmfRc provides support for structure health monitoring project
+An extension to the OMF RC, which provides support for the Structure Health Monitoring (SHM) project.
 
 ## Installation
 
 Install it as:
 
-    $ gem install omf_rc_shm
+    $ gem install omf_rc_shm --no-ri --no-rdoc
+
+(if the above command returns that it cannot download data from https://rubygems.org, then try again with the additional option `--source http://rubygems.org` and discard any subsequent SSL warning)
 
 Setup startup script
 
     $ install_omf_rc -c -i
 
-Configure OmfRc to load SHM extension, simply modify '/etc/omf_rc/config.yml' to something like this:
+This installs a generic OMF RC configuration file in `/etc/omf_rc/config.yml`, you should modify it following the [SHM-specific configuration example](config/config.yml):
 
     ---
-    :uri: xmpp://<%= "#{Socket.gethostname}-#{Process.pid}" %>:<%= "#{Socket.gethostname}-#{Process.pid}" %>@srv.mytestbed.net
+    :uri: local://local
     :environment: production
+    :debug: false
 
     :resources:
     - :type: shm_node
-      :uid: <%= Socket.gethostname %>
-      :app_definition_file: <path_to_app_definition_file>
+      :uid: <%= ip = `ifconfig br0`.match(/inet addr:(\d*\.\d*\.\d*\.\d*)/)[1].split('.') ; 'node' + (ip[2].to_i*256+ip[3].to_i).to_s.rjust(4,'0') %>
+      :app_definition_file: /etc/omf_rc/scheduled_app.rb
+      :ruby_path: /usr/local/bin/ruby
+      :watchdog_timer: 15
+
     :add_default_factories: false
     :factories:
     - :require: omf_rc_shm
 
+Where
+
+ * `:uri:` is the URI for the communication scheme to use, e.g. `local://local` (= no communication) or `xmpp://user:password@some.xmpp.server` (= use XMPP server at some.xmpp.server)
+ * `:uid:` is the ID given to this resource (e.g. the above example constructs an ID similar to 'node1234' based on the IP address of the 'br0' interface)
+ * `:app_definition_file:` is the path to the file with the default application schedule
+ * `:ruby_path:` where to find the ruby binary
+ * `:watchdog_timer:` number of second between each watchdog timer top-up (comment that parameter to disable the watchdog timer)
+
 ## Define applications
 
-app_definition_file for shm_node simply defines the applications it runs.
+The default schedule for the applications to run is in a file located at the path assigned to the above `:app_definition_file:` parameter. You should create such a file following the [default application schedule example](config/scheduled_app.rb):
 
 Example:
 
-    App.define(
-      "otr2", {
-        schedule: "* * * * *",
-        timeout: 20,
-        binary_path: "/usr/bin/otr2",
-        use_oml: true,
-        parameters: {
-          udp_local_host: { cmd: "--udp:local_host", value: "0.0.0.0" }
-        },
-        oml: {
-          experiment: "otr2_#{Time.now.to_i}",
-          id: "otr2",
-          available_mps: [
-            {
-              mp: "udp_in",
-              fields: [
-                { field: "flow_id", type: :long },
-                { field: "seq_no", type: :long },
-                { field: "pkt_length", type: :long },
-                { field: "dst_host", type: :string },
-                { field: "dst_port", type: :long }
-              ]
-            }
-          ],
-          collection: [
-            {
-              url: "tcp://0.0.0.0:3003",
-              streams: [
-                {
-                  mp: "udp_in",
-                  interval: 3
-                }
-              ]
-            }
-          ]
-        }
+    defApplication("my_app_name") do |a|
+      a.binary_path = "/usr/bin/my_app"
+      a.schedule = "*/5 * * * *"
+      a.timeout = 20
+      a.parameters = {
+        udp_target_host: { cmd: "--udp-target", value: "0.0.0.0", mandatory: true }
       }
-    )
+      a.use_oml = true
+      a.oml = {
+        experiment: "my_experiment_#{Time.now.to_i}",
+        id: "some_ID",
+        collection: [
+          {
+            url: "tcp:0.0.0.0:3003",
+            streams: [
+              {
+                mp: "udp_in", samples: 1
+              }
+            ]
+          }
+        ]
+      }
+    end
+
+Where
 
+ * `binary_path` is local path to the application's binary
+ * `schedule` is the definition of the schedule to run the application on. It can be either the string 'now' (= run this application as soon as possible) or a cron-type formatted schedule (see [crontab manual](http://www.google.com/search?q=man+crontab))
+ * `timeout` the time in second after which the application should be stopped, set to 0 to let the application stop by itself
+ * `parameters` the list of command line parameters that this application accepts, see the [OMF Documentation](https://github.com/mytestbed/omf/blob/master/doc/APPLICATION_PROXY.mkd#parameter-properties) for more detail
+ * `use_oml` enable OML instrumentation
+ * `oml` OML instrumentation parameters, see the [OML Config Documentation](http://omf.mytestbed.net/doc/oml/latest/liboml2.conf.5) for more detail. NOTE: if the sub-parameter `id:` is missing, the `:uid:` for this resource will be used by default, as requested by the SHM team.
+
+Additional definition for application to be schedule may be added following the above definition in the same file.
 
 ## Usage
 
-OmfRc with SHM extension should start up automatically during boot.
+The RC with SHM extension should start up automatically during boot.
+
+However, if you need to start it manually you may use the command `omf_rc -c <path_to_config_file>`
 
 ## Contributing
 

data/config/config.yml

@@ -0,0 +1,29 @@
+# Use this with standard omf_rc
+---
+# URI to the communication system
+# - local://local for no oustide communication
+# - xmpp://user:password@some.xmpp.server to use XMPP communication via 
+#   some.xmpp.server, using the specified user and password 
+:uri: local://local
+:environment: production
+:debug: false
+
+:resources:
+- :type: shm_node
+  # ID to give to this SHM node
+  # by default construct 'node1234' ID based on IP address of the br0 interface
+  # as requested by the SHM team
+  :uid: <%= ip = `ifconfig br0`.match(/inet addr:(\d*\.\d*\.\d*\.\d*)/)[1].split('.') ; 'node' + (ip[2].to_i*256+ip[3].to_i).to_s.rjust(4,'0') %>
+  # Path to the file with the default application schedule
+  :app_definition_file: /etc/omf_rc/scheduled_app.rb
+  # Path to find the Ruby binary
+  :ruby_path: /usr/local/bin/ruby
+  # The top-up value in second for the watchdog timer (must be lower than timeout value)
+  # Comment that line to disable the watchdog timer
+  :watchdog_timer: 15
+
+:add_default_factories: false # Not loading default type factories
+
+:factories: # Additional resources which can be created by this RC
+- :require: omf_rc_shm
+

data/config/scheduled_app.rb

@@ -0,0 +1,23 @@
+defApplication("my_app_name") do |a|
+  a.binary_path = "/usr/bin/my_app"
+  a.schedule = "*/5 * * * *"
+  a.timeout = 20
+  a.parameters = {
+    udp_target_host: { cmd: "--udp-target", value: "0.0.0.0", mandatory: true }
+  }
+  a.use_oml = true
+  a.oml = {
+    experiment: "my_experiment_#{Time.now.to_i}",
+    id: "some_ID",
+    collection: [
+      {
+        url: "tcp:0.0.0.0:3003",
+        streams: [
+          {
+            mp: "udp_in", samples: 1
+          }
+        ]
+      }
+    ]
+  }
+end

data/lib/omf_rc/resource_proxy/scheduled_application.rb

@@ -32,6 +32,7 @@
 #       - :experiment (String) name of the experiment in which this application
 #           is scheduled
 #       - :id (String) OML id to use for this application when it is scheduled
+#           if nil, then use this application's parent id
 # - parameters (Hash) the command line parameters available for this app.
 #   This hash is of the form: { :param1 => attribut1, ... }
 #   with param1 being the id of this parameter for this Proxy and
@@ -82,7 +83,6 @@ module OmfRc::ResourceProxy::ScheduledApplication
   MAX_PARAMETER_NUMBER = 1000
   DEFAULT_MANDATORY_PARAMETER = false
 
-  property :ruby_path
   property :app_id, :default => nil
   property :description, :default => ''
   property :binary_path, :default => nil
@@ -104,6 +104,8 @@ module OmfRc::ResourceProxy::ScheduledApplication
   property :file_change_callback, :default => nil
   property :file_read_offset, :default => {}
   property :app_log_dir, :default => '/tmp/omf_scheduled_app'
+  property :ruby_path
+  property :parent_id
 
   # @!macro group_hook
   #
@@ -285,6 +287,7 @@ module OmfRc::ResourceProxy::ScheduledApplication
     if res.property.state == :scheduled
       info "Removing cron job for '#{res.property.app_id}'"
       CronEdit::Crontab.Remove res.property.app_id
+      restart_cron = `/etc/init.d/cron restart` # Vixie Cron on Angstrom requires restart!
       pid_file = "#{res.property.app_log_dir}/#{res.property.app_id}.pid.log"
       File.readlines(pid_file).each do |line|
         begin
@@ -319,9 +322,9 @@ module OmfRc::ResourceProxy::ScheduledApplication
           res.property.schedule = t.strftime("%-M %-H %-d %-m *")
         end
         Dir.mkdir(res.property.app_log_dir) if !Dir.exist?(res.property.app_log_dir)
-        stderr_file = "#{res.property.app_log_dir}/#{res.property.app_id}.err.log"
-        stdout_file = "#{res.property.app_log_dir}/#{res.property.app_id}.out.log"
-        pid_file = "#{res.property.app_log_dir}/#{res.property.app_id}.pid.log"
+        stderr_file = "#{res.property.app_log_dir}/#{res.property.app_id}.#{res.uid}.err.log"
+        stdout_file = "#{res.property.app_log_dir}/#{res.property.app_id}.#{res.uid}.out.log"
+        pid_file = "#{res.property.app_log_dir}/#{res.property.app_id}.#{res.uid}.pid.log"
         File.delete(stderr_file) if File.exist?(stderr_file)
         File.delete(stdout_file) if File.exist?(stdout_file)
         File.delete(pid_file) if File.exist?(pid_file)
@@ -334,6 +337,7 @@ module OmfRc::ResourceProxy::ScheduledApplication
         info "Adding cron job for '#{res.property.app_id}' with schedule '#{res.property.schedule}' and command '#{cmd}'"
 
         CronEdit::Crontab.Add res.property.app_id, "#{res.property.schedule} #{cmd}"
+        restart_cron = `/etc/init.d/cron restart` # Vixie Cron on Angstrom requires restart!
         res.property.file_change_callback = Proc.new do |modified, added, removed|
           removed.each do |file|
             res.property.file_read_offset[file]=nil
@@ -348,13 +352,14 @@ module OmfRc::ResourceProxy::ScheduledApplication
                 event_type = "STDOUT"
                 if file.include? ".err.log"
                   event_type = "STDERR"
-                  if line.include? "exited with code:"
+                  if line.include? "exited with status:"
                     if line.split(":").last.to_i == 0
                       event_type = "DONE.OK"
                     else
                       event_type = "DONE.ERROR"
                     end
                   end
+                  event_type = "DONE.OK" if line.include? "killed by signal:"
                 end
                 res.process_event(res, event_type, res.property.app_id, line)
               end
@@ -509,7 +514,8 @@ module OmfRc::ResourceProxy::ScheduledApplication
       o = res.property.oml
       ofile = "/tmp/#{res.uid}-#{Time.now.to_i}.xml"
       of = File.open(ofile,'w')
-      of << "<omlc experiment='#{o.experiment}' id='#{o.id}'>\n"
+      oid = o.id.nil? ? res.property.parent_id : o.id
+      of << "<omlc experiment='#{o.experiment}' id='#{oid}'>\n"
       o.collection.each do |c|
         of << "  <collect url='#{c.url}'>\n"
         c.streams.each do |m|

data/lib/omf_rc/resource_proxy/shm_node.rb

@@ -19,7 +19,7 @@ module OmfRc::ResourceProxy::ShmNode
 
     OmfRcShm.app.definitions.each do |name, app_opts|
       info "Got definition #{app_opts.inspect}, now schedule them..."
-      opts = app_opts.properties.merge(hrn: name, ruby_path: node.property.ruby_path)
+      opts = app_opts.properties.merge(hrn: name, ruby_path: node.property.ruby_path, parent_id: node.uid)
       s_app = OmfRc::ResourceFactory.create(:scheduled_application, opts)
       OmfCommon.el.after(5) do
         s_app.configure_state(:scheduled)

data/lib/omf_rc_shm/version.rb

@@ -1,3 +1,3 @@
 module OmfRcShm
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omf_rc_shm
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,8 +108,8 @@ files:
 - README.md
 - Rakefile
 - bin/cronjob_app_wrapper
-- config/rc.yml.sample
-- config/test.rb
+- config/config.yml
+- config/scheduled_app.rb
 - lib/omf_rc/resource_proxy/scheduled_application.rb
 - lib/omf_rc/resource_proxy/shm_node.rb
 - lib/omf_rc_shm.rb

data/config/rc.yml.sample

@@ -1,20 +0,0 @@
-# Use this with standard omf_rc
----
-:uri: local://local
-:environment: development
-:debug: false
-
-:resources:
-- :type: shm_node
-  :uid: <%= ip = `ifconfig br0`.match(/inet addr:(\d*\.\d*\.\d*\.\d*)/)[1].split('.') ; 'node' + (ip[2].to_i*256+ip[3].to_i).to_s.rjust(4,'0') %>
-  :app_definition_file: path_to_your_app_definition_file
-  :ruby_path: <full_path_to_ruby>
-  # Uncomment :watchdog_timer line to start the watchdog time, set the top-up
-  # value in second (make sure to have it lower than timeout value)
-  #:watchdog_timer: 15
-
-:add_default_factories: false # Not loading default type factories
-
-:factories: # Additional resources which can be created by this RC
-- :require: omf_rc_shm
-

data/config/test.rb

@@ -1,25 +0,0 @@
-defApplication("otr2") do |a|
-  a.schedule = "* * * * *"
-  a.timeout = 20
-  a.binary_path = "/usr/bin/otr2"
-  a.use_oml = true
-  a.parameters = {
-    udp_local_host: { cmd: "--udp:local_host", value: "0.0.0.0" }
-  }
-  a.oml = {
-    experiment: "otr2_#{Time.now.to_i}",
-    id: "otr2",
-    collection: [
-      {
-        url: "tcp:0.0.0.0:3003",
-        streams: [
-          {
-            mp: "udp_in",
-            interval: 3
-          }
-        ]
-      }
-    ]
-  }
-end
-