ovirt-engine-sdk 4.1.8 → 4.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d87b36d7e0dc5dab224115c5a5109b052ab6cc2c
-  data.tar.gz: 163217911308f7c56022498e6eeb07e6d6d6f0c4
+  metadata.gz: 818f63a1a783df790fbf5fc8f254ded435a90ac8
+  data.tar.gz: 2a51cba1a01c8a8c62647ee2c256f3a1684684a4
 SHA512:
-  metadata.gz: 85c29a2a9c062fcbb605de0af9829735ea350f36a13ccde2dd0ce26d2733cb76a77c8a56040078c29bab6c7b2565b3a643a2d424dcc689a91f3e5e0728c468c1
-  data.tar.gz: 60c16dabedce63e73662269d961b7bf7a14d62c6b92670153378b10a654a954cbf36298d77d795862351c65aa8650e7d3bda097ab2ee38bf6d3f28ce4cd43058
+  metadata.gz: 9445021acbd41f225e882fe6ef4fc537bd97972ef9c978f0b4ed50c4b91ac53cb6f4ec5b116a7abef4f183b4764a94737fc730453278b094ff86aa7c72fbf5cd
+  data.tar.gz: 43097db69c7d043a11e147a55739e40a37455e4c2738714f451ca4b8f752a375f26be5575042643747fcd848f2639a4e6aa2c96ef4368175667e8d18bec15839

data/CHANGES.adoc

@@ -2,6 +2,27 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.1.9 / Oct 13 2017
+
+Update to model 4.1.39:
+
+* Add a `refresh` parameter to `FilesService.list`.
+    
+* Add support for Link Layer Discovery Protocol (LLDP).
+    
+* Add support for listing cluster level features, and enabling/disabing
+  them for clusters.
+
+New features:
+
+* Improve log messages so that in addition to the response codes they
+  also contain the request method and URL.
+
+Bug fixes:
+
+* Add support for multiple threads
+  https://bugzilla.redhat.com/1496846[#1496846].
+
 == 4.1.8 / Jul 17 2017
 
 Update to model 4.1.37:

data/README.adoc

@@ -106,7 +106,7 @@ locators_ and _service methods_ (described later) may change in the
 future.
 
 There are other classes, like HTTP client classes, readers and writers.
-These are used to implement the HTTP communication, and to for XML
+These are used to implement the HTTP communication, and for XML
 parsing and rendering. Refrain from using them, as they are internal
 implementation details that may change in the future: backwards
 compatibility isn't guaranteed.
@@ -127,6 +127,9 @@ connection = OvirtSDK4::Connection.new(
   password: '...',
   ca_file: 'ca.pem',
 )
+
+# Get the reference to the root of the tree of services:
+system_service = connection.system_service
 ----
 
 The connection holds expensive resources, including a pool of HTTP
@@ -139,7 +142,8 @@ important to free these resources when they are no longer in use:
 connection.close
 ----
 
-Once a connection is closed it can't be reused.
+The connection and all the services that have been obtained from it
+can't be used after the connection has been closed.
 
 The `ca.pem` file is required when connecting to a server protected
 with TLS. In an usual oVirt installation it will be in
@@ -156,9 +160,9 @@ The type classes are pure data containers, they don't have any logic or
 operations. Instances can be created and modified at will.
 
 Creating or modifying one of this instances does *not* have any effect
-in the server side, unless one they are explicitly passed to a call to
-one of the service methods described below. Changes in the server side
-are *not* automatically reflected in the instances that already exist in
+in the server side, unless they are explicitly passed to a call to one
+of the service methods described below. Changes in the server side are
+*not* automatically reflected in the instances that already exist in
 memory.
 
 The constructors of these classes have multiple optional arguments, one
@@ -181,6 +185,28 @@ vm = OvirtSDK4::Vm.new(
 )
 ----
 
