fog-libvirt 0.11.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 478f04152afea3fd1b8ea8e6aa2d8a2bcdc83fc121f2e9cf61925c64a69c483b
-  data.tar.gz: 364dcd8e9c09434b872d06b2c0d8bfce4c2f9320a57ee8d0f954223628797814
+  metadata.gz: 12e7867890312a401d0733ed3bd058c7bfba0488d32748569d6de134e516a752
+  data.tar.gz: 1e37605f3bd9fee08a79d18d4383bcb68f38d88675f12ead62b6366afc1c0a60
 SHA512:
-  metadata.gz: b65c110f9d40bc749f967da511d7c534852dd4004d39b410cc07125eac26a0ebbece4fbbe7a38de1026142d5fe6d4457abba0f472a2769ef900c31af1e98d939
-  data.tar.gz: 5e2508a3aeef1041963995a594b6c3788c9bda9638f5ff73f2a5fd2c12fbd1e18556c46a983b3ae6de07e96a08d3fd15c6b037fb1f2f845194587a69d844b360
+  metadata.gz: 6c5a173e6974eaa247bad12a3d3cacd10a43a1679dba49a361eb179e6a2a5d58ed12dacdab08b25c24ea49d05024f26b6c9564a2fb8fbf95be3e0500af6447c5
+  data.tar.gz: cb7536c410f12da3549d328e19dd6f997f0a3ae4795a90d6eea576bcca8e79a0c7a086ec8dc6b85c84e860d93ba70109d13cd3a0684769eec4991ff0c5311592

data/Gemfile

@@ -6,4 +6,7 @@ group :development, :test do
   gem "octokit", :require => false
 end
 
+# 0.8.3 breaks our tests
+gem "ruby-libvirt", ">= 0.7.0", "< 0.8.3"
+
 gemspec

data/fog-libvirt.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |s|
 
   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")
   s.add_development_dependency("rake")
   s.add_development_dependency("rubocop")

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

@@ -90,12 +90,13 @@ module Fog
           volumes.first.path if volumes and volumes.first
         end
 
-        def destroy(options={ :destroy_volumes => false, :flags => 0 })
+        def destroy(options={ :destroy_volumes => false, :flags => ::Libvirt::Domain::UNDEFINE_NVRAM })
           poweroff unless stopped?
-          if options.fetch(:flags, 0).zero?
+          flags = options.fetch(:flags, ::Libvirt::Domain::UNDEFINE_NVRAM)
+          if flags.zero?
             service.vm_action(uuid, :undefine)
           else
-            service.vm_action(uuid, :undefine, options[:flags])
+            service.vm_action(uuid, :undefine, flags)
           end
           volumes.each { |vol| vol.destroy } if options[:destroy_volumes]
           true
@@ -147,7 +148,7 @@ module Fog
 
         def volumes
           # lazy loading of volumes
-          @volumes ||= (@volumes_path || []).map{|path| service.volumes.all(:path => path).first }
+          @volumes ||= (@volumes_path || []).map{ |path| service.volumes.all(:path => path).first }.compact
         end
 
         def private_ip_address
@@ -267,9 +268,179 @@ module Fog
           "#{name}-cloud-init.iso"
         end
 
