oml4r 2.9.8 → 2.9.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDljYjJmMDA2MDdlYTJiODJiNTNiMmRmMjg0ODA3NjRkOTkxMWU3NA==
+    NzExMmRjZTY5YjU4ZDFmNjg2NzU2NDMzNWFmNThhZTAyOWY3ZDNhZg==
   data.tar.gz: !binary |-
-    OTMzMjk0NTM0OGI3Y2FmZDc4OGY3OGZkZGQxYmMwZGMwNTMwNTRmMg==
+    NGU4MmY5MjQ5M2UyMzViNjA5ODMwY2Q3MmY3ZjIzY2VmYmM0YWQ1YQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmZiMDYyMWVkM2JmNTU0MGYzNzYyMWE2NTI5MTkxMzAwMGMzZjhmNzY0OWY5
-    YjA1NGM5Y2MwNDJlMjFkMTczM2FhNTU4OTRkMjE2OGRlZjYwYWQ3N2I1YjUw
-    MjNiNTdhNDQ4MTgxNmU0ODQ3MjlkN2I0ZDFkNjFhYjBjYWY2Y2Q=
+    NzI0ZjFhMWU1MTI3NGU5YmU5OGYwMzAyZDliZmYwMzBhZmI3MzM1OWVkNjQ2
+    ZTNjNDQ0Y2FlOWEwYjA0MGJkOTc0OGJmNjA0YzY4ZTMxODk4MGJhNmQ3YTJi
+    Y2E0MjAxOTJjMDc2OTQwMDQyYjVkNTFiMzAyMTAxZTkyZjA4Y2M=
   data.tar.gz: !binary |-
-    YjRkNDFhN2FkNTg1NzMyYzY5NmQyYWM4ODI1ZTExNzYwNWFhYTAzYTQxZWZm
-    NjU1YTZhOTMyYmQzYzIzNTgyOGExZDVkNDJjOWJmYjhjZWM4ZTRhNTQ0ODNl
-    OTAzYWIwNTFlZmY4M2U4YWZlOTUyYTRiYzk1MjNhM2JlZTUzZTM=
+    MDE0ODUxZGU3OGZjNTcyZDFlYTFkNzkwZDhkZjM5ZTkxMjE4NjBkMmFmN2Mw
+    MWViYWQ2Yzg2MWE4YTc5MWVjNWRmMDMwOTRlYzMzZjk2NzgwNjYzYTM1ZjBh
+    M2IwMDRkOWVmOTkyZWYyYzRiNzY2YTZhZjgyOGMzNWIyYWM1MmE=

