omf_common 6.0.2.pre.2 → 6.0.2

data/bin/file_broadcaster.rb

@@ -1,3 +1,8 @@
+# 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.
+
 #
 DESCR = %{
 Broadcast a file to a topic group

data/bin/file_receiver.rb

@@ -1,3 +1,8 @@
+# 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.
+
 #
 DESCR = %{
 Receive a file sent to a topic group

data/bin/omf_keygen

@@ -4,7 +4,7 @@ require 'omf_common'
 
 OmfCommon::Auth::CertificateStore.init
 
-root = OmfCommon::Auth::Certificate.create(nil, 'omf_ca', 'ca', 'omf')
+root = OmfCommon::Auth::Certificate.create(nil, 'omf_ca', 'ca', 'omf', nil, Time.now, 3600 * 365 * 10)
 
 ec_key = OpenSSL::PKey::RSA.new(2048)
 rc_key = OpenSSL::PKey::RSA.new(2048)
@@ -12,8 +12,8 @@ rc_key = OpenSSL::PKey::RSA.new(2048)
 ec_pub = ec_key.public_key
 rc_pub = rc_key.public_key
 
-ec = root.create_for('ec', 'ec', 'controller', 'omf', 365, ec_pub)
-rc = root.create_for('rc', 'rc', 'controller', 'omf', 365, rc_pub)
+ec = root.create_for('my_ec', 'ec', 'controller', 'omf', 3600 * 365 * 10, ec_pub)
+rc = root.create_for('my_rc', 'rc', 'controller', 'omf', 3600 * 365 * 10, rc_pub)
 
 %w(root ec_key rc_key ec_pub rc_pub ec rc).each do |n|
   File.write("#{n}.pem", eval(n).to_pem)

data/bin/omf_send_configure

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+BIN_DIR = File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__)
+TOP_DIR = File.join(BIN_DIR, '..')
+$: << File.join(TOP_DIR, 'lib')
+
+DESCR = %{
+Send a configure message to a specific resource (topic) and print out any replies.
+
+Any additional command line arguments are interpreted as property:value and are
+sent with the create message.
+}
+
+require 'omf_common'
+
+OP_MODE = :development
+$debug = false
+$timeout = 10
+
+
+opts = {
+  communication: {
+    #url: 'xmpp://srv.mytestbed.net'
+  },
+  eventloop: { type: :em},
+  logging: {
+    level: 'info'
+  }  
+}
+
+resource_url = nil
+resource_properties = {}
+
+op = OptionParser.new
+op.banner = "Usage: #{op.program_name} [options] property1:value1 property2:value2 ...\n#{DESCR}\n"
+op.on '-r', '--resource-url URL', "URL of resource (e.g. xmpp://my.server.com/topic1)" do |url|
+  resource_url = url
+end
+op.on '-y', '--yaml YAML_FILE', "Read type and property from YAML file" do |yfile|
+  require 'yaml'
+  y = YAML.load_file(yfile)
+  unless o = y['configure']
+    puts "Expected top level 'configure', but found '#{y.keys.inspect}'"
+    abort
+  end
+  resource_properties = o['properties']
+end
+op.on '-d', '--debug', "Set log level to DEBUG" do
+  opts[:logging][:level] = 'debug'
+  $debug = true
+end
+op.on_tail('-h', "--help", "Show this message") { $stderr.puts op; exit }
+rest = op.parse(ARGV) || []
+
+unless resource_url || resource_type
+  $stderr.puts 'Missing --resource-url --type or'
+  $stderr.puts op
+  exit(-1)
+end
+
+r = resource_url.split('/')
+resource = r.pop
+opts[:communication][:url] = r.join('/')
+
+key = nil
+def err_exit
+  $stderr.puts("Options need to be of the 'key: value' type")
+  exit(-1)  
+end
+rest.each do |s|
+  sa = s.split(':')
+  if sa.length == 2
+    err_exit if key
+    resource_properties[sa[0]] = sa[1]
+  else
+    if s.end_with?(':')
+      err_exit if key
+      key = s[0]
+    else
+      err_exit unless key
+      resource_properties[key] = s[0]
+      key = nil
+    end
+  end
+end
+err_exit if key
+
+def print_prop(name, value, level = 0)
+  print "  #{'  ' * level}#{name}:"
+  if value.is_a? Hash
+    puts ''
+    value.each {|k, v| print_prop(k, v, level + 1)}
+  else 
+    puts " #{value}"
+  end
+end
+
+OmfCommon.init(OP_MODE, opts) do |el|
+  OmfCommon.comm.on_connected do |comm|
+    comm.subscribe(resource) do |topic|
+      topic.configure(resource_properties) do |msg|
+        if (src_topic = msg.src.id) == topic.id
+          puts "#{topic.id}"        
+        else
+          puts "#{src_topic} via #{topic.id}"
+        end
+        msg.each_property do |name, value|
+          print_prop(name, value)
+        end
+        puts "-----------------"
+      end
+      el.after($timeout) { el.stop } if $timeout > 0
+    end
+  end
+end

data/bin/omf_send_request

@@ -13,6 +13,7 @@ to those, otherwise all properties are requested.
 require 'omf_common'
 
 OP_MODE = :development
+$timeout = 10
 
 opts = {
   communication: {
@@ -47,17 +48,31 @@ r = resource_url.split('/')
 resource = r.pop
 opts[:communication][:url] = r.join('/')
 
+def print_prop(name, value, level = 0)
+  print "  #{'  ' * level}#{name}:"
+  if value.is_a? Hash
+    puts ''
+    value.each {|k, v| print_prop(k, v, level + 1)}
+  else 
+    puts " #{value}"
+  end
+end
+
 OmfCommon.init(OP_MODE, opts) do |el|
   OmfCommon.comm.on_connected do |comm|
     comm.subscribe(resource) do |topic|
       topic.request(req_properties) do |msg|
-        dm = (opts[:logging][:level] == 'debug') ? "    #{msg.inspect}" : ""
-        puts "#{resource}   <#{msg.type}(#{msg.itype})>#{dm}"
+        if (src_topic = msg.src.id) == topic.id
+          puts "#{topic.id}"        
+        else
+          puts "#{src_topic} via #{topic.id}"
+        end
         msg.each_property do |name, value|
-          puts "    #{name}: #{value}"
+          print_prop(name, value)
         end
-        puts "------"
+        puts "-----------------"
       end
+      el.after($timeout) { el.stop } if $timeout > 0
     end
   end
 end

data/example/engine_alt.rb

@@ -1,15 +1,20 @@
+# 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.
+
 # OMF_VERSIONS = 6.0
 require 'omf_common'
 require 'omf_common/auth/certificate'
 
-root_cert = OmfCommon::Auth::Certificate.create('sa', 'authority')
+#root_cert = OmfCommon::Auth::Certificate.create(nil, 'sa', 'authority')
 opts = {
   communication: {
     auth: {
       #store: 'amqp://localhost',
-      certs: [
-        root_cert.to_pem_compact
-      ]
+      # certs: [
+        # root_cert.to_pem_compact
+      # ]
     }
   }
 }
@@ -17,7 +22,7 @@ opts = {
 
 OmfCommon.init(:local, opts)
 # Create a certificate for this controller
-root_cert.create_for(:controller, :controller, OmfCommon.comm.local_address())
+#root_cert.create_for(:controller, :controller, OmfCommon.comm.local_address())
 
 
 def create_engine(garage)
@@ -111,8 +116,9 @@ OmfCommon.eventloop.run do |el|
 
     # Create garage proxy
     load File.join(File.dirname(__FILE__), '..', '..', 'omf_rc', 'example', 'garage_controller.rb')
-    garage_cert = root_cert.create_for(:garage1, :garage)
-    garage_inst = OmfRc::ResourceFactory.create(:garage, uid: :garage_1, certificate: garage_cert)
+    #garage_cert = root_cert.create_for(:garage1, :garage)
+    #garage_inst = OmfRc::ResourceFactory.create(:garage, uid: :garage_1, certificate: garage_cert)
+    garage_inst = OmfRc::ResourceFactory.create(:garage, uid: :garage_1)
 
     # Get handle on existing entity
     comm.subscribe('garage_1') do |garage|

data/example/viz/garage_monitor.rb

@@ -0,0 +1,69 @@
+# 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 'omf_oml/table'
+
+class GarageMonitor < OMF::Common::LObject
+  OP_MODE = :development
+
+  def initialize(opts)
+    @observed_topics = {}
+
+    create_event_table
+    Thread.new do
+      begin
+        sleep 3
+        OmfCommon.init(OP_MODE, opts) do |el|
+          OmfCommon.comm.on_connected do |comm|
+            observe('garage1', comm)
+          end
+        end
+      rescue Exception => ex
+        puts "ERROR: #{ex}"
+        puts "\t#{ex.backtrace.join("\n\t")}"
+      end
+    end
+    
+    
+  end
+  
+  def observe(tname, comm)
+    return if (tname.nil? || @observed_topics.key?(tname))
+  
+    info "Observing '#{tname}'"
+    @observed_topics[tname] = true
+    comm.subscribe(tname) do |topic|
+      topic.on_message do |msg|
+        ts = Time.now.strftime('%H:%M:%S')
+        src = topic.id
+        type = "#{msg.type}(#{msg.itype})"
+        msg.each_property do |name, value|
+          @evt_table.add_row [ts, src, type, name, value]
+        end
+        if msg.itype == 'released' && src != :garage1
+          @engine_table.add_row [ts, src, -1, -1]
+        end
+        
+        if (msg[:throttle] && msg[:rpm])
+          puts "RPM: #{msg[:rpm]}::#{msg[:rpm].class}"
+          @engine_table.add_row [ts, src, msg[:throttle], msg[:rpm]]
+        end
+        observe(msg[:res_id], comm)
+      end
+    end
+  end
+  
+  
+  
+  def create_event_table(fake_events = true)
+    evt_schema = [:ts, :address, :type, :name, :value]
+    @evt_table = OMF::OML::OmlTable.new 'events', evt_schema, :max_size => 500
+    OMF::Web.register_datasource @evt_table
+
+    engine_schema = [:ts, :source, [:throttle, :int], [:rpm, :int]]
+    @engine_table = OMF::OML::OmlTable.new 'engine', engine_schema, :max_size => 20
+    OMF::Web.register_datasource @engine_table.indexed_by(:source), name: 'engine'
+  end
+end

data/example/viz/garage_viz.rb

@@ -0,0 +1,52 @@
+# 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 'omf_common'
+require 'omf_common/lobject'
+# require 'yaml'
+# require 'log4r'
+
+OMF::Common::Loggable.init_log 'garage_monitor', searchPath: File.dirname(__FILE__)
+
+
+omf_opts = {
+  communication: {
+    url: 'amqp://0.0.0.0',
+    auth: {}
+
+  },
+  eventloop: { type: :em},
+  logging: {
+    level: 'info'
+  }
+}
+
+# Configure the web server
+#
+opts = {
+  app_name: 'garage_monitor',
+  page_title: 'Garage',
+  layout: "#{File.dirname(__FILE__)}/layout.yaml",
+  footer_right: 'git:mytestbed/omf',
+  static_dirs_pre: ["#{File.dirname(__FILE__)}/htdocs"],
+  handlers: {
+    # delay connecting to databases to AFTER we may run as daemon
+    pre_rackup: lambda do
+      load("#{File.dirname(__FILE__)}/garage_monitor.rb")
+      GarageMonitor.new(omf_opts)
+    end,
+    pre_parse: lambda do |p|
+      p.separator ""
+      p.separator "GARAGE options:"
+      p.on '--comms-url URL', "URL to communication layer [#{omf_opts[:communication][:url]}]" do |url|
+        omf_opts[:communication][:url] = url
+      end
+      p.separator ""
+    end
+  }
+}
+require 'omf_web'
+OMF::Web.start(opts)

data/example/viz/htdocs/template/garage_banner.html

@@ -0,0 +1,2 @@
+
+<img src="/resource/image/garage.png">

data/example/viz/layout.yaml

@@ -0,0 +1,44 @@
+
+
+# 
+#
+
+widget:
+  id: overview
+  name: Overview
+  top_level: true
+  priority: 900
+  type: layout/two_columns/50_50
+  chrome: false  # don't show title
+  widgets:
+    left:
+      - type: moustache
+        text: '<img src="/resource/image/garage.png">'
+        context:
+
+      - type: data/gauge
+        title: Engine
+        data_source:
+          name: engine
+          dynamic: 1  # check once a second
+        mapping:
+          id: source
+          value: rpm
+    right:
+      - type: data/table2
+        title: Events
+        data_source:
+          name: events
+          dynamic: 1  # check once a second
+        # topts: 
+          # enableCellNavigation: true
+        margin:
+          left: 5
+  
+      - type: data/table2
+        title: Engine
+        data_source:
+          name: engine
+          dynamic: 1  # check once a second
+        margin:
+          left: 5

data/example/vm_alt.rb

@@ -1,3 +1,8 @@
+# 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.
+
 
 # Communication setup
 Comm.init(:xmpp)

data/lib/omf_common.rb

@@ -1,3 +1,8 @@
+# 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 'active_support/core_ext'
 
 require 'omf_common/default_logging'
@@ -12,6 +17,10 @@ require 'omf_common/eventloop'
 
 include OmfCommon::DefaultLogging
 
+# Set the default encoding to UTF8
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 module OmfCommon
   DEFAULTS = {
     development: {
@@ -19,7 +28,7 @@ module OmfCommon
         type: 'em'
       },
       logging: {
-        level: { 
+        level: {
           default: 'debug'
         },
         appenders: {
@@ -36,7 +45,7 @@ module OmfCommon
         type: :em
       },
       logging: {
-        level: { 
+        level: {
           default: 'info'
         },
         appenders: {
@@ -62,7 +71,7 @@ module OmfCommon
         type: :em
       },
       logging: {
-        level: { 
+        level: {
           default: 'info'
         },
         appenders: {
@@ -82,7 +91,7 @@ module OmfCommon
       },
       eventloop: { type: :local},
       logging: {
-        level: { 
+        level: {
           default: 'debug'
         },
         appenders: {
@@ -106,7 +115,7 @@ module OmfCommon
         type: :em
       },
       logging: {
-        level: { 
+        level: {
           default: 'debug'
         },
         appenders: {
@@ -188,9 +197,9 @@ module OmfCommon
   #   :remove_root ROOT_NAME: Remove the root node. Throw exception if not ROOT_NAME
   #   :wait_for_readable SECS: Wait until the yaml file becomes readable. Check every SECS
   #   :erb_process flag: Run the content of the loaded file through ERB first before YAML parsing
-  #   :erb_safe_level level: If safe_level is set to a non-nil value, ERB code will be run in a 
+  #   :erb_safe_level level: If safe_level is set to a non-nil value, ERB code will be run in a
   #                                   separate thread with $SAFE set to the provided level.
-  #   :erb_binding binding: Optional binding given to ERB#result 
+  #   :erb_binding binding: Optional binding given to ERB#result
   #
   def self.load_yaml(file_name, opts = {})
     if path_opt = opts[:path]
@@ -262,7 +271,7 @@ module OmfCommon
           if name.to_s == 'default'
             logger.level = lvl.to_sym
           else
-            Logging.logger[name.to_s].level = lvl.to_sym 
+            Logging.logger[name.to_s].level = lvl.to_sym
           end
         end
       else