omf_ec 6.1.1 → 6.1.2.pre

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGE2YjllOTM5NGZjYjA5OWU0MjVlMDdjMjRjOWVmOWMwMzk5MTE4NA==
-  data.tar.gz: !binary |-
-    N2YzNTFhNGQ2MDQzY2Q2MmM0YmYxN2ViNjdmZDEwMGY1Mjc2NGYxYQ==
+SHA1:
+  metadata.gz: 945493d51a75ad28becc8a45ffb3622fc69ec31b
+  data.tar.gz: caf67781ab4f948f2f07c2b24e1019a2522219bb
 SHA512:
-  metadata.gz: !binary |-
-    YmJkMGU2NDA5MTU5NjM3YjFkM2ZkNjJmYThjMmI3NzgwNDQyNzE0OWZhZTUy
-    YWRhYjRhMjM4YzUzOTE0Zjc4ODBkMTBjODA0OTdkNDBmMzJlNWY2ZWY1ZDM0
-    ZDI5YjgzYzA5NzVlY2U0YjM2YjA0NzcyZjQ4Y2JhYzZiNjJhMzY=
-  data.tar.gz: !binary |-
-    ZDRiOTYyYmJhMGJiMWQ4OTgwNjI5YWY5YTIwNjgzODI3ZDM2Mjc5ZjYwNTJi
-    YzViMDk1NjEzYWFiYWU1YjkyZDA2NGJlODgyN2M0ZWE2YTVmM2FjMjUxMTUz
-    OTRjZDBlNWI3ZWVhMjg2ZTkxNTVhNWI4YjMzZmM4MjQ1NDIzMTA=
+  metadata.gz: d7681fc0da5fdc1c90ba18420f2eb17ed45ff63651d7c288bf31f0b9cee304772a21168ad1a12e429813c83f1b49cea19585d9f537a4ab824439b2e8bad7f391
+  data.tar.gz: 63ec04e8ef79759874205ab753a3492321149353a5576952bae21639dedd3e5057cf29d16e40315dc69b32a2b2549593426e27103e9544932761ee4486b7e8b2

data/bin/omf_ec

@@ -1,372 +1,7 @@
 #!/usr/bin/env ruby
 
-# Copyright (c) 2012 National ICT Australia Limited (NICTA).
-# This software may be used and distributed solely under the terms of the MIT license (License).
-# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
-# By downloading or using this software you accept the terms and the liability disclaimer in the License.
-
-puts "OMF Experiment Controller - Copyright (c) 2012-13 National ICT Australia Limited (NICTA)"
-abort "Please use Ruby 1.9.3 or higher" if RUBY_VERSION < "1.9.3"
-
-require 'gli'
 require 'omf_ec'
+require 'omf_ec/runner'
 $stdout.sync = true
 
