fog-libvirt 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ce7265a9a69c91518f2fe37a016da5cfd32a9c
-  data.tar.gz: 4edaa2e8d544ecd728b96908c06ca54163016edf
+  metadata.gz: 8a924f47a387da6a04d3f10ca5528ad6df73153b
+  data.tar.gz: 9f578e6cfe50d4994a610e2b427e819d633d76ba
 SHA512:
-  metadata.gz: bd061ded1d5c8a4b5910d059b3aaef646b9fdd4aa19828b6091f82e28143c9500fab5e490a49a5b314693828058d4848b2539110d3ec86488868fe51611d8571
-  data.tar.gz: 71db7a647cf6fb292452530632caaa694dce24f69d9d93cfb466308d9925092f2c3f5adab9f036d659a3e14e31308549434dcf21f48115c5aa6474b0a2cb15c0
+  metadata.gz: 66e744dc9c9b7e0072b9f5c10912f0626e7355d3c1bacf2dad20a102033dc62213fd5bc9237ea66ac38d48115bc7bfa183043d59bff2f1faffa66a804e683c95
+  data.tar.gz: e2f735103f4af3889a9679f6ba5c8bf578e5ba2966c8bcb9a902996232bee239631d433092fa90ee88073e08af29902c54f18875ec0334a4c0552212108617e5

data/fog-libvirt.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency('ruby-libvirt','>= 0.7.0')
   s.add_dependency("json")
 
+  s.add_development_dependency("net-ssh")
   s.add_development_dependency("minitest", "~> 5.0")
   s.add_development_dependency("minitest-stub-const")
   s.add_development_dependency("pry")

data/lib/fog/libvirt/compute.rb

@@ -45,6 +45,7 @@ module Fog
       request :destroy_interface
       request :get_node_info
       request :update_display
+      request :libversion
 
       module Shared
         include Fog::Compute::LibvirtUtil

data/lib/fog/libvirt/models/compute/server.rb

@@ -258,11 +258,139 @@ module Fog
         private
         attr_accessor :volumes_path
 
-        # This retrieves the ip address of the mac address
+        # This tests the library version before redefining the address
+        # method for this instance to use a method compatible with
+        # earlier libvirt libraries, or uses the dhcp method from more
+        # recent releases.
+        def addresses(service_arg=service, options={})
+          addresses_method = self.method(:addresses_dhcp)
+          # check if ruby-libvirt was compiled against a new enough version
+          # that can use dhcp_leases, as otherwise it will not provide the
+          # method dhcp_leases on any of the network objects.
+          has_dhcp_leases = true
+          begin
+            service.networks.first.dhcp_leases(self.mac)
+          rescue NoMethodError
+            has_dhcp_leases = false
+          rescue
+            # assume some other odd exception.
+          end
+
+          # if ruby-libvirt not compiled with support, or remote library is
+          # too old (must be newer than 1.2.8), then use old fallback
+          if not has_dhcp_leases or service.libversion() < 1002008
+            addresses_method = self.method(:addresses_ip_command)
+          end
+
+          # replace current definition for this instance with correct one for
+          # detected libvirt to perform check once for connection
+          (class << self; self; end).class_eval do
+            define_method(:addresses, addresses_method)
+          end
+          addresses(service_arg, options)
+        end
+
+        def ssh_ip_command(ip_command, uri)
+          # Retrieve the parts we need from the service to setup our ssh options
+          user=uri.user #could be nil
+          host=uri.host
+          keyfile=uri.keyfile
+          port=uri.port
+
+          # Setup the options
+          ssh_options={}
+          ssh_options[:keys]=[ keyfile ] unless keyfile.nil?
+          ssh_options[:port]=port unless keyfile.nil?
+          ssh_options[:paranoid]=true if uri.no_verify?
+
+          begin
+            result=Fog::SSH.new(host, user, ssh_options).run(ip_command)
+          rescue Errno::ECONNREFUSED
+            raise Fog::Errors::Error.new("Connection was refused to host #{host} to retrieve the ip_address for #{mac}")
+          rescue Net::SSH::AuthenticationFailed
+            raise Fog::Errors::Error.new("Error authenticating over ssh to host #{host} and user #{user}")
+          end
+
+          # Check for a clean exit code
+          if result.first.status == 0
+            return result.first.stdout.strip
+          else
+            # We got a failure executing the command
+            raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code")
+          end
+        end
+
+        def local_ip_command(ip_command)
+          # Execute the ip_command locally
+          # Initialize empty ip_address string
+          ip_address=""
+
+          IO.popen("#{ip_command}") do |p|
+            p.each_line do |l|
+              ip_address+=l
+            end
+            status=Process.waitpid2(p.pid)[1].exitstatus
+            if status!=0
+              raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code")
+            end
+          end
+
+          #Strip any new lines from the string
+          ip_address.chomp
+        end
+
+        # This retrieves the ip address of the mac address using ip_command
         # It returns an array of public and private ip addresses
         # Currently only one ip address is returned, but in the future this could be multiple
         # if the server has multiple network interface
