omf_rc 6.0.0.pre.7 → 6.0.0.pre.8

data/bin/omf_rc

@@ -35,12 +35,16 @@ begin
     opts.on("-d", "--debug", "Debug mode") do
       options[:debug] = true
     end
+
+    opts.on("-l LOG_FILE_DIR", "Write log file to this folder") do |file_dir|
+      options[:log_file_dir] = file_dir
+    end
   end
 rescue => e
   # Right now OML4R does not raise proper exceptions :(
   # OML4R requires --oml-noop to be set if we want to run without doing any
   # measurements... this is too restrictive here, we want to run without OML
-  # if no OML parameters were set and this even if --oml-noop is not set. 
+  # if no OML parameters were set and this even if --oml-noop is not set.
   if e.message.include?('OML4R: Missing values for parameters :expID ')
     puts "Warning: Missing some OML options to instrument this RC, so it will "+
       "run without instrumentation. (see --oml-help)"
@@ -60,6 +64,14 @@ end
 Logging.logger.root.level = :debug if options[:debug]
 Blather.logger = logger
 
+if options[:log_file_dir] && File.exist?(options[:log_file_dir])
+  Logging.logger.root.add_appenders(
+    Logging.appenders.file(
+      "#{options[:log_file_dir]}/omf_rc.log",
+      :layout => Logging.layouts.pattern(:date_pattern => '%F %T %z',
+                                         :pattern => '[%d] %-5l %c: %m\n')))
+end
+
 OmfRc::ResourceFactory.load_default_resource_proxies
 
 EM.run do

data/lib/omf_rc/resource_proxy/abstract_resource.rb

@@ -7,7 +7,7 @@ require 'hashie'
 # This MP is for measurements about messages published by the Resource Proxy
 class OmfRc::ResourceProxy::MPPublished < OML4R::MPBase
   name :proxy_published
-  param :time, :type => :double # Time (s) when this message was published 
+  param :time, :type => :double # Time (s) when this message was published
   param :uid, :type => :string # UID for this Resource Proxy
   param :topic, :type => :string # Pubsub topic to publish this message to
   param :msg_id, :type => :string # Unique ID this message
@@ -17,7 +17,7 @@ end
 # This MP is for measurements about messages received by the Resource Proxy
 class OmfRc::ResourceProxy::MPReceived < OML4R::MPBase
   name :proxy_received
-  param :time, :type => :double # Time (s) when this message was received 
+  param :time, :type => :double # Time (s) when this message was received
   param :uid, :type => :string # UID for this Resource Proxy
   param :topic, :type => :string # Pubsub topic where this message came from
   param :msg_id, :type => :string # Unique ID this message
@@ -45,7 +45,7 @@ class OmfRc::ResourceProxy::AbstractResource
   # @option opts [String] :password pubsub user password
   # @option opts [String] :server pubsub server domain
   # @option opts [String] :property A hash for keeping internal state
-  # @option opts [hash] :instrument A hash for keeping instrumentation-related state  
+  # @option opts [hash] :instrument A hash for keeping instrumentation-related state
   # @param [Comm] comm communicator instance, pass this to new resource proxy instance if want to use a common communicator instance.
   def initialize(type, opts = nil, comm = nil)
     @opts = Hashie::Mash.new(opts)
@@ -66,7 +66,12 @@ class OmfRc::ResourceProxy::AbstractResource
       @comm.create_topic(uid) do |s|
         # Creating topic failed, no point to continue; clean up and disconnect
         # Otherwise go subscribe to this pubsub topic
-        s.error? ? disconnect : @comm.subscribe(uid)
+        if s.error?
+          warn "Could not create topic '#{uid}', will shutdown, trying to clean up old topics. Please start it again once it has been shutdown."
+          disconnect
+        else
+          @comm.subscribe(uid)
+        end
       end
     end
 
