libvirt_ffi 0.8.0 → 0.8.1

data/lib/libvirt/ffi/host.rb

@@ -33,103 +33,142 @@ module Libvirt
 
       # enum virConnectCloseReason
       enum :close_reason, [
-        :ERROR, 0x0, # Misc I/O error
-        :EOF, 0x1, # End-of-file from server
-        :KEEPALIVE, 0x2, # Keepalive timer triggered
-        :CLIENT, 0x3 # Client requested it
+          :ERROR, 0x0, # Misc I/O error
+          :EOF, 0x1, # End-of-file from server
+          :KEEPALIVE, 0x2, # Keepalive timer triggered
+          :CLIENT, 0x3 # Client requested it
       ]
 
-      # int  virGetVersion  (
+      # int virGetVersion (
       #   unsigned long *libVer,
       #   const char *type,
       #   unsigned long *typeVer
       # )
-      attach_function :virGetVersion, [:pointer, :string, :pointer], :int
+      attach_function :virGetVersion,
+                      [:pointer, :string, :pointer],
+                      :int
 
-      # int  virNodeGetInfo (
+      # int virNodeGetInfo (
       #   virConnectPtr conn,
       #   virNodeInfoPtr info
       # )
-      attach_function :virNodeGetInfo, [:pointer, :pointer], :int
+      attach_function :virNodeGetInfo,
+                      [:pointer, :pointer],
+                      :int
 
-      # typedef void  (*virConnectCloseFunc) (
+      # typedef void (*virConnectCloseFunc) (
       #   virConnectPtr conn,
       #   int reason,
       #   void * opaque
       # )
-      callback :virConnectCloseFunc, [:pointer, :close_reason, :pointer], :void
+      callback :virConnectCloseFunc,
+               [:pointer, :close_reason, :pointer],
+               :void
 
-      # virConnectPtr  virConnectOpen (const char * name)
-      attach_function :virConnectOpen, [:string], :pointer
+      # virConnectPtr virConnectOpen (
+      #   const char * name
+      # )
+      attach_function :virConnectOpen,
+                      [:string],
+                      :pointer
 
-      # int  virConnectSetKeepAlive (
+      # int virConnectSetKeepAlive (
       #   virConnectPtr conn,
       #   int interval,
       #   unsigned int count
       # )
-      attach_function :virConnectSetKeepAlive, [:pointer, :int, :uint], :int
+      attach_function :virConnectSetKeepAlive,
+                      [:pointer, :int, :uint],
+                      :int
 
-      # int  virConnectGetVersion (
+      # int virConnectGetVersion (
       #   virConnectPtr conn,
       #   unsigned long * hvVer
       # )
-      attach_function :virConnectGetVersion, [:pointer, :pointer], :int
+      attach_function :virConnectGetVersion,
+                      [:pointer, :pointer],
+                      :int
 
-      # int  virConnectGetLibVersion  (
+      # int virConnectGetLibVersion (
       #   virConnectPtr conn,
       #   unsigned long * libVer
       # )
-      attach_function :virConnectGetLibVersion, [:pointer, :pointer], :int
+      attach_function :virConnectGetLibVersion,
+                      [:pointer, :pointer],
+                      :int
 
-      # char *  virConnectGetHostname  (
+      # char * virConnectGetHostname (
       #   virConnectPtr conn
       # )
-      attach_function :virConnectGetHostname, [:pointer], :string # strptr ?
+      attach_function :virConnectGetHostname,
+                      [:pointer],
+                      :string
 
-      # int  virConnectGetMaxVcpus  (
+      # int  virConnectGetMaxVcpus (
       #   virConnectPtr conn,
       #   const char * type
       # )
-      attach_function :virConnectGetMaxVcpus, [:pointer, :string], :int
+      attach_function :virConnectGetMaxVcpus,
+                      [:pointer, :string],
+                      :int
 
-      # char *  virConnectGetCapabilities  (
+      # char * virConnectGetCapabilities (
       #   virConnectPtr conn
       # )
