libvirt_ffi 0.4.1 → 0.5.0

data/test_usage/test_event_loop.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'libvirt'
@@ -16,16 +17,18 @@ GC::Tracer.start_logging(
     gc_stat: false,
     gc_latest_gc_info: false,
     rusage: false,
-    events: %i[end_mark end_sweep]
+    events: [:end_mark, :end_sweep]
 )
 
 Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
 Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
 
 IMPL = LibvirtAsync::Implementations.new
-CONNS = []
-DOMS = []
-CB_IDS = []
+OBJECTS = {
+    hv: nil,
+    domains: [],
+    cb_ids: []
+}.freeze
 
 Async do
   ASYNC_REACTOR = Async::Task.current.reactor
@@ -35,18 +38,17 @@ Async do
 
   IMPL.start
 
-  c = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
-  c.open
-  res = c.set_keep_alive(2, 1)
-  Libvirt.logger.info {  "set_keep_alive #{res}" }
-  CONNS.push(c)
-
-  puts "Connection version #{c.version.inspect}"
-  puts "Connection lib_version #{c.lib_version.inspect}"
-  puts "Connection hostname #{c.hostname.inspect}"
-  puts "Connection max_vcpus #{c.max_vcpus.inspect}"
-  puts "Connection capabilities #{c.capabilities.inspect}"
-  node_info = c.node_info
+  OBJECTS[:hv] = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  OBJECTS[:hv].open
+  res = OBJECTS[:hv].set_keep_alive(2, 1)
+  Libvirt.logger.info { "set_keep_alive #{res}" }
+
+  puts "Connection version #{OBJECTS[:hv].version.inspect}"
+  puts "Connection lib_version #{OBJECTS[:hv].lib_version.inspect}"
+  puts "Connection hostname #{OBJECTS[:hv].hostname.inspect}"
+  puts "Connection max_vcpus #{OBJECTS[:hv].max_vcpus.inspect}"
+  puts "Connection capabilities #{OBJECTS[:hv].capabilities.inspect}"
+  node_info = OBJECTS[:hv].node_info
   puts "Connection nodeInfo #{node_info}"
   puts "NodeInfo model #{node_info.model.inspect}"
   puts "NodeInfo cpus #{node_info.cpus.inspect}"
@@ -57,27 +59,27 @@ Async do
   puts "NodeInfo threads #{node_info.threads.inspect}"
   puts "NodeInfo memory #{node_info.memory.inspect}"
 
-  cb_ids = Libvirt::Connection::DOMAIN_EVENT_IDS.map do |event_id|
+  Libvirt::Connection::DOMAIN_EVENT_IDS.map do |event_id|
     op = OpenStruct.new(a: 'b', event_id: event_id)
-    c.register_domain_event_callback(event_id, nil, op) do |conn, dom, *args, opaque|
+    callback_id = OBJECTS[:hv].register_domain_event_callback(event_id, nil, op) do |conn, dom, *args, opaque|
       Libvirt.logger.info { "DOMAIN EVENT #{event_id} conn=#{conn}, dom=#{dom}, args=#{args}, opaque=#{opaque}" }
     end
+    Libvirt.logger.info { "Registered domain event callback event_id=#{event_id} callback_id=#{callback_id}" }
+    OBJECTS[:cb_ids] << callback_id
   end
-  CB_IDS.concat(cb_ids)
 
-  puts "domains qty #{c.list_all_domains_qty}"
+  puts "domains qty #{OBJECTS[:hv].list_all_domains_qty}"
 
-  domains = c.list_all_domains
-  DOMS.concat(domains)
-  puts "Domains (#{domains.size}): #{domains}"
+  OBJECTS[:domains] = OBJECTS[:hv].list_all_domains
+  puts "Domains (#{OBJECTS[:domains].size}): #{OBJECTS[:domains]}"
 
-  d = domains.first
+  d = OBJECTS[:domains].first
   puts "Domain uuid #{d.uuid.inspect}"
   puts "Domain name #{d.name.inspect}"
   puts "Domain get_state #{d.get_state.inspect}"
   puts "Domain get_cpus #{d.max_vcpus.inspect}"
   puts "Domain max_memory #{d.max_memory.inspect}"
