fog-vcloud-director 0.1.10 → 0.3.1

data/fog-vcloud-director.gemspec

@@ -18,14 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 2.0"
+  spec.required_ruby_version = ">= 2.0"
 
-  spec.add_dependency "fog-core"
+  spec.add_dependency "fog-core", ">= 1.40" # tested on 1.40 and 2.1.0
   spec.add_dependency "fog-xml"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "shindo"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "vcr"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rubocop", "~>0.52.1"
+  spec.add_development_dependency "pronto-rubocop"
 end

data/lib/fog/vcloud_director.rb

@@ -1,2 +1,15 @@
-require 'fog/vcloud_director/compute'
+require 'pp'
 require 'securerandom'
+
+require 'fog/core'
+require 'fog/core/model'
+require 'fog/core/collection'
+require 'fog/xml'
+require 'fog/vcloud_director/core'
+require 'fog/vcloud_director/query'
+require 'fog/vcloud_director/compute'
+
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'generators', '**', '*.rb')].sort.each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'models', '**', '*.rb')].sort.each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'parsers', '**', '*.rb')].sort.each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'requests', '**', '*.rb')].sort.each {|file| require file }

data/lib/fog/vcloud_director/compute.rb

@@ -1,6 +1,3 @@
-require 'fog/vcloud_director/core'
-require 'fog/vcloud_director/query'
-
 class VcloudDirectorParser < Fog::Parsers::Base
   def extract_attributes(attributes_xml)
     attributes = {}
@@ -23,8 +20,8 @@ class NonLoaded
 end
 
 module Fog
-  module Compute
-    class VcloudDirector < Fog::Service
+  module VcloudDirector
+    class Compute < Fog::Service
       module Defaults
         PATH        = '/api'
         PORT        = 443
@@ -44,6 +41,8 @@ module Fog
       class DuplicateName < Fog::VcloudDirector::Errors::DuplicateName; end
       class TaskError < Fog::VcloudDirector::Errors::TaskError; end
 
+      class PreProcessingError < Fog::Errors::Error; end
+
       requires :vcloud_director_username, :vcloud_director_password, :vcloud_director_host
       recognizes :vcloud_director_api_version, :vcloud_director_show_progress, :path, :vcloud_token, :port
 
@@ -196,7 +195,6 @@ module Fog
       request :get_vm_disks
       request :get_vm_network
       request :get_vm_pending_question
-      request :get_vms
       request :get_vms_by_metadata
       request :get_vms_disk_attached_to
       request :get_vms_in_lease_from_query
@@ -322,19 +320,33 @@ module Fog
         end
 
         def get_by_name(item_name)
-          item_found = item_list.find {|item| item[:name] == item_name}
+          item_found = _item_list.find { |item| item[:name] == item_name }
           return nil unless item_found
           get(item_found[:id])
         end
 
         def index
-          load(item_list)
+          load(_item_list)
         end
 
         def get_everyone
-          items = item_list.map {|item| get_by_id(item[:id])}
+          items = _item_list.map { |item| get_by_id(item[:id]) }
           load(items)
         end
+
+        # Use pre-fetched list of items. Particularly useful when parent's XML already contains enough information
+        # about child entities, hence we can parse them on parent already to reduce API requests. Some examples:
+        #  - vApp XML contains all the information about each of its child VMs, so we can pre-fetch `vapp.vms`
+        #  - VM XML contains all the information about customization, so we can pre-fecth `vm.guest_customization`
+        #  - VM XML contains all the information about disks, so we can pre-fetch `vm.disks`
+        def with_item_list(hashes)
+          @items = Array(hashes)
+          self
+        end
+
+        def _item_list
+          @items || item_list || []
+        end
       end
 
       class Real
@@ -348,15 +360,15 @@ module Fog
           @vcloud_director_password = options[:vcloud_director_password]
           @vcloud_director_username = options[:vcloud_director_username]
           @connection_options = options[:connection_options] || {}
-          @connection_options[:omit_default_port] = Fog::Compute::VcloudDirector::Defaults::OMIT_DEFAULT_PORT unless @connection_options[:omit_default_port]
+          @connection_options[:omit_default_port] = Fog::VcloudDirector::Compute::Defaults::OMIT_DEFAULT_PORT unless @connection_options[:omit_default_port]
           @host       = options[:vcloud_director_host]
-          @path       = options[:path]        || Fog::Compute::VcloudDirector::Defaults::PATH
+          @path       = options[:path]        || Fog::VcloudDirector::Compute::Defaults::PATH
           @persistent = options[:persistent]  || false