data/bin/ping-oml2

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+#
+# OML4R wrapper for ping
+#
+# This application runs the system ping, parses its output and reports the
+# measurements via OML
+#
+# Author: Christoph Dwertmann <christoph.dwertmann@nicta.com.au>, (C) 2012-2013
+# Author: Olivier Mehani  <olivier.mehani@nicta.com.au>, (C) 2012-2013
+#
+# Copyright (c) 2012 National ICT Australia (NICTA)
+#
+# 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.
+#
+
+require 'rubygems'
+require 'oml4r'
+
+class MPStat < OML4R::MPBase
+  name :ping
+  param :dest_addr, :type => :string
+  param :ttl, :type => :uint32
+  param :rtt, :type => :double
+  param :rtt_unit, :type => :string
+end
+
+class MPSummary < OML4R::MPBase
+  name :summary
+  param :ntransmitted, :type => :uint32
+  param :nreceived, :type => :uint32
+  param :lossratio, :type => :double
+  param :runtime, :type => :double
+  param :runtime_unit, :type => :string
+end
+
+class MPRTTStats < OML4R::MPBase
+  name :rtt_stats
+  param :min, :type => :double
+  param :avg, :type => :double
+  param :max, :type => :double
+  param :mdev, :type => :double
+  param :rtt_unit, :type => :string
+end
+
+class PingWrapper
+
+  def initialize(args)
+    @addr = nil
+    @count = ''
+    @interval = ''
+    @verbose = true
+    @inet6 = ''
+    @numeric = ''
+    @pingio = nil
+
+    leftover = OML4R::init(args, :appName => 'ping') do |argParser|
+      argParser.banner = "Runs the system ping and reports measurements via OML\n Use -h or --help for a list of options\n\n"
+      argParser.on("-a","--dest_addr ADDRESS","Address to ping (the -a switch is optional)") { |address| @addr = address.to_s() }
+      argParser.on("-c","--count NUMBER","Number of pings (default: infinite)"){ |count| @count = "-c #{count.to_i()}"}
+      argParser.on("-i","--interval NUMBER","Interval between pings (seconds)"){ |interval| @interval = "-i #{interval.to_i()}"}
+      argParser.on("-q","--[no]-quiet ","Don't show ping output on the console"){ @verbose = false }
+      argParser.on("-6","--[no]-inet6 ","Use ping6 rather than ping"){ @inet6 = "6"}
+      argParser.on("-n","--[no]-numeric ","No attempt will be made to lookup symbolic names for host addresses"){ @numeric = '-n' }
+    end
+
+    if @addr.nil?
+      if leftover.length > 0
+        @addr = leftover[0]
+      else
+        raise "You did not specify an address to ping!"
+      end
+    end
+
+  end
+
+  def process_output(row)
+    if not (parse =
+	    /^\d+ bytes from (.*):.*ttl=(\d+) time=([0-9.]+) ([a-zA-Z]+)/.match(row)
+	   ).nil?  # One sample
+	   MPStat.inject(*parse[1..4])
+
+    elsif not (parse =
+	       /^(\d+).*transmitted, (\d+).*received, ([0-9.]+)%.*loss(, time ([0-9.]+) *([a-zA-Z]+))?/.match(row)
+	      ).nil?  # Summary
+        # time (matches 5 & 6) is not printed by ping on OSX
+        # match 4 is unused
+        q = parse.to_a[1..3] + parse.to_a[5..6]
+	      MPSummary.inject(*q)
+
+    elsif not (parse =
+	       /min.*= ([0-9.]+)\/([0-9.]+)\/([0-9.]+)\/([0-9.]+) ([a-zA-Z]+)/.match(row)
+	      ).nil?  # RTT statistics
+	      MPRTTStats.inject(*parse[1..5])
+    end
+  end
+
+  def ping()
+    @pingio = IO.popen("ping#{@inet6} #{@numeric} #{@count} #{@interval} #{@addr}")
+    while true
+      row = @pingio.readline
+      puts row if @verbose
+      process_output(row)
+    end
+  end
+
+  def start()
+    return if not @pingio.nil?
+
+    # Handle for OMF's 'exit' command
+    a = Thread.new do
+      $stdin.each do |line|
+	if /^exit/ =~ line
+	  Process.kill("INT", 0)
+	end
+      end
+    end
+
+    # Handle Ctrl+C and OMF's SIGTERM
+    Signal.trap("INT", stop )
+    Signal.trap("TERM", stop)
+
+    begin
+      ping
+    rescue EOFError
+      # This error is expected
+    end
+  end
+
+  def stop()
+    return if @pingio.nil?
+    # Kill the ping process, which will result in EOFError from ping()
+    Process.kill("INT", @pingio.pid)
+  end
+
+end #end of class
+
+begin
+  $stderr.puts " INFO ping-oml2: V#{OML4R::VERSION}\n"
+  app = PingWrapper.new(ARGV)
+  app.start()
+  # XXX: Sleep for one second to let OML4R send the remaining data (see comments
+  # in #1485)
+  sleep 1
+rescue Interrupt
+rescue Exception => ex
+  $stderr.puts " ERROR ping-oml2: #{ex}\n"
+end
+
+# Local Variables:
+# mode:ruby
+# End:
+# vim: ft=ruby:sw=2

data/examples/oml4r-multiple-channel-example.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 # Copyright (c) 2013 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.

data/examples/oml4r-simple-example.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 # Copyright (c) 2009 - 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.

data/examples/oml4r-wlanconfig.rb

@@ -1,4 +1,5 @@
-#
+#!/usr/bin/env ruby
+
 # Copyright (c) 2010-2013 National ICT Australia (NICTA), Australia
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/oml4r/version.rb

@@ -5,7 +5,7 @@
 # ------------------
 
 module OML4R
-  VERSION = "2.9.8"
+  VERSION = "2.9.10"
   VERSION_STRING = "OML4R Client V#{VERSION}"
   COPYRIGHT = "Copyright 2009-2013, NICTA"
 end

data/lib/oml4r.rb

@@ -180,6 +180,8 @@ module OML4R
       a << (defs[:seq_no] += 1)
       args.each_with_index do |arg, i|
         case types[i]
+        when :double
+          arg = "NaN" if arg.nil?
         when :string
           # Escape tabs and newlines
           arg = arg.to_s.gsub("\\", "\\\\").gsub("\r", "\\r").gsub("\n", "\\n").gsub("\t", "\\t")
@@ -359,13 +361,13 @@ module OML4R
      unless omlConfigFile.nil? 
        f = File.open(omlConfigFile, 'r')
        f.each_line do |l|
