omf_rc 6.1.1 → 6.1.2.pre

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDc2ZGUxY2Y1M2IzM2RjNGNkYmFhZmZjYjFmZWJkZjUzNGI5NDU5ZA==
-  data.tar.gz: !binary |-
-    MTliNjA1NmMxNWEzNzc0Mjc4NTBiZjAzZGMzZjQwZTQ4NTk0OWNjMg==
+SHA1:
+  metadata.gz: 58d8f4886473d854c19c6fc5bdee608b74f552a3
+  data.tar.gz: 7a7a1c8bc9efc0b6332a8d61b898081adeece4b5
 SHA512:
-  metadata.gz: !binary |-
-    ZjA3MTIxNjlkZDdiYTI1OGM0ZjY3ZmVhNjAxYzEwMzJhZDYyMDhjYThlYTU4
-    NTRjNTg4ZDlhZDhmZTQ4ZGRmN2I2YzQ5NzVkMDJhNGFhMjJlODExZTA4YmUw
-    NTkzYzViZjQzNGVhNzVjMTNjMDNiMWI1NTEzY2ZlMmRhZmM4MWM=
-  data.tar.gz: !binary |-
-    MDk2NGU3M2JlYWI3ZTlhNmRmY2VlMGEwZThmYzJjY2FhNmYzMzViODczNjU0
-    MmY0OTI5ZGJlOWVlY2FiZDE2NDI2YmMxY2MyZTMxZTJiNzQxZDRjNTExZmMz
-    Yzc1NDdmNDg5MTU2YjMzZGEwNDU3ZWE2NTY5NDM3ODQ5YTQ3ZTQ=
+  metadata.gz: b1db665f420503a10073d7d580239ceaad24d80bba3b1abf18962554d34d39b6db1391489513c9f866f95321ca52c83499839c43b5b3af121ebc87c72d149d87
+  data.tar.gz: a7dde85adcbcae4a048ac43b87c5282a0776bac9ce37b349d3a041a545ca395dcf64b63b36d63d60ab8b9db24a6555599a28c7fc08a26ad89d4fc690a7666119

data/lib/omf_rc/omf_error.rb

@@ -24,3 +24,20 @@ class OmfRc::UnknownPropertyError < NoMethodError
     super(msg)
   end
 end
+
+# Customised errors for resource controller (Proposing)
+#
+class OmfRc::Error < StandardError; end
+
+class OmfRc::Error
+  class UnknownProperty < OmfRc::Error; end
+  # Try to create a resource with type not known to resource controller
+  class UnknownResourceType < OmfRc::Error; end
+  # Try to access a child resource provided by identifier but can not be found
+  class UnknownChildResource < OmfRc::Error; end
+  # Ask a parent to create a child but failed due to parent's proxy definition
+  class InvalidResourceTypeToCreate < OmfRc::Error; end
+  # Try to access a property but access specified in proxy definition would not allow.
+  # e.g. configure when its init_only
+  class PropertyAccessDenied < OmfRc::Error; end
+end

data/lib/omf_rc/resource_proxy/abstract_resource.rb

@@ -90,7 +90,7 @@ class OmfRc::ResourceProxy::AbstractResource
     @@defaults[resource_type.to_sym] = defaults
   end
 
-  attr_accessor :uid, :hrn, :type, :property, :certificate
+  attr_accessor :uid, :hrn, :type, :property, :certificate, :state
   attr_reader :opts, :children, :membership, :creation_opts, :membership_topics, :topics
 
   # Initialisation
@@ -367,7 +367,7 @@ class OmfRc::ResourceProxy::AbstractResource
   #
   # @!macro group_configure
 
-  # Make resource part of the group topic, it will overwrite existing membership array
+  # Make resource part of the group topic, it will alter existing membership array
   #
   # @param [String|Array|Hash] args name of group topic/topics
   #
@@ -381,12 +381,17 @@ class OmfRc::ResourceProxy::AbstractResource
   #
   #   # Leave a single group or multiple groups
   #   { leave: ["group_1", "group_2"] } or { leave: "group_1" }
