omf_rc 6.0.0.pre.5 → 6.0.0.pre.6

data/lib/omf_rc/util/platform_tools.rb

@@ -0,0 +1,164 @@
+#
+# Copyright (c) 2012 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.
+#
+
+#
+# This module defines a Utility with some common work blocks that handle the
+# installation of software on a given OS platform
+#
+module OmfRc::Util::PlatformTools
+  include OmfRc::ResourceProxyDSL
+
+  utility :common_tools
+  
+  # This utility block logs attempts to detect the OS platform on which it is
+  # currently running. Right now it can recognise the following platform:
+  # - Ubuntu (by looking for an Ubuntu string in /etc/*release files)
+  # - Fedora (by looking for a Fedora string in /etc/*release files)
+  #
+  # Further methods and OS platform may be supported later
+  #
+  # [Symbol] either :unknown | :ubuntu | :fedora
+  #
+  work('detect_platform') do 
+    r = `cat /etc/*release`.upcase
+    platform = :unknown
+    platform = :ubuntu if r.include?('UBUNTU')
+    platform = :fedora if r.include?('FEDORA')
+    platform 
+  end
+ 
+  # This utility block logs attempts to validate if a given package name is
+  # a valid one or not. Right now it checks the following: 
+  # - if the given pkg name is not nil
+  # - if the given pkg name has a size > 0
+  #
+  # Further checks may be implemented later 
+  # (e.g. is the pkg provided by any known repository, etc...)
+  # 
+  # @yieldparam [String] pkg_name the package name to check
+  #
+  # [Boolean] true or fals
+  #
+  work('valid_pkg_name') do |res, pkg_name|
+    valid_name = false
+    plat = res.detect_platform
+    logger.debug "Platform: '#{plat}' - Installing: '#{pkg_name}'"
+    valid_name = true unless pkg_name.nil? || (pkg_name.to_s.size == 0)
+    res.log_inform_error "Package name is not defined for "+
+      "platform: '#{plat}'. Abort install!" unless valid_name
+    valid_name
+  end
+
+  # This utility block install a package on an Ubuntu platform using
+  # the underlying apt-get tool
+  # 
+  # @yieldparam [String] pkg_name the package name to install
+  #
+  work('install_ubuntu') do |res, pkg_name|
+    next false unless res.valid_pkg_name(pkg_name)
+    ExecApp.new("#{res.hrn.nil? ? res.uid : res.hrn}_INSTALL",
+                res,
+                "LANGUAGE='C' LANG='C' "+
+                "LC_ALL='C' DEBIAN_FRONTEND='noninteractive' "+
+                "apt-get install --reinstall --allow-unauthenticated -qq "+
+                "#{pkg_name}")
+  end
+
+  # This utility block install a package on an Fedora platform using
+  # the underlying yum tool
+  # 
+  # @yieldparam [String] pkg_name the package name to install
+  #
+  work('install_fedora') do |res, pkg_name|
+    next false unless res.valid_pkg_name(pkg_name)
+    ExecApp.new("#{res.hrn.nil? ? res.uid : res.hrn}_INSTALL",
+                res,
+                "/usr/bin/yum -y install #{pkg_name}")
+  end
+
+  # This utility block install a software from a tarball archive. It first 
+  # tries to download the tarball at a given URI (if it has not been 
+  # downloaded earlier), then it unarchives it at the given install_path
+  #
+  # @yieldparam [String] pkg_name the package name to install
+  # @yieldparam [String] install_path the path where to install this package
+  # 
+  work('install_tarball') do |res, pkg_name, install_path|
+    next false unless res.valid_pkg_name(pkg_name)
+    require 'net/http'
+    require 'uri'
+    require 'digest/md5'
+
+    file = "/tmp/#{File.basename(pkg_name)}"
+    if file.empty?
+      res.log_inform_error "Failed to parse URI '#{pkg_name}'. Abort install!"
+      next false
+    end
+
+    eTagFile = "#{file}.etag"
+    download = true
+    cmd = ""
+    remoteETag = nil
+
+    # get the ETag from the HTTP header
+    begin
+      uri = URI.parse(pkg_name)
+      result = Net::HTTP.start(uri.host, uri.port) do |http|
+        header = http.request_head(pkg_name)
+        remoteETag = header['etag']
+      end
+    rescue => err
+      res.log_inform_error "Failed to access URL '#{pkg_name}'"+
+                           " (error: #{err}). Abort install!"
+      next false
+    end
+
+    # if we have the file and its ETag locally, 
+    # compare it to the ETag of the remote file
+    if File.exists?(file) && File.exists?(eTagFile)
+       f=File.open(eTagFile,'r')
+       localETag=f.gets
+       f.close
+       download = false if remoteETag == localETag
+     end
+
+    # download the file & store the ETag if necessary
+    if download
+      logger.debug "Downloading '#{pkg_name}'"
+      # -m -nd overwrites existing files
+      cmd="wget -P /tmp -m -nd -q #{pkg_name};"
+      unless remoteETag.empty?
+        f=File.open(eTagFile,'w')
+        f.write remoteETag
+        f.close
+      end
+    else
+      logger.debug "Local file '#{file}' already exists and is "+
+                   "identical to '#{pkg_name}'"
+    end
+    # Finally unarchive the file at the requested install path
+    cmd += "tar -C #{install_path} -xf #{file}"
+    id = "#{res.hrn.nil? ? res.uid : res.hrn}_INSTALL"
+    ExecApp.new(id, res, cmd, false)
+  end
+
+end

