knife-xapi 0.5.4 → 0.6.0

data/lib/chef/knife/xapi_vdi_delete.rb

@@ -8,9 +8,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,7 +18,6 @@
 # limitations under the License.
 #
 
-
 require 'chef/knife/xapi_base'
 
 class Chef
@@ -26,62 +25,61 @@ class Chef
     class XapiVdiDelete < Knife
       include Chef::Knife::XapiBase
 
-      banner "knife xapi vdi delete NAME_LABEL (options)"
+      banner 'knife xapi vdi delete NAME_LABEL (options)'
 
       option :uuid,
-        :short => "-U",
-        :long => "--uuid",
-        :description => "Treat the label as a UUID not a name label"
+             short: '-U',
+             long: '--uuid',
+             description: 'Treat the label as a UUID not a name label'
 
       option :cleanup,
-        :short => "-C",
-        :long => "--cleanup",
-        :description => "Clean up all orphaned volumes."
+             short: '-C',
+             long: '--cleanup',
+             description: 'Clean up all orphaned volumes.'
 
       option :interactive,
-        :short => "-I",
-        :long => "--interactive",
-        :description => "Interactive clean-up of orphaned volumes"
-
+             short: '-I',
+             long: '--interactive',
+             description: 'Interactive clean-up of orphaned volumes'
 
       def interactive
         # Get all VDIs known to the system
-        vdis = get_all_vdis()
+        vdis = get_all_vdis
         first = true
 
         for vdi_ in vdis do
           vbds = get_vbds_from_vdi(vdi_)
-          if vbds.empty? and xapi.VDI.get_type(vdi_).match('system')
+          if vbds.empty? && xapi.VDI.get_type(vdi_).match('system')
             if first
               first = false
             end
 
             prinlt_vdi_info(vdi_)
-            destroy_vdi(vdi_) if yes_no?("Destroy this volume? ")
+            destroy_vdi(vdi_) if yes_no?('Destroy this volume? ')
           end
         end
       end
 
       def vdi_cleanup
         orphaned_vdis = []
-        vdis = get_all_vdis()
+        vdis = get_all_vdis
 
         for vdi_ in vdis do
           vbds = get_vbds_from_vdi(vdi_)
-          if vbds.empty? and xapi.VDI.get_type(vdi_).match('system')
+          if vbds.empty? && xapi.VDI.get_type(vdi_).match('system')
             orphaned_vdis << vdi_
           end
         end
 
         orphaned_vdis.each { |item| print_vdi_info(item) }
         unless orphaned_vdis.empty?
-          if yes_no?("Destroy all these volumes? ")
+          if yes_no?('Destroy all these volumes? ')
             orphaned_vdis.each { |item| destroy_vdi(item) }
           end
         end
       end
 
-      def run 
+      def run
         if config[:interactive]
           interactive
           return
@@ -92,35 +90,34 @@ class Chef
 
         vdi_name = @name_args[0]
         if vdi_name.nil?
-          puts "Error: No VDI Name specified..."
-          puts "Usage: " + banner
+          puts 'Error: No VDI Name specified...'
+          puts 'Usage: ' + banner
           exit 1
         end
 
-        vdis = [] 
+        vdis = []
         if config[:uuid]
           vdis << get_vdi_by_uuid(vdi_name)
         else
           vdis << get_vdi_by_name_label(vdi_name)
         end
-        vdis.flatten! 
+        vdis.flatten!
 
-        if vdis.empty? 
-          ui.msg "VDI not found: #{h.color vdi_name, :red}" 
+        if vdis.empty?
+          ui.msg "VDI not found: #{h.color vdi_name, :red}"
           exit 1
         elsif vdis.length > 1
-          ui.msg "Multiple VDI matches found. Use vdi list if you are unsure"
+          ui.msg 'Multiple VDI matches found. Use vdi list if you are unsure'
           vdi = user_select(vdis)
-        else 
+        else
           vdi = vdis.first
         end
 
