omf_ec 6.0.0.pre.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in omf_ec.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_spec.rb"
+  t.verbose = true
+end

data/bin/omf_test

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require 'omf_common'
+$stdout.sync = true
+
+options = {
+  dsl: 'xmpp_blather',
+  pubsub_host: 'pubsub',
+}
+
+executable_name = File.basename($PROGRAM_NAME)
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "usage: #{executable_name} [options]"
+
+  opts.on("-u USER", "Username") do |user|
+    options[:user] = user
+  end
+
+  opts.on("-p PASSWORD", "Password") do |password|
+    options[:password] = password
+  end
+
+  opts.on("-s SERVER", "XMPP server") do |server|
+    options[:server] = server
+  end
+
+  opts.on("-n NODE", "PubSub node to subscribe") do |node|
+    options[:uid] = node
+  end
+
+  opts.on("-d", "--debug", "Debug mode") do
+    options[:debug] = true
+  end
+end
+
+begin
+  option_parser.parse!
+rescue => e
+  puts e.message
+  puts ""
+  puts option_parser.help
+  exit(1)
+end
+
+unless options[:server] && options[:user] && options[:server]
+  puts option_parser.help
+  exit(1)
+end
+
+Logging.logger.root.level = :debug if options[:debug]
+Blather.logger = logger
+
+comm = OmfCommon::Comm.new(options[:dsl])
+host = nil
+
+# Create a resource of type mock
+create_msg = OmfCommon::Message.create { |v| v.property('type', 'mock') }.sign
+
+create_wifi_msg = OmfCommon::Message.create do |v|
+  v.property('hrn', 'wlan0')
+  v.property('type', 'wifi')
+end.sign
+
+# A request message to be sent to mock
+request_mock_property = OmfCommon::Message.request do |v|
+  v.property('available_properties')
+  v.property('kernel_version')
+  v.property('resource_proxy_list')
+  v.property('resource_utility_list')
+  v.property('bob')
+end.sign
+
+request_wifi_property = OmfCommon::Message.request do |v|
+  v.property('link')
+  v.property('available_properties')
+end.sign
+
+# A request message to be sent to node
+request_node_property = OmfCommon::Message.request do |v|
+  v.property('available_properties')
+  v.property('proxies')
+end
+
+# A configure message to be sent to mock
+configure_mock_property = OmfCommon::Message.configure do |v|
+  v.property('hrn', 'human_readable_name')
+end.sign
+
+# Simple release message
+release_message = OmfCommon::Message.release.sign
+
+# For simplicity, use comm instance directly
+comm.when_ready do
+  logger.info "CONNECTED: #{comm.jid.inspect}"
+  host = "#{options[:pubsub_host]}.#{comm.jid.domain}"
+
+  # We assume the node where RC runs started already
+  comm.subscribe(options[:uid], host) do |e|
+    if e.error?
+      comm.disconnect(host)
+    else
+      # Publish the create message to RC's pubsub node
+      comm.publish(options[:uid], request_node_property, host)
+      comm.publish(options[:uid], create_wifi_msg, host)
+    end
+  end
+end
+
+# Fired when messages published to the nodes I subscribed to
+comm.node_event do |e|
+  e.items.each do |item|
+    begin
+      # Parse the message (pubsub item payload)
+      message = OmfCommon::Message.parse(item.payload)
+      context_id = message.read_content("context_id")
+
+      # We are only interested in inform messages for the moment
+      if message.operation == :inform
+        inform_type = message.read_content("inform_type")
+
+        case inform_type
+        when 'CREATED'
+          resource_id = message.read_content("resource_id")
+          logger.info "Resource #{resource_id} created"
+
+          comm.subscribe(resource_id, host) do |m|
+            EM.add_periodic_timer(2) do
+              comm.publish(resource_id, request_wifi_property, host)
+              #comm.publish(resource_id, request_mock_property, host)
+              #comm.publish(resource_id, configure_mock_property, host)
+            end
+          end
+
+        when 'STATUS'
+          message.read_element("//property").each do |p|
+            logger.info "#{p.attr('key')} => #{p.content.strip}"
+          end
+        when 'RELEASED'
+          logger.info "Resource #{message.read_content("resource_id")} released"
+        when 'FAILED'
+          logger.error message.read_content("error_message")
+        end
+      end
+    rescue => e
+      logger.error "#{e.message}\n#{e.backtrace.join("\n")}"
+    end
+  end
+end
+
+trap(:INT) { comm.disconnect(host) }
+trap(:TERM) { comm.disconnect(host) }
+
+EM.run do
+  comm.connect(options[:user], options[:password], options[:server])
+
+  EM.add_timer(5) do
+    comm.publish(options[:uid], release_message, host)
+  end
+end

