omf_rc 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_rc.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_spec.rb"
+  t.verbose = true
+end
+
+Rake::TestTask.new(:integration) do |t|
+  t.libs << 'integration_test'
+  t.pattern = "integration_test/**/*_spec.rb"
+  t.verbose = true
+end

data/bin/omf_rc

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require 'omf_common'
+require 'omf_rc'
+require 'omf_rc/resource_factory'
+$stdout.sync = true
+
+options = {
+  uid: 'interlagos'
+}
+
+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 create, also becomes the uid of the resource") 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
+
+OmfRc::ResourceFactory.load_default_resource_proxies
+
+EM.run do
+  node = OmfRc::ResourceFactory.new(:node, options)
+  node.connect
+
+  trap(:INT) { node.disconnect }
+  trap(:TERM) { node.disconnect }
+end

data/config/omf_rc.yml

@@ -0,0 +1,70 @@
+# This is an example configuration for the Resource Controller at NICTA
+#
+# NOTE: use only 'spaces' to indent !
+# ('tab' indents are not supported by the ruby yaml parser used to read this file)
+#
+---
+:rcontroller:
+  # Communication settings 
+  :communicator:
+    
+    # Interface to the control network from which this resource can be 
+    # controlled & managed
+    :control_if: 'control'
+
+    # set this to true or false if you want to enable or disable signature checks and message signing                                       
+    :authenticate_messages: false
+    # your RSA/DSA SSH private key file
+    :private_key: '/etc/omf-resctl-5.4/id_rsa'
+    # directory holding the public keys of your OMF peers
+    :public_key_dir: '/etc/omf-resctl-5.4/peer_keys'
+    
+    :type: 'xmpp'
+    :xmpp:
+      # Address of the PubSub server to use as gateway for PubSub communication
+      :pubsub_gateway: 'norbit.npc.nicta.com.au'
+      #:pubsub_port: 5222
+      # Address of the PubSub server which host the communication for my slice
+      # Leave this commented if the pubsub groups for this slice are hosted on 
+      # the same server as the 'pubsub_gateway'
+      #:pubsub_domain: 10.0.0.200
+      # The following 'home_pubsub_user' and 'home_pubsub_pwd' are optional
+      # RC 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_RC_name' 
+      #:pubsub_pwd: 'my_RC_password'
+      # set this to "true" if you have a DNS SRV record pointing to the
+      # real pubsub server hostname
+      :pubsub_use_dnssrv: false
+
+  # Agent settings
+  :agent:
+
+    # Name (i.e. unique HRN ID) of this resource
+    # Or this could also be passed as a command line parameter "--name"
+    # This is either a fully defined string, e.g. "my_resource_name"
+    # Or a string for which some values will be replaced by the running RC, 
+    # currently we support the values: %hostname%, %macaddr%, %fqdn%
+    # For example, if you use "some_prefix.%hostname%.some_suffix"
+    # Then if your hostname is 'node1', then your RC name will be
+    # 'some_prefix.node1.some_suffix'
+    # %macaddr% is replaced with the MAC address of the control interface
+    # %fqdn% is the fully qualified hostname (incl. domain part)
+    :name: 'omf.nicta.%hostname%'
+
+    # Name (i.e. unique HRN ID) of the slice to which this resource is assigned
+    :slice: default_slice
+    
+    # shrink the filesystem size before saving an image
+    # grow the filesystem to match the disk size after loading an image
+    # enabling this may slow down load/save significantly
+    :resizefs: false
+
+  # Mote settings
+  # Uncomment and set the following parameters if this resource has
+  # a Mote device attached to it
+  #:mote:
+    #:moteport: /dev/ttyUSB0
+    #:motetype: telosb

data/integration_test/omf_rc/resource_proxy/app_spec.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'omf_rc/resource_proxy'
+
+include OmfRc::ResourceProxy
+
+describe App do
+  before do
+    @resource = AbstractResource.new(properties: { pubsub: "mytestbed.net" })
+    @app1 = @resource.create(:type => 'app', :uid => 'zathura')
+    @app2 = @resource.create(:type => 'app', :uid => 'bob')
+  end
+
+  describe "when configured with properties" do
+    it "must run the underline commands" do
+    end
+  end
+
+  describe "when properties requested" do
+    it "must return an array with actual properties" do
+      @resource.request([:version], {:uid => 'zathura'}).first.version.must_match /[\d|\.|-]+/
+      @resource.request([:version], {:uid => 'bob'}).first.version.must_be_nil
+    end
+  end
+end
+

