omf_ec 6.0.0.pre.2 → 6.0.0.pre.3

data/Rakefile

@@ -1,6 +1,8 @@
 require 'rake/testtask'
 require "bundler/gem_tasks"
 
+task :default => :test
+
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_spec.rb"
   t.verbose = true

data/bin/omf

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+#
+require 'gli'
+require 'omf_ec'
+
+include GLI::App
+
+program_desc "Run a command on the testbed(s)"
+
+version OmfEc::VERSION
+
+desc "Debug (this script only, not passed to omf exec)"
+switch [:d, :debug]
+
+desc "Execute an experiment script"
+arg_name 'Describe arguments to exec here'
+command :exec do |c|
+  c.desc 'Describe a switch to exec'
+  c.switch :s
+
+  c.desc 'Describe a flag to exec'
+  c.default_value 'default'
+  c.flag :f
+  c.action do |global_options,options,args|
+
+    # Your command logic here
+
+    # If you have any errors, just raise them
+    # raise "that command made no sense"
+  end
+end
+
+desc "Load a disk image on a given set of nodes"
+command :load do |c|
+  c.desc 'Describe a flag to exec'
+  c.default_value 'default'
+  c.flag :f
+
+  c.desc "Aggregate Name"
+  c.arg_name "AGGREGATE"
+  c.flag [:c, :config]
+
+  c.desc "A valid topology file or description. If a file 'TOPOLOGY' doesn't exist, interpret it as a comma-separated list of nodes)"
+  c.default_value "system:topo:all"
+  c.arg_name "TOPOLOGY"
+  c.flag [:t, :topology]
+
+  c.desc "Disk image to load"
+  c.default_value "baseline.ndz"
+  c.arg_name "IMAGE"
+  c.flag [:i, :image]
+
+  c.desc "A duration (in sec.) after which imageNodes should stop waiting for nodes that have not finished their image installation"
+  c.default_value "800"
+  c.arg_name "SECONDS"
+  c.flag [:o, :timeout]
+
+  c.desc "Path where the resulting Topologies should be saved"
+  c.default_value "/tmp"
+  c.arg_name "PATH"
+  c.flag [:outpath]
+
+  c.desc "Prefix to use for naming the resulting Topologies"
+  c.default_value "your experiment ID"
+  c.arg_name "PREFIX"
+  c.flag [:outprefix]
+
+  c.action do |global_options,options,args|
+  end
+end
+
+desc "Save a disk image from a given node into a file"
+command :save do |c|
+  c.desc "Aggregate Name"
+  c.arg_name "AGGREGATE"
+  c.flag [:c, :config]
+
+  c.desc "Save image node"
+  c.arg_name "NODE"
+  c.flag [:n, :node]
+
+  c.action do |global_options,options,args|
+  end
+end
+
+desc "Switch a given set of nodes ON/OFF or reboot them"
+long_desc <<-DESC
+  Specify a CMC action:
+
+  on      - turn node(s) ON
+
+  offs    - turn node(s) OFF (soft)
+
+  offh    - turn node(s) OFF (hard)
+
+  reboot  - treboots node(s) (soft)
+
+  reset   - tresets node(s) (hard)
+DESC
+command :tell do |c|
+  c.desc "A valid topology file or description. If a file 'TOPOLOGY' doesn't exist, interpret it as a comma-separated list of nodes)"
+  c.default_value "system:topo:all"
+  c.arg_name "TOPOLOGY"
+  c.flag [:t, :topology]
+
+  c.desc "Aggregate Name"
+  c.arg_name "AGGREGATE"
+  c.flag [:c, :config]
+
+  c.desc "CMC action"
+  c.arg_name "ACTION"
+  c.flag [:a, :action], :must_match => %w(on offs offh reboot reset)
+
+  c.action do |global_options,options,args|
+  end
+end
+
+desc "Returns the status of a given set of nodes"
+command :stat do |c|
+  c.desc "Print a summary of the node status for the testbed"
+  c.switch [:s, :summary]
+
+  c.desc "A valid topology file or description. If a file 'TOPOLOGY' doesn't exist, interpret it as a comma-separated list of nodes)"
+  c.default_value "system:topo:all"
+  c.arg_name "TOPOLOGY"
+  c.flag [:t, :topology]
+
+  c.desc "Aggregate Name"
+  c.arg_name "AGGREGATE"
+  c.flag [:c, :config]
+
+  c.action do |global_options,options,args|
+  end
+end
+
+pre do |global,command,options,args|
+  true
+end
+
+post do |global,command,options,args|
+end
+
+on_error do |exception|
+  true
+end
+
+exit run(ARGV)