data/config/ec.yml

@@ -0,0 +1,164 @@
+#
+# Copyright (c) 2006-2009 National ICT Australia (NICTA), Australia
+#
+# Copyright (c) 2004-2009 WINLAB, Rutgers University, USA
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#
+# This is the config file for the OMF Experiment Controller
+#
+# NOTE: use only 'spaces' to indent !
+# ('tab' indents are not supported by the ruby yaml parser, which is used to
+# read this file)
+#
+---
+:econtroller:
+
+  :config:
+
+    # Config Parameter for the "default" profile
+    # IMPORTANT: There has to be a default entry. It should contain a complete
+    # set of parameters, so other profiles can fall back to it
+    :default:
+
+      # This is the domain name of the testbed
+      # You need a corresponding entry in the testbed table of your inventory
+      # that has this name set in the 'node_domain' column
+      :domain: 'norbit'
+      :slice: 'default_slice'
+
+      # This is the Path where EC should look for its repository of built-in
+      # experiments (e.g. example experiments, maintenance experiments, etc...)
+      :repository:
+        :path: ["../share/repository", "/usr/share/omf-expctl-5.4/repository"]
+
+      # URI to the OML server to use for this EC
+      # (can be overwritten on the EC command line)
+      :omluri: 'tcp:norbit.npc.nicta.com.au:3003'
+
+      # This should be the IP address of the local interface that is accessible
+      # from the nodes. This address will be given to the nodes so they can
+      # retrieve applications from the EC via HTTP.
+      :web:
+        :host: '10.0.0.200'
+        :resource_dir: ["../../omf-common/share/htdocs", "/usr/share/omf-common-5.4/share/htdocs"]
+
+      :communicator:
+
+        # set this to false if you want to disable signature checks and message signing
+        :authenticate_messages: false
+        # your RSA/DSA SSH private key file
+        :private_key: '~/.ssh/id_rsa'
+        # directory holding the public keys of your OMF peers
+        :public_key_dir: '~/.omf-expctl/peer_keys'
+
+        :type: 'xmpp'
+        :xmpp:
+          # Address of the server to use as gateway for PubSub communication
+          :pubsub_gateway: 'norbit.npc.nicta.com.au'
+          #:pubsub_port: 5222
+          # The 'pubsub_domain' is the hostname of the pubsub server on which
+          # you would like to host your slice's communications. Leave this
+          # commented if you wish to host them on the 'pubsub_gateway' server
+          # which you selected above.
+          #:pubsub_domain: 'norbit.npc.nicta.com.au'
+          # The following 'pubsub_user' and 'pubsub_pwd' are optional
+          # EC will create a unique user/pwd for itself if this is not provided
+          # In a typical OMF install, you should not uncomment these lines
+          # (do so only if you need to manually set user/password for
+          # your client to connect to your pubsub server)
+          #:pubsub_user: 'my_EC_name'
+          #:pubsub_pwd: 'my_EC_password'
+          # set this to "true" if you have a DNS SRV record pointing to the
+          # real pubsub server hostname
+          :pubsub_use_dnssrv: false
+
+      # AM contact details. By default, the AM is contacted through the EC's XMPP
+      # connection as specified in the ':communicator:' section above. In this
+      # ':services:' section, you can specify additional AM contact details.
+      # Supported protocols are XMPP and HTTP for legacy services.
+      :services:
+        -
+          :type: :http
+          :uri: 'http://norbit.npc.nicta.com.au:5054'
+        # -
+        #   :type: :xmpp
+        #   :uri: 'norbit.npc.nicta.com.au'
+        #   :user: 'joe'
+        #   :password: 'fluffy'
+
+
+    ##########################
+    # config parameters for the "p2p" profile
+    :p2p:
+      :domain: 'planetlab'
+      :repository:
+         :path: [".", "../share/repository", "/usr/share/omf-expctl-5.4/repository"]
+      :inventory:
+        :url: 'http://planetlab-europe-07.ipv6.lip6.fr:5054/inventory'
+#      :web:
+#       :host: 'your_hostname_or_ip_here'
+      :result:
+        :url: 'http://planetlab-europe-07.ipv6.lip6.fr:5054/result/'
+      :communicator:
+        :type: 'xmpp'
+        :xmpp:
+          :server: planetlab-europe-07.ipv6.lip6.fr
+          :password: '123'
+    ####
+    :planetlab:
+      :domain: 'planetlab'
+      :slice: 'ost_securexmpp'
+      :repository:
+        :path: ["../share/repository", "/usr/share/omf-expctl-5.4/repository"]
+      :inventory:
+        :url: 'http://mytestbed.net:5054/inventory'
+
+      :web:
+        :host: '10.0.0.200'
+        :resource_dir: ["../../omf-common/share/htdocs", "/usr/share/omf-common-5.4/share/htdocs"]
+
+      :communicator:
+
+        :authenticate_messages: true
+        :private_key: '~/.ssh/id_rsa'
+        :public_key_dir: '~/.omf-expctl/peer_keys'
+
+        :type: 'xmpp'
+        :xmpp:
+          :pubsub_gateway: 'mytestbed.net'
+
+    ##########################
+    # config parameters for the "p2p" profile
+    #
+    # To use this testbed, call EC with the option PRINT_ONLY or "-d debug"
+    # Any parameter settings within this section will override the settings
+    # done in the "default" section. The EC first loads the "default"
+    # settings, then it uses the "debug" specific settings to override the
+    # relevant parameters
+    :debug:
+      :repository:
+        :path: ['.', '../share/repository']
+      :communicator:
+        :type: 'mock'
+      :log: '../etc/omf-expctl/debug_log.xml'
+      :inventory:
+        :url: 'http://norbit.npc.nicta.com.au:5054/inventory'
+