+  #
+  #   # Leave all groups except a selection of specific ones
+  #   { only: ["group_1", "group_2"] }  or { only: "group_1" }
+  #
   def configure_membership(*args)
     case args[0]
     when Symbol, String, Array
       new_membership = [args[0]].flatten.compact
     when Hash
       leave_membership = [args[0][:leave]].flatten.compact
+      only_membership = [args[0][:only]].flatten.compact
     end
 
     new_membership && new_membership.each do |new_m|
@@ -422,6 +427,11 @@ class OmfRc::ResourceProxy::AbstractResource
       end
     end
 
+    unless only_membership.nil? || only_membership.empty?
+      configure_membership({ leave: @membership })
+      configure_membership(only_membership)
+    end
+
     @membership
   end
 
@@ -554,14 +564,27 @@ class OmfRc::ResourceProxy::AbstractResource
   # @param [OmfRc::ResourceProxy::AbstractResource] obj resource object
   # @param [OmfCommon::Message] response initialised FRCP INFORM message object
   def handle_configure_message(message, obj, response)
-    message.each_property do |key, value|
-      method_name =  "#{message.operation.to_s}_#{key}"
-      p_value = message[key]
+    conf_properties = message.properties
+    conf_result = Hashie::Mash.new
+
+    call_hook(:pre_configure, obj, conf_properties, conf_result)
+
+    if obj.respond_to?(:configure_all)
+      obj.configure_all(conf_properties, conf_result)
+    else
+      conf_properties.each do |key, value|
+        method_name = "configure_#{key}"
+        conf_result[key] = obj.__send__(method_name, value)
+      end
+    end
+
+    call_hook(:post_configure, obj, conf_properties, conf_result)
 
+    conf_result.each do |key, value|
       if namespaced_property?(key)
-        response[key, namespace] = obj.__send__(method_name, p_value)
+        response[key, namespace] = value
       else
-        response[key] = obj.__send__(method_name, p_value)
+        response[key] = value
       end
     end
   end

data/lib/omf_rc/resource_proxy/wlan.rb

@@ -41,22 +41,52 @@ module OmfRc::ResourceProxy::Wlan
   #   @!macro prop
   property :phy
 
+  property :timer
+
   # @!endgroup
 
   # @!macro group_hook
-  #
+  hook :before_ready do |device|
+    device.property.timer = OmfCommon.el.every(5) do |timer|
+      wlan_state = device.request_state
+      if wlan_state == 'UP'
+        device.inform(:status, { state: wlan_state })
+        timer.cancel
+      end
+    end
+  end
+
   # Stop hostapd or wpa instances before releasing wifi device
   # @!macro hook
   # @!method before_release
   hook :before_release do |device|
+    device.property.timer.cancel
+
     case device.property.mode.to_sym
     when :master
       device.stop_hostapd
     when :managed
       device.stop_wpa
     end
-    #TODO need to remove all virtual interfaces of that phy device
-    #device.remove_all_interfaces
+    device.interface_down
   end
   # @!endgroup
+
+
+  configure_all do |res, conf_props, conf_result|
+    # Make sure to set up wifi mode first
+    if (mode = conf_props.delete(:mode))
+      res.configure_mode(mode)
+    end
+
+    # Then if everything goes well, configure the ip address
+    if (ip_addr = conf_props.delete(:ip_addr))
+      res.configure_ip_addr(ip_addr)
+    end
+
+    conf_result[:ip_addr] = res.request_ip_addr
+    conf_result[:state] = res.request_state
+
+    conf_props.each { |k, v| conf_result[k] = res.__send__("configure_#{k}", v) }
+  end
 end

data/lib/omf_rc/resource_proxy_dsl.rb

@@ -23,6 +23,10 @@ module OmfRc::ResourceProxyDSL
     context.send(hook_name, *params) if context.respond_to? hook_name
   end
 