-          @port       = options[:port]        || Fog::Compute::VcloudDirector::Defaults::PORT
-          @scheme     = options[:scheme]      || Fog::Compute::VcloudDirector::Defaults::SCHEME
+          @port       = options[:port]        || Fog::VcloudDirector::Compute::Defaults::PORT
+          @scheme     = options[:scheme]      || Fog::VcloudDirector::Compute::Defaults::SCHEME
           @connection = Fog::XML::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
           @end_point = "#{@scheme}://#{@host}#{@path}/"
-          @api_version = options[:vcloud_director_api_version] || Fog::Compute::VcloudDirector::Defaults::API_VERSION
+          @api_version = options[:vcloud_director_api_version] || Fog::VcloudDirector::Compute::Defaults::API_VERSION
           @show_progress = options[:vcloud_director_show_progress]
           @show_progress = $stdin.tty? if @show_progress.nil?
           @vcloud_token  = options[:vcloud_token]
@@ -394,9 +406,23 @@ module Fog
           response.body[:href].split('/').last # returns the vapp_id if it was instantiated successfully.
         end
 
+        # Perform HTTP request against vCloud API.
+        #
+        # @param [Hash] params request parameters.
+        #  - params[:parser] SAX parser class, SAX parser instance or string. String can be one of:
+        #    - 'plaintext': returns unparsed text in response.body
+        #    - 'xml': returns Nokogiri::XML instance in response.body
+        # @return [Excon::Response]
         def request(params)
           begin
-            do_request(params)
+            parser_type = params[:parser]
+            params[:parser] = nil if parser_type.instance_of?(String)
+            params[:parser] = parser_type.new if parser_type.respond_to?(:new)
+
+            resp = do_request(params)
+
+            resp.body = Nokogiri::XML(resp.body) if parser_type == 'xml'
+            resp
           rescue EOFError
             # This error can occur if Vcloud receives a request from a network
             # it deems to be unauthorized; no HTTP response is sent, but the
@@ -806,13 +832,13 @@ module Fog
           @vcloud_director_username = options[:vcloud_director_username]
           #@connection_options = options[:connection_options] || {}
           @host = options[:vcloud_director_host]
-          @path = options[:path] || Fog::Compute::VcloudDirector::Defaults::PATH
+          @path = options[:path] || Fog::VcloudDirector::Compute::Defaults::PATH
           @persistent = options[:persistent] || false
-          @port = options[:port] || Fog::Compute::VcloudDirector::Defaults::PORT
-          @scheme = options[:scheme] || Fog::Compute::VcloudDirector::Defaults::SCHEME
+          @port = options[:port] || Fog::VcloudDirector::Compute::Defaults::PORT
+          @scheme = options[:scheme] || Fog::VcloudDirector::Compute::Defaults::SCHEME
           #@connection = Fog::XML::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
           @end_point    = "#{@scheme}://#{@host}#{@path}/"
-          @api_version  = options[:vcloud_director_api_version] || Fog::Compute::VcloudDirector::Defaults::API_VERSION
+          @api_version  = options[:vcloud_director_api_version] || Fog::VcloudDirector::Compute::Defaults::API_VERSION
           @vcloud_token = options[:vcloud_token]
         end
 

data/lib/fog/vcloud_director/core.rb

@@ -1,6 +1,3 @@
-require 'fog/core'
-require 'fog/xml'
-
 module Fog
   module VcloudDirector
     extend Fog::Provider
@@ -64,6 +61,9 @@ module Fog
       class TaskError < ServiceError; end
     end
 
+    # Services
+    autoload :Compute, File.expand_path('../compute', __FILE__)
+
     service(:compute, 'Compute')
   end
 end

data/lib/fog/vcloud_director/generators/compute/compose_common.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         module ComposeCommon
 
           def initialize(configuration={})
@@ -251,6 +251,19 @@ module Fog
             return 'bridged' unless mode && mode != 'isolated'
             mode
           end
+
+          def network_section_nic(xml, new_idx:, name: 'none', mac: nil, ip: nil, connected: true, mode: 'DHCP', type: nil, needs: nil)
+            attr = { :network => name }
+            attr[:needsCustomization] = needs unless needs.nil?
+            xml.NetworkConnection(attr) do
+              xml.NetworkConnectionIndex(new_idx) if new_idx
+              xml.IpAddress(ip) unless ip.nil?
+              xml.IsConnected(connected) unless connected.nil?
+              xml.MACAddress(mac) if mac
+              xml.IpAddressAllocationMode(mode) if mode
+              xml.NetworkAdapterType(type) if type
+            end
+          end
         end
       end
     end

