omf_ec 6.0.8.pre.1 → 6.0.8.pre.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmRmNjg3NjEwYzNkMWJlODQ3MWYyYTMzYmUwYzc1YWRkZjhmMWZiNg==
+    MWEyOGNkMWYxODcyY2Q0MDUxN2QxYWNhMWMyZTYyNWNiMzdlZGYzOA==
   data.tar.gz: !binary |-
-    ZjgxMTE4NGZhODc1NGEzNWJlNDgwMjM3NTIxN2EwMGViZjQ2M2NmNw==
+    NWQ4MzQ5NjY2MWYxNGVjZTMzZWFmNzliY2ViNjAzMmYwMzlkZWRkZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZWFlMjZmZjdlOWM5M2QzYzhiZDE2NzNmN2M5ZDY1ZDMyNjNkMjdjZDRhZmQ4
-    Y2NiM2U3OWE5YjQ2OTkzM2I1ZjgzZjg5YzJmMzhhNTc5MjcwNWU2ZjYwYWQ2
-    YTgwYmIwOWM5ZDUyYTI1ZmVhMmI1YTA1MzYzYTBjM2IxZWM2MDY=
+    Y2MzYmFjMmM3MDZmNWQ4OTk4Y2JlYTYwYWFiOGQ3ODk5YzUzNzhiZGIxMjIx
+    ZWNhODM0MmFjMmU3ZTNhMmM3ZTY3YzNhYTVjZjdkMWQ5MGYzYzdlN2NhMGM4
+    NWNkOGZlZWM3ZWZmM2ZlYTk5MTEzNmRhOWIwYmZmODMwMjk0YzU=
   data.tar.gz: !binary |-
-    YmNhZGJmMzZkYTNlZjkxZTI4YTdmYmVmNTgyZTg1YWQwOTQ2ZmIzZGVjMDdk
-    N2Y5NTlmNDM0N2FkYmU1ODM1YmU2ZGU5MmNkNjUxYWU4M2JhYTAwNzc1NWQz
-    NDNhMDI4ZWQwZjFmNWEwMzdiNTBhYzA5M2M3ZWFjZmQ1MDI3MzY=
+    ZmE5N2VkOWJmM2Y5NzExOGVmN2M0YzFlY2FkN2E5ZTVmMTUzNjMyMzJkNmYx
+    YWIxM2JhOTZhNDAzZjhlOTc0MGYzNzBlMGQ0ZjE5ZTZlM2MzOWMxYzNhYzdj
+    N2MyOWEzMGVhMmRhNGFjMzRlY2Q5ZWYxZDk4NWI3OGY1ZTg4MDE=

data/bin/omf_ec

@@ -44,6 +44,9 @@ desc "Logging config file"
 arg_name "file"
 flag [:log_config]
 
+desc "Add some colours to logging"
+switch [:colour]
+
 # the path given here is relative to the user's home directory
 config_file(".config/omf_ec.yml")
 
@@ -52,7 +55,11 @@ 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]
+  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"
@@ -73,6 +80,9 @@ command :exec do |c|
   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]))
@@ -94,6 +104,8 @@ command :exec do |c|
       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
@@ -250,6 +262,12 @@ def setup_logging(global_options = {})
     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(
@@ -279,8 +297,7 @@ def load_exp(exp_path, global_options = {} , options = {}, properties = {})
         appenders: {
           stdout: {
             date_pattern: '%H:%M:%S',
-            pattern: '%d %-5l %c{2}: %m\n',
-            color_scheme: 'default'
+            pattern: '%d %-5l %c{2}: %m\n'
           }
         }
       }
@@ -298,14 +315,16 @@ def load_exp(exp_path, global_options = {} , options = {}, properties = {})
         info "Execute: #{exp_path}"
         info "Properties: #{OmfEc.experiment.cmdline_properties}"
 