-  puts "Domain xml_desc #{d.xml_desc.inspect}"
+  # puts "Domain xml_desc #{d.xml_desc.inspect}"
 
   # ASYNC_REACTOR.every(10) do
   #   LibvirtAsync::Util.create_task(nil, ASYNC_REACTOR) { IMPL.print_debug_info }.run
@@ -90,20 +92,94 @@ Async do
     # Libvirt.logger.info { "MEM USAGE: #{GetProcessMem.new.mb} MB" }
   end
 
-  ASYNC_REACTOR.after(20) do
-    LibvirtAsync::Util.create_task(nil, ASYNC_REACTOR) do
+  # ASYNC_REACTOR.after(20) do
+  #   Libvirt.logger.info { 'START Cleaning up!' }
+  #
+  #   LibvirtAsync::Util.create_task(nil, ASYNC_REACTOR) do
+  #
+  #     OBJECTS[:cb_ids].each do |callback_id|
+  #       Libvirt.logger.info { "Start retrieving callback_id=#{callback_id}" }
+  #       opaque = OBJECTS[:hv].deregister_domain_event_callback(callback_id)
+  #       Libvirt.logger.info { "Retrieved opaque=#{opaque}" }
+  #     end
+  #     Libvirt.logger.info { 'Cleaning up!' }
+  #     OBJECTS[:hv] = nil
+  #     OBJECTS[:domains] = []
+  #     OBJECTS[:cb_ids] = []
+  #     Libvirt.logger.info { "GC.start 1" }
+  #     GC.start
+  #
+  #     ASYNC_REACTOR << LibvirtAsync::Util.create_task(nil, ASYNC_REACTOR) do
+  #       Libvirt.logger.info { "GC.start 2" }
+  #       GC.start
+  #     end.fiber
+  #
+  #   end.run
+  # end
 
-      c = CONNS.first
-      CB_IDS.each do |callback_id|
-        opaque = c.deregister_domain_event_callback(callback_id)
-        puts "Retrieved opaque #{opaque}"
-      end
-      Libvirt.logger.info { 'Cleaning up!' }
-      CONNS = []
-      DOMS = []
-      CB_IDS = []
-      GC.start
+  # puts 'undefine DOM'
+  # d.undefine
+  # ASYNC_REACTOR.sleep 5
 
-    end
-  end
+  # begin
+  #   puts 'DOM starting...'
+  #   d.start
+  #   puts 'DOM started'
+  # rescue Libvirt::Errors::LibError => e
+  #   STDERR.puts "error starting\n#{e.class}\n#{e.message}", e.error_data
+  # end
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state} before save_memory"
+  # d.save_memory
+  # puts "DOMAIN state #{d.get_state} after save_memory"
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state} before start"
+  # d.start
+  # puts "DOMAIN state #{d.get_state} after start"
+  #
+  # #ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state} before resume"
+  # d.resume
+  # puts "DOMAIN state #{d.get_state} after resume"
+
+  # ASYNC_REACTOR.sleep 10
+  # puts "DOMAIN state #{d.get_state} before shutdown"
+  # d.shutdown(1)
+  # puts "DOMAIN state #{d.get_state} after shutdown"
+  #
+  # ASYNC_REACTOR.sleep 10
+  # puts "DOMAIN state #{d.get_state}"
+  # d.start
+  # puts 'DOM start'
+  #
+  # ASYNC_REACTOR.sleep 10
+  # puts "DOMAIN state #{d.get_state}"
+  # d.reboot
+  # puts 'DOM reboot'
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state}"
+  # d.suspend
+  # puts 'DOM suspend'
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state}"
+  # d.resume
+  # puts 'DOM resume'
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state}"
+  # d.reset
+  # puts 'DOM reset'
+  #
+  # ASYNC_REACTOR.sleep 5
+  # puts "DOMAIN state #{d.get_state}"
+  # d.power_off
+  # puts 'DOM power_off'
+  #
+  # ASYNC_REACTOR.sleep 5
+  # d.start
+  # puts 'DOM start'
 end

