opennebula 7.2.0 → 7.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba213cbf9c61bf639e606a86a5496dc10523a36845bab21e78dc69e096e4a6a
-  data.tar.gz: 6c56a7baf3e61745b7ab9d2959dc0cc21d04aa717e69153e21e4c4b07a57c0f9
+  metadata.gz: ec857d82d9122d895b79906537bc2bdd190c4a8b5ce0af34293fb944b7e222e4
+  data.tar.gz: 07f7b9481eb44a0d18d65d81381c65024492d22cba724378f8f598ce97ee5bdc
 SHA512:
-  metadata.gz: 6946c2f94864b1101171a7a60d67afe95956777b031f87699601fc3165a410949e1e9b3470c21bb04375ce151a773561731e8275b53fae73174ef6b5365f1e63
-  data.tar.gz: ab5eda8064f4133f6e3751a10923a21f3000903e63bce981d652cd54fd9c15d9a3d8fbefa15a98eb0235008d27898199ee973ecef541c10b1d80b571d036b14f
+  metadata.gz: 4b23c2de26bd07cb1d8949921ee385cf4746b248028197bbf0e14f3c23f96f6d577e2d76c3db4cf52190ba1542c4b1da606a5b641f76df9d47e5d0fd7cea52df
+  data.tar.gz: 7eb669f3a42846376ed7e8423923e86e32767774be0bf854d5797cde069ae8dc5544a5c4a9ce0c9ca2a2cf0664841bd8ce22f38c00658aa13d963d3f18cc99a3

data/lib/cloud/CloudClient.rb

@@ -51,7 +51,7 @@ end
 module CloudClient
 
     # OpenNebula version
-    VERSION = '7.2.0'
+    VERSION = '7.2.1'
 
     # #########################################################################
     # Default location for the authentication file

data/lib/opennebula/error.rb

@@ -63,7 +63,7 @@ module OpenNebula
     # Returns true if the object returned by a method of the OpenNebula
     # library is an Error
     def self.is_error?(value)
-        value.class==OpenNebula::Error
+        value.is_a?(OpenNebula::Error)
     end
 
 end

data/lib/opennebula/lib/client.rb