data/lib/fog/vcloud_director/generators/compute/compose_vapp.rb

@@ -1,9 +1,9 @@
 require 'fog/vcloud_director/generators/compute/compose_common'
 
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # @see http://pubs.vmware.com/vcd-51/index.jsp#types/ComposeVAppParamsType.html
         class ComposeVapp
 

data/lib/fog/vcloud_director/generators/compute/create_snapshot.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # @see http://pubs.vmware.com/vcd-56/topic/com.vmware.ICbase/PDF/vcd_56_api_guide.pdf @page 121
         class CreateSnapshot
           attr_reader :attrs

data/lib/fog/vcloud_director/generators/compute/customization.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # This is the data structure it accepts, this is the output of
         # #get_vm_customization:
         #

data/lib/fog/vcloud_director/generators/compute/disks.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # This is the data structure it accepts, this is the output of
         # #get_vm_disks:
         #

data/lib/fog/vcloud_director/generators/compute/edge_gateway_service_configuration.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         class EdgeGatewayServiceConfiguration
           def initialize(configuration={})
             @configuration = configuration

data/lib/fog/vcloud_director/generators/compute/instantiate_vapp_template_params.rb

@@ -1,9 +1,9 @@
 require 'fog/vcloud_director/generators/compute/compose_common'
 
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/VAppType.html
         class InstantiateVappTemplateParams
           attr_reader :options

data/lib/fog/vcloud_director/generators/compute/metadata.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         #   {:metadata=>
         #    {"buenas si"=>"no tanto ya",
         #     "hola"=>"adios"},

data/lib/fog/vcloud_director/generators/compute/org_vdc_network.rb

@@ -1,7 +1,7 @@
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/OrgVdcNetworkType.html
         class OrgVdcNetwork
           attr_reader :options
@@ -11,7 +11,7 @@ module Fog
           end
 
           def generate_xml