+  def hook_defined?(hook_name, context)
+    context.respond_to? hook_name
+  end
+
   # When this module included, methods defined under ClassMethods will be available in resource definition files
   #
   def self.included(base)
@@ -220,6 +224,29 @@ module OmfRc::ResourceProxyDSL
       end
     end
 
+    # Configure multiple properties when operations need to be completed in order, or the all operations are transactional
+    #
+    # @example
+    #
+    #   configure_all do |resource, configure_properties, result|
+    #     # Execute property one first, and make sure it is successful before attending property two
+    #     if resource.some_operation(configure_properties[:property_one])
+    #       if resource.other_operation(configure_properties[:property_two])
+    #         result[:property_one] = 'GOOD'
+    #         result[:property_two] = 'GREAT'
+    #       else
+    #         raise "Some errors"
+    #       end
+    #     else
+    #       raise "Some errors"
+    #     end
+    #   end
+    def configure_all(&register_block)
+      define_method("configure_all") do |*args, &block|
+        register_block.call(self, *args, block) if register_block
+      end
+    end
+
     # Register a property that could be requested
     #
     # @param (see #configure)
@@ -365,10 +392,10 @@ module OmfRc::ResourceProxyDSL
     #
     # @example
     #   # Read-only property, i.e. could not be modified through FRCP protocol
-    #   property :bob, default: 1, access: :configure
+    #   property :bob, default: 1, access: :read_only
     #
     #   # Read & Write property, i.e. could be modified through FRCP protocol
-    #   property :bob, default: 1, access: :read_only
+    #   property :bob, default: 1, access: :configure
     #
     #   # Read & could be modified ONLY through FRCP CREATE message
     #   property :bob, default: 1, access: :init_only

data/lib/omf_rc/runner.rb

@@ -8,12 +8,6 @@ module OmfRc
   # in decreasing priority through the command line,  configuration
   # file and default settings (see @def_opts).
   #
-  # For historic reasons and to make this implementation more interesting
-  # there are two different config file formats. A 'normal' one inherited from
-  # earlier version of OMF, and an 'advanced' one which is identical to the
-  # format accepted by OmfCommon.init(). To maintain some level of sanity,
-  # only one configuration file is accepted.
-  #
   # Having said that, there is one exception and that relates to the 'oml'
   # configuration which is stripped out first and handed to the OML4R library
   # during command line parsing.
@@ -35,17 +29,12 @@ module OmfRc
         environment: 'production',
         resources: [ { type: :node, uid: @node_id }],
         factories: {},
-        communication: { url: "xmpp://#{@node_id}-#{Process.pid}:#{@node_id}-#{Process.pid}@localhost" },
+        communication: { url: "amqp://localhost" },
+        logging: {},
         add_default_factories: true,
       )
 
-      @gopts = Mash.new(
-        config_file: nil,
-        adv_config_file: nil,
-        logging_configfile: nil,
-        environment: nil
-      )
-
+      @gopts = Mash.new
       @opts = Mash.new
 
       @omlopts = {appName: @executable_name}
@@ -64,9 +53,14 @@ module OmfRc
 
         Signal.trap("SIGINT") do
           # TODO: Should release resources first
-          info "Stopping ..."
-          OmfCommon.comm.disconnect
-          OmfCommon.eventloop.stop
+
+          # Workaround to EM issue under ruby v2
+          # https://github.com/eventmachine/eventmachine/issues/418
+          el.after(0) do
+            info "Stopping ..."
+            OmfCommon.comm.disconnect
+            el.stop
+          end
         end
 
         # Load extensions
@@ -121,7 +115,7 @@ module OmfRc
     end
 
     def parse_config_files()
-      config_file = @gopts[:config_file]
+      config_file = @gopts.delete(:config_file)
 
       if config_file.nil?
         puts "You must specify a config file"
@@ -139,11 +133,15 @@ module OmfRc
           when :uid
             @opts[:resources][0][:type] = :node
             @opts[:resources][0][:uid] = v
