fog-vcloud-director 0.1.10 → 0.2.0

data/fog-vcloud-director.gemspec

@@ -26,6 +26,9 @@ Gem::Specification.new do |spec|
   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')].each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'models', '**', '*.rb')].each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'parsers', '**', '*.rb')].each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'vcloud_director', 'requests', '**', '*.rb')].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 = {}
@@ -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
@@ -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

data/lib/fog/vcloud_director/core.rb

@@ -1,6 +1,3 @@
-require 'fog/core'
-require 'fog/xml'
-
 module Fog
   module VcloudDirector
     extend Fog::Provider

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

@@ -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/reconfigure_vm.rb

@@ -0,0 +1,110 @@
+require 'fog/vcloud_director/generators/compute/compose_common'
+
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        class ReconfigureVm
+          extend ComposeCommon
+
+          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]
+              if options[:hardware]
+                update_virtual_hardware_section(current, options[:hardware])
+              else
+                # Remove entire VirtualHardwareSection if no hardware is modified.
+                # https://pubs.vmware.com/vcd-80/index.jsp#com.vmware.vcloud.api.sp.doc_90/GUID-4759B018-86C2-4C91-8176-3EC73CD7122B.html
+                current.at('//ovf:VirtualHardwareSection').remove
+              end
+              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
+
+            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::Compute::VcloudDirector::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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,7 +12,6 @@ module Fog
           end
 
           def generate_xml
-            attrs = @attrs
             Nokogiri::XML::Builder.new do
               VApp('xmlns' => 'http://www.vmware.com/vcloud/v1.5',
                    'name' => name

data/lib/fog/vcloud_director/models/compute/catalog.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/catalog_item.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/catalog_items.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/catalog_item'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/catalogs.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/catalog'
 require 'fog/vcloud_director/models/compute/catalog_item'
 

data/lib/fog/vcloud_director/models/compute/custom_field.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/disk.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector
@@ -17,6 +15,7 @@ module Fog
         attribute :bus_sub_type
         attribute :bus_type
 
+        remove_method :capacity=
         # TODO Virtual machine disk sizes may only be increased, not decreased.
         def capacity=(new_capacity)
           has_changed = ( capacity != new_capacity.to_i )

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

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/disk'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/media.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/medias.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/media'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/network.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/networks.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/network'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/organization.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/organizations.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/organization'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/tag.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector
@@ -7,6 +5,7 @@ module Fog
         identity  :id
         attribute :value
 
+        remove_method :value=
         def value=(new_value)
           has_changed = ( value != new_value )
           not_first_set = !value.nil?

data/lib/fog/vcloud_director/models/compute/tags.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/tag'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/task.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector

data/lib/fog/vcloud_director/models/compute/tasks.rb

@@ -1,4 +1,3 @@
-require 'fog/core/collection'
 require 'fog/vcloud_director/models/compute/task'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/template_vm.rb

@@ -1,4 +1,3 @@
-require 'fog/core/model'
 require 'fog/vcloud_director/models/compute/vm_customization'
 
 module Fog

data/lib/fog/vcloud_director/models/compute/template_vms.rb

@@ -1,5 +1,4 @@
-require 'fog/core/collection'
-require 'fog/vcloud_director/models/compute/vm'
+require 'fog/vcloud_director/models/compute/template_vm'
 
 module Fog
   module Compute
@@ -13,7 +12,7 @@ module Fog
         attribute :vapp_template
 
 
-        def get_single_vm(vm_id)
+        def get_single_template_vm(vm_id)
           item = service.get_template_vm(vm_id).body
           return nil unless item
           new(item[:vm])

data/lib/fog/vcloud_director/models/compute/vapp.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector
@@ -12,13 +10,32 @@ module Fog
         attribute :description, :aliases => :Description
         attribute :deployed, :type => :boolean
         attribute :status
-        attribute :lease_settings, :aliases => :LeaseSettingsSection
-        attribute :network_section, :aliases => :"ovf:NetworkSection", :squash => :"ovf:Network"
-        attribute :network_config, :aliases => :NetworkConfigSection, :squash => :NetworkConfig
-        attribute :owner, :aliases => :Owner, :squash => :User
-        attribute :InMaintenanceMode, :type => :boolean
+        attribute :lease_settings
+        attribute :network_section
+        attribute :network_config
+        attribute :owner
+        attribute :maintenance, :type => :boolean
+
+        def initialize(*args, **kwargs)
+          # Memorize VMs because their full XML description was already included in the vApp XML description.
+          # Instead simple Array we rather store as Collection in order to provide common interface e.g.
+          #    vapp.vms.all
+          #    vapp.vms.get_by_name
+          if (vms = kwargs.delete(:vms))
+            @vms = Fog::Compute::VcloudDirector::Vms.new(
+              :vapp    => self,
+              :service => kwargs[:service]
+            ).with_item_list(Array(vms))
+          end
+
+          super(*args, **kwargs)
+        end
+
+        def vms(force: false)
+          # Return memorized Collection that we parsed based on vApp XML description. This way we prevent
+          # additional API request to be made for each VM in a vApp.
+          return @vms unless @vms.nil? || force
 
-        def vms
           requires :id
           service.vms(:vapp => self)
         end

data/lib/fog/vcloud_director/models/compute/vapp_template.rb

@@ -1,5 +1,3 @@
-require 'fog/core/model'
-
 module Fog
   module Compute
     class VcloudDirector