@@ -0,0 +1,138 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2026, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/ClassVars
+# rubocop:disable Style/EnvHome
+# rubocop:disable Naming/AccessorMethodName
+module OpenNebula
+
+    DEFAULT_POOL_PAGE_SIZE = 200
+    size = ENV['ONE_POOL_PAGE_SIZE']
+
+    @@pool_page_size =
+        if size&.strip&.match?(/^\d+$/) && size.to_i >= 2
+            size.to_i
+        else
+            DEFAULT_POOL_PAGE_SIZE
+        end
+
+    def self.pool_page_size
+        @@pool_page_size
+    end
+
+    class Client
+
+        NO_ONE_AUTH_ERROR = 'ONE_AUTH file not present'
+        GRPC_NOT_SUPPORTED = 'gRPC API not supported'
+
+        attr_reader :client, :one_auth, :one_endpoint, :one_zmq
+
+        # Initialize an OpenNebula client
+        #
+        # @param [String, nil] secret user credentials ("user:password") or
+        #   nil to get the credentials from user auth file
+        # @param [String, nil] endpoint OpenNebula server endpoint
+        #   or nil to get it form the environment or use the default endpoint
+        # @param [Hash] options specific XML client options (see XMLClient
+        #   and GRPCClient for details)
+        #
+        # @return [OpenNebula::XMLClient || OpenNebula::GRPCClient]
+        def initialize(secret = nil, endpoint = nil, options = {})
+            if options[:subscriber_endpoint]
+                @one_zmq = options[:subscriber_endpoint]
+            elsif ENV['ONE_ZMQ']
+                @one_zmq = ENV['ONE_ZMQ']
+            else
+                @one_zmq = 'tcp://localhost:2101'
+            end
+
+            auth_file     = File.join(ENV['HOME'], '/.one/one_auth')
+            one_auth_file = '/var/lib/one/.one/one_auth'
+
+            @one_auth =
+                if secret
+                    secret
+                elsif ENV['ONE_AUTH'] && File.file?(ENV['ONE_AUTH'])
+                    File.read(ENV['ONE_AUTH'])
+                elsif File.file?(auth_file)
+                    File.read(auth_file)
+                elsif File.file?(one_auth_file)
+                    File.read(one_auth_file)
+                else
+                    raise NO_ONE_AUTH_ERROR
+                end
+
+            @one_auth = @one_auth.rstrip
+
+            is_grpc = ENV['ONEAPI_PROTOCOL'] == 'grpc' || options.key?(:grpc)
+
+            # Override protocol from endpoint name, if endpoint is defined
+            is_grpc = !endpoint.include?('RPC2') if !endpoint.nil? && !endpoint.empty?
+
+            if is_grpc
+                begin
+                    require_relative 'grpc_client'
+                rescue LoadError
+                    raise GRPC_NOT_SUPPORTED
+                end
+                @one_endpoint = mk_endpoint(endpoint,
+                                            'ONE_GRPC',
+                                            'localhost:2634').rstrip
+
+                @client = GRPCClient.new(@one_auth, @one_endpoint, options)
+            else
+                require_relative 'xml_client'
+                @one_endpoint = mk_endpoint(endpoint,
+                                            'ONE_XMLRPC',
+                                            'http://localhost:2633/RPC2').rstrip
+
+                @client = XMLClient.new(@one_auth, @one_endpoint, options)
+            end
+        end
+
+        def call(action, *args)
+            @client.call(action, *args)
+        end
+
+        def get_version
+            call('system.version')
+        end
+
+        def mk_endpoint(endpoint, env_var, default)
+            ep_file      = File.join(ENV['HOME'], '/.one/one_endpoint')
+            one_ep_file  = '/var/lib/one/.one/one_endpoint'
+
+            if endpoint
+                endpoint
+            elsif ENV[env_var]
+                ENV[env_var]
+            elsif File.exist?(ep_file)
+                File.read(ep_file)
+            elsif File.exist?(one_ep_file)
+                File.read(one_ep_file)
+            else
+                default
+            end
+        end
+
+    end
+
+end
+# rubocop:enable Style/Documentation
+# rubocop:enable Style/ClassVars
+# rubocop:enable Style/EnvHome
+# rubocop:enable Naming/AccessorMethodName

data/lib/opennebula/lib/grpc_client.rb

@@ -0,0 +1,105 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2026, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'grpc'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'grpc')
+
+require 'lib/grpc_map_loader'
+
+# rubocop:disable Style/Documentation
+module OpenNebula
+
+    class GRPCClient
+
+        # gRPC mappings from OpenNebula actions to gRPC actions
+        GRPC_MAP = GRPCMappings::MapLoader.load
+
+        # Creates a new gRPC client object that will be used to call OpenNebula
+        # functions.
+        #
+        # @param [String] secret user credentials ("user:password") or
+        #   nil to get the credentials from user auth file
+        # @param [String] endpoint OpenNebula gRPC server endpoint
+        #   (http://host:2634) or nil to get it from the environment
+        #   variable ONE_GRPC or use the default endpoint
+        #
+        # @return [OpenNebula::GRPCClient]
+        def initialize(secret, endpoint, options = {})
+            @one_auth     = secret
+            @one_endpoint = endpoint
+            @timeout      = options[:timeout] || ENV['ONE_GRPC_TIMEOUT']&.to_i
+        end
+
+        def call(action, *args)
+            handler = GRPC_MAP[action]
+            raise Error.new("Method 'one.#{action}' not defined", Error::EGRPC_CALL) unless handler
+
+            options = {}
+            options[:deadline] = Time.now.to_i + @timeout if @timeout
+
+            response = handler.call(@one_auth, @one_endpoint, *args, options)
+
+            if response.respond_to?(:oid)
+                response.oid
+            elsif response.respond_to?(:xml)
+                response.xml
+            else
+                Error.new("Unexpected response: #{response.inspect}", Error::EGRPC_CALL)
+            end
+        rescue GRPC::DeadlineExceeded
+            Error.new("Timeout exceeded for gRPC call '#{action}'", Error::ETIMEOUT)
+        rescue GRPC::Unavailable => e
+            Error.new("#{action}: #{clean_error_message(e.message)}", Error::EGRPC_CALL)
+        rescue GRPC::BadStatus => e
+            Error.new(clean_error_message(e.message), grpc_code_to_one(e.code))
+        rescue StandardError => e
+            Error.new("#{action}: #{e.message}", Error::EGRPC_CALL)
+        end
+
+        private
+
+        def clean_error_message(msg)
+            cleaned = msg.sub(/\A\d+:/, '').strip
+            cleaned.sub(/debug_error_string:.*$/, '').strip
+        end
+
+        # Maps gRPC status codes to OpenNebula error codes
+        def grpc_code_to_one(grpc_code)
+            case grpc_code
+            when GRPC::Core::StatusCodes::UNAUTHENTICATED
+                Error::EAUTHENTICATION
+            when GRPC::Core::StatusCodes::PERMISSION_DENIED
+                Error::EAUTHORIZATION
+            when GRPC::Core::StatusCodes::NOT_FOUND
+                Error::ENO_EXISTS
+            when GRPC::Core::StatusCodes::INVALID_ARGUMENT
+                Error::ERPC_API
+            when GRPC::Core::StatusCodes::INTERNAL
+                Error::EINTERNAL
+            when GRPC::Core::StatusCodes::ALREADY_EXISTS
+                Error::EALLOCATE
+            when GRPC::Core::StatusCodes::UNIMPLEMENTED
+                Error::ENOTDEFINED
+            else
+                Error::EGRPC_CALL
+            end
+        end
+
+    end
+
+end
+# rubocop:enable Style/Documentation