-        ec_cert = OmfCommon.load_credentials(
-          root_cert_dir: global_options[:root_cert_dir],
-          entity_cert: global_options[:cert],
-          entity_key: global_options[:key]
-        )
+        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)
+          ec_cert.resource_id = OmfCommon.comm.local_address
+          OmfCommon::Auth::CertificateStore.instance.register(ec_cert)
+        end
 
         begin
           include OmfEc::Backward::DefaultEvents

data/lib/omf_ec/backward/dsl.rb

@@ -15,6 +15,7 @@ module OmfEc
           v5_style(:onEvent, base)
           v5_style(:allGroups, base)
           v5_style(:allNodes!, base)
+          v5_style(:defGraph, base)
         end
 
         def v5_style(name, base)
@@ -49,7 +50,7 @@ module OmfEc
       def wait(duration)
         info "Request from Experiment Script: Wait for #{duration}s...."
         warn "Calling 'wait' or 'sleep' will block entire EC event loop. Please try 'after' or 'every'"
-        sleep duration
+        sleep duration.to_s.to_i
       end
     end
   end

data/lib/omf_ec/context/app_context.rb

@@ -88,5 +88,14 @@ module OmfEc::Context
       end
       p
     end
+
+    def mp_table_names
+      {}.tap do |m_t_n|
+        @oml_collections.map { |v| v[:streams] }.flatten.each do |s|
+          mp = s[:mp].to_s
+          m_t_n[mp] = "#{self.app_def.name}_#{mp}"
+        end
+      end
+    end
   end
 end

data/lib/omf_ec/dsl.rb

@@ -174,6 +174,21 @@ module OmfEc
       end
     end
 
+    # Define a new graph widget showing experiment related measurements to be
+    # be used in a LabWiki column.
+    #
+    # The block is called with an instance of the 'LabWiki::OMFBridge::GraphDescription'
+    # class. See that classes' documentation on the methods supported.
+    #
+    # @param name short/easy to remember name for this graph
+    def def_graph(name = nil, &block)
+      if OmfEc.experiment.show_graph
+        gd = OmfEc::Graph::GraphDescription.create(name)
+        block.call(gd)
+        gd._report
+      end
+    end
+
     include OmfEc::Backward::DSL
   end
 end

data/lib/omf_ec/experiment.rb

@@ -15,7 +15,7 @@ module OmfEc
 
     include MonitorMixin
 
-    attr_accessor :name, :oml_uri, :app_definitions, :property, :cmdline_properties
+    attr_accessor :name, :oml_uri, :app_definitions, :property, :cmdline_properties, :show_graph
     attr_reader :groups, :sub_groups, :state
 
     def initialize
@@ -27,6 +27,7 @@ module OmfEc
       @app_definitions ||= Hash.new
       @sub_groups ||= []
       @cmdline_properties ||= Hash.new
+      @show_graph = false
     end
 
     def property
@@ -140,7 +141,7 @@ module OmfEc
 
     # Unique experiment id
     def id
-      @name.nil? ? @id : @name
+      @name || @id
     end
 
     # Parsing user defined events, checking conditions against internal state, and execute callbacks if triggered
@@ -160,6 +161,14 @@ module OmfEc
       end
     end
 
+    def mp_table_names
+      {}.tap do |m_t_n|
+        groups.map(&:app_contexts).flatten.map(&:mp_table_names).each do |v|
+          m_t_n.merge!(v)
+        end
+      end
+    end
+
     # Purely for backward compatibility
     class << self
       # Disconnect communicator, try to delete any XMPP affiliations

data/lib/omf_ec/graph/graph_description.rb

