ruby-libvirt 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25025f1aa369d862c8fce5c8469309c19782309a
-  data.tar.gz: '090a8ccc0dd056d096fc1d450e38b07b0581f294'
+SHA256:
+  metadata.gz: ca7edd355f3679b48ebacb442e8d9c3d77af72a88681064e06a247ceabd4e391
+  data.tar.gz: dd4253fb78b7e584396aec931be145bc236db2e86a56eb275fe7c5675e7cd3f1
 SHA512:
-  metadata.gz: f88b82044556d2fb1940f56d009d605d00d4438db8443cedcda6febd32572b44073d03e3eda42c12916d4219c7a912b8eb0584fe79cfcaa5a6627c849d28c5ea
-  data.tar.gz: 6c9282d08593f50d8c45b92d401c4d6e98d0ae3915fe1678132985661b23c54c7d96bbe7f1af9b37c73e87c8f6652b310e798d6b5ff80b65509b691ec4b2fef6
+  metadata.gz: bf2f9cb3c62d5fb51e919eac7513603bbae31b23b7c712238fc98064c11563451963f5d6bdaa8e6c25f9680bdec14dcc651184d52001cb3d6c24a56134d7535f
+  data.tar.gz: 5561b660c8ec0ce8d61c363a6f1c467c3563277c55998661b75e24936fb6c11708e774a1aab859bfe48fc4f54c1864c371f620cb54bfabe9c9a2ae55d8d33c47

data/NEWS

@@ -1,3 +1,10 @@
+2021-11-15 0.8.0
+  * Fix default values for node_cpu_stats and node_memory_stats
+  * Fix cpumap allocation for virDomainGetVcpus
+  * Enforce UTF8 for strings and exceptions
+  * Drop local have_const
+  * Use sensible default for libvirt_domain_qemu_agent_command
+
 2018-02-18 0.7.1
   * Fix a bad bug in block_resize (Marius Rieder)
   * Fix up some problems pointed out by clang

data/Rakefile

@@ -21,7 +21,7 @@ require 'rubygems/package_task'
 require 'rbconfig'
 
 PKG_NAME='ruby-libvirt'
-PKG_VERSION='0.7.1'
+PKG_VERSION='0.8.0'
 
 EXT_CONF='ext/libvirt/extconf.rb'
 MAKEFILE="ext/libvirt/Makefile"
@@ -145,7 +145,7 @@ SPEC = Gem::Specification.new do |s|
     s.author = "David Lutterkort, Chris Lalancette"
     s.rubyforge_project = "None"
     s.description = "Ruby bindings for libvirt."
-    s.license = "LGPLv2"
+    s.license = "LGPL-2.1-or-later"
 end
 
 Gem::PackageTask.new(SPEC) do |pkg|

data/ext/libvirt/common.c

@@ -24,7 +24,8 @@
 #endif
 #include <stdio.h>
 #include <ruby.h>
-#include <st.h>
+#include <ruby/encoding.h>
+#include <ruby/st.h>
 #include <libvirt/libvirt.h>
 #include <libvirt/virterror.h>
 #include "common.h"
@@ -38,8 +39,9 @@ struct rb_exc_new2_arg {
 static VALUE ruby_libvirt_exc_new2_wrap(VALUE arg)
 {
     struct rb_exc_new2_arg *e = (struct rb_exc_new2_arg *)arg;
+    VALUE ruby_msg = ruby_libvirt_str_new2_wrap((VALUE)&e->msg);
 
-    return rb_exc_new2(e->error, e->msg);
+    return rb_exc_new3(e->error, ruby_msg);
 }
 
 VALUE ruby_libvirt_ary_new2_wrap(VALUE arg)
@@ -66,8 +68,11 @@ VALUE ruby_libvirt_ary_store_wrap(VALUE arg)
 VALUE ruby_libvirt_str_new2_wrap(VALUE arg)
 {
     char **str = (char **)arg;
+    VALUE ruby_msg = rb_str_new2(*str);
+    int enc = rb_enc_find_index("UTF-8");
 
-    return rb_str_new2(*str);
+    rb_enc_associate_index(ruby_msg, enc);
+    return ruby_msg;
 }
 
 VALUE ruby_libvirt_str_new_wrap(VALUE arg)
@@ -144,7 +149,7 @@ void ruby_libvirt_raise_error_if(const int condition, VALUE error,
         rb_iv_set(ruby_errinfo, "@libvirt_level", INT2NUM(err->level));
         if (err->message != NULL) {
             rb_iv_set(ruby_errinfo, "@libvirt_message",
-                      rb_str_new2(err->message));
+                      ruby_libvirt_str_new2_wrap((VALUE)&err->message));
         }
     }
 