-         d = l[/.*experiment=["']([^["']]*)/,1]
+         d = l[/.*experiment=["']([^"']*)/,1]
          opts[:domain] = d if d
-         d = l[/.*domain=["']([^["']]*)/,1]
+         d = l[/.*domain=["']([^"']*)/,1]
          opts[:domain] = d if d
-         i = l[/.*id=["']([^["']]*)/,1]
+         i = l[/.*id=["']([^"']*)/,1]
          opts[:nodeID] = i if i
-         u = l[/.*url=["']([^["']]*)/,1]
+         u = l[/.*url=["']([^"']*)/,1]
          opts[:omlCollectUri] = u if u
        end
        f.close

data/omf/README

@@ -0,0 +1 @@
+This directory contains OMF application definitions for the applications that ship with the oml4r gem. To use it, copy the application definition file into the ame directory as your OEDL experiment and run the EC from there.

data/omf/ping-oml2.app.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2012-2013 National ICT Australia (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
+# COPYING or at http://opensource.org/licenses/MIT. By downloading or
+# using this software you accept the terms and the liability disclaimer
+# in the License.
+#
+defApplication('oml:app:ping', 'ping') do |a|
+
+  a.version(2, 9, 0)
+  a.shortDescription = "Wrapper around ping"
+  a.description = %{This application runs the system ping, parses its output and
+reports the measurements via OML
+  }
+  a.path = "/usr/local/bin/ping-oml2"
+
+  a.defProperty('dest_addr', 'Address to ping', nil,
+		:type => :string)
+  a.defProperty('count', 'Number of times to ping', '-c',
+		:type => :integer)
+  a.defProperty('interval', 'Interval between echo requests', '-i',
+		:type => :integer, :unit => "seconds")
+  a.defProperty('quiet', 'Don\'t show ping output on the console', '-q',
+		:type => :boolean)
+  a.defProperty('inet6', 'Use ping6 rather than ping', '-6',
+		:type => :boolean)
+
+  a.defMeasurement('ping') do |m|
+    m.defMetric('dest_addr',:string)
+    m.defMetric('ttl',:uint32)
+    m.defMetric('rtt',:double)
+    m.defMetric('rtt_unit',:string)
+  end
+
+  a.defMeasurement('summary') do |m|
+    m.defMetric('ntransmitted',:uint32)
+    m.defMetric('nreceived',:uint32)
+    m.defMetric('lossratio',:double)
+    m.defMetric('runtime',:double)
+    m.defMetric('runtime_unit',:string)
+  end
+
+  a.defMeasurement('rtt_stats') do |m|
+    m.defMetric('min',:double)
+    m.defMetric('avg',:double)
+    m.defMetric('max',:double)
+    m.defMetric('mdev',:double)
+    m.defMetric('rtt_unit',:string)
+  end
+end
+
+# Example use with OMF:
+#defProperty('source', "node1-1.grid.orbit-lab.org", "ID of a resource")
+#defProperty('sink', "node1-2.grid.orbit-lab.org", "ID of a resource")
+#defProperty('sinkaddr', 'node1-2.grid.orbit-lab.org', "Ping destination address")
+#
+#defGroup('Source', property.source) do |node|
+#  node.addApplication("oml:app:ping") do |app|
+#    app.setProperty('dest_addr', property.sinkaddr)
+#    app.setProperty('count', 5)
+#    app.setProperty('interval', 1)
+#    app.measure('ping', :samples => 1)
+#  end
+#end
+#
+#defGroup('Sink', property.sink) do |node|
+#end
+#
+#onEvent(:ALL_UP_AND_INSTALLED) do |event|
+#  info "Starting the ping"
+#  group('Source').startApplications
+#  wait 6
+#  info "Stopping the ping"
+#  group('Source').stopApplications
+#  Experiment.done
+#end
+
+# Local Variables:
+# mode:ruby
+# End:
+# vim: ft=ruby:sw=2

data/oml4r.gemspec

@@ -6,8 +6,8 @@ require "oml4r/version"
 Gem::Specification.new do |gem|
   gem.authors       = ["NICTA"]
   gem.email         = ["oml-user@lists.nicta.com.au"]
-  gem.description   = ["Simple OML client library for Ruby"]
-  gem.summary       = ["This is a simple client library for OML which does not use liboml2 and its filters, but connects directly to the server using the +text+ protocol.  User can use this library to create ruby applications which can send measurement to the OML collection server."]
+  gem.description   = ["Simple OML client library and applications for Ruby"]
+  gem.summary       = ["This is a simple client library for OML which does not use liboml2 and its filters, but connects directly to the server using the +text+ protocol.  User can use this library to create ruby applications which can send measurement to the OML collection server. The gem ships with some example applications."]
   gem.homepage      = "http://oml.mytestbed.net"
 
   # ls-files won't work in VPATH builds;

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: oml4r
 version: !ruby/object:Gem::Version
-  version: 2.9.8
+  version: 2.9.10
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies: []
-description: ! '["Simple OML client library for Ruby"]'
+description: ! '["Simple OML client library and applications for Ruby"]'
 email:
 - oml-user@lists.nicta.com.au
-executables: []
+executables:
+- ping-oml2
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,6 +23,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/ping-oml2
 - examples/oml4r-multiple-channel-example.rb
 - examples/oml4r-neuca-beacon.rb
 - examples/oml4r-orca-beacon.rb
@@ -34,6 +36,8 @@ files:
 - lib/oml4r/benchmark.rb
 - lib/oml4r/log4r/oml_outputter.rb
 - lib/oml4r/version.rb
+- omf/README
+- omf/ping-oml2.app.rb
 - oml4r.gemspec
 homepage: http://oml.mytestbed.net
 licenses:
@@ -61,5 +65,6 @@ specification_version: 4
 summary: ! '["This is a simple client library for OML which does not use liboml2 and
   its filters, but connects directly to the server using the +text+ protocol.  User
   can use this library to create ruby applications which can send measurement to the
-  OML collection server."]'
+  OML collection server. The gem ships with some example applications."]'
 test_files: []
+has_rdoc: