opennebula 4.13.80.beta1 → 4.13.85.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c22ee052b29d751b16a22e9be737f1d4009a4ef
-  data.tar.gz: b882b0d31b1096e5287b47ec799f8f6b88fbcecd
+  metadata.gz: 34c2819d350be1117978fe3b3f78afec44b8e940
+  data.tar.gz: 4e38c2f9cd5727cdbedeed755432a3ac48d4db76
 SHA512:
-  metadata.gz: 2602b4e09ee0587d0eadd55f581209d3f5946f1bedc826a477fa2bf1b1238000df4801358ecf2042e4e769f7d9c21f01aa4da4799f81b6edca7417037ef9cecc
-  data.tar.gz: a89f6eabb2d2f196b2c82abf5cb7facc4a04ba7edb7b002fe1ed3bd47a90a88bf046e0386022782769d847625d81817eb25711920b764897a0868561bf2c4b47
+  metadata.gz: 51dc60b82690e463c9e751c4cbc61511cefcd314900cd49cb0c5009bcecf48de30e7c8053c59257064324d6a7e6023d0d25eaa6980f193203a789bbe6af38507
+  data.tar.gz: a1a8dda4f61c98046af6fec6bd66ab2f825962cde62cd19bfc9c7bab158179f74c8fede788f239da8f200f014cf34f79b44d31c1e4f5eba244912cece753dfd8

data/lib/cloud/CloudClient.rb

@@ -0,0 +1,211 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2015, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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 'rubygems'
+require 'uri'
+
+require 'digest/sha1'
+require 'net/https'
+
+require "rexml/document"
+
+begin
+    require 'rexml/formatters/pretty'
+    REXML_FORMATTERS=true
+rescue LoadError
+    REXML_FORMATTERS=false
+end
+
+begin
+    require 'curb'
+    CURL_LOADED=true
+rescue LoadError
+    CURL_LOADED=false
+end
+
+begin
+    require 'net/http/post/multipart'
+    MULTIPART_LOADED=true
+rescue LoadError
+    MULTIPART_LOADED=false
+end
+
+###############################################################################
+# The CloudClient module contains general functionality to implement a
+# Cloud Client
+###############################################################################
+module CloudClient
+
+    # OpenNebula version
+    VERSION = '4.13.85'
+
+    # #########################################################################
+    # Default location for the authentication file
+    # #########################################################################
+    DEFAULT_AUTH_FILE = ENV["HOME"]+"/.one/one_auth"
+
+    # #########################################################################
+    # Gets authorization credentials from ONE_AUTH or default
+    # auth file.
+    #
+    # Raises an error if authorization is not found
+    # #########################################################################
+    def self.get_one_auth
+        if ENV["ONE_AUTH"] and !ENV["ONE_AUTH"].empty? and
+            File.file?(ENV["ONE_AUTH"])
+            one_auth=File.read(ENV["ONE_AUTH"]).strip.split(':')
+        elsif File.file?(DEFAULT_AUTH_FILE)
+            one_auth=File.read(DEFAULT_AUTH_FILE).strip.split(':')
+        else
+            raise "No authorization data present"
+        end
+
+        raise "Authorization data malformed" if one_auth.length < 2
+
+        one_auth
+    end
+
+    # #########################################################################
+    # Starts an http connection and calls the block provided. SSL flag
+    # is set if needed.
+    # #########################################################################
+    def self.http_start(url, timeout, &block)
+        host = nil
+        port = nil
+
+        if ENV['http_proxy']
+            uri_proxy  = URI.parse(ENV['http_proxy'])
+            host = uri_proxy.host
+            port = uri_proxy.port
+        end
+
+        http = Net::HTTP::Proxy(host, port).new(url.host, url.port)
+
+        if timeout
+            http.read_timeout = timeout.to_i
+        end
+
+        if url.scheme=='https'
+            http.use_ssl = true
+            http.verify_mode=OpenSSL::SSL::VERIFY_NONE
+        end
+
+        begin
+            res = http.start do |connection|
+                block.call(connection)
+            end
+        rescue Errno::ECONNREFUSED => e
+            str =  "Error connecting to server (#{e.to_s}).\n"
+            str << "Server: #{url.host}:#{url.port}"
+
+            return CloudClient::Error.new(str,"503")
+        rescue Errno::ETIMEDOUT => e
+            str =  "Error timeout connecting to server (#{e.to_s}).\n"
+            str << "Server: #{url.host}:#{url.port}"
+
+            return CloudClient::Error.new(str,"504")
+        rescue Timeout::Error => e
+            str =  "Error timeout while connected to server (#{e.to_s}).\n"
+            str << "Server: #{url.host}:#{url.port}"
+
+            return CloudClient::Error.new(str,"504")
+        rescue SocketError => e
+            str =  "Error timeout while connected to server (#{e.to_s}).\n"
+
+            return CloudClient::Error.new(str,"503")
+        rescue
+            return CloudClient::Error.new($!.to_s,"503")
+        end
+
+        if res.is_a?(Net::HTTPSuccess)
+            res
+        else
+            CloudClient::Error.new(res.body, res.code)
+        end
+    end
+
+    # #########################################################################
+    # The Error Class represents a generic error in the Cloud Client
+    # library. It contains a readable representation of the error.
+    # #########################################################################
+    class Error
+        attr_reader :message
+        attr_reader :code
+
+        # +message+ a description of the error
+        def initialize(message=nil, code="500")
+            @message=message
+            @code=code
+        end
+
+        def to_s()
+            @message
+        end
+    end
+
+    # #########################################################################
+    # Returns true if the object returned by a method of the OpenNebula
+    # library is an Error
+    # #########################################################################
+    def self.is_error?(value)
+        value.class==CloudClient::Error
+    end
+end
+
+# Command line help functions
+module CloudCLI
+    def print_xml(xml_text)
+        begin
+            doc = REXML::Document.new(xml_text)
+        rescue REXML::ParseException => e
+            return e.message, -1
+        end
+
+        xml = doc.root
+
+        if xml.nil?
+            return xml_text, -1
+        end
+
+        str = String.new
+        if REXML_FORMATTERS
+            formatter = REXML::Formatters::Pretty.new
+            formatter.compact = true
+
+            formatter.write(xml,str)
+        else
+            str = xml.to_s
+        end
+
+        return str, 0
+    end
+
+    # Returns the command name
+    def cmd_name
+        File.basename($0)
+    end
+
+    def version_text
+        version=<<EOT
+OpenNebula #{CloudClient::VERSION}
+Copyright 2002-2015, OpenNebula Project (OpenNebula.org), C12G Labs
+
+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
+EOT
+    end
+end