data/lib/opennebula/lib/xml_client.rb

@@ -0,0 +1,178 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2026, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'xmlrpc/client'
+require 'bigdecimal'
+require 'stringio'
+require 'openssl'
+require 'opennebula/xml_utils'
+
+# rubocop:disable Style/Documentation
+# rubocop:disable Lint/MissingSuper
+module OpenNebula
+
+    if OpenNebula::OX
+
+        class OxStreamParser < XMLRPC::XMLParser::AbstractStreamParser
+
+            def initialize
+                @parser_class = OxParser
+            end
+
+            class OxParser < Ox::Sax
+
+                include XMLRPC::XMLParser::StreamParserMixin
+
+                alias text character
+                alias end_element endElement
+                alias start_element startElement
+
+                def parse(str)
+                    Ox.sax_parse(self,
+                                 StringIO.new(str),
+                                 :symbolize => false,
+                                 :convert_special => true,
+                                 :skip => :skip_none)
+                end
+
+            end
+
+        end
+    elsif OpenNebula::NOKOGIRI
+        class NokogiriStreamParser < XMLRPC::XMLParser::AbstractStreamParser
+
+            def initialize
+                @parser_class = NokogiriParser
+            end
+
+            class NokogiriParser < Nokogiri::XML::SAX::Document
+
+                include XMLRPC::XMLParser::StreamParserMixin
+
+                alias cdata_block character
+                alias characters character
+                alias end_element endElement
+                alias start_element startElement
+
+                def parse(str)
+                    parser = Nokogiri::XML::SAX::Parser.new(self)
+                    parser.parse(str)
+                end
+
+            end
+
+        end
+    end
+
+    # The openNebula XMLRPC client class, represents the connection with the core
+    # and handles the xml-rpc calls.
+    class XMLClient
+
+        begin
+            require 'xmlparser'
+            XMLPARSER=true
+        rescue LoadError
+            XMLPARSER=false
+        end
+
+        # Creates a new XMLRPC client object that will be used to call OpenNebula
+        # functions.
+        #
+        # @param [String, nil] secret user credentials ("user:password") or
+        #   nil to get the credentials from user auth file
+        # @param [String, nil] endpoint OpenNebula server endpoint
+        #   (http://host:2633/RPC2) or nil to get it from the environment
+        #   variable ONE_XMLRPC or use the default endpoint
+        # @param [Hash] options
+        # @option params [Integer] :timeout connection timeout in seconds,
+        #   defaults to 30
+        # @option params [String] :http_proxy HTTP proxy string used for
+        #  connecting to the endpoint; defaults to no proxy
+        # @option params [Boolean] :sync Use only one http connection for
+        #  all calls. It should not be used for multithreaded programs.
+        #  It's the only mode that can be used with :cert_dir and
+        #  :disable_ssl_verify
+        # @option params [String] :cert_dir Extra directory where to import
+        #  trusted issuer certificates. Use with :sync = true
+        # @option params [String] :disable_ssl_verify Disable SSL certificate
+        #  verification. Use only for testing and with :sync = true
+        #
+        # @return [OpenNebula::XMLClient]
+        def initialize(secret, endpoint, options = {})
+            @one_auth = secret
+            @one_endpoint = endpoint
+
+            @async = !options[:sync]
+
+            http_proxy = options[:http_proxy]
+            timeout    = options[:timeout] || ENV['ONE_XMLRPC_TIMEOUT']&.to_i
+
+            @server    = XMLRPC::Client.new2(@one_endpoint, http_proxy, timeout)
+            @server.http_header_extra = { 'accept-encoding' => 'identity' }
+
+            http = @server.instance_variable_get('@http')
+
+            if options[:cert_dir] || ENV['ONE_CERT_DIR']
+                raise "SSL options don't work in async mode" if @async
+
+                cert_dir = options[:cert_dir] || ENV['ONE_CERT_DIR']
+                cert_files = Dir["#{cert_dir}/*"]
+
+                cert_store = OpenSSL::X509::Store.new
+                cert_store.set_default_paths
+                cert_files.each {|cert| cert_store.add_file(cert) }
+
+                http.cert_store = cert_store
+            end
+
+            if options[:disable_ssl_verify] || ENV['ONE_DISABLE_SSL_VERIFY']
+                raise "SSL options don't work in async mode" if @async
+
+                http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
+
+            if defined?(OxStreamParser)
+                @server.set_parser(OxStreamParser.new)
+            elsif OpenNebula::NOKOGIRI
+                @server.set_parser(NokogiriStreamParser.new)
+            elsif XMLPARSER
+                @server.set_parser(XMLRPC::XMLParser::XMLStreamParser.new)
+            end
+        end
+
+        def call(action, *args)
+            begin
+                if @async
+                    response = @server.call_async("one.#{action}", @one_auth, *args)
+                else
+                    response = @server.call("one.#{action}", @one_auth, *args)
+                end
+
+                if response[0] == false
+                    Error.new(response[1], response[2])
+                else
+                    response[1] # response[1..-1]
+                end
+            rescue StandardError => e
+                Error.new(e.message, Error::EXML_RPC_CALL)
+            end
+        end
+
+    end
+
+end
+# rubocop:enable Style/Documentation
+# rubocop:enable Lint/MissingSuper

data/lib/opennebula/version.rb

@@ -17,6 +17,6 @@
 module OpenNebula
 
     # OpenNebula version
-    VERSION = '7.2.0'
+    VERSION = '7.2.1'
 
 end

data/lib/opennebula/virtual_machine_pool.rb

@@ -348,7 +348,6 @@ module OpenNebula
         #
         # @return [String] the xml representing the accounting data
         def accounting_xml(filter_flag=INFO_ALL, options={})
-            acct_hash = Hash.new
             xml_str = "<HISTORY_RECORDS>\n"
 
             rc = build_accounting(filter_flag, options) do |history|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opennebula
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.2.1
 platform: ruby
 authors:
 - OpenNebula
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-30 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -185,6 +185,9 @@ files:
 - lib/opennebula/image_pool.rb
 - lib/opennebula/ldap_auth.rb
 - lib/opennebula/ldap_auth_spec.rb
+- lib/opennebula/lib/client.rb
+- lib/opennebula/lib/grpc_client.rb
+- lib/opennebula/lib/xml_client.rb
 - lib/opennebula/lockable_ext.rb
 - lib/opennebula/marketplace.rb
 - lib/opennebula/marketplace_pool.rb