@@ -86,14 +91,18 @@ class OmfRc::ResourceProxy::AbstractResource
   # If method missing, try the property mash
   def method_missing(method_name, *args)
     if (method_name =~ /request_(.+)/)
-      property.key?($1) ? property.send($1) : (raise OmfRc::UnknownPropertyError)
+      property.key?($1) ? property.send($1) : (raise OmfRc::UnknownPropertyError, method_name.to_s)
     elsif (method_name =~ /configure_(.+)/)
-      property.key?($1) ? property.send("[]=", $1, *args) : (raise OmfRc::UnknownPropertyError)
+      property.key?($1) ? property.send("[]=", $1, *args) : (raise OmfRc::UnknownPropertyError, method_name.to_s)
     else
       super
     end
   end
 
+  def get_binding
+    binding
+  end
+
   # Connect to pubsub server
   def connect
     @comm.connect(opts.user, opts.password, opts.server)
@@ -101,17 +110,8 @@ class OmfRc::ResourceProxy::AbstractResource
 
   # Try to clean up pubsub topics, and wait for DISCONNECT_WAIT seconds, then shutdown event machine loop
   def disconnect
-    @comm.affiliations do |a|
-      my_pubsub_topics = a[:owner] ? a[:owner].size : 0
-      if my_pubsub_topics > 0
-        logger.info "Cleaning #{my_pubsub_topics} pubsub topic(s)"
-        a[:owner].each { |topic| @comm.delete_topic(topic) }
-      else
-        logger.info "Disconnecting now"
-        @comm.disconnect
-      end
-    end
-    logger.info "Disconnecting in #{DISCONNECT_WAIT} seconds"
+    @comm.disconnect(delete_affiliations: true)
+    logger.info "Disconnecting #{hrn}(#{uid}) in #{DISCONNECT_WAIT} seconds"
     EM.add_timer(DISCONNECT_WAIT) do
       @comm.disconnect
     end
@@ -137,15 +137,19 @@ class OmfRc::ResourceProxy::AbstractResource
   #
   def release(resource_id)
     obj = children.find { |v| v.uid == resource_id }
-    raise StandardError, "Resource #{resource_id} could not be found" if obj.nil?
+    if obj.nil?
+      warn "#{resource_id} does not belong to #{self.uid}(#{self.hrn})"
+      nil
+    else
+      # Release children resource recursively
+      obj.children.each do |c|
+        obj.release(c.uid)
+      end
+      obj.before_release if obj.respond_to? :before_release
 
-    # Release children resource recursively
-    obj.children.each do |c|
-      obj.release(c.uid)
+      @comm.delete_topic(obj.uid)
+      children.delete(obj)
     end
-    obj.before_release if obj.respond_to? :before_release
-
-    children.delete(obj)
   end
 
   # Return a list of all properties can be requested and configured
@@ -168,6 +172,14 @@ class OmfRc::ResourceProxy::AbstractResource
     hrn
   end
 
+  alias_method :request_name, :request_hrn
+  alias_method :name, :hrn
+  alias_method :name=, :hrn=
+
+  def request_type(*args)
+    type
+  end
+
   # Make hrn configurable through pubsub interface
   def configure_hrn(hrn)
     @hrn = hrn
@@ -180,13 +192,27 @@ class OmfRc::ResourceProxy::AbstractResource
   # @param [Array] name of group topics
   def configure_membership(*args)
     new_membership = [args[0]].flatten
-    @membership = new_membership
+    new_membership.each do |n_m|
+      @membership << n_m unless @membership.include?(n_m)
+    end
     @membership.each do |m|
-      @comm.subscribe(m)
+      @comm.subscribe(m) do |stanza|
+        if stanza.error?
+          warn "Group #{m} disappeared"
+          EM.next_tick do
+            @membership.delete(m)
+          end
+        end
+      end
     end
     @membership
   end
 
+  # Query resource's membership
+  def request_membership(*args)
+    @membership
+  end
+
   # Request child resources
   # @return [Hashie::Mash] child resource mash with uid and hrn
   def request_child_resources(*args)