-include GLI::App
-include OmfEc
-
-program_desc "Run a command on the testbed(s)"
-version OmfEc::VERSION
-
-desc "Debug mode (printing debug logging messages)"
-switch [:d, :debug]
-
-desc "URI for communication layer"
-arg_name "URI"
-default_value "xmpp://localhost"
-flag [:u, :uri]
-
-desc "Debug XMPP traffic mode (include XMPP debug logging messages under debug mode)."
-switch [:x, :xmpp]
-
-desc "Directory containing root certificates"
-arg_name "directory", :optional
-flag [:root_cert_dir]
-
-desc "Your certificate"
-arg_name "cert", :optional
-flag [:cert]
-
-desc "Your private key"
-arg_name "key", :optional
-flag [:key]
-
-desc "Log file directory"
-arg_name "directory"
-default_value "/tmp"
-flag [:log_file_dir]
-
-desc "Logging config file"
-arg_name "file"
-flag [:log_config]
-
-desc "Add some colours to logging"
-switch [:colour]
-
-desc "EC config file"
-arg_name "file"
-flag [:c, :config]
-
-$config_file = ".config/omf_ec.yml"
-ARGV.each_index {|a|
-  if ARGV[a]=="-c" or ARGV[a]=="--config"
-    $config_file = ARGV[a+1] if not ARGV[a+1].nil?
-  end
-}
-# the path given here is relative to the user's home directory
-config_file($config_file)
-
-desc "Execute an experiment script"
-arg_name "path_to_script_file [-- --experiment_property value]"
-command :exec do |c|
-  c.desc "Experiment name"
-  c.arg_name "experiment_name"
-  c.flag [:e, :experiment, "experiment-id"]
-
-  c.desc "Slice name [Deprecated]"
-  c.arg_name "slice_name"
-  c.flag [:slice]
-
-  c.desc "OML URI to use for collecting the experiment's measurements"
-  c.arg_name "uri"
-  c.flag [:oml_uri]
-
-  c.desc "OML URI to use for EC Instrumentation"
-  c.arg_name "uri"
-  c.flag [:inst_oml_uri]
-
-  c.desc "OML ID to use for EC Instrumentation"
-  c.arg_name "id"
-  c.flag [:inst_oml_id]
-
-  c.desc "OML Domain to use for EC Instrumentation"
-  c.arg_name "domain"
-  c.flag [:inst_oml_domain]
-
-  c.desc "Check script version (you need to define OMF_VERSIONS in your script"
-  c.switch "version_check"
-
-  c.desc "Parse graph definition to construct graph information in log output"
-  c.switch [:g, "show-graph"]
-
-  c.action do |global_options, options, args|
-    help_now! "Missing experiment script" if args[0].nil?
-    help_now! "Experiment script not found" unless File.exist?(File.expand_path(args[0]))
-
-    # User-provided command line values for Experiment Properties cannot be
-    # set here as the propertties have not been defined yet by the experiment.
-    # Thus just pass them to the experiment, which will be responsible
-    # for setting them later
-    properties = {}
-    if args.size > 1
-      exp_properties = args[1..-1]
-      exp_properties.in_groups_of(2) do |p|
-        unless p[0] =~ /^--(.+)/ && !p[1].nil?
-          help_now! "Malformatted properties '#{exp_properties.join(' ')}'"
-        else
-          properties[$1.to_sym] = p[1].ducktype
-        end
-      end
-      OmfEc.experiment.cmdline_properties = properties
-    end
-
-    OmfEc.experiment.show_graph = options['show-graph']
-
-    # FIXME this loading script is way too simple
-    load_exp(File.expand_path(args[0]), global_options, options, properties)
-  end
-end
-
-desc "Load an image onto the nodes"
-command :load do |c|
-  #c.desc "use this testbed configuration in OMF 5 EC config file"
-  #c.arg_name "AGGREGATE"
-  #c.flag [:c, :config], :default_value => "default"
-
-  c.desc "comma-separated list of nodes to image"
-  c.arg_name "TOPOLOGY"
-  c.flag [:t, :topology], :default_value => "system:topo:all"
-
-  c.desc "disk image to load"
-  c.arg_name "IMAGE"
-  c.flag [:i, :image], :default_value => "baseline.ndz"
-
-  c.desc "seconds to wait for the imaging process to complete"
-  c.arg_name "TIMEOUT"
-  c.flag [:o, :timeout], :default_value => "800"
-
-  c.desc "resize the first partition to SIZE GB or to maximum size if SIZE=0 "+
-    "or leave x percent of free space if SIZE=x%"
-  c.arg_name "SIZE"
-  c.flag [:r, :resize]
-
-  c.desc "Path where the resulting Topologies should be saved"
-  c.arg_name "PATH"
-  c.flag [:outpath], :default_value => "/tmp"
-
-  c.desc "Prefix to use for naming the resulting Topologies (default is your experiment ID)"
-  c.arg_name "PREFIX"
-  c.flag [:outprefix]
-
-  c.action do |global_options, options, args|
-    @cmd = "USER=#{ENV['USER']} omf-5.4 load -t #{options[:t]} -i #{options[:i]} "
-    @cmd += "-o #{options[:o]} --outpath #{options[:outpath]} "
-    @cmd += "-r #{options[:r]} " if options[:r]
-    @cmd += "--outprefix #{options[:outprefix]} " if options[:outprefix]
-    load_exp(@testbed_exp_path, global_options, options)
-  end
-end
-
-desc "Save an image of a node"
-command :save do |c|
-  #c.desc "use this testbed configuration in OMF 5 EC config file"
-  #c.arg_name "AGGREGATE"
-  #c.flag [:c, :config], :default_value => "default"
-
-  c.desc "node to save from"
-  c.arg_name "NODE"
-  c.flag [:n, :node]
-
-  c.desc "resize the first partition to SIZE GB or to maximum size if SIZE=0 "+
-    "or leave x percent of free space if SIZE=x%"
-  c.arg_name "SIZE"
-  c.flag [:r, :resize]
-
-  c.action do |global_options, options, args|
-    @cmd = "USER=#{ENV['USER']} omf-5.4 save "
-    @cmd += "-n #{options[:n]} " if options[:n]
-    @cmd += "-r #{options[:r]} " if options[:r]
-    load_exp(@testbed_exp_path, global_options, options)
-  end
-end
-
-desc "Return the status of the nodes"
-command :stat do |c|
-  c.desc "use this testbed configuration in OMF 5 EC config file"
-  c.arg_name "AGGREGATE"
-  c.flag [:C], :default_value => "default"
-
-  c.desc "comma-separated list of nodes to image"
-  c.arg_name "TOPOLOGY"
-  c.flag [:t, :topology], :default_value => "system:topo:all"
-
-  c.desc "print a summary of the node status for the testbed"
-  c.switch [:s, :summary]
-
-  c.action do |global_options, options, args|
-    @cmd = "omf-5.4 stat -c #{options[:C]} -t #{options[:t]} "
-    @cmd += "-s" if options[:s]
-    load_exp(@testbed_exp_path, global_options, options)
-  end
-end
-
-desc "Power on/off, reset or reboot the nodes"
-command :tell do |c|
-  c.desc "use this testbed configuration in OMF 5 EC config file"
-  c.arg_name "AGGREGATE"
-  c.flag [:c, :config], :default_value => "default"
-
-  c.desc "comma-separated list of nodes to image"
-  c.arg_name "TOPOLOGY"
-  c.flag [:t, :topology], :default_value => "system:topo:all"
-
-  c.desc "
-      'on'              turn node(s) ON -
-      'offs'            turn node(s) OFF (soft) -
-      'offh'            turn node(s) OFF (hard) -
-      'reboot'          reboots node(s) (soft) -
-      'reset'           resets node(s) (hard)"
-      c.arg_name "ACTION"
-      c.flag [:a, :action]
-
-      c.action do |global_options, options, args|
-        @cmd = "omf-5.4 tell -c #{options[:c]} -t #{options[:t]} "
-        @cmd += "-a #{options[:a]} " if options[:a]
-        load_exp(@testbed_exp_path, global_options, options)
-      end
-end
-
-on_error do |exception|
-  true
-end
-
-pre do |global_options, command, options, args|
-  #opts = OmfCommon.load_yaml(config_file_name) if File.exist?(config_file_name)
-  #opts.delete("commands")
-  #global_options.merge!(opts)
-
-  unless global_options[:uri]
-    help_now! "Incomplete options. Need communication URI"
-  end
-
-  # Check version
-  if options[:check]
-    File.open(args[0], 'r') do |f|
-      f.read.chomp.match(/OMF_VERSIONS\W*=\W*(.*)/)
-      versions = $1
-      unless versions && versions.split(',').include?(OmfCommon::PROTOCOL_VERSION)
-        raise StandardError, "Could not find compatibile protocol version number in your script"
-      end
-    end
-  end
-
-  include OmfEc::DSL
-
-  OmfEc.experiment.name = options[:experiment] if options[:experiment]
-  OmfEc.experiment.oml_uri = options[:oml_uri] if options[:oml_uri]
-
-  @testbed_exp_path = File.join(OmfEc.lib_root, "omf_ec/backward/exp/testbed.rb")
-end
-
-def setup_logging(global_options = {})
-  if global_options[:xmpp]
-    require 'blather'
-    Blather.logger = logger
-  end
-
-  unless global_options[:debug]
-    Logging.consolidate 'OmfCommon', 'OmfRc'
-  end
-
-  if global_options[:colour]
-    Logging.logger.root.appenders.first.layout = Logging.layouts.pattern(date_pattern: '%F %T %z',
-                                                                         color_scheme: 'default',
-                                                                         pattern: '[%d] %-5l %c: %m\n')
-  end
-
-  # FIXME this should go to common setup
-  if global_options[:log_file_dir] && File.exist?(File.expand_path(global_options[:log_file_dir]))
-    Logging.logger.root.add_appenders(
-      Logging.appenders.file(
-        "#{File.expand_path(global_options[:log_file_dir])}/#{OmfEc.experiment.id}.log",
-        :layout => Logging.layouts.pattern(:date_pattern => '%F %T %z',
-                                           :pattern => '[%d] %-5l %c: %m\n')))
-  end
-
-  if OmfEc.experiment.oml_uri
-    require 'oml4r/logging/oml4r_appender'
-    Logging.logger.root.add_appenders(Logging.appenders.oml4r('oml4r', :appName => 'omf_ec', :domain => "#{OmfEc.experiment.id}", :collect => "#{OmfEc.experiment.oml_uri}"))
-  end
-
-  OmfCommon.load_logging_config(global_options[:log_config])
-end
-
-def load_exp(exp_path, global_options = {} , options = {}, properties = {})
-  begin
-    if options[:inst_oml_uri] && options[:inst_oml_id] && options[:inst_oml_domain]
-      require 'oml4r'
-      instrument_ec = OML4R::init(nil, { collect: options[:inst_oml_uri], nodeID: options[:inst_oml_id], domain: options[:inst_oml_domain] , appName: File.basename($PROGRAM_NAME)} )
-      OmfCommon::Measure.enable if instrument_ec
-    end
-
-    opts = {
-      communication: { url: global_options[:uri] },
-      eventloop: { type: :em },
-      logging: {
-        level: { default: global_options[:debug] ? 'debug' : 'info' },
-        appenders: {
-          stdout: {
-            date_pattern: '%H:%M:%S',
-            pattern: '%d %-5l %c{2}: %m\n'
-          }
-        }
-      }
-    }
-
-    opts[:communication][:auth] = { authenticate: true } if global_options[:cert]
-
-    OmfCommon.init(:development, opts) do |el|
-
-      setup_logging(global_options)
-
-      OmfCommon.comm.on_connected do |comm|
-        info "OMF Experiment Controller #{OmfEc::VERSION} - Start"
-        info "Connected using #{comm.conn_info}"
-        info "Execute: #{exp_path}"
-        info "Properties: #{OmfEc.experiment.cmdline_properties}"
-
-        if opts[:communication][:auth] && opts[:communication][:auth][:authenticate]
-          ec_cert = OmfCommon.load_credentials(
-            root_cert_dir: global_options[:root_cert_dir],
-            entity_cert: global_options[:cert],
-            entity_key: global_options[:key]
-          )
-
-          ec_cert.resource_id = OmfCommon.comm.local_address
-          OmfCommon::Auth::CertificateStore.instance.register(ec_cert)
-        end
-
-        OmfEc.experiment.log_metadata("ec_version", "#{OmfEc::VERSION}")
-        OmfEc.experiment.log_metadata("exp_path", exp_path)
-        OmfEc.experiment.log_metadata("ec_pid", "#{Process.pid}")
-
-        begin
-          include OmfEc::Backward::DefaultEvents
-          load exp_path
-          OmfEc::Experiment.start
-        rescue => e
-          OmfEc.experiment.log_metadata("state", "error")
-          error e.message
-          error e.backtrace.join("\n")
-        end
-
-        comm.on_interrupted { OmfEc::Experiment.done }
-      end
-    end
-  rescue => e
-    logger.fatal e.message
-    logger.fatal e.backtrace.join("\n")
-  end
-end
-
-exit run(ARGV)
+OmfEc::Runner.new.run