+The hashes passed to these constructors are processed recursively. For
+example, in the above code instead of explicitly calling the constructor
+for the `Cluster` and `Template` classes it is also possible to use
+plain hashes:
+
+[source,ruby]
+----
+vm = OvirtSDK4::Vm.new(
+  name: 'myvm',
+  cluster: {
+    name: 'mycluster'
+  },
+  template: {
+    name: 'mytemplate'
+  },
+  memory: 1073741824
+)
+----
+
+The SDK will internally convert those hashes to the required classes, so
+the result will be exactly the same.
+
 Using the constructors in this way is recommended, but not mandatory.
 You can also create the instance with no arguments in the call to the
 constructor, and then populate the object step by step, using the
@@ -192,7 +218,7 @@ vm = OvirtSDK4::Vm.new
 vm.name = 'myvm'
 vm.cluster = OvirtSDK4::Cluster.new(name: 'mycluster')
 vm.template = OvirtSDK4::Template.new(name: 'mytemplate')
-vm.memory=1073741824
+vm.memory = 1073741824
 ----
 
 Attributes that are defined as lists of objects in the specification of
@@ -299,7 +325,7 @@ manages the collection of virtual machines of the system lives in
 
 In the SDK the root of that tree of services is implemented by the
 _system service_. It is obtained calling the
-{rererence}/Connection#system_service-instance_method[system_service]
+{reference}/Connection#system_service-instance_method[system_service]
 method of the connection:
 
 [source,ruby]
@@ -352,7 +378,8 @@ The services that manage a single object usually have the `get`,
 
 Both kinds of services can also have additional _action methods_, which
 perform actions other than retrieving, creating, updating or removing.
-Most frequently they available in services that manage a single object.
+Most frequently they are available in services that manage a single
+object.
 
 ==== Using the _get_ methods
 
@@ -427,7 +454,7 @@ vms_service = system_service.vms_service
 vms = vms_service.list
 ----
 
-The result will be a Ruby array containing the instances of
+The result will be a Ruby array containing the instances of the
 corresponding types. For example, in this case, the result will be a
 list of instances of the Ruby class {reference}/Vm[Vm].
 
@@ -456,8 +483,8 @@ of the failure.
 
 ==== Using the _add_ methods
 
-These service methods add new elements to the collection. They receive
-an instance of the relevant type describing the object to add, send the
+These service methods add new elements to collections. They receive an
+instance of the relevant type describing the object to add, send the
 request to add it, and return an instance of the type describing the
 added object.
 
@@ -469,12 +496,12 @@ For example, to add a new virtual machine named `myvm`:
 vm = vms_service.add(
   OvirtSDK4::Vm.new(
     name: 'myvm',
-    cluster: OvirtSDK4::Cluster.new(
+    cluster: {
       name: 'mycluster'
-    ),
-    template: OvirtSDK4::Template.new(
+    },
+    template: {
       name: 'mytemplate'
-    )
+    }
   )
 )
 ----
@@ -539,10 +566,10 @@ updated.
 
 ==== Using the _update_ methods
 
-These service methods update existing objects. They receive
-an instance of the relevant type describing the update to perform, send
-the request to update it, and return an instance of the type describing
-the updated object.
+These service methods update existing objects. They receive an instance
+of the relevant type describing the update to perform, send the request
+to update it, and return an instance of the type describing the updated
+object.
 
 For example, to update the name of a virtual machine from `myvm` to
 `newvm`:
@@ -569,7 +596,7 @@ update. For example, try to *avoid* this:
 [source,ruby]
 ----
 # Retrieve the current representation:
-vm = vm_service.get()
+vm = vm_service.get
 
 # Update the representation, in memory, no request sent
 # to the server:

data/ext/ovirtsdk4c/ov_http_client.c