-      attach_function :virConnectGetCapabilities, [:pointer], :string # strptr ?
+      attach_function :virConnectGetCapabilities,
+                      [:pointer],
+                      :string
 
-      # int  virConnectClose  (
+      # int virConnectClose (
       #   virConnectPtr conn
       # )
-      attach_function :virConnectClose, [:pointer], :int
+      attach_function :virConnectClose,
+                      [:pointer],
+                      :int
 
-      # int  virConnectRegisterCloseCallback  (
+      # int virConnectRegisterCloseCallback (
       #   virConnectPtr conn,
       #   virConnectCloseFunc cb,
       #   void * opaque,
       #   virFreeCallback freecb
       # )
-      attach_function :virConnectRegisterCloseCallback, [
-          :pointer,
-          :virConnectCloseFunc,
-          :pointer,
-          FFI::Common::FREE_CALLBACK
-      ], :int
-
-      # int  virConnectUnregisterCloseCallback  (
+      attach_function :virConnectRegisterCloseCallback,
+                      [
+                          :pointer,
+                          :virConnectCloseFunc,
+                          :pointer,
+                          FFI::Common::FREE_CALLBACK
+                      ],
+                      :int
+
+      # int virConnectUnregisterCloseCallback (
       #   virConnectPtr conn,
       #   virConnectCloseFunc cb
       # )
-      attach_function :virConnectUnregisterCloseCallback, [:pointer, :pointer], :int
+      attach_function :virConnectUnregisterCloseCallback,
+                      [:pointer, :pointer],
+                      :int
 
-      # int  virConnectRef  (
+      # int virConnectRef (
       #   virConnectPtr conn
       # )
-      attach_function :virConnectRef, [:pointer], :int
+      attach_function :virConnectRef,
+                      [:pointer],
+                      :int
 
       # unsigned long long virNodeGetFreeMemory (
       #   virConnectPtr conn
       # )
-      attach_function :virNodeGetFreeMemory, [:pointer], :ulong_long
+      attach_function :virNodeGetFreeMemory,
+                      [:pointer],
+                      :ulong_long
+
+      # char * virConnectGetURI (
+      #   virConnectPtr conn
+      # )
+      attach_function :virConnectGetURI,
+                      [:pointer],
+                      :string
     end
   end
 end