data/lib/omf_ec/backward/default_events.rb

@@ -6,11 +6,9 @@
 module OmfEc
   module Backward
     module DefaultEvents
-
       class << self
         def included(base)
-          base.instance_eval do
-
+          base.class_eval do
             def all_nodes_up?(state)
               all_groups? do |g|
                 plan = g.members.values.uniq.sort
@@ -36,11 +34,13 @@ module OmfEc
             end
 
             def all_apps_ready?(state)
+              results = []
               all_groups? do |g|
                 plan = g.app_contexts.size * g.members.values.uniq.size
-                actual = state.count { |v| v.joined?(g.address("application")) }
-                plan == 0 ? false : plan == actual
+                actual = state.count { |v| v.joined?(g.address("application")) } 
+                results << (plan == actual) unless (plan == 0)
               end
+              !results.include?(false)
             end
 
             def all_nodes_up_cbk
@@ -93,13 +93,12 @@ module OmfEc
 
             def_event :ALL_APPS_DONE do |state|
               all_nodes_up?(state) &&
-              all_groups? do |g|
-                plan = (g.execs.size + g.app_contexts.size) * g.members.values.uniq.size
-                actual = state.count { |v| v.joined?(g.address("application")) && v[:event] == 'EXIT' }
-                plan == 0 ? false : plan == actual
-              end
+                all_groups? do |g|
+                  plan = (g.execs.size + g.app_contexts.size) * g.members.values.uniq.size
+                  actual = state.count { |v| v.joined?(g.address("application")) && v[:event] == 'EXIT' }
+                  plan == 0 ? false : plan == actual
+                end
             end