data/exp_repo/system/exp/eventlib.rb

@@ -0,0 +1,96 @@
+#
+# Copyright (c) 2006-2010 National ICT Australia (NICTA), Australia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#
+# = eventlib.rb 
+#
+# == Description
+#
+# This Ruby file contains various common Event declarations, which the EC will 
+# load before the user's experiment file
+#
+
+#
+# This provide some default Event definition that the user may use in his 
+# experiment, without having to worry about how to define them.
+# To start one of the event monitoring defined here, the user need to associate 
+# at least one block of tasks to it, using the onEvent() OEDL call.
+# See the OEDL documentation for more info and a tutorial
+#
+
+defEvent(:ALL_UP_AND_INSTALLED) do |event|
+  node_status = allGroups.state("status/@value")
+  app_status = allGroups.state("apps/app/status/@value")
+  if allEqual(node_status, "UP") && allEqual(app_status, "INSTALLED.OK")
+    event.fire 
+  end
+end
+
+defEvent(:ALL_UP) do |event|
+  node_status = allGroups.state("status/@value")
+  event.fire if allEqual(node_status, "UP")
+end
+
+defEvent(:ALL_INTERFACE_UP) do |event|
+  iface_status = allGroups.state("net/*/*/current/@status")
+  #info "TDEBUG - #{if_status.join(" ")}"
+  event.fire if allEqual(iface_status, "CONFIGURED.OK")
+end
+
+defEvent(:EXPERIMENT_DONE) do |event|
+  exp_status = Experiment.state("status/text()")
+  event.fire if allEqual(exp_status, "DONE")
+end
+
+onEvent(:EXPERIMENT_DONE, true) do |event|
+  Experiment.close
+end
+
+defEvent(:INTERRUPT, 1) do |event|
+  exp_status = Experiment.state("status/text()")
+  event.fire if allEqual(exp_status, "INTERRUPTED")
+end
+
+onEvent(:INTERRUPT) do |event|
+  MObject.info(:INTERRUPT, "\n\nUser issued an Interruption. Stopping the experiment now! Please wait...\n")
+  Experiment.done
+end
+
+defEvent(:NO_USER_DEFINED_EVENTS) do |event|
+  if Experiment.running? && !Experiment.disconnection_allowed?
+    if Event.empty?(:ignore => [:EXPERIMENT_DONE, :NO_USER_DEFINED_EVENTS])
+      event.fire 
+    end
+  end
+end
+
+onEvent(:NO_USER_DEFINED_EVENTS) do |event|
+  warn " "
+  warn "Warning!!! Your experiment has no user-defined events!"
+  warn "It is likely that nothing will happen from now one..."
+  warn "Press CTRL-C only ONCE to stop your experiment.\n"
+  # An alternative... not sure what is the best here, for now use the above
+  # warn "Closing down your experiment now..."
+  # Experiment.done
+end
+
+
+