data/integration_test/omf_rc/resource_proxy/interface_spec.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'omf_rc/resource_proxy'
+
+include OmfRc::ResourceProxy
+
+describe Interface do
+  before do
+    @resource = AbstractResource.new(properties: { pubsub: "mytestbed.net" })
+    @interface = @resource.create(:type => 'interface', :uid => 'eth0')
+  end
+
+  describe "when configured with properties" do
+    it "must run the underline commands" do
+    end
+  end
+
+  describe "when properties requested" do
+    it "must return an array with actual properties" do
+      @resource.request([:mac, :ip], {:type => 'interface'}).each do |interface|
+        interface.mac.must_match /([\da-fA-F]+:){5}[\da-fA-F]+/
+        interface.ip.must_match /([.\d]+\.){3}[.\d]+/
+      end
+    end
+  end
+end
+

data/integration_test/omf_rc/resource_proxy/mock_spec.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+require 'omf_rc/resource_factory'
+
+include OmfRc::ResourceProxy
+
+module OmfRc::Util::UMock
+  include OmfRc::ResourceProxyDSL
+
+  register_utility :u_mock
+
+  register_configure :very_important_property do
+    raise StandardError, 'We just did something very important, I need your attention'
+  end
+
+  register_request :very_important_property do
+    "Very important property's value"
+  end
+end
+
+module OmfRc::ResourceProxy::Mock
+  include OmfRc::ResourceProxyDSL
+
+  register_proxy :mock
+
+  utility :u_mock
+
+  register_bootstrap do
+    logger.debug 'I am starting up, but have nothing to do there'
+  end
+
+  register_cleanup do
+    logger.debug 'I am shutting down, but have nothing to do there'
+  end
+
+  def test
+  end
+end
+
+describe Mock do
+  before do
+    @resource = OmfRc::ResourceFactory.new(:mock, :uid => 'suzuka', :properties => {:mock_property => "test"})
+  end
+
+  describe "when child resource with a known type" do
+    it "must load methods from related module correctly" do
+      @resource.create(:mock, uid: 'mock') do |mock|
+        mock.must_respond_to :test
+        mock.must_respond_to :configure_very_important_property
+        mock.must_respond_to :request_very_important_property
+        proc { mock.configure_very_important_property('test') }.must_raise StandardError
+        mock.request_very_important_property do |value|
+          value.must_equal "Very important property's value"
+        end
+      end
+    end
+  end
+end
+

data/integration_test/omf_rc/resource_proxy/node_spec.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'omf_rc/resource_proxy'
+
+include OmfRc::ResourceProxy
+
+describe Node do
+  before do
+    @resource = AbstractResource.new(properties: { pubsub: "mytestbed.net" })
+    @node = @resource.create(:type => 'node', :uid => 'monaco')
+  end
+
+  describe "when configured with properties" do
+    it "must run the underline commands" do
+    end
+  end
+
+  describe "when properties requested" do
+    it "must return an array with actual properties" do
+      @resource.request([:devices], {:uid => 'monaco'}).first.devices.each do |device|
+        device.type.wont_be_nil
+        device.name.wont_be_nil
+      end
+    end
+  end
+end
+

data/integration_test/omf_rc/resource_proxy/wifi_spec.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'omf_rc/resource_proxy'
+
+include OmfRc::ResourceProxy
+
+describe Wifi do
+  before do
+    @resource = AbstractResource.new(properties: { pubsub: "mytestbed.net" })
+    @wifi = @resource.create(:type => 'wifi', :uid => 'wlan0')
+  end
+
+  describe "when configured with properties" do
+    it "must run the underline commands" do
+    end
+  end
+
+  describe "when properties requested" do
+    it "must return an array with actual properties" do
+      @resource.request([:ssid, :freq, :rx, :tx, :signal, :tx_bitrate], {:type => 'wifi'}).each do |wifi|
+        wifi.ssid.wont_be_nil
+        wifi.freq.wont_be_nil
+        wifi.rx.wont_be_nil
+        wifi.tx.wont_be_nil
+        wifi.signal.wont_be_nil
+        wifi.tx_bitrate.wont_be_nil
+      end
+    end
+  end
+end
+