@@ -0,0 +1,117 @@
+# 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.
+
+require 'sequel'
+require 'json'
+
+module OmfEc::Graph
+  # Describes a graph which can be displayed through the web interface or any other defined graph visualiser.
+  class GraphDescription
+    @@gds = {}
+
+    def self.create(name = nil)
+      if name
+        @@gds[name.to_sym] ||= self.new(name)
+      else
+        self.new("Unknown #{self.object_id}")
+      end
+    end
+
+    # Define text to be shown above the graph
+    #
+    # @param text
+    #
+    def postfix(text)
+      @postfix = text
+    end
+
+    # Define the measurement stream to be visualized in
+    # the graph. The optional 'context' parameter defines
+    # the context in which the MS is used in the graph. This
+    # is necessary for graphs, such as 'networks' which need
+    # more than one MS to describe the visualization.
+    #
+    # @param ms_name
+    # @param context
+    #
+    def ms(ms_name, context = :default)
+      if (table_name = OmfEc.experiment.mp_table_names[ms_name])
+        (@ms[context] ||= []) << (msb = MSBuilder.new(@db[table_name.to_sym]))
+      else
+        warn "Measurement point '#{ms_name}' NOT defined"
+      end
+      msb
+    end
+
+    # Defines the mapping of columns in the measurement tuples to properties
+    # of the visualization.
+    #
+    # @param mhash Hash of mappings specific to the graph ifentified by 'type'
+    def mapping(mhash)
+      @mapping = mhash
+    end
+
+    def type(gtype)
+      @gtype = gtype
+    end
+
+    def xaxis(props)
+      (@axis ||= {})[:x] = props
+    end
+
+    def yaxis(props)
+      (@axis ||= {})[:y] = props
+    end
+
+    def caption(text)
+      @caption = text
+    end
+
+    def _report
+      info "REPORT:START: #{@name}"
+      info "REPORT:TYPE: #{@gtype}"
+      info "REPORT:POSTFIX: #{URI.encode(@postfix)}" if @postfix
+      @ms.each do |ctxt, a|
+        a.each do |ms|
+          info "REPORT:MS:#{ctxt}: #{URI.encode(ms.sql)}"
+        end
+      end
+      info "REPORT:MAPPING: #{URI.encode(@mapping.to_json)}"
+      if @axis
+        info "REPORT:AXIS: #{URI.encode(@axis.to_json)}"
+      end
+      info "REPORT:CAPTION: #{URI.encode(@caption)}" if @caption
+      info "REPORT:STOP"
+    end
+
+    protected
+
+    def initialize(name)
+      @name = name
+      @ms = {}
+      # Create a generic Sequel object which can be used to serialize the query.
+      # TODO: Make sure this is generic enough
+      @db = Sequel.postgres
+      @db.instance_variable_set('@server_version', 90105)
+    end
+  end
+
+  class MSBuilder
+    def initialize(data_set)
+      @data_set = data_set
+    end
+
+    def method_missing(symbol, *args, &block)
+      debug "Calling #{symbol}::#{args.inspect}"
+      res = @data_set.send(symbol, *args, &block)
+      if res.is_a? Sequel::Postgres::Dataset
+        @data_set = res
+        res = self
+      end
+      debug "Result: #{res.class}"
+      res
+    end
+  end
+end

data/lib/omf_ec/graph.rb

@@ -0,0 +1,6 @@
+require "omf_ec/graph/graph_description"
+
+module OmfEc
+  module Graph
+  end
+end

data/lib/omf_ec.rb

@@ -16,6 +16,7 @@ require "omf_ec/experiment"
 require "omf_ec/group"
 require "omf_ec/app_definition"
 require "omf_ec/context"
+require "omf_ec/graph"
 require "omf_ec/dsl"
 
 module OmfEc

data/omf_ec.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency "omf_common", "= #{OmfCommon::VERSION}"
   s.add_runtime_dependency "gli"
+  s.add_runtime_dependency "sequel"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omf_ec
 version: !ruby/object:Gem::Version
-  version: 6.0.8.pre.1
+  version: 6.0.8.pre.2
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.8.pre.1
+        version: 6.0.8.pre.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.8.pre.1
+        version: 6.0.8.pre.2
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ! '>='
       - !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
   managing networking testbeds.
 email:
@@ -146,6 +160,8 @@ files:
 - lib/omf_ec/dsl.rb
 - lib/omf_ec/experiment.rb
 - lib/omf_ec/experiment_property.rb
+- lib/omf_ec/graph.rb
+- lib/omf_ec/graph/graph_description.rb
 - lib/omf_ec/group.rb
 - lib/omf_ec/version.rb
 - omf_ec.gemspec