+        # rubocop:disable Metrics
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.domain(:type => domain_type) do
+              xml.name(name)
+              xml.memory(memory_size)
+
+              if hugepages
+                xml.memoryBacking do
+                  xml.hugepages
+                end
+              end
+
+              xml.vcpu(cpus)
+              xml.os do
+                type = xml.type(os_type, :arch => arch)
+                type[:machine] = "q35" if ["i686", "x86_64"].include?(arch)
+
+                boot_order.each do |dev|
+                  xml.boot(:dev => dev)
+                end
+              end
+              xml.features do
+                xml.acpi
+                xml.apic
+              end
+
+              unless cpu.empty?
+                if cpu.dig(:model, :name)
+                  xml.cpu do
+                    xml.model(cpu.dig(:model, :name), :fallback => cpu.dig(:model, :fallback) || "allow")
+                  end
+                else
+                  xml.cpu(
+                    :mode => cpu.dig(:model, :name) || "host-passthrough",
+                    :check => cpu.fetch(:check, "none"),
+                    :migratable => cpu.fetch(:migratable, "on")
+                  )
+                end
+              end
+
+              xml.clock(:offset => "utc") do
+                xml.timer(:name => "rtc", :tickpolicy => "catchup")
+                xml.timer(:name => "pit", :tickpolicy => "delay")
+                xml.timer(:name => "hpet", :present => "no")
+              end
+
+              xml.devices do
+                ceph_args = read_ceph_args
+
+                volumes.each_with_index do |volume, index|
+                  target_device = "vd#{('a'..'z').to_a[index]}"
+                  if ceph_args && volume.pool_name.include?(ceph_args["libvirt_ceph_pool"])
+                    xml.disk(:type => "network", :device => "disk") do
+                      xml.driver(:name => "qemu", :type => volume.format_type, :cache => "writeback", :discard => "unmap")
+                      xml.source(:protocol => "rbd", :name => volume.path)
+
+                      ceph_args["monitor"]&.split(",")&.each do |monitor|
+                        xml.host(:name => monitor, :port => ceph_args["port"])
+                      end
+
+                      xml.auth(:username => ceph_args["auth_username"]) do
+                        if ceph_args.key?("auth_uuid")
+                          xml.secret(:type => "ceph", :uuid => ceph_args["auth_uuid"])
+                        else
+                          xml.secret(:type => "ceph", :usage => ceph_args["auth_usage"])
+                        end
+                      end
+
+                      xml.target(:dev => target_device, :bus => args["bus_type"] == "virtio" ? "virtio" : "scsi")
+                    end
+                  else
+                    is_block = volume.path.start_with?("/dev/")
+                    xml.disk(:type => is_block ? "block" : "file", :device => "disk") do
+                      xml.driver(:name => "qemu", :type => volume.format_type)
+                      if is_block
+                        xml.source(:dev => volume.path)
+                      else
+                        xml.source(:file => volume.path)
+                      end
+                      xml.target(:dev => target_device, :bus => "virtio")
+                    end
+                  end
+                end
+
+                if iso_file
+                  xml.disk(:type => "file", :device => "cdrom") do
+                    xml.driver(:name => "qemu", :type => "raw")
+                    xml.source(:file => "#{iso_dir}/#{iso_file}")
+                    xml.target(:dev => "hdc", :bus => "ide")
+                    xml.readonly
+                    xml.address(:type => "drive", :controller => 0, :bus => 1, :unit => 0)
+                  end
+                end
+
+                nics.each do |nic|
+                  xml.interface(:type => nic.type) do
+                    if nic.type == "bridge"
+                      xml.source(:bridge => nic.bridge)
+                    else
+                      xml.source(:network => nic.network)
+                    end
+                    xml.model(:type => nic.model)
+                  end
+                end
+
+                if guest_agent
+                  xml.channel(:type => "unix") do
+                    xml.target(:type => "virtio", :name => "org.qemu.guest_agent.0")
+                  end
+                end
+
+                xml.rng(:model => "virtio") do
+                  xml.backend(virtio_rng[:backend_path], :model => virtio_rng.fetch(:backend_model, "random"))
+                end
+
+                if arch == "s390x"
+                  xml.controller(:type => "scsi", :index => "0", :model => "virtio-scsi")
+                  xml.console(:type => "pty") do
+                    xml.target(:type => "sclp")
+                  end
+                  xml.memballoon(:model => "virtio")
+                else
+                  xml.serial(:type => "pty") do
+                    xml.target(:port => 0)
+                  end
+                  xml.console(:type => "pty") do
+                    xml.target(:port => 0)
+                  end
+                  xml.input(:type => "tablet", :bus => "usb")
+                  xml.input(:type => "mouse", :bus => "ps2")
+
+                  graphics = xml.graphics(:type => display[:type])
+                  if display[:port].empty?
+                    graphics.port = display[:port]
+                    graphics.autoport = "no"
+                  else
+                    graphics.port = -1
+                    graphics.autoport = "yes"
+                  end
+                  graphics.listen = display[:listen] unless display[:listen].empty?
+                  graphics.passwd = display[:password] unless display[:password].empty?
+
+                  xml.video do
+                    xml.model(:type => "cirrus", :vram => 9216, :heads => 1)
+                  end
+                end
+              end
+            end
+          end
+
+          builder.to_xml
+        end
+        # rubocop:enable Metrics
+
         private
         attr_accessor :volumes_path
 
+        def read_ceph_args(path = "/etc/foreman/ceph.conf")
+          return unless File.file?(path)
+
+          args = {}
+
+          File.readlines(path).each do |line|
+            pair = line.strip.split("=")
+            key = pair[0]
+            value = pair[1]
+            args[key] = value
+          end
+
+          args
+        end
+
         # 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