@@ -303,25 +329,36 @@ class OmfRc::ResourceProxy::AbstractResource
       begin
         default_response = {
           operation: message.operation,
-          context_id: message.context_id,
+          context_id: message.msg_id,
           inform_to: inform_to_address(obj, message.publish_to)
         }
 
+        guard = message.read_element("guard").first
+
+        unless guard.nil? || guard.element_children.empty?
+          guard_check = guard.element_children.all? do |g|
+            obj.__send__("request_#{g.attr('key')}") == g.content.ducktype
+          end
+          next nil unless guard_check
+        end
+
         case message.operation
         when :create
-          new_opts = opts.dup.merge(uid: nil)
+          new_name = message.read_property(:name) || message.read_property(:hrn)
+          new_opts = opts.dup.merge(uid: nil, hrn: new_name)
           new_obj = obj.create(message.read_property(:type), new_opts)
           message.each_property do |p|
-            unless p.attr('key') == 'type'
+            unless %w(type hrn name).include?(p.attr('key'))
               method_name = "configure_#{p.attr('key')}"
-              new_obj.__send__(method_name, message.read_property(p.attr('key')))
+              p_value = message.read_property(p.attr('key'), new_obj.get_binding)
+              new_obj.__send__(method_name, p_value)
             end
           end
           new_obj.after_initial_configured if new_obj.respond_to? :after_initial_configured
           default_response.merge(resource_id: new_obj.uid)
         when :request, :configure
           result = Hashie::Mash.new.tap do |mash|
-            properties = message.read_element("//property")
+            properties = message.read_element("property")
             if message.operation == :request && properties.empty?
               obj.request_available_properties.request.each do |r_p|
                 method_name = "request_#{r_p.to_s}"
@@ -330,14 +367,18 @@ class OmfRc::ResourceProxy::AbstractResource
             else
               properties.each do |p|
                 method_name =  "#{message.operation.to_s}_#{p.attr('key')}"
-                mash[p.attr('key')] ||= obj.__send__(method_name, message.read_property(p.attr('key')))
+                p_value = message.read_property(p.attr('key'), obj.get_binding)
+                mash[p.attr('key')] ||= obj.__send__(method_name, p_value)
               end
             end
           end
+          # Always return uid
+          result.uid = obj.uid
           default_response.merge(status: result)
         when :release
           resource_id = message.resource_id
-          default_response.merge(resource_id: obj.release(resource_id).uid)
+          released_obj = obj.release(resource_id)
+          released_obj ? default_response.merge(resource_id: released_obj.uid) : nil
         when :inform
           nil # We really don't care about inform messages which created from here
         else
@@ -348,8 +389,8 @@ class OmfRc::ResourceProxy::AbstractResource
         end
       rescue => e
         if (e.kind_of? OmfRc::UnknownPropertyError) && (message.operation == :configure || message.operation == :request)
-          msg = "Cannot #{message.operation} unknown property "+
-            "'#{message.read_element("//property")}' for resource '#{type}'"
+          msg = "Cannot #{message.operation} unknown property '#{e.message}' for resource '#{obj.type}'. Original message fragment: " +
+            "'#{message.read_element("property")}'"
           logger.warn msg
           raise OmfRc::MessageProcessError.new(message.context_id, inform_to_address(obj, message.publish_to), msg)
         else

data/lib/omf_rc/resource_proxy/application.rb

@@ -20,7 +20,8 @@
 # THE SOFTWARE.
 
 #
-# This module defines a Resource Proxy (RP) for an Application
+# This module defines a Resource Proxy (RP) for an Application.
+# For a detailed usage tutorial see {file:doc/RESOURCE\_PROXY.mkd Resource Proxy tutorial}
 #
 # Utility dependencies: platform_toos, common_tools
 #
@@ -31,35 +32,35 @@
 # - pkg_ubuntu (String) the name of the Ubuntu package for this app
 # - pkg_fedora (String) the name of the Fedora package for this app
 # - state (String) the state of this Application RP