data/lib/omf_rc/util/wpa.rb

@@ -0,0 +1,42 @@
+require 'hashie'
+require 'cocaine'
+
+module OmfRc::Util::Wpa
+  include OmfRc::ResourceProxyDSL
+  include Cocaine
+
+  # Initialise wpa related conf and pid location
+  #
+  work :init_wpa_conf_pid do |device|
+    device.property.wpa_conf = "/tmp/wpa.#{device.hrn}.conf"
+    device.property.wpa_pid = "/tmp/wpa.#{device.hrn}.pid"
+  end
+
+  work :wpasup do |device|
+    device.init_wpa_conf_pid
+
+    File.open(device.property.wpa_conf, "w") do |f|
+      f << "network={\n  ssid=\"#{device.property.essid}\"\n  scan_ssid=1\n  key_mgmt=NONE\n}"
+    end
+    CommandLine.new("wpa_supplicant", "-B -P :wpa_pid -i:dev -c:wpa_conf",
+                    :dev => device.hrn,
+                    :wpa_conf => device.property.wpa_conf,
+                    :wpa_pid => device.property.wpa_pid).run
+  end
+
+  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}"
+        CommandLine.new("kill", "-9 :pid", :pid => f.read.chomp).run
+      end
+
+      CommandLine.new("rm", "-f :wpa_pid :wpa_conf",
+                      :wpa_pid => device.property.wpa_pid,
+                      :wpa_conf => device.property.wpa_conf).run
+    rescue => e
+      logger.warn "Failed to clean wpa supplicant and its related files '#{device.property.wpa_pid}' and '#{device.property.wpa_conf}'!"
+      logger.warn e.message
+    end
+  end
+end

data/lib/omf_rc/version.rb

@@ -1,3 +1,3 @@
 module OmfRc
-  VERSION = "6.0.0.pre.5"
+  VERSION = "6.0.0.pre.6"
 end

data/omf_rc.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
   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_development_dependency "em-minitest-spec", "~> 1.1.1"
+  s.add_development_dependency "simplecov"
   s.add_runtime_dependency "omf_common", "~> 6.0.0.pre"
+  s.add_runtime_dependency "cocaine", "~> 0.3.0"
 end

data/test/fixture/ip/addr_show

@@ -0,0 +1,5 @@
+3: wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
+    link/ether 00:00:00:29:00:00 brd ff:ff:ff:ff:ff:ff
+    inet 192.168.1.124/24 brd 192.168.1.255 scope global wlan0
+    inet6 fe80::2677:3ff:fe29:4d5c/64 scope link
+       valid_lft forever preferred_lft forever

data/test/fixture/iw/info

@@ -0,0 +1,4 @@
+Interface wlan0
+	ifindex 3
+	type managed
+	wiphy 0

data/test/fixture/sys/class/ieee80211/phy0/device/uevent

@@ -0,0 +1,6 @@
+DRIVER=iwlwifi
+PCI_CLASS=28000
+PCI_ID=8086:4238
+PCI_SUBSYS_ID=8086:1111
+PCI_SLOT_NAME=0000:03:00.0
+MODALIAS=pci:v00008086d00004238sv00008086sd00001111bc02sc80i00

data/test/fixture/sys/class/net/eth0/device/uevent

@@ -0,0 +1,6 @@
+DRIVER=e1000e
+PCI_CLASS=20000
+PCI_ID=8086:1502
+PCI_SUBSYS_ID=17AA:21CE
+PCI_SLOT_NAME=0000:00:19.0
+MODALIAS=pci:v00008086d00001502sv000017AAsd000021CEbc02sc00i00

data/test/fixture/sys/class/net/eth0/uevent

@@ -0,0 +1,2 @@
+INTERFACE=eth0
+IFINDEX=2

data/test/fixture/sys/class/net/wlan0/device/uevent