-
           end
         end
       end

data/lib/omf_ec/backward/dsl.rb

@@ -16,6 +16,8 @@ module OmfEc
           v5_style(:allGroups, base)
           v5_style(:allNodes!, base)
           v5_style(:defGraph, base)
+          v5_style(:loadOEDL, base)
+          v5_style(:ensureProperty, base)
         end
 
         def v5_style(name, base)
@@ -52,6 +54,7 @@ module OmfEc
         warn "Calling 'wait' or 'sleep' will block entire EC event loop. Please try 'after' or 'every'"
         sleep duration.to_s.to_i
       end
+
     end
   end
 end

data/lib/omf_ec/backward/group.rb

@@ -16,14 +16,15 @@ module OmfEc
 
       # Create an application for the group and start it
       #
-      def exec(name)
+      def exec(command)
+        name = SecureRandom.uuid
+
         self.synchronize do
           self.execs << name
         end
-        create_resource(name, type: 'application', binary_path: name)
+        create_resource(name, type: 'application', binary_path: command)
 
-        e_uid = SecureRandom.uuid
-        e_name = "#{self.name}_application_#{name}_created_#{e_uid}"
+        e_name = "#{self.name}_application_#{name}_created"
 
         resource_group_name = self.address("application")
 
@@ -68,8 +69,8 @@ module OmfEc
         end
       end
 