data/integration_test/test_helper.rb

@@ -0,0 +1,5 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'omf_rc'

data/lib/omf_rc/deferred_process.rb

@@ -0,0 +1,20 @@
+# To be used for handling long running processes
+#
+class OmfRc::DeferredProcess
+  include EM::Deferrable
+
+  # Pass a block of long running process
+  #
+  def fire(&block)
+    raise ArgumentError, "Missing code block to be executed" if block.nil?
+
+    EM.defer do
+      begin
+        result = block.call
+        succeed result
+      rescue => e
+        fail e
+      end
+    end
+  end
+end

data/lib/omf_rc/message_process_error.rb

@@ -0,0 +1,11 @@
+# Error during message processing,  include message related information context_id and inform_to, for publishing  errors to pubsub server
+#
+class OmfRc::MessageProcessError < StandardError
+  attr_reader :context_id, :inform_to
+
+  def initialize(context_id, inform_to, msg = nil)
+    @context_id = context_id
+    @inform_to = inform_to
+    super(msg)
+  end
+end

data/lib/omf_rc/resource_factory.rb

@@ -0,0 +1,74 @@
+require 'omf_common'
+require 'securerandom'
+require 'hashie'
+require 'omf_rc/resource_proxy_dsl'
+require 'omf_rc/resource_proxy/abstract_resource'
+
+# Factory class for managing available proxies and creating new resource proxy instances
+#
+class OmfRc::ResourceFactory
+  # List of registered resource proxies
+  @@proxy_list = []
+  # List of registered utilities
+  @@utility_list = []
+
+  # By default, we use xmpp_blather dsl, which based on blather
+  DEFAULT_OPTS = {
+    dsl: 'xmpp_blather',
+    pubsub_host: 'pubsub'
+  }
+
+  class << self
+    # Factory method to initiate new resource proxy
+    #
+    # @param (see OmfRc::ResourceProxy::AbstractResource#initialize)
+    #
+    # @see OmfRc::ResourceProxy::AbstractResource
+    def new(type, opts = nil, comm = nil, &block)
+      raise ArgumentError, "Resource type not found: #{type.to_s}" unless @@proxy_list.include?(type)
+      type = type.to_s
+      opts = opts ? DEFAULT_OPTS.merge(opts) : DEFAULT_OPTS
+      # Create a new instance of abstract resource
+      resource = OmfRc::ResourceProxy::AbstractResource.new(type, opts, comm)
+      # Then extend this instance with relevant module identified by type
+      resource.extend("OmfRc::ResourceProxy::#{type.camelcase}".constant)
+      # Execute resource before_ready hook if any
+      resource.before_ready if resource.respond_to? :before_ready
+      resource
+    end
+
+    # Return the proxy list
+    def proxy_list
+      @@proxy_list
+    end
+
+    # Add a proxy to the list
+    def register_proxy(proxy)
+      @@proxy_list << proxy
+    end
+
+    # Return the utility list
+    def utility_list
+      @@utility_list
+    end
+
+    # Add a utility to the list
+    def register_utility(utility)
+      @@utility_list << utility
+    end
+
+    # Require files from default resource proxy library folder
+    #
+    def load_default_resource_proxies
+      Dir["#{File.dirname(__FILE__)}/resource_proxy/*.rb"].each do |file|
+        require "omf_rc/resource_proxy/#{File.basename(file).gsub(/\.rb/, '')}"
+      end
+    end
+
+    def load_addtional_resource_proxies(folder)
+      Dir["#{folder}/*.rb"].each do |file|
+        require "#{folder}/#{File.basename(file).gsub(/\.rb/, '')}"
+      end
+    end
+  end
+end