data/bin/omf_pre

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+#
+require 'gli'
+require 'omf_ec'
+require 'omf_common'
+$stdout.sync = true
+
+include GLI::App
+include OmfCommon
+
+program_desc "Run a command on the testbed(s)"
+
+version OmfEc::VERSION
+desc "Debug mode (printing debug logging messages)"
+switch [:d, :debug]
+
+desc "Execute an experiment script"
+arg_name 'path_to_script_file'
+command :exec do |c|
+  c.desc "XMPP user name"
+  c.arg_name "USER"
+  c.flag [:u, :user]
+
+  c.desc "XMPP user password"
+  c.arg_name "PASSWORD"
+  c.flag [:p, :password]
+
+  c.desc "XMPP server domain"
+  c.arg_name "DOMAIN"
+  c.flag [:s, :server]
+
+  c.desc "Check script version (you need to define OMF_VERSIONS in your script"
+  c.switch [:c, :check]
+
+  c.action do |global_options,options,args|
+    if global_options[:debug]
+      Logging.logger.root.level = :debug
+      Blather.logger = logger
+    end
+    unless options[:user] && options[:password] && options[:server]
+      help_now! "Incomplete options"
+    end
+    @opts = options
+    @comm = Comm.new(:xmpp)
+
+    # 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?(PROTOCOL_VERSION)
+          raise StandardError, "Could not find compatibile protocol version number in your script"
+        end
+      end
+    end
+
+    begin
+      load args[0], true
+    rescue => e
+      logger.fatal e.message
+      logger.fatal e.backtrace.join("\n")
+    end
+
+    EM.run do
+      @comm.connect(@opts[:user], @opts[:password], @opts[:server])
+      trap(:INT) { @comm.disconnect }
+      trap(:TERM) { @comm.disconnect }
+    end
+  end
+end
+
+on_error do |exception|
+  true
+end
+
+exit run(ARGV)

data/bin/omf_test

@@ -5,7 +5,7 @@ require 'omf_common'
 $stdout.sync = true
 
 options = {
-  dsl: 'xmpp_blather',
+  dsl: 'xmpp',
   pubsub_host: 'pubsub',
 }
 
@@ -56,12 +56,12 @@ 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_msg = OmfCommon::Message.create { |v| v.property('type', 'mock') }
 
 create_wifi_msg = OmfCommon::Message.create do |v|
   v.property('hrn', 'wlan0')
   v.property('type', 'wifi')
-end.sign
+end
 
 # A request message to be sent to mock
 request_mock_property = OmfCommon::Message.request do |v|
@@ -70,12 +70,12 @@ request_mock_property = OmfCommon::Message.request do |v|
   v.property('resource_proxy_list')
   v.property('resource_utility_list')
   v.property('bob')
-end.sign
+end
 
 request_wifi_property = OmfCommon::Message.request do |v|
   v.property('link')
   v.property('available_properties')
-end.sign
+end
 
 # A request message to be sent to node
 request_node_property = OmfCommon::Message.request do |v|
@@ -86,10 +86,10 @@ 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
+end
 
 # Simple release message
-release_message = OmfCommon::Message.release.sign
+release_message = OmfCommon::Message.release
 
 # For simplicity, use comm instance directly
 comm.when_ready do
@@ -101,7 +101,7 @@ comm.when_ready do
     if e.error?
       comm.disconnect(host)
     else
-      # Publish the create message to RC's pubsub node
+      # Publish the create message to RC's pubsub topic
       comm.publish(options[:uid], request_node_property, host)
       comm.publish(options[:uid], create_wifi_msg, host)
     end

data/example/net_devices.rb

@@ -0,0 +1,75 @@
+# @comm is default communicator defined in script runner
+#
+@node = @comm.get_topic(`hostname`.chomp)
+
+@node.on_message lambda {|m| m.operation == :inform && m.read_content('inform_type') == 'FAILED' } do |message|
+  logger.error message
+end
+
+device_request = @comm.request_message([:devices])
+
+device_request.on_inform_status do |message|
+  @devices = message.read_property('devices').items
+
+  logger.info <<-LOG
+DEVICES ->
+#{@devices.map { |item| "Name: #{item.name}, Driver: #{item.driver}, Proxy: #{item.proxy}"}.join("\n") }
+  LOG
+
+  first_wlan = @devices.find { |v| v.proxy == 'wlan' }
+  first_eth = @devices.find { |v| v.proxy == 'net' }
+
+  wlan_create = @comm.create_message([type: first_wlan.proxy, hrn: first_wlan.name])
+  eth_create = @comm.create_message([type: first_eth.proxy, hrn: first_eth.name])
+
+  wlan_create.on_inform_created do |message|
+    @wlan = @comm.get_topic(message.resource_id)
+
+    @wlan.subscribe do
+      wlan_p = @comm.request_message([:link, :ip_addr])
+
+      wlan_p.on_inform_status do |message|
+        freq = message.read_property(:link).freq
+        ip_addr = message.read_property(:ip_addr)
+        logger.info "WLAN : #{freq}, #{ip_addr}"
+      end
+
+      wlan_p.publish @wlan.id
+    end
+  end
+
+  eth_create.on_inform_created do |message|
+    @eth = @comm.get_topic(message.resource_id)
+    @eth.on_message lambda {|m| m.operation == :inform && m.read_content('inform_type') == 'FAILED' } do |message|
+      logger.error message.read_content(:reason)
+    end
+
+    @eth.subscribe do
+      eth_ip = @comm.request_message([:ip_addr])
+
+      eth_ip.on_inform_status do |m|
+        logger.info "ETH #{m.read_property(:ip_addr)}"
+      end
+
+      eth_ip_conf = @comm.configure_message([{ip_addr: '192.168.7.1'}])
+
+      eth_ip.on_inform_status do |m|
+        logger.info "ETH #{m.read_property(:ip_addr)}"
+      end
+
+      eth_ip.publish @eth.id
+      eth_ip_conf.publish @eth.id
+    end
+  end
+
+  wlan_create.publish @node.id
+  eth_create.publish @node.id
+end
+
+@comm.when_ready do
+  logger.info "CONNECTED: #{@comm.jid.inspect}"
+
+  @node.subscribe do
+    device_request.publish @node.id
+  end
+end

data/lib/omf_ec/version.rb

@@ -1,3 +1,3 @@
 module OmfEc
-  VERSION = "6.0.0.pre.2"
+  VERSION = "6.0.0.pre.3"
 end

data/omf_ec.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = ["omf_pre"]
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "minitest", "~> 2.11.3"
+  s.add_development_dependency "minitest", "~> 3.2"
   s.add_runtime_dependency "omf_common", "~> 6.0.0.pre"
+  s.add_runtime_dependency "gli", "~> 2.0.0.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omf_ec
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre.2
+  version: 6.0.0.pre.3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.3
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.3
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: omf_common
   requirement: !ruby/object:Gem::Requirement
@@ -43,20 +43,39 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 6.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
 description: Experiment controller of OMF, a generic framework for controlling and
   managing networking testbeds.
 email:
 - omf-user@lists.nicta.com.au
 executables:
-- omf_test
+- omf_pre
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
 - Rakefile
+- bin/omf
+- bin/omf_pre
 - bin/omf_test
 - config/ec.yml
+- example/net_devices.rb
 - exp_repo/system/exp/eventlib.rb
 - exp_repo/system/exp/imageNode.rb
 - exp_repo/system/exp/reset.rb
@@ -137,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: omf_ec
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: OMF experiment controller