@@ -479,7 +650,7 @@ module Fog
           {
             :persistent             => true,
             :cpus                   => 1,
-            :memory_size            => 256 *1024,
+            :memory_size            => 256 * 1024,
             :name                   => randomized_name,
             :os_type                => "hvm",
             :arch                   => "x86_64",

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

@@ -109,7 +109,7 @@ module Fog
               :memory_size     => 6,
               :cpus            => 5,
               :autostart       => false,
-              :os_type         => "RHEL6",
+              :os_type         => "hvm",
               :active          => false,
               :vnc_port        => 5910,
               :boot_order      => boot_order(xml),

data/lib/fog/libvirt/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Libvirt
-    VERSION = '0.11.0'
+    VERSION = '0.12.1'
   end
 end

data/minitests/server/server_test.rb

@@ -36,8 +36,8 @@ class ServerTest < Minitest::Test
   end
 
   def test_ssh_ip_command_success
-    fog_ssh = MiniTest::Mock.new
-    result = MiniTest::Mock.new
+    fog_ssh = Minitest::Mock.new
+    result = Minitest::Mock.new
     result.expect(:status, 0)
     result.expect(:stdout, "any_ip")
     fog_ssh.expect(:run, [result], [String])
@@ -49,10 +49,10 @@ class ServerTest < Minitest::Test
   end
 
   def test_local_ip_command_success
-    proc_info = MiniTest::Mock.new
+    proc_info = Minitest::Mock.new
     proc_info.expect(:each_line, "127.0.0.1")
     proc_info.expect(:pid, 0)
-    status = MiniTest::Mock.new
+    status = Minitest::Mock.new
     status.expect(:exitstatus, 0)
     Process.stubs(:waitpid2).returns([0, status])
     IO.stub(:popen, true, proc_info) do

data/tests/libvirt/models/compute/server_tests.rb

@@ -59,5 +59,25 @@ Shindo.tests('Fog::Compute[:libvirt] | server model', ['libvirt']) do
       end
     end
     test('be a kind of Fog::Libvirt::Compute::Server') { server.kind_of? Fog::Libvirt::Compute::Server }
+    tests("serializes to xml") do
+      test("with memory") { server.to_xml.match?(%r{<memory>\d+</memory>}) }
+      test("with disk of type file") do
+        xml = server.to_xml
+        xml.match?(/<disk type="file" device="disk">/) && xml.match?(%r{<source file="path/to/disk"/>})
+      end
+      test("with disk of type block") do
+        server = Fog::Libvirt::Compute::Server.new(
+          {
+            :nics => [],
+            :volumes => [
+              Fog::Libvirt::Compute::Volume.new({ :path => "/dev/sda", :pool_name => "dummy" })
+            ]
+          }
+        )
+        xml = server.to_xml
+        xml.match?(/<disk type="block" device="disk">/) && xml.match?(%r{<source dev="/dev/sda"/>})
+      end
+      test("with q35 machine type on x86_64") { server.to_xml.match?(%r{<type arch="x86_64" machine="q35">hvm</type>}) }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fog-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - geemus (Wesley Beary)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -108,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-stub-const
-  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +244,6 @@ files:
 - lib/fog/libvirt/models/compute/servers.rb
 - lib/fog/libvirt/models/compute/templates/network.xml.erb
 - lib/fog/libvirt/models/compute/templates/pool.xml.erb
-- lib/fog/libvirt/models/compute/templates/server.xml.erb
 - lib/fog/libvirt/models/compute/templates/volume.xml.erb
 - lib/fog/libvirt/models/compute/util/uri.rb
 - lib/fog/libvirt/models/compute/util/util.rb
@@ -335,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 2
 summary: Module for the 'fog' gem to support libvirt

data/lib/fog/libvirt/models/compute/templates/server.xml.erb

@@ -1,155 +0,0 @@
-<domain type='<%= domain_type %>'>
-  <name><%= name %></name>
-  <memory><%= memory_size %></memory>
-<% if hugepages -%>
-  <memoryBacking>
-    <hugepages/>
-  </memoryBacking>
-<% end -%>
-  <vcpu><%= cpus %></vcpu>
-  <os>
-    <type arch='<%= arch %>'><%= os_type %></type>
-<% boot_order.each do |dev| -%>
-    <boot dev='<%= dev %>'/>
-<% end -%>
-  </os>
-  <features>
-    <acpi/>
-    <apic/>
-    <pae/>
-  </features>
-<% if !cpu.empty? -%>
-<% if cpu[:mode] -%>
-  <cpu mode='<%= cpu[:mode] %>'>
-<% else -%>
-  <cpu>
-<% end -%>
-<%
-  fallback = 'allow'
-  model = ''
-  if cpu[:model]
-    fallback = cpu[:model][:fallback] if cpu[:model][:fallback]
-    model    = cpu[:model][:name]     if cpu[:model][:name]
-  end
--%>
-    <model fallback='<%= fallback %>'><%= model %></model>
-  </cpu>
-<% end -%>
-  <clock offset='utc'/>
-  <devices>
-<% args = {}
-   if File.file?('/etc/foreman/ceph.conf')
-     File.readlines('/etc/foreman/ceph.conf').each do |line|
-       pair = line.strip.split("=")
-       key = pair[0]
-       value = pair[1]
-       args[key] = value
-     end
-   end
-%>
-<% volumes.each do |vol| -%>
-  <% if File.file?('/etc/foreman/ceph.conf') && vol.pool_name.include?(args["libvirt_ceph_pool"]) %>
-    <disk type='network' device='disk'>
-      <driver name='qemu' type='<%= vol.format_type %>' cache='writeback' discard='unmap'/>
-      <source protocol='rbd' name='<%= vol.path %>'>
-      <% if args.key?("monitor") -%>
-        <% args["monitor"].split(",").each do |mon| %>
-        <host name='<%= mon %>' port='<%= args["port"] %>'/>
-        <% end %>
-      <% end %>
-      </source>
-      <auth username='<%= args["auth_username"] %>'>
-       <% if args.key?("auth_uuid") -%>
-        <secret type='ceph' uuid='<%= args["auth_uuid"] %>'/>
-       <% else -%>
-        <secret type='ceph' usage='<%= args["auth_usage"] %>'/>
-       <% end -%>
-      </auth>
-      <% if args['bus_type'] == 'virtio' %>
-        <target dev='vd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='virtio'/>
-      <% else %>
-        <target dev='sd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='scsi'/>
-      <% end %>
-    </disk>
-  <% else %>
-    <disk type='file' device='disk'>
-      <driver name='qemu' type='<%= vol.format_type %>'/>
-      <source file='<%= vol.path %>'/>
-      <%# we need to ensure a unique target dev -%>
-      <target dev='vd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='virtio'/>
-    </disk>
-  <% end %>
-<% end -%>
-<% if iso_file -%>
-    <disk type='file' device='cdrom'>
-      <driver name='qemu' type='raw'/>
-      <source file='<%= "#{iso_dir}/#{iso_file}" %>'/>
-      <target dev='hdc' bus='ide'/>
-      <readonly/>
-      <address type='drive' controller='0' bus='1' unit='0'/>
-    </disk>
-<% end -%>
-<% nics.each do |nic| -%>
-    <interface type='<%= nic.type %>'>
-      <source <%= nic.type == 'bridge' ? "bridge='#{nic.bridge}'" : "network='#{nic.network}'" %> />
-      <model type='<%= nic.model %>'/>
-    </interface>
-<% end -%>
-<% if guest_agent -%>
-    <channel type='unix'>
-      <target type='virtio' name='org.qemu.guest_agent.0'/>
-    </channel>
-<% end -%>
-    <rng model='virtio'>
-<%
-  rng_backend_model = virtio_rng[:backend_model] ? virtio_rng[:backend_model] : 'random'
--%>
-<% if virtio_rng[:backend_path] -%>
-      <backend model='<%= rng_backend_model %>'><%= virtio_rng[:backend_path] %></backend>
-<% else -%>
-      <backend model='<%= rng_backend_model %>'/>
-<% end -%>
-    </rng>
-<% if arch == "s390x" -%>
-    <controller type="scsi" index="0" model="virtio-scsi"/>
-    <console type="pty">
-      <target type="sclp"/>
-    </console>
-    <memballoon model="virtio"/>
-<% else -%>
-    <serial type='pty'>
-      <target port='0'/>
-    </serial>
-    <console type='pty'>
-      <target port='0'/>
-    </console>
-    <input type='tablet' bus='usb'/>
-    <input type='mouse' bus='ps2'/>
-<% end -%>
-<%
-display_type = display[:type]
-
-if display[:port].empty?
-  display_port = display[:port]
-  autoport = 'no'
-else
-  display_port = '-1'
-  autoport = 'yes'
-end
-
-unless display[:listen].empty?
-  display_listen = "listen='#{display[:listen]}'"
-end
-
-unless display[:password].empty?
-  display_password = "passwd='#{display[:password]}'"
-end
--%>
-<% if arch != "s390x" -%>
-    <graphics type='<%= display_type %>' port='<%= display_port %>' autoport='<%= autoport %>' <%= display_listen %> <%= display_password %> />
-    <video>
-      <model type='cirrus' vram='9216' heads='1'/>
-    </video>
-<% end -%>
-  </devices>
-</domain>