-#     (stop, run, pause, install)
+#   (stop, run, pause, install)
 # - installed (Boolean) is this application installed? (default false)
 # - force_tarball_install (Boolean) if true then force the installation
-#     from tarball even if other distribution-specific
-#     installation are available (default false)
+#   from tarball even if other distribution-specific installation are 
+#   available (default false)
 # - map_err_to_out (Boolean) if true then map StdErr to StdOut for this
-#     app (default false)
+#   app (default false)
 # - platform (Symbol) the OS platform where this app is running
-# - environment (Hash) the environment variables to set prior to starting 
-#     this app. {k1 => v1, ...} will result in "env -i K1=v1 ... "
-#     (with k1 being either a String or a Symbol)
+# - environment (Hash) the environment variables to set prior to starting
+#   this app. { k1 => v1, ... } will result in "env -i K1=v1 ... "
+#   (with k1 being either a String or a Symbol)
 # - use_oml (Boolean) if true enable OML for this application (default false)
 # - oml_loglevel (Integer) set a specific OML log level (default unset)
 # - oml_logfile (String) set a specific path for OML log file (default unset)
 # - oml_configfile (String) path of the OML config file (optional)
-# - oml (Hash) OML specific properties (optional), this Hash contains the 
-#     following keys:
-#       - :available_mps (Hash) list of available OML Measurement Points 
+# - oml (Hash) OML specific properties (optional), this Hash contains the
+#   following keys:
+#       - :available_mps (Array) list of available OML Measurement Points (Hash)
 #       - :collection (Hash) list of required OML Measurement Stream to collect
-#           when this application is running, as defined at
+#           when this application is running (defined in liboml2.conf manpage)
 #           http://omf.mytestbed.net/doc/oml/html/liboml2.conf.html
 #       - :experiment (String) name of the experiment in which this application
 #           is running
 #       - :id (String) OML id to use for this application when it is running
 # - 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
-#     with attribut1 being another Hash with the following possible
-#     keys and values (all are optional):
+#   This hash is of the form: { :param1 => attribut1, ... }
+#   with param1 being the id of this parameter for this Proxy and
+#   with attribut1 being another Hash with the following possible
+#   keys and values (all are optional):
 #     :cmd (String) the command line for this parameter
 #     :order (Fixnum) the appearance order on the command line, default FIFO
 #     :dynamic (Boolean) parameter can be dynammically changed, default false
@@ -87,7 +88,7 @@
 #     { :title => {:value => "My First Application"} }
 #
 module OmfRc::ResourceProxy::Application
-  include OmfRc::ResourceProxyDSL 
+  include OmfRc::ResourceProxyDSL
   require 'omf_common/exec_app'
 
   register_proxy :application
@@ -97,26 +98,28 @@ module OmfRc::ResourceProxy::Application
   MAX_PARAMETER_NUMBER = 1000
   DEFAULT_MANDATORY_PARAMETER = false
 
+  property :app_id, :default => nil
+  property :description, :default => ''
+  property :binary_path, :default => nil
+  property :platform, :default => nil
+  property :pkg_tarball, :default => nil
+  property :tarball_install_path, :default => '/'
+  property :force_tarball_install, :default => false
+  property :pkg_ubuntu, :default => nil
+  property :pkg_fedora, :default => nil
+  property :state, :default => :stop
+  property :installed, :default => false
+  property :map_err_to_out, :default => false
+  property :event_sequence, :default => 0
+  property :parameters, :default => Hash.new
+  property :environments, :default => Hash.new
+  property :use_oml, :default => false
+  property :oml_configfile, :default => nil
+  property :oml, :default => Hash.new
+  property :oml_logfile, :default => nil
+  property :oml_loglevel, :default => nil
+
   hook :before_ready do |res|