data/lib/opennebula.rb

@@ -60,5 +60,5 @@ require 'opennebula/system'
 module OpenNebula
 
     # OpenNebula version
-    VERSION = '4.13.80'
+    VERSION = '4.13.85'
 end

data/lib/opennebula/image_pool.rb

@@ -49,7 +49,7 @@ module OpenNebula
         # XML-RPC Methods for the Image Object
         #######################################################################
 
-        # Retrieves all or part of the VirtualMachines in the pool.
+        # Retrieves all or part of the Images in the pool.
         def info(*args)
             case args.size
                 when 0

data/lib/opennebula/template.rb

@@ -65,8 +65,22 @@ module OpenNebula
         #######################################################################
 
         # Retrieves the information of the given Template.
-        def info()
-            super(TEMPLATE_METHODS[:info], 'VMTEMPLATE')
+        # @param extended [true,false] optional flag to process the template and
+        # include extended information, such as the SIZE for each DISK
+        def info(extended=false)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(TEMPLATE_METHODS[:info], @pe_id, extended)
+
+            if !OpenNebula.is_error?(rc)
+                initialize_xml(rc, 'VMTEMPLATE')
+                rc   = nil
+
+                @pe_id = self['ID'].to_i if self['ID']
+                @name  = self['NAME'] if self['NAME']
+            end
+
+            return rc
         end
 
         alias_method :info!, :info

data/lib/opennebula/template_pool.rb

@@ -49,7 +49,7 @@ module OpenNebula
         # XML-RPC Methods for the Template Object
         #######################################################################
 
-        # Retrieves all or part of the VirtualMachines in the pool.
+        # Retrieves all or part of the Templates in the pool.
         def info(*args)
             case args.size
                 when 0

data/lib/opennebula/virtual_machine.rb

@@ -702,6 +702,12 @@ module OpenNebula
             self['DEPLOY_ID']
         end
 
+        # Returns the deploy_id of the VirtualMachine (numeric value)
+        def keep_disks?
+            !self['USER_TEMPLATE/KEEP_DISKS_ON_DONE'].nil? &&
+                self['USER_TEMPLATE/KEEP_DISKS_ON_DONE'].downcase=="yes"
+        end
+
         # Clones the VM's source Template, replacing the disks with live snapshots
         # of the current disks. The VM capacity and NICs are also preserved
         #
@@ -710,114 +716,139 @@ module OpenNebula
         # @return [Integer, OpenNebula::Error] the new Template ID in case of
         #   success, error otherwise
         def save_as_template(name)
-            rc = info()
-            return rc if OpenNebula.is_error?(rc)
+            img_ids = []
+            new_tid = nil
 
-            tid = self['TEMPLATE/TEMPLATE_ID']
-            if tid.nil? || tid.empty?
-                return Error.new('VM has no template to be saved')
-            end
+            begin
+                rc = info()
+                raise if OpenNebula.is_error?(rc)
 
-            if state_str() != "POWEROFF"
-                return Error.new("VM state must be POWEROFF, "<<
-                    "current state is #{state_str()}, #{lcm_state_str()}")
-            end
+                tid = self['TEMPLATE/TEMPLATE_ID']
+                if tid.nil? || tid.empty?
+                    rc = Error.new('VM has no template to be saved')
+                    raise
+                end
 
-            # Clone the source template
-            new_tid = OpenNebula::Template.new_with_id(tid, @client).clone(name)
-            return new_tid if OpenNebula.is_error?(new_tid)
+                if state_str() != "POWEROFF"
+                    rc = Error.new("VM state must be POWEROFF, "<<
+                        "current state is #{state_str()}, #{lcm_state_str()}")
+                    raise
+                end
 
-            # Replace the original template's capacity with the actual VM values
-            replace = ""
+                # Clone the source template
+                rc = OpenNebula::Template.new_with_id(tid, @client).clone(name)
+                raise if OpenNebula.is_error?(rc)
 
-            cpu = self['TEMPLATE/CPU']
-            if !cpu.nil? && !cpu.empty?
-                replace << "CPU = #{cpu}\n"
-            end
+                new_tid = rc
 
-            vcpu = self['TEMPLATE/VCPU']
-            if !vcpu.nil? && !vcpu.empty?
-                replace << "VCPU = #{vcpu}\n"
-            end
+                # Replace the original template's capacity with the actual VM values
+                replace = ""
 
-            mem = self['TEMPLATE/MEMORY']
-            if !mem.nil? && !mem.empty?
-                replace << "MEMORY = #{mem}\n"
-            end
+                cpu = self['TEMPLATE/CPU']
+                if !cpu.nil? && !cpu.empty?
+                    replace << "CPU = #{cpu}\n"
+                end
 
-            self.each('TEMPLATE/DISK') do |disk|
-                # While the previous snapshot is still in progress, we wait
-                # indefinitely
-                rc = info()
-                return rc if OpenNebula.is_error?(rc)
+                vcpu = self['TEMPLATE/VCPU']
+                if !vcpu.nil? && !vcpu.empty?
+                    replace << "VCPU = #{vcpu}\n"
+                end
 
-                steps = 0
-                while lcm_state_str() == "HOTPLUG_SAVEAS_POWEROFF"
-                    if steps < 30
-                        sleep 1
-                    else
-                        sleep 15
-                    end
+                mem = self['TEMPLATE/MEMORY']
+                if !mem.nil? && !mem.empty?
+                    replace << "MEMORY = #{mem}\n"
+                end
 
+                self.each('TEMPLATE/DISK') do |disk|
+                    # While the previous snapshot is still in progress, we wait
+                    # indefinitely
                     rc = info()
-                    return rc if OpenNebula.is_error?(rc)
+                    raise if OpenNebula.is_error?(rc)
 
-                    steps += 1
-                end
+                    steps = 0
+                    while lcm_state_str() == "HOTPLUG_SAVEAS_POWEROFF"
+                        if steps < 30
+                            sleep 1
+                        else
+                            sleep 15
+                        end
 
-                # If the VM is not busy with a previous disk snapshot, we wait
-                # but this time with a timeout
-                rc = wait_state("POWEROFF")
-                return rc if OpenNebula.is_error?(rc)
+                        rc = info()
+                        raise if OpenNebula.is_error?(rc)
 
-                disk_id = disk["DISK_ID"]
-                if disk_id.nil? || disk_id.empty?
-                    return Error.new('The DISK_ID is missing from the VM template')
-                end
+                        steps += 1
+                    end
 
-                image_id = disk["IMAGE_ID"]
+                    # If the VM is not busy with a previous disk snapshot, we wait
+                    # but this time with a timeout
+                    rc = wait_state("POWEROFF")
+                    raise if OpenNebula.is_error?(rc)
 