data/test_usage/test_libvirtd_restart.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libvirt'
+require 'logger'
+require 'active_support/all'
+require 'async'
+require 'get_process_mem'
+require 'gc_tracer'
+
+require_relative 'support/libvirt_async'
+require_relative 'support/log_formatter'
+
+GC::Tracer.start_logging(
+    nil,
+    gc_stat: false,
+    gc_latest_gc_info: false,
+    rusage: false,
+    events: [:end_mark, :end_sweep]
+)
+
+Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
+Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
+
+IMPL = LibvirtAsync::Implementations.new
+OBJECTS = {
+    hv: nil
+}.freeze
+
+def async_task(run, parent = nil, &block)
+  task = LibvirtAsync::Util.create_task(parent, ASYNC_REACTOR, &block)
+  case run
+  when :now
+    task.run
+  when :later
+    task.reactor << task.fiber
+  else
+    raise ArgumentError, "invalid run #{run}"
+  end
+end
+
+Async do
+  ASYNC_REACTOR = Async::Task.current.reactor
+
+  puts "Lib version #{Libvirt.lib_version}"
+  puts "Gem version #{Libvirt::VERSION}"
+
+  IMPL.start
+
+  OBJECTS[:hv] = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  OBJECTS[:hv].open
+  OBJECTS[:hv].register_close_callback do |conn, reason, _op|
+    puts "Im closing conn=#{conn}, reason=#{reason}"
+  end
+  # OBJECTS[:hv].set_keep_alive(2, 1)
+
+  ASYNC_REACTOR.every(5) do
+    async_task(:now) do
+      puts "list_all_domains_qty #{OBJECTS[:hv].list_all_domains_qty}"
+    end
+  end
+end

data/test_usage/test_metadata.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libvirt'
+require 'logger'
+require 'active_support/all'
+require 'async'
+
+require_relative 'support/libvirt_async'
+require_relative 'support/log_formatter'
+
+require 'libvirt/xml'
+
+Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
+Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
+
+IMPL = LibvirtAsync::Implementations.new
+
+STDOUT.sync = true
+STDERR.sync = true
+
+def log_error(error, skip_backtrace: false, causes: [])
+  STDERR.puts "<#{error.class}>: #{error.message}", error.backtrace
+  if error.cause && error.cause != error && !causes.include?(error.cause)
+    causes.push(error)
+    log_error(error.cause, skip_backtrace: skip_backtrace, causes: causes)
+  end
+end
+
+def libvirt_safe(rescue_value = nil)
+  yield
+rescue Libvirt::Errors::LibError => e
+  STDERR.puts "<#{e.class}>: #{e.message}"
+  rescue_value
+end
+
+Async do
+  ASYNC_REACTOR = Async::Task.current.reactor
+
+  puts "Lib version #{Libvirt.lib_version}"
+  puts "Gem version #{Libvirt::VERSION}"
+
+  IMPL.start
+
+  conn = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  conn.open
+
+  puts "Connection version #{conn.version.inspect}"
+  puts "Connection lib_version #{conn.lib_version.inspect}"
+  puts "Connection hostname #{conn.hostname.inspect}"
+
+  dom = conn.list_all_domains.first
+  puts "Domain #{dom.uuid} #{dom.name}"
+
+  libvirt_safe do
+    dom.start
+  end
+
+  dom.set_metadata("test title #{Process.pid}", type: :TITLE, flags: :AFFECT_CONFIG)
+  dom.set_metadata("test desc #{Process.pid}", type: :DESCRIPTION, flags: :AFFECT_CONFIG)
+
+  puts "domain title", libvirt_safe{ dom.get_metadata(type: :TITLE, flags: :AFFECT_CONFIG) }
+  puts "domain description", libvirt_safe { dom.get_metadata(type: :DESCRIPTION, flags: :AFFECT_CONFIG) }
+
+  puts "full XML title", Libvirt::Xml::Domain.load(dom.xml_desc).title
+  puts "full XML description", Libvirt::Xml::Domain.load(dom.xml_desc).description
+
+  namespace = 'https://example.com'
+  old_metadata = dom.get_metadata(
+      uri: namespace, flags: :AFFECT_CONFIG
+  )
+
+  puts "Old Metadata", old_metadata
+
+  new_metadata = "<pid>#{Process.pid}</pid>"
+  key = 'example'
+  dom.set_metadata new_metadata,
+                   key: key,
+                   uri: namespace,
+                   flags: :AFFECT_CONFIG
+
+  puts "new metadata", dom.get_metadata(
+      uri: namespace, flags: :AFFECT_CONFIG
+  )
+
+  puts "full XML metadata", Libvirt::Xml::Domain.load(dom.xml_desc).metadata
+
+  puts "domain shutdown", libvirt_safe { dom.shutdown }
+  ASYNC_REACTOR.sleep 5
+  puts dom.get_state
+
+  puts "domain start", libvirt_safe { dom.start }
+  ASYNC_REACTOR.sleep 2
+  puts dom.get_state
+
+  puts "full XML metadata", Libvirt::Xml::Domain.load(dom.xml_desc).metadata
+  puts "full XML title", Libvirt::Xml::Domain.load(dom.xml_desc).title
+  puts "full XML description", Libvirt::Xml::Domain.load(dom.xml_desc).description
+
+rescue StandardError => e
+  log_error(e)
+  exit 1
+end