@@ -587,6 +587,7 @@ static void* ov_http_client_complete_task(void* data) {
     VALUE transfer;
     long code;
     ov_http_client_object* client_ptr;
+    ov_http_request_object* request_ptr;
     ov_http_response_object* response_ptr;
     ov_http_transfer_object* transfer_ptr;
 
@@ -600,6 +601,7 @@ static void* ov_http_client_complete_task(void* data) {
     /* Get the pointers to the transfer, client and response: */
     ov_http_transfer_ptr(transfer, transfer_ptr);
     ov_http_client_ptr(transfer_ptr->client, client_ptr);
+    ov_http_request_ptr(transfer_ptr->request, request_ptr);
     ov_http_response_ptr(transfer_ptr->response, response_ptr);
 
     /* Remove the transfer from the pending hash: */
@@ -617,8 +619,10 @@ static void* ov_http_client_complete_task(void* data) {
         /* Send a summary of the response to the log: */
         ov_http_client_log_info(
             client_ptr->log,
-            "Received response code '%"PRIsVALUE"'.",
-            response_ptr->code
+            "Received response code %"PRIsVALUE" for %"PRIsVALUE" request to URL '%"PRIsVALUE"'.",
+            response_ptr->code,
+            request_ptr->method,
+            request_ptr->url
         );
     }
     else {
@@ -806,7 +810,7 @@ static void ov_http_client_prepare_handle(ov_http_client_object* client_ptr, ov_
     /* Send a summary of the request to the log: */
     ov_http_client_log_info(
         client_ptr->log,
-        "Sending '%"PRIsVALUE"' request to URL '%"PRIsVALUE"'.",
+        "Sending %"PRIsVALUE" request to URL '%"PRIsVALUE"'.",
         request_ptr->method,
         url
     );

data/lib/ovirtsdk4/connection.rb

@@ -16,6 +16,7 @@
 
 require 'json'
 require 'tempfile'
+require 'thread'
 require 'uri'
 
 module OvirtSDK4
@@ -145,6 +146,9 @@ module OvirtSDK4
         @ca_store.close
       end
 
+      # Create the mutex that will be used to prevents simultaneous access to the same HTTP client by multiple threads:
+      @mutex = Mutex.new
+
       # Create the HTTP client:
       @client = HttpClient.new(
         insecure: @insecure,
@@ -184,65 +188,24 @@ module OvirtSDK4
     end
 
     #
-    # Sends an HTTP request.
+    # Sends an HTTP request, making sure that multiple threads are coordinated correctly.
     #
     # @param request [HttpRequest] The request object containing the details of the HTTP request to send.
     #
     # @api private
     #
     def send(request)
-      # Add the base URL to the request:
-      request.url = request.url.nil? ? request.url = @url : "#{@url}#{request.url}"
-
-      # Set the headers common to all requests:
-      request.headers.merge!(
-        'User-Agent'   => "RubySDK/#{VERSION}",
-        'Version'      => '4',
-        'Content-Type' => 'application/xml',
-        'Accept'       => 'application/xml'
-      )
-
-      # Older versions of the engine (before 4.1) required the 'all_content' as an HTTP header instead of a query
-      # parameter. In order to better support those older versions of the engine we need to check if this parameter is
-      # included in the request, and add the corresponding header.
-      unless request.query.nil?
-        all_content = request.query['all_content']
-        request.headers['All-Content'] = all_content unless all_content.nil?
-      end
-
-      # Add the global headers, but without replacing the values that may already exist:
-      request.headers.merge!(@headers) { |_name, local, _global| local } if @headers
-
-      # Set the authentication token:
-      @token ||= create_access_token
-      request.token = @token
-
-      # Send the request:
-      @client.send(request)
+      @mutex.synchronize { internal_send(request) }
     end
 
     #
-    # Waits for the response to the given request.
+    # Waits for the response to the given request, making sure that multiple threads are coordinated correctly.
     #
     # @param request [HttpRequest] The request object whose corresponding response you want to wait for.
-    # @return [Response] A request object containing the details of the HTTP response received.
+    # @return [HttpResponse] A request object containing the details of the HTTP response received.
     #
     def wait(request)
-      # Wait for the response:
-      response = @client.wait(request)
-      raise response if response.is_a?(Exception)
-
-      # If the request failed because of authentication, and it wasn't a request to the SSO service, then the
-      # most likely cause is an expired SSO token. In this case we need to request a new token, and try the original
-      # request again, but only once. It if fails again, we just return the failed response.
-      if response.code == 401 && request.token
-        @token = create_access_token
-        request.token = @token
-        @client.send(request)
-        response = @client.wait(request)
-      end
-
-      response
+      @mutex.synchronize { internal_wait(request) }
     end
 
     #
@@ -466,17 +429,10 @@ module OvirtSDK4
     end
 
     #
-    # Releases the resources used by this connection.
+    # Releases the resources used by this connection, making sure that multiple threads are coordinated correctly.
     #
     def close
-      # Revoke the SSO access token:
-      revoke_access_token if @token
-
-      # Close the HTTP client:
-      @client.close if @client
-
-      # Remove the temporary file that contains the trusted CA certificates:
-      @ca_store.unlink if @ca_store
+      @mutex.synchronize { internal_close }
     end
 
     #
@@ -596,5 +552,85 @@ module OvirtSDK4
       end
       raise_error(response, detail)
     end
+
+    #
+    # Sends an HTTP request.
+    #
+    # @param request [HttpRequest] The request object containing the details of the HTTP request to send.
+    #
+    # @api private
+    #
+    def internal_send(request)
+      # Add the base URL to the request:
+      request.url = request.url.nil? ? request.url = @url : "#{@url}/#{request.url}"
+
+      # Set the headers common to all requests:
+      request.headers.merge!(
+        'User-Agent'   => "RubySDK/#{VERSION}",
+        'Version'      => '4',
+        'Content-Type' => 'application/xml',
+        'Accept'       => 'application/xml'
+      )
+
+      # Older versions of the engine (before 4.1) required the 'all_content' as an HTTP header instead of a query
+      # parameter. In order to better support those older versions of the engine we need to check if this parameter is
+      # included in the request, and add the corresponding header.
+      unless request.query.nil?
+        all_content = request.query['all_content']
+        request.headers['All-Content'] = all_content unless all_content.nil?
+      end
+
+      # Add the global headers, but without replacing the values that may already exist:
+      request.headers.merge!(@headers) { |_name, local, _global| local } if @headers
+
+      # Set the authentication token:
+      @token ||= create_access_token
+      request.token = @token
+
+      # Send the request:
+      @client.send(request)
+    end
+
+    #
+    # Waits for the response to the given request.
+    #
+    # @param request [HttpRequest] The request object whose corresponding response you want to wait for.
+    # @return [Response] A request object containing the details of the HTTP response received.
+    #
+    # @api private
+    #
+    def internal_wait(request)
+      # Wait for the response:
+      response = @client.wait(request)
+      raise response if response.is_a?(Exception)
+
+      # If the request failed because of authentication, and it wasn't a request to the SSO service, then the
+      # most likely cause is an expired SSO token. In this case we need to request a new token, and try the original
+      # request again, but only once. It if fails again, we just return the failed response.
+      if response.code == 401 && request.token
+        @token = create_access_token
+        request.token = @token
+        @client.send(request)
+        response = @client.wait(request)
+      end
+
+      response
+    end
+
+    #
+    # Releases the resources used by this connection.
+    #
+    # @api private
+    #
+    def internal_close
+      # Revoke the SSO access token:
+      revoke_access_token if @token
+
+      # Close the HTTP client:
+      @client.close if @client
+
+      # Remove the temporary file that contains the trusted CA certificates:
+      @ca_store.unlink if @ca_store
+    end
   end
 end

data/lib/ovirtsdk4/reader.rb

@@ -92,7 +92,7 @@ module OvirtSDK4
       return nil if text.nil?
       begin
         return Integer(text, 10)
-      rescue
+      rescue ArgumentError
         raise Error, "The text '#{text}' isn't a valid integer value."
       end
     end
@@ -127,7 +127,7 @@ module OvirtSDK4
       return nil if text.nil?
       begin
         return Float(text)
-      rescue
+      rescue ArgumentError
         raise Error, "The text '#{text}' isn't a valid decimal value."
       end
     end
@@ -163,7 +163,7 @@ module OvirtSDK4
       return nil if text.nil?
       begin
         return DateTime.xmlschema(text)
-      rescue
+      rescue ArgumentError
         raise Error, "The text '#{text}' isn't a valid date."
       end
     end