-        if vdi == :all 
-          vdis.each {|vdi|  destroy_vdi(vdi)}
-        else 
+        if vdi == :all
+          vdis.each { |vdi|  destroy_vdi(vdi) }
+        else
           destroy_vdi(vdi)
         end
-
       end
     end
   end

data/lib/chef/knife/xapi_vdi_detach.rb

@@ -18,63 +18,56 @@
 # limitations under the License.
 #
 
-
 require 'chef/knife/xapi_base'
 
 class Chef
   class Knife
-	  class XapiVdiDetach < Knife
-	    include Chef::Knife::XapiBase
+	   class XapiVdiDetach < Knife
+ 	    include Chef::Knife::XapiBase
+
+ 	    banner 'knife xapi vdi detach NAME_LABEL (options)'
+
+ 	    option :uuid,
+ 	           short: '-U',
+      	      long: '--uuid',
+      		     description: 'Treat the label as a UUID not a name label'
 
-	    banner "knife xapi vdi detach NAME_LABEL (options)"
+ 	    def run
+ 	      vbd_name = @name_args[0]
 
-	    option :uuid,
-	      :short => "-U",
-	      :long => "--uuid",
-		    :description => "Treat the label as a UUID not a name label"
-	  
-	    def run
-	      vbd_name = @name_args[0]
+ 		     if vbd_name.nil?
+  		      ui.msg 'Error: No VDI Name specified...'
+  		      ui.msg 'Usage: ' + banner
+  		      exit 1
+  		    end
 
-		    if vbd_name.nil?
-		      ui.msg "Error: No VDI Name specified..."
-		      ui.msg "Usage: " +banner
-		      exit 1
-		    end
-		
-        vdis = []  
+        vdis = []
         # detach vdi with VDI's UUID
-	      if config[:uuid]
+ 	      if config[:uuid]
           vdis << xapi.VDI.get_by_uuid(vbd_name)
-        else
-        # detach with VDI's Name 
-          vdis = xapi.VDI.get_by_name_label(vbd_name)
-	      end
+         else
+           # detach with VDI's Name
+           vdis = xapi.VDI.get_by_name_label(vbd_name)
+ 	      end
 
         if vdis.empty?
-	        ui.msg "VDI not found: #{h.color vbd_name, :red}"
-	    	  exit 1
-		    # When multiple VDI matches
-	      elsif vdis.length > 1
-			    ui.msg "Multiple VDI matches found use guest list if you are unsure"
-			    vdi_ref = user_select(vdis)
-	      else
-			    vdi_ref = vdis.first
-		    end
-			  
-        # Detach VDI	
+ 	        ui.msg "VDI not found: #{h.color vbd_name, :red}"
+ 	    	   exit 1
+ 		     # When multiple VDI matches
+ 	      elsif vdis.length > 1
+ 			      ui.msg 'Multiple VDI matches found use guest list if you are unsure'
+ 			      vdi_ref = user_select(vdis)
+ 	      else
+ 			      vdi_ref = vdis.first
+ 		    end
+
+        # Detach VDI
         if vdi_ref == :all
-          vdis.each{|vdi_ref| detach_vdi(vdi_ref)}
+          vdis.each { |vdi_ref| detach_vdi(vdi_ref) }
         else
           detach_vdi(vdi_ref)
         end
-        
-     end
-	  end
+      end
+ 	  end
   end
 end
-
-	  
-
-
-

data/lib/chef/knife/xapi_vdi_list.rb

@@ -8,9 +8,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,7 +18,6 @@
 # limitations under the License.
 #
 
-
 require 'chef/knife/xapi_base'
 
 class Chef
@@ -26,43 +25,40 @@ class Chef
     class XapiVdiList < Knife
       include Chef::Knife::XapiBase
 
-      banner "knife xapi vdi list"
+      banner 'knife xapi vdi list'
 
       option :vdi_name,
-        :short => "-N",
-        :long => "--vdi-name",
-        :default => false,
-        :description => "Indicates this is a vdi name not a guest name"
+             short: '-N',
+             long: '--vdi-name',
+             default: false,
+             description: 'Indicates this is a vdi name not a guest name'
 