-        def addresses(service_arg=service, options={})
+        def addresses_ip_command(service_arg=service, options={})
+          mac=self.mac
+
+          # Aug 24 17:34:41 juno arpwatch: new station 10.247.4.137 52:54:00:88:5a:0a eth0.4
+          # Aug 24 17:37:19 juno arpwatch: changed ethernet address 10.247.4.137 52:54:00:27:33:00 (52:54:00:88:5a:0a) eth0.4
+          # Check if another ip_command string was provided
+          ip_command_global=service_arg.ip_command.nil? ? 'grep $mac /var/log/arpwatch.log|sed -e "s/new station//"|sed -e "s/changed ethernet address//g" |sed -e "s/reused old ethernet //" |tail -1 |cut -d ":" -f 4-| cut -d " " -f 3' : service_arg.ip_command
+          ip_command_local=options[:ip_command].nil? ? ip_command_global : options[:ip_command]
+
+          ip_command="mac=#{mac}; server_name=#{name}; "+ip_command_local
+
+          ip_address=nil
+
+          if service_arg.uri.ssh_enabled?
+            ip_address=ssh_ip_command(ip_command, service_arg.uri)
+          else
+            # It's not ssh enabled, so we assume it is
+            if service_arg.uri.transport=="tls"
+              raise Fog::Errors::Error.new("TlS remote transport is not currently supported, only ssh")
+            end
+            ip_address=local_ip_command(ip_command)
+          end
+
+          # The Ip-address command has been run either local or remote now
+
+          if ip_address==""
+            #The grep didn't find an ip address result"
+            ip_address=nil
+          else
+            # To be sure that the command didn't return another random string
+            # We check if the result is an actual ip-address
+            # otherwise we return nil
+            unless ip_address=~/^(\d{1,3}\.){3}\d{1,3}$/
+              raise Fog::Errors::Error.new(
+                        "The result of #{ip_command} does not have valid ip-address format\n"+
+                            "Result was: #{ip_address}\n"
+                    )
+            end
+          end
+
+          return { :public => [ip_address], :private => [ip_address]}
+        end
+
+        # This retrieves the ip address of the mac address using dhcp_leases
+        # It returns an array of public and private ip addresses
+        # Currently only one ip address is returned, but in the future this could be multiple
+        # if the server has multiple network interface
+        def addresses_dhcp(service_arg=service, options={})
           mac=self.mac
 
           ip_address = nil

data/lib/fog/libvirt/requests/compute/libversion.rb

@@ -0,0 +1,18 @@
+
+module Fog
+  module Compute
+    class Libvirt
+      class Real
+        def libversion()
+          client.libversion
+        end
+      end
+
+      class Mock
+        def libversion()
+          return 1002009
+        end
+      end
+    end
+  end
+end

data/lib/fog/libvirt/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Libvirt
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

data/minitests/server/server_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class ServerTest < Minitest::Test
+  def setup
+    @compute = Fog::Compute[:libvirt]
+    @server = @compute.servers.new(:name => "test")
+  end
+
+  def test_addresses_calls_compat_version_for_no_dhcp_leases_support
+    network = Libvirt::Network.new
+    @compute.expects(:networks).returns([network])
+    network.expects(:dhcp_leases).raises(NoMethodError)
+    @server.expects(:addresses_ip_command).returns(true)
+
+    @server.send(:addresses)
+  end
+
+  def test_addresses_calls_compat_version_for_older_libvirt
+    network = Libvirt::Network.new
+    @compute.expects(:libversion).returns(1002007)
+    @compute.expects(:networks).returns([network])
+    network.expects(:dhcp_leases).returns(true)
+    @server.expects(:addresses_ip_command).returns(true)
+
+    @server.send(:addresses)
+  end
+
+  def test_addresses_calls_compat_version_for_newer_libvirt
+    network = Libvirt::Network.new
+    @compute.expects(:libversion).returns(1002008)
+    @compute.expects(:networks).returns([network])
+    network.expects(:dhcp_leases).returns(true)
+    @server.expects(:addresses_dhcp).returns(true)
+
+    @server.send(:addresses)
+  end
+
+  def test_ssh_ip_command_success
+    fog_ssh = MiniTest::Mock.new
+    result = MiniTest::Mock.new
+    result.expect(:status, 0)
+    result.expect(:stdout, "any_ip")
+    fog_ssh.expect(:run, [result], [String])
+    uri = ::Fog::Compute::LibvirtUtil::URI.new('qemu+ssh://localhost:22?keyfile=nofile')
+    Fog::SSH.stub(:new, fog_ssh) do
+      @server.send(:ssh_ip_command, "test command", uri)
+    end
+    fog_ssh.verify
+  end
+
+  def test_local_ip_command_success
+    proc_info = MiniTest::Mock.new
+    proc_info.expect(:each_line, "127.0.0.1")
+    proc_info.expect(:pid, 0)
+    status = MiniTest::Mock.new
+    status.expect(:exitstatus, 0)
+    Process.stubs(:waitpid2).returns([0, status])
+    IO.stub(:popen, true, proc_info) do
+      @server.send(:local_ip_command, "test command")
+    end
+    proc_info.verify
+    status.verify
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fog-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - geemus (Wesley Beary)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -259,6 +273,7 @@ files:
 - lib/fog/libvirt/requests/compute/destroy_network.rb
 - lib/fog/libvirt/requests/compute/dhcp_leases.rb
 - lib/fog/libvirt/requests/compute/get_node_info.rb
+- lib/fog/libvirt/requests/compute/libversion.rb
 - lib/fog/libvirt/requests/compute/list_domains.rb
 - lib/fog/libvirt/requests/compute/list_interfaces.rb
 - lib/fog/libvirt/requests/compute/list_networks.rb
@@ -272,6 +287,7 @@ files:
 - lib/fog/libvirt/requests/compute/vm_action.rb
 - lib/fog/libvirt/requests/compute/volume_action.rb
 - lib/fog/libvirt/version.rb
+- minitests/server/server_test.rb
 - minitests/server/user_data_iso_test.rb
 - minitests/test_helper.rb
 - tests/helper.rb