-      def addApplication(name, &block)
-        app_cxt = OmfEc::Context::AppContext.new(name,self)
+      def addApplication(name, location = nil, &block)
+        app_cxt = OmfEc::Context::AppContext.new(name,location,self)
         block.call(app_cxt) if block
         self.app_contexts << app_cxt
       end

data/lib/omf_ec/backward/timeout_resources.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
+# This OEDL script implements a timeout timer for resources to checked-in an 
+# experiment. When it is loaded as part as another experiment, it will wait
+# for the specified time in the experiment property 'oedl_timeout'. When that
+# wait is over, it checks if all resources defined in the experiment have 
+# joined all their groups (also as defined in the experiment). If not, then
+# it stops the experiment.
+#
+# The default timeout value is set here to 120 s. To modify that you should
+# set in your experiment the oedl_timeout property to the desired timeout in 
+# second. You must do that prior to or as you load this script.
+#
+# For example, in your OEDL experiment:
+#   
+#  load_oedl('omf_ec/backward/timeout_resources', { oedl_timeout: 180 })
+#
+ensureProperty('oedl_timeout',120,'default timeout in second')
+info "Waiting for all resources to join... (timeout set to #{property.oedl_timeout} s)"
+after property.oedl_timeout.to_i do
+ unless all_nodes_up?(OmfEc.experiment.state) 
+   info "Waited #{property.oedl_timeout} s for all resources to join, but still some missing! Aborting the experiment execution now!"
+   Experiment.done
+ end
+end

data/lib/omf_ec/context/app_context.rb

@@ -14,7 +14,8 @@ module OmfEc::Context
     # values for each. Thus we need to distinguish these different context
     @@context_count = Hash.new
 
-    def initialize(name, group)
+    def initialize(name, location = nil, group)
+      load_oedl(location) unless location.nil?
       if OmfEc.experiment.app_definitions.key?(name)
         self.app_def = OmfEc.experiment.app_definitions[name]
         self.param_values = Hash.new

data/lib/omf_ec/dsl.rb

@@ -3,6 +3,8 @@
 # You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
 # By downloading or using this software you accept the terms and the liability disclaimer in the License.
 
+require 'active_support'
+require 'active_support/deprecation'
 require 'active_support/core_ext'
 require 'eventmachine'
 
@@ -63,7 +65,7 @@ module OmfEc
       OmfCommon.eventloop.every(time, &block)
     end
 
-    def def_application(name,&block)
+    def def_application(name, &block)
       app_def = OmfEc::AppDefinition.new(name)
       OmfEc.experiment.app_definitions[name] = app_def
       block.call(app_def) if block
@@ -135,6 +137,17 @@ module OmfEc
       return OmfEc.experiment.property
     end
 
+    # Check if a property exist, if not then define it
+    # Take the same parameter as def_property
+    #
+    def ensure_property(name, default_value, description = nil, type = nil)
+      begin 
+        property[name]
+      rescue
+        def_property(name, default_value, description, type)
+      end
+    end
+
     alias_method :prop, :property
 
     # Check if all elements in array equal the value provided
@@ -198,6 +211,43 @@ module OmfEc
       end
     end
 