-
-      def run 
+      def run
         # Get all VDIs known to the system
         name = @name_args[0]
 
-        # if we were passed a guest name find its vdi's 
+        # if we were passed a guest name find its vdi's
         # otherwise do it for everything
-        vdis = Array.new
-        if name.nil? or name.empty?
+        vdis = []
+        if name.nil? || name.empty?
           vdis = xapi.VDI.get_all
 
         elsif config[:vdi_name]
-          vdis = xapi.VDI.get_by_name_label( name )
+          vdis = xapi.VDI.get_by_name_label(name)
 
         else
-          ref = xapi.VM.get_by_name_label( name ) 
-          vm = xapi.VM.get_record( ref.first )
+          ref = xapi.VM.get_by_name_label(name)
+          vm = xapi.VM.get_record(ref.first)
 
-          vm["VBDs"].each do |vbd|
-            vdis << xapi.VBD.get_record( vbd )["VDI"]
+          vm['VBDs'].each do |vbd|
+            vdis << xapi.VBD.get_record(vbd)['VDI']
           end
         end
 
-        vdis.each do |vdi| 
+        vdis.each do |vdi|
           print_vdi_info vdi
         end
-
       end
     end
   end
 end
-

data/lib/chef/knife/xapi_vlan_list.rb

@@ -8,9 +8,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,7 +18,6 @@
 # limitations under the License.
 #
 
-
 require 'chef/knife/xapi_base'
 require 'pry'
 class Chef
@@ -26,15 +25,13 @@ class Chef
     class XapiVlanList < Knife
       include Chef::Knife::XapiBase
 
-      banner "knife xapi vlan list"
+      banner 'knife xapi vlan list'
 
-      def run 
-        xapi.VLAN.get_all_records.map { |k,v| v["tag"].to_i }.uniq.sort.each do |vlan|
-          color_kv "Tag: ", vlan.to_s      
+      def run
+        xapi.VLAN.get_all_records.map { |_k, v| v['tag'].to_i }.uniq.sort.each do |vlan|
+          color_kv 'Tag: ', vlan.to_s
         end
       end
-
     end
   end
 end
-

data/lib/chef/knife/xapi_vmselect.rb

@@ -1,20 +1,19 @@
 
 class Chef::Knife
   module XapiVmSelect
-
     def self.included(includer)
       includer.class_eval do
-      option :uuid,
-        :short => "-U",
-        :long => "--uuid",
-        :description => "Treat the label as a UUID not a name label"
+        option :uuid,
+               short: '-U',
+               long: '--uuid',
+               description: 'Treat the label as a UUID not a name label'
       end
     end
 
     def select_vm(name)
       if name.nil?
-        ui.msg "Must Provide VM Name"
-        ui.msg "Usage: " + banner
+        ui.msg 'Must Provide VM Name'
+        ui.msg 'Usage: ' + banner
         exit 1
       end
 
@@ -33,7 +32,7 @@ class Chef::Knife
 
       if vms.length > 1
         vm = user_select(vms)
-        if vm == :all 
+        if vm == :all
           return vms
         end
       else
@@ -41,6 +40,5 @@ class Chef::Knife
       end
       vm
     end
-
   end
 end

data/lib/knife-xapi/version.rb

@@ -1,3 +1,3 @@
 module KnifeXenserver
-  VERSION = "0.5.4"
+  VERSION = '0.6.0'
 end

data/lib/xenapi/xenapi.rb

@@ -23,14 +23,14 @@ module XenApi
   # @yieldparam [Client] client Client instance
   # @return [Object] block return value
   # @raise [NoHostsAvailable] No hosts could be contacted
-  def self.connect(uris, username, password, options={})
+  def self.connect(uris, username, password, options = {})
     uris = uris.respond_to?(:shift) ? uris.dup : [uris]
     method = options[:slave_login] ? :slave_local_login_with_password : :login_with_password
 
     client = Client.new(uris, options[:timeout] || 10, options[:ssl_verify] || :verify_peer)
     begin
       args = [method, username, password]
-      args << options[:api_version] if options.has_key?(:api_version)
+      args << options[:api_version] if options.key?(:api_version)
       client.send(*args)
 
       if block_given?
@@ -44,4 +44,3 @@ module XenApi
     end
   end
 end
-

data/lib/xenapi/xenapi/async_dispatcher.rb

@@ -29,8 +29,8 @@ module XenApi #:nodoc:
     # @param [String,Symbol] meth Method prefix name
     # @param [...] args Method arguments
     # @return [Dispatcher] dispatcher instance to handle the +Async.meth+ prefix
-    def method_missing(meth, *args)
+    def method_missing(meth, *_args)
       Dispatcher.new(@client, "Async.#{meth}", @sender)
     end
-  end  
+  end
 end

data/lib/xenapi/xenapi/client.rb

@@ -107,10 +107,10 @@ module XenApi #:nodoc:
     # @param [Integer] timeout Maximum number of seconds to wait for an API response
     # @param [Symbol] ssl_verify SSL certificate verification mode.
     #   Can be one of :verify_none or :verify_peer
-    def initialize(uris, timeout=10, ssl_verify=:verify_peer)
+    def initialize(uris, timeout = 10, ssl_verify = :verify_peer)
       @timeout = timeout
       @ssl_verify = ssl_verify
-      @uris = [uris].flatten.collect do |uri|
+      @uris = [uris].flatten.map do |uri|
         uri = URI.parse(uri)
         uri.path = '/' if uri.path == ''
         uri
@@ -179,7 +179,7 @@ module XenApi #:nodoc:
     # @return [String] API version
     def api_version
       @api_version ||= begin
-        pool = self.pool.get_all()[0]
+        pool = self.pool.get_all[0]
         host = self.pool.get_master(pool)
         major = self.host.get_API_version_major(host)
         minor = self.host.get_API_version_minor(host)
@@ -228,24 +228,23 @@ module XenApi #:nodoc:
     # object state is invalid. No API calls can be performed unless one of
     # the login methods is called again.
     def logout
-      begin
-        if @login_meth.to_s.start_with? "slave_local"
-          _do_call("session.local_logout", [@session])
-        else
-          _do_call("session.logout", [@session])
-        end
-      rescue
-        # We don't care about any error. If it works: great, if not: shit happens...
-        nil
-      ensure
-        @session = ""
-        @login_meth = nil
-        @login_args = []
-        @api_version = nil
+      if @login_meth.to_s.start_with? 'slave_local'
+        _do_call('session.local_logout', [@session])
+      else
+        _do_call('session.logout', [@session])
       end
+    rescue
+      # We don't care about any error. If it works: great, if not: shit happens...
+      nil
+    ensure
+      @session = ''
+      @login_meth = nil
+      @login_args = []
+      @api_version = nil
     end
 
-  protected
+    protected
+
     # @param [String,Symbol] meth API method to call
     # @param [Array] args Arguments to pass to the method call
     # @raise [SessionInvalid] Reauthentication failed
@@ -253,39 +252,38 @@ module XenApi #:nodoc:
     # @raise [EOFError] XMLRPC::Client exception
     # @raise [Errno::EPIPE] XMLRPC::Client exception
     def _call(meth, *args)
-      begin
-        _do_call(meth, args.dup.unshift(@session))
-      rescue SessionInvalid
-        _relogin_attempts = (_relogin_attempts || 0) + 1
-        _relogin
-        retry unless _relogin_attempts > 2
-        _reconnect ? retry : raise
-      rescue Timeout::Error
-        _timeout_retries = (_timeout_retries || 0) + 1
-        @client = nil
-        retry unless _timeout_retries > 1
-        _reconnect ? retry : raise
-      rescue EOFError
-        _eof_retries = (_eof_retries || 0) + 1
-        @client = nil
-        retry unless _eof_retries > 1
-        _reconnect ? retry : raise
-      rescue Errno::EPIPE
-        _epipe_retries = (_epipe_retries || 0) + 1
-        @client = nil
-        retry unless _epipe_retries > 1
-        _reconnect ? retry : raise
-      rescue Errno::EHOSTUNREACH
-        @client = nil
-        _reconnect ? retry : raise
-      end
+      _do_call(meth, args.dup.unshift(@session))
+    rescue SessionInvalid
+      _relogin_attempts = (_relogin_attempts || 0) + 1
+      _relogin
+      retry unless _relogin_attempts > 2
+      _reconnect ? retry : raise
+    rescue Timeout::Error
+      _timeout_retries = (_timeout_retries || 0) + 1
+      @client = nil
+      retry unless _timeout_retries > 1
+      _reconnect ? retry : raise
+    rescue EOFError
+      _eof_retries = (_eof_retries || 0) + 1
+      @client = nil
+      retry unless _eof_retries > 1
+      _reconnect ? retry : raise
+    rescue Errno::EPIPE
+      _epipe_retries = (_epipe_retries || 0) + 1
+      @client = nil
+      retry unless _epipe_retries > 1
+      _reconnect ? retry : raise
+    rescue Errno::EHOSTUNREACH
+      @client = nil
+      _reconnect ? retry : raise
     end
 
-  private
+    private
+
     # Reauthenticate with the API
     # @raise [LoginRequired] Missing authentication credentials
     def _relogin
-      raise LoginRequired if @login_meth.nil? || @login_args.nil? || @login_args.empty?
+      fail LoginRequired if @login_meth.nil? || @login_args.nil? || @login_args.empty?
       _login(@login_meth, *@login_args)
     end
 
@@ -315,7 +313,7 @@ module XenApi #:nodoc:
           failed_uris << @uri
         end
       end
-      raise Errors::NoHostsAvailable.new("No server reachable. Giving up.")
+      fail Errors::NoHostsAvailable.new('No server reachable. Giving up.')
     end
 
     # Login to the API
@@ -347,7 +345,7 @@ module XenApi #:nodoc:
     #
     # @return [XMLRPC::Client] XMLRPC client instance
     def _client
-      @client ||= XMLRPCClient.new(@uri.host, @uri.path, @uri.port, nil, nil, nil, nil, @uri.scheme == "https" ? @ssl_verify : false, @timeout)
+      @client ||= XMLRPCClient.new(@uri.host, @uri.path, @uri.port, nil, nil, nil, nil, @uri.scheme == 'https' ? @ssl_verify : false, @timeout)
     end
 
     # Perform XMLRPC method call.
@@ -361,21 +359,21 @@ module XenApi #:nodoc:
     # @raise [ResponseMissingErrorDescriptionField] API response error missing +ErrorDescription+ field
     # @raise [SessionInvalid] API session has expired
     # @raise [Errors::GenericError] API method specific error
-    def _do_call(meth, args, attempts = 3)
+    def _do_call(meth, args, _attempts = 3)
       r = _client.call(meth, *args)
-      raise ResponseMissingStatusField unless r.has_key?('Status')
+      fail ResponseMissingStatusField unless r.key?('Status')
 
       if r['Status'] == 'Success'
-        return r['Value'] if r.has_key?('Value')
-        raise ResponseMissingValueField
+        return r['Value'] if r.key?('Value')
+        fail ResponseMissingValueField
       else
-        raise ResponseMissingErrorDescriptionField unless r.has_key?('ErrorDescription')
-        raise SessionInvalid if r['ErrorDescription'][0] == 'SESSION_INVALID'
+        fail ResponseMissingErrorDescriptionField unless r.key?('ErrorDescription')
+        fail SessionInvalid if r['ErrorDescription'][0] == 'SESSION_INVALID'
 
         ed = r['ErrorDescription'].shift
         ex = Errors.exception_class_from_desc(ed)
         r['ErrorDescription'].unshift(ed) if ex == Errors::GenericError
-        raise ex, r['ErrorDescription']
+        fail ex, r['ErrorDescription']
       end
     end
   end