-                if !image_id.nil? && !image_id.empty?
-                    rc = disk_saveas(disk_id.to_i,"#{name}-disk-#{disk_id}","",-1)
+                    disk_id = disk["DISK_ID"]
+                    if disk_id.nil? || disk_id.empty?
+                        rc = Error.new('The DISK_ID is missing from the VM template')
+                        raise
+                    end
 
-                    return rc if OpenNebula.is_error?(rc)
+                    image_id = disk["IMAGE_ID"]
 
-                    replace << "DISK = [ IMAGE_ID = #{rc} ]\n"
-                else
-                    # Volatile disks cannot be saved, so the definition is copied
-                    replace << self.template_like_str(
-                        "TEMPLATE", true, "DISK[DISK_ID=#{disk_id}]") << "\n"
-                end
-            end
+                    if !image_id.nil? && !image_id.empty?
+                        rc = disk_saveas(disk_id.to_i,"#{name}-disk-#{disk_id}","",-1)
 
-            self.each('TEMPLATE/NIC') do |nic|
-                nic_id = nic["NIC_ID"]
-                if nic_id.nil? || nic_id.empty?
-                    return Error.new('The NIC_ID is missing from the VM template')
+                        raise if OpenNebula.is_error?(rc)
+
+                        img_ids << rc.to_i
+
+                        replace << "DISK = [ IMAGE_ID = #{rc} ]\n"
+                    else
+                        # Volatile disks cannot be saved, so the definition is copied
+                        replace << self.template_like_str(
+                            "TEMPLATE", true, "DISK[DISK_ID=#{disk_id}]") << "\n"
+                    end
                 end
 
-                net_id = nic["NETWORK_ID"]
+                self.each('TEMPLATE/NIC') do |nic|
+                    nic_id = nic["NIC_ID"]
+                    if nic_id.nil? || nic_id.empty?
+                        rc = Error.new('The NIC_ID is missing from the VM template')
+                        raise
+                    end
 
-                if !net_id.nil? && !net_id.empty?
-                    replace << "NIC = [ NETWORK_ID = #{net_id} ]\n"
-                else
-                    # This NIC does not use a Virtual Network
-                    replace << self.template_like_str(
-                        "TEMPLATE", true, "NIC[NIC_ID=#{nic_id}]") << "\n"
+                    net_id = nic["NETWORK_ID"]
+
+                    if !net_id.nil? && !net_id.empty?
+                        replace << "NIC = [ NETWORK_ID = #{net_id} ]\n"
+                    else
+                        # This NIC does not use a Virtual Network
+                        replace << self.template_like_str(
+                            "TEMPLATE", true, "NIC[NIC_ID=#{nic_id}]") << "\n"
+                    end
                 end
-            end
 
-            # Required by the Sunstone Cloud View
-            replace << "SAVED_TEMPLATE_ID = #{tid}\n"
+                # Required by the Sunstone Cloud View
+                replace << "SAVED_TEMPLATE_ID = #{tid}\n"
 
-            new_tmpl = OpenNebula::Template.new_with_id(new_tid, @client)
+                new_tmpl = OpenNebula::Template.new_with_id(new_tid, @client)
 
-            rc = new_tmpl.update(replace, true)
-            return rc if OpenNebula.is_error?(rc)
+                rc = new_tmpl.update(replace, true)
+                raise if OpenNebula.is_error?(rc)
 
-            return new_tid
+                return new_tid
 
-            # TODO: rollback in case of error
+            rescue
+                # Rollback. Delete the template and the images created
+                if !new_tid.nil?
+                    new_tmpl = OpenNebula::Template.new_with_id(new_tid, @client)
+                    new_tmpl.delete()
+                end
+
+                img_ids.each do |id|
+                    img = OpenNebula::Image.new_with_id(id, @client)
+                    img.delete()
+                end
+
+                return rc
+            end
         end
 
     private

data/lib/opennebula/virtual_network_pool.rb

@@ -49,7 +49,7 @@ module OpenNebula
         # XML-RPC Methods for the Virtual Network Object
         #######################################################################
 
-        # Retrieves all or part of the VirtualMachines in the pool.
+        # Retrieves all or part of the VirtualNetworks in the pool.
         def info(*args)
             case args.size
                 when 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opennebula
 version: !ruby/object:Gem::Version
-  version: 4.13.80.beta1
+  version: 4.13.85.beta2
 platform: ruby
 authors:
 - OpenNebula
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -60,6 +60,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - NOTICE
+- lib/cloud/CloudClient.rb
 - lib/opennebula.rb
 - lib/opennebula/acl.rb
 - lib/opennebula/acl_pool.rb
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: OpenNebula Client API