-    include OmfEc::Backward::DSL
+    # Load an additional OEDL script 
+    #
+    # First try to load the script from the paths associated to this running 
+    # Ruby instance. This would allow the loading of scripts shipped with 
+    # the EC gem. If that fails, then look for the script in the local file
+    # system or at the given web URL.
+    #
+    # If an optional has of key/value is provided, then define an OMF
+    # Experiment Property for each keys and assigne them the values.
+    #
+    # @param location name, path or URL for the OEDL script to load
+    # @param opts optional hash of key/values for extra Experiment Property to define
+    #
+    def load_oedl(location, opts = {})
+      # Define the additional properties from opts
+      opts.each { |k,v| def_property(k, v,) } 
+      # Try to load OEDL Library as built-in then external
+      begin
+        require location
+        info "Loaded built-in OEDL library '#{location}'"
+      rescue LoadError
+        begin
+          require 'open-uri'
+          require 'tempfile'
+          file = Tempfile.new("oedl-#{Time.now.to_i}")
+          open(location) { |io| file.write(io.read) }
+          file.close
+          load(file.path) 
+          file.unlink
+          info "Loaded external OEDL library '#{location}'"
+        rescue Exception => e
+          error "Fail loading external OEDL library '#{location}': #{e}"
+        end
+      rescue Exception => e 
+        error "Fail loading built-in OEDL library '#{location}': #{e}"
+      end
+    end
+
   end
 end

data/lib/omf_ec/experiment.rb

@@ -145,7 +145,8 @@ module OmfEc
 
     def add_event(name, trigger)
       self.synchronize do
-        raise RuntimeError, "Event '#{name}' has already been defined" if event(name)
+        warn "Event '#{name}' has already been defined. Overwriting it now." if event(name)
+        @events.delete_if { |e| e[:name] == name }
         @events << { name: name, trigger: trigger, aliases: [] }
       end
     end

data/lib/omf_ec/runner.rb