-            body = Nokogiri::XML::Builder.new do
+            Nokogiri::XML::Builder.new do
               attrs = {
                 :xmlns => 'http://www.vmware.com/vcloud/v1.5',
                 :name  => options[:name]

data/lib/fog/vcloud_director/generators/compute/recompose_vapp.rb

@@ -1,9 +1,9 @@
 require 'fog/vcloud_director/generators/compute/compose_common'
 
 module Fog
-  module Generators
-    module Compute
-      module VcloudDirector
+  module VcloudDirector
+    module Generators
+      module Compute
         # @see http://pubs.vmware.com/vcd-51/index.jsp#types/RecomposeVAppParamsType.html
         class RecomposeVapp
 

data/lib/fog/vcloud_director/generators/compute/reconfigure_vm.rb

@@ -0,0 +1,189 @@
+require 'fog/vcloud_director/generators/compute/compose_common'
+
+module Fog
+  module VcloudDirector
+    module Generators
+      module Compute
+        class ReconfigureVm
+          extend ComposeCommon
+
+          NETWORK_SECTION_ORDER = ['ovf:Info'] + %w(PrimaryNetworkConnectionIndex NetworkConnection Link)
+          NETWORK_CONNECTION_ORDER = %w(NetworkConnectionIndex IpAddress ExternalIpAddress IsConnected MACAddress IpAddressAllocationMode NetworkAdapterType).freeze
+
+          class << self
+            # Generates VM reconfiguration XML.
+            #
+            # @param [Nokogiri::Xml] current DOM representing current VM configuration.
+            # @param [Hash] options desired configuration. Please see examples-vm-reconfigure.md for details.
+            #
+            # @return [String] xml string, a modification of `current` input, with desired configurations applied.
+            def generate_xml(current, options)
+              current.root['name'] = options[:name] if options[:name]
+              current.at('Description').content = options[:description] if options[:description]
+              # Remove entire section when no moification is required to improve performance, see
+              # https://pubs.vmware.com/vcd-80/index.jsp#com.vmware.vcloud.api.sp.doc_90/GUID-4759B018-86C2-4C91-8176-3EC73CD7122B.html
+              options[:hardware] ? update_virtual_hardware_section(current, options[:hardware]) : current.at('//ovf:VirtualHardwareSection').remove
+              options[:networks] ? update_network_connection_section(current, options[:networks]) : current.at('//xmlns:NetworkConnectionSection').remove
+              current.at('//ovf:OperatingSystemSection').remove # TODO(miha-plesko): support this type of customization
+              current.at('//xmlns:GuestCustomizationSection').remove # TODO(miha-plesko): support this type of customization
+
+              current.to_xml
+            end
+
+            # Apply desired hardware modifications to the original xml.
+            def update_virtual_hardware_section(xml, hardware)
+              update_virtual_hardware_section_item_mem(xml, **hardware[:memory]) if hardware[:memory]
+              update_virtual_hardware_section_item_cpu(xml, **hardware[:cpu]) if hardware[:cpu]
+              array_wrap(hardware[:disk]).reject { |d| d[:id].nil? || d[:capacity_mb] == -1 }.each { |disk| update_virtual_hardware_section_item_hdd(xml, **disk) }
+              array_wrap(hardware[:disk]).select { |d| d[:id].nil? }.each { |disk| add_virtual_hardware_section_item_hdd(xml, **disk) }
+              array_wrap(hardware[:disk]).select { |d| d[:capacity_mb] == -1 }.each { |disk| remove_virtual_hardware_section_item_hdd(xml, id: disk[:id]) }
+            end
+
+            # Apply desired NIC connection modifications to the original xml.
+            def update_network_connection_section(xml, networks)
+              array_wrap(networks).reject { |n| n[:new_idx] == -1 || n[:idx].nil? }.each { |nic| update_network_connection_section_by_index(xml, **nic) }
+              array_wrap(networks).select { |n| n[:new_idx] == -1 }.each { |nic| remove_network_connection_section_by_index(xml, :idx => nic[:idx]) }
+              array_wrap(networks).select { |n| n[:idx].nil? }.each { |nic| add_network_connection_section(xml, **nic) }
+            end
+
+            def update_virtual_hardware_section_item_cpu(xml, num_cores: nil, cores_per_socket: nil, reservation: nil, limit: nil, weight: nil)
+              update_virtual_hardware_section_item(xml, :type => 3) do |item|
+                item.at('./rasd:VirtualQuantity').content = num_cores if num_cores
+                item.at('./rasd:Reservation').content = reservation if reservation
+                item.at('./rasd:Limit').content = limit if limit
+                item.at('./rasd:Weight').content = weight if weight
+                item.at('./vmw:CoresPerSocket').content = cores_per_socket if cores_per_socket
+              end
+            end
+
+            def update_virtual_hardware_section_item_mem(xml, quantity_mb: nil, reservation: nil, limit: nil, weight: nil)
+              update_virtual_hardware_section_item(xml, :type => 4) do |item|
+                item.at('./rasd:VirtualQuantity').content = quantity_mb if quantity_mb
+                item.at('./rasd:Reservation').content = reservation if reservation
+                item.at('./rasd:Limit').content = limit if limit
+                item.at('./rasd:Weight').content = weight if weight
+              end
+            end
+
+            def update_virtual_hardware_section_item_hdd(xml, id:, capacity_mb: nil, address: nil, type: nil, subtype: nil)
+              hdd_exists = update_virtual_hardware_section_item(xml, :type => 17, :id => id) do |item|
+                item.at('./rasd:AddressOnParent').content = address if address
+                item.at('./rasd:HostResource')['ns13:capacity'] = capacity_mb if capacity_mb
+                item.at('./rasd:HostResource')['ns13:busType'] = type if type
+                item.at('./rasd:HostResource')['ns13:busSubType'] = subtype if subtype
+              end
+              raise Fog::VcloudDirector::Compute::PreProcessingError.new("Error resizing disk: disk with id '#{id}' does not exist.") unless hdd_exists
+            end
+
+            def remove_virtual_hardware_section_item_hdd(xml, id:)
+              remove_virtual_hardware_section_item(xml, :type => 17, :id => id)
+            end
+
+            def add_virtual_hardware_section_item_hdd(xml, **disk)
+              disk[:id] = rand(10_000..100_000)
+              add_virtual_hardware_section_item(xml) do |section|
+                virtual_hardware_section_item_hdd(section, **disk)
+              end
+            end
+
+            def add_virtual_hardware_section_item(xml)
+              virtual_hardware = xml.at('//ovf:VirtualHardwareSection')
+              virtual_hardware.add_namespace_definition('vcloud', 'http://www.vmware.com/vcloud/v1.5')
+              Nokogiri::XML::Builder.with(virtual_hardware) do |section|
+                yield section
+              end
+              # Move the new item to satisfy vCloud's sorting requirements.
+              item = virtual_hardware.at('./ovf:Item[last()]').remove
+              virtual_hardware.at('./ovf:Item[last()]').after(item)
+            end
+
+            def update_virtual_hardware_section_item(xml, type:, id: nil)
+              condition = "rasd:ResourceType = '#{type}'"
+              condition += " and rasd:InstanceID = '#{id}'" if id
+              if (item = xml.at("//ovf:VirtualHardwareSection/ovf:Item[#{condition}]"))
+                yield item
+                true
+              else
+                false
+              end
+            end
+
+            def remove_virtual_hardware_section_item(xml, type:, id:)
+              item = xml.at("//ovf:VirtualHardwareSection/ovf:Item[rasd:ResourceType = '#{type}' and rasd:InstanceID = '#{id}']")
+              item.remove if item
+            end
+
+            def update_network_connection_section_by_index(xml, idx:, name: nil, mac: nil, ip: nil, connected: nil, mode: nil, type: nil, needs: nil, new_idx: nil, primary: nil)
+              conn = xml.at("//xmlns:NetworkConnectionSection/xmlns:NetworkConnection[./xmlns:NetworkConnectionIndex = '#{idx}']")
+              conn['network'] = name if name
+              conn['needsCustomization'] = needs unless needs.nil?
+              leaf_at(conn, 'IpAddress', NETWORK_CONNECTION_ORDER).content = ip unless ip.nil?
+              leaf_at(conn, 'IpAddressAllocationMode', NETWORK_CONNECTION_ORDER).content = mode if mode
+              leaf_at(conn, 'IsConnected', NETWORK_CONNECTION_ORDER).content = connected unless connected.nil?
+              leaf_at(conn, 'MACAddress', NETWORK_CONNECTION_ORDER).content = mac if mac
+              leaf_at(conn, 'NetworkAdapterType', NETWORK_CONNECTION_ORDER).content = type if type
+              leaf_at(conn, 'NetworkConnectionIndex', NETWORK_CONNECTION_ORDER).content = new_idx if new_idx
+
+              set_primary_nic(xml, new_idx || idx) if primary
+            end
+
+            def remove_network_connection_section_by_index(xml, idx:)
+              conn = xml.at("//xmlns:NetworkConnectionSection/xmlns:NetworkConnection[./xmlns:NetworkConnectionIndex = '#{idx}']")
+              conn.remove if conn
+            end
+
+            def add_network_connection_section(xml, primary: nil, **nic)
+              nic.delete(:idx)
+              network_section = xml.at('//xmlns:NetworkConnectionSection')
+              network_section.add_namespace_definition('vcloud', 'http://www.vmware.com/vcloud/v1.5')
+              Nokogiri::XML::Builder.with(network_section) do |section|
+                network_section_nic(section, **nic)
+              end
+
+              # Move the new item to satisfy vCloud's sorting requirements.
+              item = network_section.at('./xmlns:NetworkConnection[last()]').remove
+              (previous = find_previous(network_section, 'NetworkConnection', NETWORK_SECTION_ORDER)) ? previous.after(item) : network_section.prepend_child(item)
+
+              set_primary_nic(xml, nic[:new_idx]) if primary
+            end
+
+            def set_primary_nic(xml, idx)
+              leaf_at(xml.at('//xmlns:NetworkConnectionSection'), 'PrimaryNetworkConnectionIndex', NETWORK_SECTION_ORDER).content = idx
+            end
+
+            # Find leaf element if present or create new one. Respect XML ordering when adding new.
+            # Arguments:
+            # - xml: parent xml whose child element are we updating/adding
+            # - leaf_name: child element name (without namespace)
+            # - order: list of child names in proper order
+            # - ns: leaf element's namespace
+            # Returns:
+            # - leaf element
+            def leaf_at(xml, leaf_name, order, ns: 'xmlns')
+              el = xml.at("./#{ns}:#{leaf_name}")
+              el || begin
+                el = Nokogiri::XML::Node.new(ns == 'xmlns' ? leaf_name : "#{ns}:#{leaf_name}", xml)
+                (previous = find_previous(xml, leaf_name, order)) ? previous.after(el) : xml.prepend_child(el)
+                el
+              end
+            end
+
+            # Finds previous sybling for a leaf_name in accordance with ordered list of child elements.
+            # Arguments:
+            # - xml: parent xml whose children are we checking
+            # - leaf_name: child element name that we want to find preceeding sybling for (without namespace)
+            # - order: list of child names in proper order
+            # Returns:
+            # - previous sybling element if found or nil
+            def find_previous(xml, leaf_name, order)
+              order.reduce(nil) do |res, curr_name|
+                break res if curr_name == leaf_name
+                xml.at(curr_name.include?(':') ? "./#{curr_name}" : "./xmlns:#{curr_name}") || res
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end