data/ext/libvirt/common.h

@@ -56,7 +56,7 @@ void ruby_libvirt_raise_error_if(const int condition, VALUE error,
             }                                                            \
         }                                                                \
         else {                                                           \
-            result = rb_str_new2(str);                                   \
+            result = ruby_libvirt_str_new2_wrap((VALUE)&str);            \
         }                                                                \
         return result;                                                   \
     } while(0)

data/ext/libvirt/connect.c

@@ -2079,7 +2079,12 @@ static VALUE libvirt_connect_node_cpu_stats(int argc, VALUE *argv, VALUE c)
 
     rb_scan_args(argc, argv, "02", &intparam, &flags);
 
-    tmp = ruby_libvirt_value_to_int(intparam);
+    if (NIL_P(intparam)) {
+        tmp = -1;
+    }
+    else {
+        tmp = ruby_libvirt_value_to_int(intparam);
+    }
 
     return ruby_libvirt_get_parameters(c, ruby_libvirt_value_to_uint(flags),
                                        (void *)&tmp, sizeof(virNodeCPUStats),
@@ -2139,7 +2144,12 @@ static VALUE libvirt_connect_node_memory_stats(int argc, VALUE *argv, VALUE c)
 
     rb_scan_args(argc, argv, "02", &intparam, &flags);
 
-    tmp = ruby_libvirt_value_to_int(intparam);
+    if (NIL_P(intparam)) {
+        tmp = -1;
+    }
+    else {
+        tmp = ruby_libvirt_value_to_int(intparam);
+    }
 
     return ruby_libvirt_get_parameters(c, ruby_libvirt_value_to_uint(flags),
                                        (void *)&tmp, sizeof(virNodeMemoryStats),
@@ -2280,9 +2290,7 @@ static struct ruby_libvirt_typed_param memory_allowed[] = {
     {VIR_NODE_MEMORY_SHARED_PAGES_UNSHARED, VIR_TYPED_PARAM_ULLONG},
     {VIR_NODE_MEMORY_SHARED_PAGES_VOLATILE, VIR_TYPED_PARAM_ULLONG},
     {VIR_NODE_MEMORY_SHARED_FULL_SCANS, VIR_TYPED_PARAM_ULLONG},
-#if HAVE_CONST_VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES
     {VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES, VIR_TYPED_PARAM_UINT},
-#endif
 };
 
 /*

data/ext/libvirt/domain.c

@@ -23,7 +23,7 @@
 #include <unistd.h>
 #include <ruby.h>
 /* we need to include st.h since ruby 1.8 needs it for RHash */
-#include <st.h>
+#include <ruby/st.h>
 #include <libvirt/libvirt.h>
 #if HAVE_VIRDOMAINQEMUMONITORCOMMAND
 #include <libvirt/libvirt-qemu.h>
@@ -803,7 +803,7 @@ static VALUE libvirt_domain_vcpus(VALUE d)
 
     cpumaplen = VIR_CPU_MAPLEN(maxcpus);
 
-    cpumap = alloca(sizeof(unsigned char) * cpumaplen);
+    cpumap = alloca(sizeof(unsigned char) * cpumaplen * dominfo.nrVirtCpu);
 
     r = virDomainGetVcpus(ruby_libvirt_domain_get(d), cpuinfo,
                           dominfo.nrVirtCpu, cpumap, cpumaplen);
@@ -832,15 +832,16 @@ static VALUE libvirt_domain_vcpus(VALUE d)
 
     result = rb_ary_new();
 
-    for (i = 0; i < dominfo.nrVirtCpu; i++) {
+    for (i = 0; i < r; i++) {
         vcpuinfo = rb_class_new_instance(0, NULL, c_domain_vcpuinfo);
-        rb_iv_set(vcpuinfo, "@number", UINT2NUM(i));
         if (cpuinfo != NULL) {
+            rb_iv_set(vcpuinfo, "@number", INT2NUM(cpuinfo[i].number));
             rb_iv_set(vcpuinfo, "@state", INT2NUM(cpuinfo[i].state));
             rb_iv_set(vcpuinfo, "@cpu_time", ULL2NUM(cpuinfo[i].cpuTime));
             rb_iv_set(vcpuinfo, "@cpu", INT2NUM(cpuinfo[i].cpu));
         }
         else {
+            rb_iv_set(vcpuinfo, "@number", Qnil);
             rb_iv_set(vcpuinfo, "@state", Qnil);
             rb_iv_set(vcpuinfo, "@cpu_time", Qnil);
             rb_iv_set(vcpuinfo, "@cpu", Qnil);
@@ -1948,12 +1949,8 @@ static struct ruby_libvirt_typed_param domain_scheduler_allowed[] = {
     {VIR_DOMAIN_SCHEDULER_CPU_SHARES, VIR_TYPED_PARAM_ULLONG},
     {VIR_DOMAIN_SCHEDULER_VCPU_PERIOD, VIR_TYPED_PARAM_ULLONG},
     {VIR_DOMAIN_SCHEDULER_VCPU_QUOTA, VIR_TYPED_PARAM_LLONG},
-#if HAVE_CONST_VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD
     {VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD, VIR_TYPED_PARAM_ULLONG},
-#endif
-#if HAVE_CONST_VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA
     {VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA, VIR_TYPED_PARAM_LLONG},
-#endif
     {VIR_DOMAIN_SCHEDULER_WEIGHT, VIR_TYPED_PARAM_UINT},
     {VIR_DOMAIN_SCHEDULER_CAP, VIR_TYPED_PARAM_UINT},
     {VIR_DOMAIN_SCHEDULER_RESERVATION, VIR_TYPED_PARAM_LLONG},
@@ -3262,9 +3259,7 @@ static struct ruby_libvirt_typed_param iotune_allowed[] = {
     {VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC, VIR_TYPED_PARAM_ULLONG},
     {VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC, VIR_TYPED_PARAM_ULLONG},
     {VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC, VIR_TYPED_PARAM_ULLONG},
-#if HAVE_CONST_VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC
     {VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC, VIR_TYPED_PARAM_ULLONG},
-#endif
 };
 
 /*
@@ -3775,6 +3770,10 @@ static VALUE libvirt_domain_qemu_agent_command(int argc, VALUE *argv, VALUE d)
 
     rb_scan_args(argc, argv, "12", &command, &timeout, &flags);
 
+    if (NIL_P(timeout)) {
+        timeout = INT2NUM(VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT);
+    }
+
     ret = virDomainQemuAgentCommand(ruby_libvirt_domain_get(d),
                                     StringValueCStr(command),
                                     ruby_libvirt_value_to_int(timeout),
@@ -3866,16 +3865,14 @@ static struct ruby_libvirt_typed_param migrate3_allowed[] = {
     {VIR_MIGRATE_PARAM_DEST_XML, VIR_TYPED_PARAM_STRING},
     {VIR_MIGRATE_PARAM_BANDWIDTH, VIR_TYPED_PARAM_ULLONG},
     {VIR_MIGRATE_PARAM_GRAPHICS_URI, VIR_TYPED_PARAM_STRING},
-#if HAVE_CONST_VIR_MIGRATE_PARAM_LISTEN_ADDRESS
     {VIR_MIGRATE_PARAM_LISTEN_ADDRESS, VIR_TYPED_PARAM_STRING},
-#endif
 };
 
 /*
  * call-seq:
  *   dom.migrate3(dconn, Hash=nil, flags=0) -> Libvirt::Domain
  *
- * Call virDomainMigrate3[http://www.libvirt.org/html/libvirt-libvirt-domain.html#virDomainMigrate2]
+ * Call virDomainMigrate3[http://www.libvirt.org/html/libvirt-libvirt-domain.html#virDomainMigrate3]
  * to migrate a domain from the host on this connection to the connection
  * referenced in dconn.
  */

data/ext/libvirt/extconf.h

@@ -381,6 +381,7 @@
 #define HAVE_VIRDOMAINQEMUMONITORCOMMAND 1
 #define HAVE_VIRDOMAINQEMUATTACH 1
 #define HAVE_VIRDOMAINQEMUAGENTCOMMAND 1
+#define HAVE_CONST_VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN 1
 #define HAVE_CONST_VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK 1
 #define HAVE_CONST_VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT 1
 #define HAVE_CONST_VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT 1

data/ext/libvirt/extconf.rb

@@ -4,38 +4,6 @@ RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
 RbConfig::MAKEFILE_CONFIG['CCDLFLAGS'] = ENV['CFLAGS'] if ENV['CFLAGS']
 RbConfig::MAKEFILE_CONFIG['EXTDLDFLAGS'] = ENV['CFLAGS'] if ENV['CFLAGS']
 
-# older mkmf does not have checking_message, so implement our own here
-def libvirt_checking_message(target, place = nil, opt = nil)
-  [["in", place], ["with", opt]].inject("#{target}") do |msg, (pre, noun)|
-    if noun
-      [[:to_str], [:join, ","], [:to_s]].each do |meth, *args|
-        if noun.respond_to?(meth)
-          break noun = noun.send(meth, *args)
-        end
-      end
-      msg << " #{pre} #{noun}" unless noun.empty?
-    end
-    msg
-  end
-end
-
-def have_const(const, headers = nil, opt = "", &b)
-  checking_for libvirt_checking_message(const, headers, opt) do
-    headers = cpp_include(headers)
-    if try_compile(<<"SRC", opt, &b)
-#{COMMON_HEADERS}
-#{headers}
-/*top*/
-static int t = #{const};
-SRC
-      $defs.push(format("-DHAVE_CONST_%s", const.strip.upcase.tr_s("^A-Z0-9_", "_")))
-      true
-    else
-      false
-    end
-  end
-end
-
 extension_name = '_libvirt'
 
 # this is a poor-man's dir_config, but is a bit more flexible.  In particular,
@@ -58,22 +26,23 @@ extension_name = '_libvirt'
 include = with_config("libvirt-include")
 lib = with_config("libvirt-lib")
 if include and lib
+  print "Looking for libvirt in " + include + " and " + lib + "\n"
   $LIBPATH = [lib] | $LIBPATH
   $CPPFLAGS += " -I" + include
-  have_library("virt", "virConnectOpen", "libvirt/libvirt.h")
-
-  # if we are using custom libvirt libraries, we have to suppress the default
-  # library path so have_func() only picks up the custom ones, not the installed
-  # ones
-  $DEFLIBPATH = []
 elsif (include and not lib) or (not include and lib)
   raise "Must specify both --with-libvirt-include and --with-libvirt-lib, or neither"
 else
+  print "Looking for libvirt using pkg-config\n"
   unless pkg_config("libvirt")
     raise "libvirt library not found in default locations"
   end
 end
 
+# Quick sanity check: if we can't find the virConnectOpen() function,
+# there's no way anything will work and we might as well give up now
+unless have_library("virt", "virConnectOpen", "libvirt/libvirt.h")
+  raise "No working libvirt installation found"
+end
 
 libvirt_types = [ 'virNetworkPtr',
                   'virStoragePoolPtr',
@@ -409,11 +378,7 @@ libvirt_consts = [ 'VIR_MIGRATE_LIVE',
                    'VIR_DOMAIN_BLOCK_JOB_FAILED',
                    'VIR_DOMAIN_BLOCK_JOB_CANCELED',
                    'VIR_DOMAIN_BLOCK_JOB_READY',
-                   'VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES',
                    'VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC',
-                   'VIR_MIGRATE_PARAM_LISTEN_ADDRESS',
-                   'VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD',
-                   'VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA',
                    'VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT',
                    'VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE',
                    'VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC',
@@ -430,14 +395,12 @@ libvirt_consts = [ 'VIR_MIGRATE_LIVE',
                    'VIR_DOMAIN_BLOCK_COMMIT_ACTIVE',
                    'VIR_DOMAIN_BLOCK_COMMIT_RELATIVE',
                    'VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES',
-                   'VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC',
                    'VIR_STORAGE_POOL_CREATE_NORMAL',
                    'VIR_STORAGE_POOL_CREATE_WITH_BUILD',
                    'VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE',
                    'VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE',
                    'VIR_STORAGE_VOL_CREATE_REFLINK',
                    'VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS',
-                   'VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN',
                    'VIR_DOMAIN_DEFINE_VALIDATE',
                    'VIR_DOMAIN_PASSWORD_ENCRYPTED',
                    'VIR_DOMAIN_TIME_SYNC',
@@ -480,6 +443,7 @@ virterror_consts = [
                    ]
 
 libvirt_qemu_consts = [
+                       'VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN',
                        'VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK',
                        'VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT',
                        'VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT',
@@ -492,13 +456,13 @@ libvirt_funcs.each { |f| have_func(f, "libvirt/libvirt.h") }
 libvirt_consts.each { |c| have_const(c, ["libvirt/libvirt.h"]) }
 virterror_consts.each { |c| have_const(c, ["libvirt/virterror.h"]) }
 if find_header("libvirt/libvirt-qemu.h")
-  have_library("virt-qemu", "virDomainQemuMonitorCommand")
+  have_library("virt-qemu", "virDomainQemuMonitorCommand", "libvirt/libvirt-qemu.h")
   libvirt_qemu_funcs.each { |f| have_func(f, "libvirt/libvirt-qemu.h") }
   libvirt_qemu_consts.each { |c| have_const(c, ["libvirt/libvirt-qemu.h"]) }
 end
 
 if find_header("libvirt/libvirt-lxc.h")
-  have_library("virt-lxc", "virDomainLxcOpenNamespace")
+  have_library("virt-lxc", "virDomainLxcOpenNamespace", "libvirt/libvirt-lxc.h")
   libvirt_lxc_funcs.each{ |f| have_func(f, "libvirt/libvirt-lxc.h") }
 end
 

data/tests/test_domain.rb

@@ -606,6 +606,7 @@ sleep 1
 expect_too_many_args(newdom, "name", 1)
 
 expect_success(newdom, "no args", "name") {|x| x == "rb-libvirt-test"}
+expect_success(newdom, "is UTF-8", "name") {|x| x.encoding.name == "UTF-8"}
 
 newdom.destroy
 
@@ -909,6 +910,7 @@ expect_too_many_args(newdom, "lookup_snapshot_by_name", 1, 2, 3)
 expect_too_few_args(newdom, "lookup_snapshot_by_name")
 expect_invalid_arg_type(newdom, "lookup_snapshot_by_name", 1)
 expect_invalid_arg_type(newdom, "lookup_snapshot_by_name", 'foo', 'bar')
+expect_utf8_exception_msg(newdom, Libvirt::RetrieveError, "lookup_snapshot_by_name", "__non_existing_snapshot")
 
 expect_success(newdom, "name arg", "lookup_snapshot_by_name", "foo")
 

data/tests/test_utils.rb

@@ -166,6 +166,24 @@ def expect_fail(object, errtype, errmsg, func, *args)
   end
 end
 
+def expect_utf8_exception_msg(object, errtype, func, *args)
+  begin
+    object.__send__(func, *args)
+  rescue NoMethodError
+    puts_skipped "#{$test_object}.#{func} does not exist"
+  rescue errtype => e
+    if e.message.encoding.name == 'UTF-8'
+      puts_ok "#{$test_object}.#{func} threw #{errtype.to_s} with UTF-8 encoding"
+    else
+      puts_fail "#{$test_object}.#{func} threw #{errtype.to_s} with #{e.message.encoding.name} encoding"
+    end
+  rescue => e
+    puts_fail "#{$test_object}.#{func} expected to throw #{errtype.to_s}, but instead threw #{e.class.to_s}: #{e.to_s}"
+  else
+    puts_fail "#{$test_object}.#{func} expected to throw #{errtype.to_s}, but threw nothing"
+  end
+end
+
 def expect_too_many_args(object, func, *args)
   expect_fail(object, ArgumentError, "too many args", func, *args)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - David Lutterkort, Chris Lalancette
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for libvirt.
 email: libvir-list@redhat.com
@@ -59,9 +59,9 @@ files:
 - tests/test_utils.rb
 homepage: http://libvirt.org/ruby/
 licenses:
-- LGPLv2
+- LGPL-2.1-or-later
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: None
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby bindings for LIBVIRT
 test_files: []