@@ -0,0 +1,266 @@
+# Copyright (c) 2014 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License
+
+require 'hashie'
+
+module OmfEc
+  class Runner
+    include Hashie
+
+    def initialize
+      @gem_version = OmfEc::VERSION
+      @oml_enabled = false
+      @executable_name = File.basename($PROGRAM_NAME)
+
+      @oml_opts = {
+        appName: @executable_name,
+        afterParse: lambda { |o| parse_cmd_opts }
+      }
+
+      # Default configuration options
+      @config_opts = Mash.new(
+        environment: 'development',
+        communication: { url: "amqp://localhost" },
+      )
+
+      @cmd_opts = Mash.new
+
+      @argv = ARGV.dup
+    end
+
+    def oml_init
+      begin
+        @oml_enabled = OML4R::init(ARGV, @oml_opts) do |op|
+          op.banner = "OMF Experiment Controller version '#{@gem_version}'\n"
+          op.banner += "Usage: #{@executable_name} [options] path_to_oedl_file [-- --experiment_property value]"
+
+          op.on("-u", "--uri ADDRESS", "URI for communication layer [amqp://localhost]") do |uri|
+            @cmd_opts[:uri] = uri
+            remove_cmd_opts_from_argv("-u", "--uri", uri)
+          end
+
+          op.on("-c CONFIGFILE", "Configuration File") do |file|
+            @cmd_opts[:config_file] = file
+            remove_cmd_opts_from_argv("-c", file)
+          end
+
+          op.on("--log_config CONFIGFILE", "Logging Configuration File") do |file|
+            @cmd_opts[:logging_configfile] = file
+            remove_cmd_opts_from_argv("--log_config", file)
+          end
+
+          op.on("-e ENVIRONMENT", "Environment (development, production ...) [#{@config_opts[:environment]}]") do |e|
+            @cmd_opts[:environment] = e
+            remove_cmd_opts_from_argv("-e", e)
+          end
+
+          op.on("--root_cert_dir DIRECTORY", "Directory containing root certificates") do |dir|
+            @cmd_opts[:root_cert_dir] = dir
+            remove_cmd_opts_from_argv("--root_cert_dir", dir)
+          end
+
+          op.on("--cert CERTIFICATE", "Your certificate") do |cert|
+            @cmd_opts[:cert] = cert
+            remove_cmd_opts_from_argv("--cert", cert)
+          end
+
+          op.on("--key KEY", "Your private key") do |key|
+            @cmd_opts[:key] = key
+            remove_cmd_opts_from_argv("--key", key)
+          end
+
+          op.on("--name", "--experiment EXPERIMENT_NAME", "Experiment name") do |e_name|
+            @cmd_opts[:experiment_name] = e_name
+            remove_cmd_opts_from_argv("--name", "--experiment", e_name)
+          end
+
+          op.on("--slice SLICE_NAME", "Slice name [Deprecated]") do |slice|
+            @cmd_opts[:slice] = slice
+            remove_cmd_opts_from_argv("--slice", slice)
+          end
+
+          op.on("--inst_oml_uri URI", "EC Instrumentation: OML URI to use") do |uri|
+            @cmd_opts[:inst_oml_uri] = uri
+            remove_cmd_opts_from_argv("--inst_oml_uri", uri)
+          end
+
+          op.on("--inst_oml_id ID", "EC Instrumentation: OML ID to use") do |id|
+            @cmd_opts[:inst_oml_id] = id
+            remove_cmd_opts_from_argv("--inst_oml_id", id)
+          end
+
+          op.on("--inst_oml_domain DOMAIN", "EC Instrumentation: OML Domain to use") do |domain|
+            @cmd_opts[:inst_oml_domain] = domain
+            remove_cmd_opts_from_argv("--inst_oml_domain", domain)
+          end
+
+          op.on("-g", "--show-graph", "Parse graph definition to construct graph information in log output") do
+            @cmd_opts['show-graph'] = true
+            remove_cmd_opts_from_argv("--show-graph")
+          end
+
+          op.on("-v", "--version", "Show version") do
+            puts "OMF Experiment Controller version '#{@gem_version}'"
+            exit
+          end
+
+          op.on("-d", "--debug", "Debug mode (printing debug logging messages)") do
+            @cmd_opts[:debug] = true
+            remove_cmd_opts_from_argv("-d", "--debug")
+          end
+
+          op.on("-h", "--help", "Show this message") do
+            puts op
+            exit
+          end
+        end
+      rescue OML4R::MissingArgumentException => e
+        puts "Warning: #{e.message} to instrument, so it will run without instrumentation. (see --oml-help)"
+      rescue => e
+        puts e.message
+        puts e.backtrace.join("\n")
+        exit(1)
+      end
+    end
+
+    def parse_cmd_opts
+      parse_config_file
+
+      # uri in command line is short for communication/url
+      uri = @cmd_opts.delete(:uri)
+      @config_opts[:communication][:url] = uri if uri
+      @config_opts[:communication][:auth] = { authenticate: true } if @cmd_opts[:cert]
+      @config_opts.merge!(@cmd_opts)
+    end
+
+    def parse_config_file
+      if (config_file = @cmd_opts.delete(:config_file))
+        if File.exist?(config_file)
+          @config_opts.merge!(OmfCommon.load_yaml(config_file))
+        else
+          puts "Config file '#{config_file}' doesn't exist"
+          exit(1)
+        end
+      end
+    end
+
+    def remove_cmd_opts_from_argv(*args)
+      args.each { |v| @argv.delete(v) }
+    end
+
+    def setup_experiment
+      OmfEc.experiment.name = @config_opts[:experiment_name] if @config_opts[:experiment_name]
+      OmfEc.experiment.oml_uri = @config_opts[:oml_uri] if @config_opts[:oml_uri]
+      OmfEc.experiment.show_graph = @config_opts['show-graph']
+
+      # Instrument EC
+      if @config_opts[:inst_oml_uri] && @config_opts[:inst_oml_id] && @config_opts[:inst_oml_domain]
+        instrument_ec = OML4R::init(nil, {
+          collect: @config_opts[:inst_oml_uri],
+          nodeID: @config_opts[:inst_oml_id],
+          domain: @config_opts[:inst_oml_domain],
+          appName: @executable_name
+        })
+
+        OmfCommon::Measure.enable if instrument_ec
+      end
+
+      remove_cmd_opts_from_argv("exec")
+
+      @oedl_path = @argv[0] && File.expand_path(@argv[0])
+
+      if @oedl_path.nil? || !File.exist?(@oedl_path)
+        puts "Experiment script '#{@argv[0]}' not found"
+        exit(1)
+      end
+
+      # User-provided command line values for Experiment Properties cannot be
+      # set here as the properties have not been defined yet by the experiment.
+      # Thus just pass them to the experiment, which will be responsible
+      # for setting them later
+      properties = {}
+      if @argv.size > 1 && @argv[1] == "--"
+        exp_properties = @argv[2..-1]
+        exp_properties.in_groups_of(2) do |p|
+          unless p[0] =~ /^--(.+)/ && !p[1].nil?
+            puts "Malformatted properties '#{exp_properties.join(' ')}'"
+            exit(1)
+          else
+            properties[$1.to_sym] = p[1].ducktype
+          end
+        end
+        OmfEc.experiment.cmdline_properties = properties
+      end
+    end
+
+    def setup_logging
+      OmfCommon.load_logging_config(@config_opts[:logging_configfile])
+
+      if @config_opts[:debug]
+        Logging.logger.root.level = 'debug'
+      else
+        Logging.consolidate 'OmfCommon', 'OmfRc'
+      end
+
+      if OmfEc.experiment.oml_uri
+        require 'oml4r/logging/oml4r_appender'
+        Logging.logger.root.add_appenders(Logging.appenders.oml4r('oml4r', :appName => 'omf_ec', :domain => "#{OmfEc.experiment.id}", :collect => "#{OmfEc.experiment.oml_uri}"))
+      end
+    end
+
+    def load_experiment
+      begin
+        OmfCommon.init(@config_opts.delete(:environment), @config_opts) do |el|
+          setup_logging
+          OmfCommon.comm.on_connected do |comm|
+            info "OMF Experiment Controller #{OmfEc::VERSION} - Start"
+            info "Connected using #{comm.conn_info}"
+            info "Execute: #{@oedl_path}"
+            info "Properties: #{OmfEc.experiment.cmdline_properties}"
+
+            if @config_opts[:communication][:auth] && @config_opts[:communication][:auth][:authenticate]
+              ec_cert = OmfCommon.load_credentials(
+                root_cert_dir: @config_opts[:root_cert_dir],
+                entity_cert: @config_opts[:cert],
+                entity_key: @config_opts[:key]
+              )
+
+              ec_cert.resource_id = OmfCommon.comm.local_address
+              OmfCommon::Auth::CertificateStore.instance.register(ec_cert)
+            end
+
+            OmfEc.experiment.log_metadata("ec_version", "#{OmfEc::VERSION}")
+            OmfEc.experiment.log_metadata("exp_path", @oedl_path)
+            OmfEc.experiment.log_metadata("ec_pid", "#{Process.pid}")
+
+            begin
+              load @oedl_path
+              OmfEc::Experiment.start
+            rescue => e
+              OmfEc.experiment.log_metadata("state", "error")
+              error e.message
+              error e.backtrace.join("\n")
+            end
+
+            trap(:TERM) { OmfEc::Experiment.done }
+            trap(:INT) { OmfEc::Experiment.done }
+          end
+        end
+      rescue => e
+        logger.fatal e.message
+        logger.fatal e.backtrace.join("\n")
+        puts "Experiment controller exits unexpectedly"
+        puts e
+        exit(1)
+      end
+    end
+
+    def run
+      oml_init
+      setup_experiment
+      load_experiment
+    end
+  end
+end