-    res.property.app_id ||= nil
-    res.property.binary_path ||= nil
-    res.property.platform ||= nil
-    res.property.pkg_tarball ||= nil
-    res.property.tarball_install_path ||= '/'
-    res.property.force_tarball_install ||= false
-    res.property.pkg_ubuntu ||= nil
-    res.property.pkg_fedora ||= nil
-    res.property.state ||= :stop
-    res.property.installed ||= false
-    res.property.map_err_to_out ||= false
-    res.property.event_sequence ||= 0
-    res.property.parameters ||= Hash.new
-    res.property.environments ||= Hash.new
-    res.property.use_oml ||= false
-    res.property.oml_configfile ||= nil
-    res.property.oml ||= Hash.new
-    res.property.oml_logfile ||= nil
-    res.property.oml_loglevel ||= nil
     define_method("on_app_event") { |*args| process_event(self, *args) }
   end
 
@@ -135,19 +138,24 @@ module OmfRc::ResourceProxy::Application
                   "(##{res.property.event_sequence}) - "+
                   "#{event_type}: '#{msg}'"
       res.property.state = :stop if event_type.to_s.include?('DONE')
-      res.comm.publish(res.uid,
-        OmfCommon::Message.inform('STATUS') do |message|
-          message.property('status_type' , 'APP_EVENT')
-          message.property('event' , event_type.to_s.upcase)
-          message.property('app' , app_id)
-          message.property('msg' , "#{msg}")
-          message.property('seq' , "#{res.property.event_sequence}")
-        end)
+
+      (res.membership + [res.uid]).each do |m|
+        res.inform(:status, {
+          inform_to: m,
+          status: { status_type: 'APP_EVENT',
+                    event: event_type.to_s.upcase,
+                    app: app_id,
+                    msg: msg,
+                    seq: res.property.event_sequence,
+                    uid: res.uid }
+        })
+      end
+
       res.property.event_sequence += 1
       res.property.installed = true if app_id.include?("_INSTALL") &&
                                        event_type.to_s.include?('DONE.OK')
   end
-  
+
   # Request the platform property of this Application RP
   # @see OmfRc::ResourceProxy::Application
   #
@@ -156,7 +164,7 @@ module OmfRc::ResourceProxy::Application
     res.property.platform.to_s
   end
 
-  # Configure the environments property of this Application RP
+  # Configure the environments and oml property of this Application RP
   # @see OmfRc::ResourceProxy::Application
   #
   %w(environments oml).each do |prop|
@@ -217,7 +225,7 @@ module OmfRc::ResourceProxy::Application
   #   application instance is finished or paused. The Application RP can
   #   only enter this state from a previous 'pause' or 'stop' state.
   # - pause: upon entering this state, the currently running instance of this
-  #   application should be paused (it is the responsibility of 
+  #   application should be paused (it is the responsibility of
   #   specialised Application Proxy to ensure that! The default
   #   Application Proxy does nothing to the application instance when
   #   entering this state). The Application RP can only enter this
@@ -451,17 +459,28 @@ module OmfRc::ResourceProxy::Application
   # - if the 'oml_configfile' property is set with a filename, then we use that
   #   file as the OML Configuration file. Thus we add the parameter
   #   "--oml-config filename" to this application's command line
-  # - if the 'oml' property is set with a Hash holding an OML configuration, 
+  # - if the 'oml' property is set with a Hash holding an OML configuration,
   #   then we write turn it into OML's XML configuration representation, write
-  #   it to a temporary file, and add the parameter "--oml-config tmpfile" to 
-  #   this application's command line. The OML configuration hash is based 
-  #   on the liboml2.conf man page here: 
-  #   http://omf.mytestbed.net/doc/oml/latest/liboml2.conf.html
+  #   it to a temporary file, and add the parameter "--oml-config tmpfile" to
+  #   this application's command line. The OML configuration hash is based
+  #   on the liboml2.conf man page, an example of which is:
+  #       <omlc domain="my_experiment" id="my_source_id">
+  #         <collect url="tcp://10.0.0.200">
+  #           <stream mp="radiotap" interval="2">
+  #             <filter field="sig_strength_dBm" />
+  #             <filter field="noise_strength_dBm" />
+  #             <filter field="power" />
+  #           </stream>
+  #           <stream mp="udp" samples="10">
+  #             <filter field="udp_len" />
+  #           </stream>
+  #         </collect>
+  #       </omlc>
   #
   # The 'oml_configfile' case takes precedence over the 'oml' case above.
   #