data/test_usage/test_screenshot.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'libvirt'
@@ -28,21 +29,22 @@ def run_gc(msg)
 end
 
 IMPL = LibvirtAsync::Implementations.new
-CONNS = []
-DOMS = []
-STREAMS = { stream: nil }
+CONNS = [].freeze
+DOMS = [].freeze
+STREAMS = { stream: nil }.freeze
 
 class ScreenshotOpaque
   CALLBACK = proc do |s, ev, op|
-    #run_gc('ScreenshotOpaque CALLBACK start')
+    # run_gc('ScreenshotOpaque CALLBACK start')
     next unless (Libvirt::Stream::EVENT_READABLE & ev) != 0
+
     begin
       code, data = s.recv(1024)
-    rescue Libvirt::Error => e
+    rescue Libvirt::Errors::LibError => e
       op.on_libvirt_error(s, e)
       next
     end
-    #run_gc('ScreenshotOpaque CALLBACK after recv')
+    # run_gc('ScreenshotOpaque CALLBACK after recv')
 
     case code
     when 0
@@ -96,9 +98,9 @@ class ScreenshotOpaque
       print_usage "Opaque#finish_stream stream.finish #{@filepath}"
       stream.finish
       [true, nil]
-    rescue Libvirt::Error => e
-      STDERR.puts "Opaque#finish_stream stream.finish exception rescued #{e.class} #{e.message}"
-      [false, e.message]
+             rescue Libvirt::Errors::LibError => e
+               warn "Opaque#finish_stream stream.finish exception rescued #{e.class} #{e.message}"
+               [false, e.message]
     end
     print_usage "Opaque#finish_stream ends #{@filepath}"
     result
@@ -158,14 +160,14 @@ Async do
   domain = c.list_all_domains.first
   DOMS.push(domain)
 
-  print_usage "First generation"
+  print_usage 'First generation'
   5.times do |i|
     save_screenshot(c, domain, 100 + i)
   end
 
   ASYNC_REACTOR.after(15) do
     Async::Task.new(ASYNC_REACTOR, nil) do
-      print_usage "Second generation"
+      print_usage 'Second generation'
 
       con = CONNS.first
       dom = DOMS.first
@@ -177,7 +179,7 @@ Async do
 
   ASYNC_REACTOR.after(30) do
     Async::Task.new(ASYNC_REACTOR, nil) do
-      print_usage "Third generation"
+      print_usage 'Third generation'
 
       con = CONNS.first
       dom = DOMS.first
@@ -192,5 +194,4 @@ Async do
       run_gc 'PERIODIC'
     end.run
   end
-
 end