@@ -0,0 +1,6 @@
+DRIVER=iwlwifi
+PCI_CLASS=28000
+PCI_ID=8086:4238
+PCI_SUBSYS_ID=8086:1111
+PCI_SLOT_NAME=0000:03:00.0
+MODALIAS=pci:v00008086d00004238sv00008086sd00001111bc02sc80i00

data/test/fixture/sys/class/net/wlan0/uevent

@@ -0,0 +1,3 @@
+DEVTYPE=wlan
+INTERFACE=wlan0
+IFINDEX=3

data/test/omf_rc/message_process_error_spec.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+describe OmfRc::MessageProcessError do
+  it "must be able to initialised" do
+    mpe = OmfRc::MessageProcessError.new('test_context_id', 'inform_to_address', 'error_messsage')
+    mpe.context_id.must_equal 'test_context_id'
+    mpe.inform_to.must_equal 'inform_to_address'
+    mpe.message.must_equal 'error_messsage'
+    mpe.must_be_kind_of StandardError
+  end
+end

data/test/omf_rc/resource_factory_spec.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'mock_helper'
 require 'omf_rc/resource_factory'
 
 describe OmfRc::ResourceFactory do
@@ -17,5 +16,13 @@ describe OmfRc::ResourceFactory do
       mock.request_nothing.must_equal mock.uid
       mock.must_respond_to :configure_nothing
     end
+
+    it "must be able to load addtional proxies from local folder" do
+      Dir.stub :[], ["non_exist_folder/test.rb"] do
+        proc do
+          OmfRc::ResourceFactory.load_addtional_resource_proxies("non_exist_folder")
+        end.must_raise LoadError
+      end
+    end
   end
 end

data/test/omf_rc/resource_proxy/abstract_resource_spec.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'em/minitest/spec'
 require 'omf_rc/resource_factory'
 
 include OmfRc::ResourceProxy
@@ -63,7 +64,9 @@ describe AbstractResource do
 
   describe "when destroyed" do
     it "must destroy itself together with any resources created by it" do
-      @node.release
+      child = @node.create(:wifi, { hrn: 'default_wifi' })
+      @node.children.wont_be_empty
+      @node.release(child.uid)
       @node.children.must_be_empty
     end
   end
@@ -81,4 +84,57 @@ describe AbstractResource do
       @node.request_hrn.must_equal 'bob'
     end
   end
+
+  describe "when interacted with communication layer" do
+    include EM::MiniTest::Spec
+
+    before do
+      @client = Blather::Client.new
+      @stream = MiniTest::Mock.new
+      @stream.expect(:send, true, [Blather::Stanza])
+      @client.post_init @stream, Blather::JID.new('n@d/r')
+      @xmpp = Class.new { include OmfCommon::DSL::Xmpp }.new
+    end
+
+    it "must be able to send inform message" do
+      @node.comm.stub :publish, proc { |inform_to, message| message.valid?.must_equal true} do
+        @node.inform(:created, resource_id: 'bob', context_id: 'id', inform_to: 'topic')
+        @node.inform(:released, resource_id: 'bob', context_id: 'id', inform_to: 'topic')
+        @node.inform(:status, status: { key: 'value' }, context_id: 'id', inform_to: 'topic')
+        @node.inform(:created, resource_id: 'bob', context_id: 'id', inform_to: 'topic')
+        @node.inform(:warn, 'going to fail')
+        @node.inform(:error, 'failed')
+        @node.inform(:warn, Exception.new('going to fail'))
+        @node.inform(:error, Exception.new('failed'))
+        @node.inform(:failed, Exception.new('failed'))
+      end
+
+      lambda { @node.inform(:failed, 'bob') }.must_raise ArgumentError
+      lambda { @node.inform(:created, 'topic') }.must_raise ArgumentError
+      lambda { @node.inform(:status, 'topic') }.must_raise ArgumentError
+    end
+
+    it "must be able to connect & disconnect" do
+      Blather::Client.stub :new, @client do
+        Blather::Stream::Client.stub(:start, @client) do
+          @node = OmfRc::ResourceFactory.new(:node, { hrn: 'default_node', user: 'bob', password: 'pw', server: 'example.com'}, @xmpp)
+          @client.stub(:connected?, true) do
+            @node.connect
+            @node.comm.jid.inspect.must_equal "bob@example.com"
+          end
+        end
+      end
+    end
+  end
+
+  describe "when request/configure property not pre-defined in proxy" do
+    it "must try property hash" do
+      @node.property[:bob] = "bob"
+      @node.request_bob.must_equal "bob"
+      @node.configure_bob("not_bob")
+      @node.request_bob.must_equal "not_bob"
+      proc { @node.request_bobs_cousin }.must_raise NoMethodError
+      proc { @node.bobs_cousin }.must_raise NoMethodError
+    end
+  end
 end