+          when :debug
+            @opts[:logging][:level] = 'debug' if v
           else
             @opts[k] = v
           end
         end
 
+        @opts.merge!(@gopts)
+
         @omlopts.merge(@opts[:instrumentation] || {}) { |k, v1, v2| v1 } # merge in place as OML may hold @omlopts
       end
     end
@@ -159,10 +157,6 @@ module OmfRc
             @gopts[:config_file] = file
           end
 
-          op.on("-a ADVANCED_CONFIGFILE", "Advanced Configuration File") do |file|
-            @gopts[:adv_config_file] = file
-          end
-
           op.on("--log_config CONFIGFILE", "Logging Configuration File") do |file|
             @gopts[:logging_configfile] = file
           end

data/lib/omf_rc/util/ip.rb

@@ -31,6 +31,12 @@ module OmfRc::Util::Ip
     addr = CommandLine.new("ip", "addr show dev :device", :device => resource.property.if_name).run
     addr && addr.chomp.match(/link\/ether ([\d[a-f][A-F]\:]+)/) && $1
   end
+
+  request :state do |device|
+    link = CommandLine.new("ip", "link show :device", :device => device.property.if_name).run
+    link && link.chomp.match(/state (\w+) /) && $1
+  end
+
   # @!endgroup
 
   # @!macro group_configure
@@ -66,6 +72,10 @@ module OmfRc::Util::Ip
     CommandLine.new("ip", "link set :dev up", :dev => resource.property.if_name).run
   end
 
+  work :interface_down do |device|
+    CommandLine.new("ip", "link set :dev down", :dev => device.property.if_name).run
+  end
+
   # Remove IP addresses associated with the interface
   #
   # @!macro work

data/lib/omf_rc/util/wpa.rb

@@ -39,7 +39,7 @@ module OmfRc::Util::Wpa
   work :stop_wpa do |device|
     begin
       File.open(device.property.wpa_pid,'r') do |f|
-        logger.debug "Stopping wpa supplicant at PID: #{device.property.wpa_pid}"
+        info "Stopping wpa supplicant at PID: #{device.property.wpa_pid}"
         CommandLine.new("kill", "-9 :pid", :pid => f.read.chomp).run
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omf_rc
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.1.2.pre
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -42,28 +42,28 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.1.2.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.1.2.pre
 - !ruby/object:Gem::Dependency
   name: cocaine
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +98,14 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Resource controller of OMF, a generic framework for controlling and managing
@@ -201,18 +201,47 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: omf_rc
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: OMF resource controller
-test_files: []
+test_files:
+- test/fixture/ip/addr_show
+- test/fixture/iw/help
+- test/fixture/iw/info
+- test/fixture/iw/link
+- test/fixture/lsmod
+- test/fixture/omf_rc.simple.yml
+- test/fixture/omf_rc.yml
+- test/fixture/oml.hash
+- test/fixture/oml.spec
+- test/fixture/oml.xml
+- test/fixture/sys/class/ieee80211/phy0/device/uevent
+- test/fixture/sys/class/ieee80211/phy0/uevent
+- test/fixture/sys/class/net/eth0/device/uevent
+- test/fixture/sys/class/net/eth0/uevent
+- test/fixture/sys/class/net/wlan0/device/uevent
+- test/fixture/sys/class/net/wlan0/uevent
+- test/omf_rc/deferred_process_spec.rb
+- test/omf_rc/message_process_error_spec.rb
+- test/omf_rc/resource_factory_spec.rb
+- test/omf_rc/resource_proxy/abstract_resource_spec.rb
+- test/omf_rc/resource_proxy/application_spec.rb
+- test/omf_rc/resource_proxy/node_spec.rb
+- test/omf_rc/resource_proxy_dsl_spec.rb
+- test/omf_rc/runner_spec.rb
+- test/omf_rc/util/common_tools_spec.rb
+- test/omf_rc/util/ip_spec.rb
+- test/omf_rc/util/iw_spec.rb
+- test/omf_rc/util/mod_spec.rb
+- test/test_helper.rb