data/lib/omf_ec.rb

@@ -21,14 +21,14 @@ require "omf_ec/dsl"
 
 module OmfEc
 
-# OML Measurement Point (MP)
-# This MP is for measurements about messages received by the Resource Proxy
-class OmfEc::MPReceived < OML4R::MPBase
-  name :ec_received
-  param :time, :type => :double # Time (s) when this message was received
-  param :topic, :type => :string # Pubsub topic where this message came from
-  param :mid, :type => :string # Unique ID this message
-end
+  # OML Measurement Point (MP)
+  # This MP is for measurements about messages received by the Resource Proxy
+  class OmfEc::MPReceived < OML4R::MPBase
+    name :ec_received
+    param :time, :type => :double # Time (s) when this message was received
+    param :topic, :type => :string # Pubsub topic where this message came from
+    param :mid, :type => :string # Unique ID this message
+  end
 
   class << self
     # Experiment instance
@@ -101,3 +101,9 @@ end
     end
   end
 end
+
+include OmfEc::DSL
+include OmfEc::Backward::DSL
+include OmfEc::Backward::DefaultEvents
+
+Experiment = OmfEc::Experiment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omf_ec
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.1.2.pre
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -42,42 +42,42 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -86,40 +86,40 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.1.2.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.1.2.pre
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Experiment controller of OMF, a generic framework for controlling and
@@ -151,6 +151,7 @@ files:
 - lib/omf_ec/backward/dsl.rb
 - lib/omf_ec/backward/exp/testbed.rb
 - lib/omf_ec/backward/group.rb
+- lib/omf_ec/backward/timeout_resources.rb
 - lib/omf_ec/context.rb
 - lib/omf_ec/context/app_context.rb
 - lib/omf_ec/context/def_app_context.rb
@@ -163,6 +164,7 @@ files:
 - lib/omf_ec/graph.rb
 - lib/omf_ec/graph/graph_description.rb
 - lib/omf_ec/group.rb
+- lib/omf_ec/runner.rb
 - lib/omf_ec/version.rb
 - omf_ec.gemspec
 - test/omf_ec/app_context_spec.rb
@@ -182,18 +184,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: omf_ec
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: OMF experiment controller
-test_files: []
+test_files:
+- test/omf_ec/app_context_spec.rb
+- test/omf_ec/context_spec.rb
+- test/omf_ec/dsl_spec.rb
+- test/omf_ec/experiment_property_spec.rb
+- test/omf_ec/experiment_spec.rb
+- test/omf_ec/group_spec.rb
+- test/test_helper.rb