data/lib/libvirt/loggable.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Loggable
+    # caller[0].match(/`(.*)'/)[1]
+
+    module ClassMethods
+      def dbg(prog_name = nil, &block)
+        return if Libvirt.logger.nil?
+
+        if prog_name.nil?
+          meth = caller[0].match(/`(.*)'/)[1]
+          meth = "<#{meth}>" if meth.include?(' ')
+          prog_name = "#{name}.#{meth}"
+        end
+        Libvirt.logger.debug(prog_name, &block)
+      end
+
+      def err(prog_name = nil, &block)
+        return if Libvirt.logger.nil?
+
+        if prog_name.nil?
+          meth = caller[0].match(/`(.*)'/)[1]
+          meth = "<#{meth}>" if meth.include?(' ')
+          prog_name = "#{name}.#{meth}"
+        end
+        Libvirt.logger.error(prog_name, &block)
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+      super
+    end
+
+    def dbg(prog_name = nil, &block)
+      return if Libvirt.logger.nil?
+
+      if prog_name.nil?
+        meth = caller[0].match(/`(.*)'/)[1]
+        meth = "<#{meth}>" if meth.include?(' ')
+        prog_name = "#{self.class.name}##{meth}"
+      end
+      Libvirt.logger.debug(prog_name, &block)
+    end
+
+    def err(prog_name = nil, &block)
+      return if Libvirt.logger.nil?
+
+      if prog_name.nil?
+        meth = caller[0].match(/`(.*)'/)[1]
+        meth = "<#{meth}>" if meth.include?(' ')
+        prog_name = "#{self.class.name}##{meth}"
+      end
+      Libvirt.logger.error(prog_name, &block)
+    end
+  end
+end

data/lib/libvirt/util.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'objspace'
+
 module Libvirt
   module Util
+    extend Loggable::ClassMethods
+
     UNIT_TO_BYTES = {
         b: 1,
         bytes: 1,
@@ -21,83 +25,102 @@ module Libvirt
 
     UUID_STRING_BUFLEN = 0x80 # RFC4122
 
-    class << self
-      attr_writer :logger
-
-      attr_reader :logger
+    module_function
 
-      def log(severity, prog = nil, &block)
-        return if @logger.nil?
+    def logger
+      @logger if defined?(@logger)
+    end
 
-        @logger.public_send(severity, prog, &block)
-      end
+    def logger=(value)
+      @logger = value
+    end
 
-      def library_path
-        %w[libvirt libvirt.so.0]
-      end
+    def log(severity, prog = nil, &block)
+      return if logger.nil?
 
-      # @param [Integer] version_number ulong
-      def parse_version(version_number)
-        major = version_number / 1_000_000
-        minor = (version_number - major * 1_000_000) / 1_000
-        release = version_number - major * 1_000_000 - minor * 1_000
-        "#{major}.#{minor}.#{release}"
-      end
+      logger.public_send(severity, prog, &block)
+    end
 
-      # @param enum [FFI::Enum]
-      # @param value [Symbol, Integer]
-      # @return [Array] event_id, event_id_sym
-      # @raise ArgumentError
-      def parse_enum(enum, value)
-        if value.is_a?(Symbol)
-          raise ArgumentError, 'invalid enum value' unless enum.symbols.include?(value)
+    def library_path
+      %w[libvirt libvirt.so.0]
+    end
 
-          return [enum.find(value), value]
-        end
+    # @param [Integer] version_number ulong
+    def parse_version(version_number)
+      major = version_number / 1_000_000
+      minor = (version_number - major * 1_000_000) / 1_000
+      release = version_number - major * 1_000_000 - minor * 1_000
+      "#{major}.#{minor}.#{release}"
+    end
 
-        raise ArgumentError, 'invalid enum value' unless enum.symbol_map.values.include?(value)
+    # @param enum [FFI::Enum]
+    # @param value [Symbol, Integer]
+    # @return [Array] event_id, event_id_sym
+    # @raise ArgumentError
+    def parse_enum(enum, value)
+      if value.is_a?(Symbol)
+        raise ArgumentError, 'invalid enum value' unless enum.symbols.include?(value)
 
-        [value, enum.symbol_map[value]]
+        return [enum.find(value), value]
       end
 
-      # Bitwise OR integer flags calculation for C language.
-      # @param flags [Integer,Symbol,Array<Symbol>,Hash{Symbol=>Boolean},nil]
-      # @param enum [FFI::Enum]
-      # @param default [Integer] optional (default 0x0)
-      # @return [Integer] bitwise OR of keys
-      #  @example Usage:
-      #    parse_flags(nil, enum)
-      #    parse_flags({MANAGED_SAVE: true, SNAPSHOTS_METADATA: true, NVRAM: false}, enum)
-      #    parse_flags({managed_save: true, snapshots_metadata: true, keep_nvram: nil}, enum)
-      #    parse_flags(3, enum)
-      #    parse_flags([:MANAGED_SAVE, :SNAPSHOTS_METADATA], enum)
-      #    parse_flags([:managed_save, :snapshots_metadata], enum)
-      #
-      def parse_flags(flags, enum, default: 0x0)
-        flags = default if flags.nil?
-        flags = enum[flags] if flags.is_a?(Symbol)
-        return flags if flags.is_a?(Integer)
-
-        result = 0x0
-        flags = flags.select { |_, v| v }.keys if flags.is_a?(Hash)
-
-        raise ArgumentError, 'flags must be an Integer or a Hash or an Array' unless flags.is_a?(Array)
-
-        flags.each do |key|
-          result |= enum[key.to_s.upcase.to_sym]
-        end
-
-        result
+      raise ArgumentError, 'invalid enum value' unless enum.symbol_map.values.include?(value)
+
+      [value, enum.symbol_map[value]]
+    end
+
+    # Bitwise OR integer flags calculation for C language.
+    # @param flags [Integer,Symbol,Array<Symbol>,Hash{Symbol=>Boolean},nil]
+    # @param enum [FFI::Enum]
+    # @param default [Integer] optional (default 0x0)
+    # @return [Integer] bitwise OR of keys
+    #  @example Usage:
+    #    parse_flags(nil, enum)
+    #    parse_flags({MANAGED_SAVE: true, SNAPSHOTS_METADATA: true, NVRAM: false}, enum)
+    #    parse_flags({managed_save: true, snapshots_metadata: true, keep_nvram: nil}, enum)
+    #    parse_flags(3, enum)
+    #    parse_flags([:MANAGED_SAVE, :SNAPSHOTS_METADATA], enum)
+    #    parse_flags([:managed_save, :snapshots_metadata], enum)
+    #
+    def parse_flags(flags, enum, default: 0x0)
+      flags = default if flags.nil?
+      flags = enum[flags] if flags.is_a?(Symbol)
+      return flags if flags.is_a?(Integer)
+
+      result = 0x0
+      flags = flags.select { |_, v| v }.keys if flags.is_a?(Hash)
+
+      raise ArgumentError, 'flags must be an Integer or a Hash or an Array' unless flags.is_a?(Array)
+
+      flags.each do |key|
+        result |= enum[key.to_s.upcase.to_sym]
       end
 
-      # @param value [Integer,String]
-      # @param unit [String,Symbol] default 'bytes'
-      # @return [Integer] memory in bytes
-      def parse_memory(value, unit)
-        unit ||= 'bytes'
-        multiplier = UNIT_TO_BYTES.fetch(unit.to_sym)
-        Integer(value) * multiplier
+      result
+    end
+
+    # @param value [Integer,String]
+    # @param unit [String,Symbol] default 'bytes'
+    # @return [Integer] memory in bytes
+    def parse_memory(value, unit)
+      unit ||= 'bytes'
+      multiplier = UNIT_TO_BYTES.fetch(unit.to_sym)
+      Integer(value) * multiplier
+    end
+
+    def define_finalizer(object, &block)
+      free = ->(obj_id) do
+        obj_id_hex = "0x#{obj_id.to_s(16)}"
+        ptr = object.to_ptr
+        ptr_hex = "0x#{ptr.address.to_s(16)}"
+        klass = object.class
+        dbg { "Finalize #{klass} object_id=#{obj_id_hex}, pointer=#{ptr_hex}" }
+        return if ptr.null?
+
+        cl_result = block.call(ptr)
+        err { "Couldn't close #{klass} object_id=#{obj_id_hex}, pointer=#{ptr_hex}" } if cl_result.negative?
       end
+      ObjectSpace.define_finalizer(object, free)
     end
   end
 end

data/lib/libvirt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Libvirt
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/lib/libvirt/xml/generic.rb

@@ -26,7 +26,7 @@ module Libvirt
         attr_accessor(*names)
       end
 
-      def self.attribute(name, options = {})
+      def self.attribute(name, **options)
         _attributes_opts.merge!(name.to_sym => options.dup)
         attr_accessor name
       end
@@ -41,7 +41,7 @@ module Libvirt
       # Build xml object with attributes.
       # @param attrs [Hash]
       # @return [Xml::Base]
-      def self.build(attrs = {})
+      def self.build(**attrs)
         xml_node = Nokogiri::XML(nil)
         obj = new(xml_node)
         attrs.each { |key, val| obj.public_send("#{key}=", val) }

data/lib/libvirt/xml.rb

@@ -11,16 +11,17 @@ module Libvirt
     # requires nokogiri.
 
     require 'libvirt/xml/generic'
-    require 'libvirt/xml/storage_pool'
-    require 'libvirt/xml/storage_volume'
-    require 'libvirt/xml/interface'
-    require 'libvirt/xml/ip_address'
-    require 'libvirt/xml/network'
     require 'libvirt/xml/memory'
     require 'libvirt/xml/graphics'
     require 'libvirt/xml/disk'
     require 'libvirt/xml/max_vcpu'
     require 'libvirt/xml/vcpu'
+    require 'libvirt/xml/ip_address'
+    require 'libvirt/xml/device_address'
+    require 'libvirt/xml/storage_pool'
+    require 'libvirt/xml/storage_volume'
+    require 'libvirt/xml/network'
+    require 'libvirt/xml/interface'
     require 'libvirt/xml/domain'
   end
 end

data/lib/libvirt.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'ffi'
-require 'objspace'
+require 'libvirt/version'
+require 'libvirt/loggable'
 require 'libvirt/host_callback_storage'
 require 'libvirt/util'
 require 'libvirt/errors'
@@ -18,7 +19,6 @@ require 'libvirt/storage_pool'
 require 'libvirt/storage_volume'
 require 'libvirt/network'
 require 'libvirt/interface'
-require 'libvirt/version'
 
 module Libvirt
   EVENT_HANDLE_READABLE = 1
@@ -26,22 +26,22 @@ module Libvirt
   EVENT_HANDLE_ERROR = 4
   EVENT_HANDLE_HANGUP = 8
 
-  class << self
-    def lib_version
-      version_ptr = ::FFI::MemoryPointer.new(:ulong)
-      code = FFI::Host.virGetVersion(version_ptr, nil, nil)
-      raise Errors::LibError, 'failed to get version' if code.negative?
+  module_function
 
-      version_number = version_ptr.get_ulong(0)
-      Util.parse_version(version_number)
-    end
+  def lib_version
+    version_ptr = ::FFI::MemoryPointer.new(:ulong)
+    code = FFI::Host.virGetVersion(version_ptr, nil, nil)
+    raise Errors::LibError, 'failed to get version' if code.negative?
 
-    def logger
-      Util.logger
-    end
+    version_number = version_ptr.get_ulong(0)
+    Util.parse_version(version_number)
+  end
+
+  def logger
+    Util.logger
+  end
 
-    def logger=(logger)
-      Util.logger = logger
-    end
+  def logger=(logger)
+    Util.logger = logger
   end
 end

data/libvirt.gemspec

@@ -3,15 +3,15 @@
 require_relative 'lib/libvirt/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'libvirt_ffi'
-  spec.version       = Libvirt::VERSION
-  spec.authors       = ['Denis Talakevich']
-  spec.email         = ['senid231@gmail.com']
+  spec.name = 'libvirt_ffi'
+  spec.version = Libvirt::VERSION
+  spec.authors = ['Denis Talakevich']
+  spec.email = ['senid231@gmail.com']
 
-  spec.summary       = 'Libvirt FFI'
-  spec.description   = 'Libvirt FFI'
-  spec.homepage      = 'https://github.com/senid231/libvirt_ffi'
-  spec.license       = 'MIT'
+  spec.summary = 'Libvirt FFI'
+  spec.description = 'Libvirt FFI'
+  spec.homepage = 'https://github.com/senid231/libvirt_ffi'
+  spec.license = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -20,13 +20,11 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|examples)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'ffi', '>= 1.0'
-
-  spec.add_development_dependency 'rubocop', '~> 0.80.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libvirt_ffi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,20 +24,6 @@ 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
@@ -46,9 +32,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -76,6 +63,7 @@ files:
 - lib/libvirt/ffi/stream.rb
 - lib/libvirt/host_callback_storage.rb
 - lib/libvirt/interface.rb
+- lib/libvirt/loggable.rb
 - lib/libvirt/network.rb
 - lib/libvirt/network_dhcp_lease.rb
 - lib/libvirt/node_info.rb
@@ -101,16 +89,6 @@ files:
 - 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_interface.rb
-- test_usage/test_libvirtd_restart.rb
-- test_usage/test_metadata.rb
-- test_usage/test_network.rb
-- test_usage/test_screenshot.rb
-- test_usage/test_storage.rb
 homepage: https://github.com/senid231/libvirt_ffi
 licenses:
 - MIT
@@ -133,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Libvirt FFI

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.7
-before_install: gem install bundler -v 2.1.4 --no-doc