-  # Regardless of which case is performed, we will always set the 
-  # '--oml-log-level' and '--oml-log-file' parameter on the command line if 
+  # Regardless of which case is performed, we will always set the
+  # '--oml-log-level' and '--oml-log-file' parameter on the command line if
   # the corresponsding 'oml_logfile' and 'oml_loglevel' properties are set for
   # this application resource.
   #
@@ -490,16 +509,18 @@ module OmfRc::ResourceProxy::Application
           s = "interval='#{m.interval}'" if m.interval
           s = "samples='#{m.samples}'" if m.samples
           of << "    <stream mp='#{m.mp}' #{s}>\n"
-          m.filters.each do |f|
-            line = "      <filter field='#{f.field}' "
-            line += "operation='#{f.operation}' " unless f.operation.nil? 
-            line += "rename='#{f.rename}' " unless f.rename.nil? 
-            line += "/>\n" 
-            of << line           
+          unless m.filters.nil?
+            m.filters.each do |f|
+              line = "      <filter field='#{f.field}' "
+              line += "operation='#{f.operation}' " unless f.operation.nil?
+              line += "rename='#{f.rename}' " unless f.rename.nil?
+              line += "/>\n"
+              of << line
+            end
           end
           of << "    </stream>\n"
         end
-        of << "  </collect>\n"      
+        of << "  </collect>\n"
       end
       of << "</omlc>\n"
       of.close

data/lib/omf_rc/resource_proxy/net.rb

@@ -4,4 +4,5 @@ module OmfRc::ResourceProxy::Net
   register_proxy :net
 
   utility :ip
+  utility :sysfs
 end

data/lib/omf_rc/resource_proxy/node.rb

@@ -4,6 +4,7 @@ module OmfRc::ResourceProxy::Node
   register_proxy :node
 
   utility :mod
+  utility :sysfs
 
   request :proxies do
     OmfRc::ResourceFactory.proxy_list
@@ -21,35 +22,4 @@ module OmfRc::ResourceProxy::Node
     end.sort { |x, y| x[:name] <=> y[:name] }
   end
 
-  request :devices do |resource|
-    devices = []
-    # Support net devices for now
-    category = "net"
-
-    Dir.glob("/sys/class/net/eth*").each do |v|
-      File.exist?("#{v}/uevent") && File.open("#{v}/uevent") do |f|
-        subcategory = f.read.match(/DEVTYPE=(.+)/) && $1
-        proxy = "net"
-        File.exist?("#{v}/device/uevent") && File.open("#{v}/device/uevent") do |f|
-          driver = f.read.match(/DRIVER=(.+)/) && $1
-          device = { name: File.basename(v), driver: driver, category: category }
-          device[:subcategory] = subcategory if subcategory
-          device[:proxy] = proxy if resource.request_proxies.include?(proxy.to_sym)
-          devices << device
-        end
-      end
-    end
-
-    Dir.glob("/sys/class/ieee80211/*").each do |v|
-      subcategory = "wlan"
-      proxy = "wlan"
-      File.exist?("#{v}/device/uevent") && File.open("#{v}/device/uevent") do |f|
-        driver = f.read.match(/DRIVER=(.+)/) && $1
-        device = { name: File.basename(v), driver: driver, category: category, subcategory: subcategory }
-        device[:proxy] = proxy if resource.request_proxies.include?(proxy.to_sym)
-        devices << device
-      end
-    end
-    devices
-  end
 end