data/test_usage/test_storage.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libvirt'
+require 'logger'
+require 'active_support/all'
+require 'async'
+
+require_relative 'support/libvirt_async'
+require_relative 'support/log_formatter'
+
+require 'libvirt/xml'
+
+Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
+Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
+
+IMPL = LibvirtAsync::Implementations.new
+
+Async do
+  ASYNC_REACTOR = Async::Task.current.reactor
+
+  puts "Lib version #{Libvirt.lib_version}"
+  puts "Gem version #{Libvirt::VERSION}"
+
+  IMPL.start
+
+  conn = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  conn.open
+
+  puts "Connection version #{conn.version.inspect}"
+  puts "Connection lib_version #{conn.lib_version.inspect}"
+  puts "Connection hostname #{conn.hostname.inspect}"
+
+  pools = conn.list_all_storage_pools
+  puts "Connection storage pools qty #{pools.size}"
+
+  pools.each.with_index do |pool, i|
+    puts "Storage pool #{i} info", pool.info.to_h
+    puts "Storage pool #{i} xml", Libvirt::Xml::StoragePool.load(pool.xml_desc).to_h
+  end
+
+  pools.each.with_index do |pool, i|
+    volumes = pool.list_all_volumes
+    puts "Storage pool #{i} volumes qty #{volumes.size}"
+
+    volumes.each.with_index do |vol, j|
+      puts "Storage pool #{i} volume #{j} info", vol.info.to_h
+      puts "Storage pool #{i} volume #{j} xml", Libvirt::Xml::StorageVolume.load(vol.xml_desc).to_h
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libvirt_ffi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
 description: Libvirt FFI
 email:
 - senid231@gmail.com
@@ -33,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -43,28 +58,49 @@ files:
 - bin/setup
 - exe/libvirt
 - lib/libvirt.rb
+- lib/libvirt/base_info.rb
 - lib/libvirt/connection.rb
 - lib/libvirt/domain.rb
 - lib/libvirt/domain_callback_storage.rb
-- lib/libvirt/error.rb
+- lib/libvirt/errors.rb
 - lib/libvirt/event.rb
+- lib/libvirt/ffi.rb
 - lib/libvirt/ffi/common.rb
-- lib/libvirt/ffi/connection.rb
 - lib/libvirt/ffi/domain.rb
+- lib/libvirt/ffi/error.rb
 - lib/libvirt/ffi/event.rb
-- lib/libvirt/ffi/libvirt.rb
-- lib/libvirt/ffi/node_info.rb
+- lib/libvirt/ffi/helpers.rb
+- lib/libvirt/ffi/host.rb
+- lib/libvirt/ffi/storage.rb
 - lib/libvirt/ffi/stream.rb
 - lib/libvirt/node_info.rb
+- lib/libvirt/storage_pool.rb
+- lib/libvirt/storage_pool_info.rb
+- lib/libvirt/storage_volume.rb
+- lib/libvirt/storage_volume_info.rb
 - lib/libvirt/stream.rb
 - lib/libvirt/util.rb
 - lib/libvirt/version.rb
+- lib/libvirt/xml.rb
+- lib/libvirt/xml/disk.rb
+- lib/libvirt/xml/domain.rb
+- lib/libvirt/xml/generic.rb
+- lib/libvirt/xml/graphics.rb
+- lib/libvirt/xml/max_vcpu.rb
+- lib/libvirt/xml/memory.rb
+- lib/libvirt/xml/storage_pool.rb
+- lib/libvirt/xml/storage_volume.rb
+- lib/libvirt/xml/vcpu.rb
 - lib/libvirt_ffi.rb
 - libvirt.gemspec
 - test_usage/support/libvirt_async.rb
 - test_usage/support/log_formatter.rb
+- test_usage/test_domain.rb
 - test_usage/test_event_loop.rb
+- test_usage/test_libvirtd_restart.rb
+- test_usage/test_metadata.rb
 - test_usage/test_screenshot.rb
+- test_usage/test_storage.rb
 homepage: https://github.com/senid231/libvirt_ffi
 licenses:
 - MIT

data/lib/libvirt/error.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Libvirt
-  class Error < StandardError
-  end
-end