fog-vcloud-director 0.1.0

data/lib/fog/vcloud_director/core.rb

@@ -0,0 +1,69 @@
+require 'fog/core'
+require 'fog/xml'
+
+module Fog
+  module VcloudDirector
+    extend Fog::Provider
+
+    module Errors
+      class ServiceError < Fog::Errors::Error
+        attr_reader :minor_error_code
+        attr_reader :major_error_code
+        attr_reader :stack_trace
+        attr_reader :status_code
+        attr_reader :vendor_specific_error_code
+
+        def self.slurp(error, service=nil)
+          major_error_code = nil
+          message = nil
+          minor_error_code = nil
+          stack_trace = nil
+          status_code = nil
+          vendor_specific_error_code = nil
+
+          if error.response
+            status_code = error.response.status
+            unless error.response.body.empty?
+              _, media_type = error.response.headers.find {|k,v| k.downcase == 'content-type'}
+              if media_type =~ /vnd\.vmware\.vcloud\.error\+xml/i
+                begin
+                  document = Fog::ToHashDocument.new
+                  Nokogiri::XML::SAX::Parser.new(document).parse_memory(error.response.body)
+                  major_error_code = document.body[:majorErrorCode]
+                  message = document.body[:message]
+                  minor_error_code = document.body[:minorErrorCode]
+                  stack_trace = document.body[:stackTrace]
+                  vendor_specific_error_code = document.body[:vendorSpecificErrorCode]
+                rescue => e
+                  Fog::Logger.warning("Received exception '#{e}' while decoding>> #{error.response.body}")
+                  message = error.response.body
+                end
+              else
+                message = CGI::unescapeHTML(error.response.body)
+              end
+            end
+          end
+
+          new_error = super(error, message)
+          new_error.instance_variable_set(:@major_error_code, major_error_code)
+          new_error.instance_variable_set(:@minor_error_code, minor_error_code)
+          new_error.instance_variable_set(:@stack_trace, stack_trace)
+          new_error.instance_variable_set(:@status_code, status_code)
+          new_error.instance_variable_set(:@vendor_specific_error_code, vendor_specific_error_code)
+          new_error
+        end
+      end
+
+      class BadRequest < ServiceError; end
+      class Unauthorized < ServiceError; end
+      class Forbidden < ServiceError; end
+      class Conflict < ServiceError; end
+      class MalformedResponse < ServiceError; end
+
+      class DuplicateName < ServiceError; end
+      class TaskError < ServiceError; end
+    end
+
+    service(:compute, 'Compute')
+  end
+end

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

@@ -0,0 +1,122 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        module ComposeCommon
+
+          def initialize(configuration={})
+            @configuration = configuration
+          end
+
+          private
+
+          def vapp_attrs
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              'xmlns:ovf' => 'http://schemas.dmtf.org/ovf/envelope/1'
+            }
+
+            [:deploy, :powerOn, :name].each do |a|
+              attrs[a] = @configuration[a] if @configuration.key?(a)
+            end
+            
+            attrs
+          end
+
+          def has_source_items?
+            (@configuration[:source_vms] && (@configuration[:source_vms].size > 0)) || 
+            (@configuration[:source_templates] && (@configuration[:source_templates].size > 0))
+          end
+
+          def build_vapp_instantiation_params(xml)
+            xml.Description @configuration[:Description] if @configuration[:Description]
+            
+            vapp = @configuration[:InstantiationParams]
+            if vapp 
+              xml.InstantiationParams {
+                xml.DefaultStorageProfileSection {
+                    xml.StorageProfile vapp[:DefaultStorageProfile]
+                } if (vapp.key? :DefaultStorageProfile)
+                xml.NetworkConfigSection {
+                  xml['ovf'].Info
+                  vapp[:NetworkConfig].each do |network|
+                    xml.NetworkConfig(:networkName => network[:networkName]) {
+                      xml.Configuration {
+                        xml.ParentNetwork(:href => network[:networkHref])
+                        xml.FenceMode network[:fenceMode]
+                      }
+                    }
+                  end if vapp[:NetworkConfig]
+                }
+              }
+            end
+          end
+          
+          def build_source_template(xml)
+            xml.Source(:href => @configuration[:Source])
+          end
+
+          def build_source_items(xml)
+            vms = @configuration[:source_vms]
+            vms.each do |vm|
+              xml.SourcedItem {
+                xml.Source(:name =>vm[:name], :href => vm[:href])
+                xml.VmGeneralParams {
+                  xml.Name vm[:name]
+                  xml.Description vm[:Description] if vm[:Description]
+                  xml.NeedsCustomization if vm[:NeedsCustomization]
+                } if vm[:name]
+                xml.InstantiationParams {
+                  if vm[:networks]
+                    xml.NetworkConnectionSection(:href => "#{vm[:href]}/networkConnectionSection/", :type => "application/vnd.vmware.vcloud.networkConnectionSection+xml", 'xmlns:ovf' => "http://schemas.dmtf.org/ovf/envelope/1", "ovf:required" => "false") {
+                      xml['ovf'].Info
+                      xml.PrimaryNetworkConnectionIndex 0
+                      vm[:networks].each_with_index do |network, i|
+                        xml.NetworkConnection(:network => network[:networkName]) {
+                          xml.NetworkConnectionIndex i
+                          xml.IpAddress network[:IpAddress] if (network.key? :IpAddress)
+                          xml.ExternalIpAddress network[:ExternalIpAddress] if (network.key? :ExternalIpAddress)
+                          xml.IsConnected network[:IsConnected]
+                          xml.MACAddress network[:MACAddress] if (network.key? :MACAddress)
+                          xml.IpAddressAllocationMode network[:IpAddressAllocationMode]
+                        }
+                      end
+                    }
+                  end
+                  if customization = vm[:guest_customization]
+                    xml.GuestCustomizationSection(:xmlns => "http://www.vmware.com/vcloud/v1.5", 'xmlns:ovf' => "http://schemas.dmtf.org/ovf/envelope/1") {
+                      xml['ovf'].Info
+                      xml.Enabled (customization[:Enabled] || false)
+                      xml.ChangeSid customization[:ChangeSid] if (customization.key? :ChangeSid)
+                      xml.JoinDomainEnabled customization[:JoinDomainEnabled] if (customization.key? :JoinDomainEnabled)
+                      xml.UseOrgSettings customization[:UseOrgSettings] if (customization.key? :UseOrgSettings)
+                      xml.DomainName customization[:DomainName] if (customization.key? :DomainName)
+                      xml.DomainUserName customization[:DomainUserName] if (customization.key? :DomainUserName)
+                      xml.DomainUserPassword customization[:DomainUserPassword] if (customization.key? :DomainUserPassword)
+                      xml.MachineObjectOU customization[:MachineObjectOU] if (customization.key? :MachineObjectOU)
+                      xml.AdminPasswordEnabled customization[:AdminPasswordEnabled] if (customization.key? :AdminPasswordEnabled)
+                      xml.AdminPasswordAuto customization[:AdminPasswordAuto] if (customization.key? :AdminPasswordAuto)
+                      xml.AdminPassword customization[:AdminPassword] if (customization.key? :AdminPassword)
+                      xml.ResetPasswordRequired customization[:ResetPasswordRequired] if (customization.key? :ResetPasswordRequired)
+                      xml.CustomizationScript CGI::escapeHTML(customization[:CustomizationScript]).gsub(/\r/, "
") if (customization.key? :CustomizationScript)
+                      xml.ComputerName customization[:ComputerName]
+                    }
+                  end
+                }
+                xml.StorageProfile(:href => vm[:StorageProfileHref]) if (vm.key? :StorageProfileHref)
+              }
+            end if vms
+
+            templates = @configuration[:source_templates]
+            templates.each do |template|
+              xml.SourcedItem { xml.Source(:href => template[:href]) }
+            end if templates
+
+            xml.AllEULAsAccepted (@configuration[:AllEULAsAccepted] || true)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'fog/vcloud_director/generators/compute/compose_common'
+
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # @see http://pubs.vmware.com/vcd-51/index.jsp#types/ComposeVAppParamsType.html
+        class ComposeVapp
+
+          include ComposeCommon
+
+          def generate_xml
+            Nokogiri::XML::Builder.new do |xml|
+              xml.ComposeVAppParams(vapp_attrs) {
+                build_vapp_instantiation_params(xml)
+                build_source_items(xml)
+              }
+            end.to_xml
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # @see http://pubs.vmware.com/vcd-56/topic/com.vmware.ICbase/PDF/vcd_56_api_guide.pdf @page 121
+        class CreateSnapshot
+          attr_reader :attrs
+
+          def initialize(attrs={})
+            @attrs = attrs
+          end
+
+          def generate_xml
+            attrs = @attrs
+            Nokogiri::XML::Builder.new do
+              CreateSnapshotParams('xmlns' => 'http://www.vmware.com/vcloud/v1.5', 'memory' => attrs[:memory], 'name' => attrs[:name], 'quiesce' => attrs[:quiesce]) {
+                Description attrs[:Description] if attrs.key?(:Description)
+              }
+            end.to_xml
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # This is the data structure it accepts, this is the output of
+        # #get_vm_customization:
+        #
+        #   {:type=>"application/vnd.vmware.vcloud.guestCustomizationSection+xml",
+        #    :href=>
+        #     "https://example.com/api/vApp/vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64/guestCustomizationSection/",
+        #    :id=>"vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+        #    :enabled=>false,
+        #    :change_sid=>false,
+        #    :virtual_machine_id=>"2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+        #    :join_domain_enabled=>false,
+        #    :use_org_settings=>false,
+        #    :admin_password_enabled=>false,
+        #    :admin_password_auto=>true,
+        #    :reset_password_required=>false,
+        #    :customization_script=>"hola\nmundo",
+        #    :has_customization_script=>true,
+        #    :computer_name=>"DEVWEB-001"}
+        #
+        # This is what it generates:
+        #
+        #   <vcloud:GuestCustomizationSection
+        #     xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+        #     xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+        #     href="https://vcloud.example.com/api/vApp/vm-55cc91f2-7e12-48d4-ad90-6f637a51fd88/guestCustomizationSection/"
+        #     ovf:required="false"
+        #     type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
+        #     <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
+        #     <vcloud:Enabled>true</vcloud:Enabled>
+        #     <vcloud:ChangeSid>true</vcloud:ChangeSid>
+        #     <vcloud:VirtualMachineId>55cc91f2-7e12-48d4-ad90-6f637a51fd88</vcloud:VirtualMachineId>
+        #     <vcloud:JoinDomainEnabled>false</vcloud:JoinDomainEnabled>
+        #     <vcloud:UseOrgSettings>false</vcloud:UseOrgSettings>
+        #     <vcloud:AdminPasswordEnabled>true</vcloud:AdminPasswordEnabled>
+        #     <vcloud:AdminPasswordAuto>true</vcloud:AdminPasswordAuto>
+        #     <vcloud:ResetPasswordRequired>false</vcloud:ResetPasswordRequired>
+        #     <vcloud:ComputerName>DEVWEB-001</vcloud:ComputerName>
+        #   </vcloud:GuestCustomizationSection>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/GuestCustomizationSectionType.html
+        class Customization
+          def initialize(attrs={})
+            @attrs = attrs
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            output << body(@attrs)
+            output << tail
+            output
+          end
+
+          private
+
+          def header
+            <<-END
+            <GuestCustomizationSection xmlns="http://www.vmware.com/vcloud/v1.5"
+              xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+              type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
+            END
+          end
+
+          # The order matters: http://communities.vmware.com/thread/448760?start=0&tstart=0
+          #
+          # CustomizationScript: Script to run on guest customization. You
+          # could use XML escape sequence &#13; to make multiple lines script.
+          # The script could contain any UNICODE symbol by specifying its
+          # number in format &#xxxx; where xxxx is the number. The predefined
+          # symbols in the XML are:
+          #   * & &amp;
+          #   * < &lt;
+          #   * > &gt;
+          #   * " &quot;
+          #   * ' &apos;
+          def body(opts={})
+            <<-END
+              <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
+              <Enabled>#{opts[:enabled]}</Enabled>
+              <ChangeSid>#{opts[:change_sid]}</ChangeSid>
+              <VirtualMachineId>#{opts[:virtual_machine_id]}</VirtualMachineId>
+              <JoinDomainEnabled>#{opts[:join_domain_enabled]}</JoinDomainEnabled>
+              <UseOrgSettings>#{opts[:use_org_settings]}</UseOrgSettings>
+              <AdminPasswordEnabled>#{opts[:admin_password_enabled]}</AdminPasswordEnabled>
+              <AdminPasswordAuto>#{opts[:admin_password_auto]}</AdminPasswordAuto>
+              <ResetPasswordRequired>#{opts[:reset_password_required]}</ResetPasswordRequired>
+              <CustomizationScript>#{CGI::escapeHTML(opts[:customization_script]).gsub(/\r/, "&#13;")}</CustomizationScript>
+              <ComputerName>#{opts[:computer_name]}</ComputerName>
+            END
+          end
+
+          def tail
+            <<-END
+            </GuestCustomizationSection>
+            END
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # This is the data structure it accepts, this is the output of
+        # #get_vm_disks:
+        #
+        #   {:disks=>
+        #    [{:address=>0,
+        #      :description=>"SCSI Controller",
+        #      :name=>"SCSI Controller 0",
+        #      :id=>2,
+        #      :resource_sub_type=>"VirtualSCSI",
+        #      :resource_type=>6},
+        #     {:address_on_parent=>0,
+        #      :description=>"Hard disk",
+        #      :name=>"Hard disk 1",
+        #      :id=>2000,
+        #      :parent=>2,
+        #      :resource_type=>17,
+        #      :capacity=>16384,
+        #      :bus_sub_type=>"VirtualSCSI",
+        #      :bus_type=>6},
+        #     {:address=>0,
+        #      :description=>"IDE Controller",
+        #      :name=>"IDE Controller 0",
+        #      :id=>3,
+        #      :resource_type=>5}]}
+        #
+        # This is what it generates:
+        #
+        #   <vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+        #     xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+        #     type="application/vnd.vmware.vcloud.rasdItemsList+xml">
+        #     <vcloud:Item>
+        #       <rasd:Address>0</rasd:Address>
+        #       <rasd:Description>SCSI Controller</rasd:Description>
+        #       <rasd:ElementName>SCSI Controller 0</rasd:ElementName>
+        #       <rasd:InstanceID>2</rasd:InstanceID>
+        #       <rasd:ResourceSubType>VirtualSCSI</rasd:ResourceSubType>
+        #       <rasd:ResourceType>6</rasd:ResourceType>
+        #     </vcloud:Item>
+        #     <vcloud:Item>
+        #       <rasd:AddressOnParent>0</rasd:AddressOnParent>
+        #       <rasd:Description>Hard disk</rasd:Description>
+        #       <rasd:ElementName>Hard disk 1</rasd:ElementName>
+        #       <rasd:HostResource vcloud:capacity="16384" vcloud:busSubType="VirtualSCSI" vcloud:busType="6"></rasd:HostResource>
+        #       <rasd:InstanceID>2000</rasd:InstanceID>
+        #       <rasd:Parent>2</rasd:Parent>
+        #       <rasd:ResourceType>17</rasd:ResourceType>
+        #     </vcloud:Item>
+        #     <vcloud:Item>
+        #       <rasd:Address>0</rasd:Address>
+        #       <rasd:Description>IDE Controller</rasd:Description>
+        #       <rasd:ElementName>IDE Controller 0</rasd:ElementName>
+        #       <rasd:InstanceID>3</rasd:InstanceID>
+        #       <rasd:ResourceType>5</rasd:ResourceType>
+        #     </vcloud:Item>
+        #   </vcloud:RasdItemsList>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/RasdItemsListType.html
+        class Disks
+          def initialize(items=[])
+            @items = items[:disks]
+          end
+
+          def modify_hard_disk_size(disk_number, new_size)
+            found = false
+            @items.each do |item|
+              if item[:resource_type] == 17
+                if item[:name] == "Hard disk #{disk_number}"
+                  found = true
+                  raise "Hard disk size can't be reduced" if item[:capacity].to_i > new_size.to_i
+                  item[:capacity] = new_size
+                end
+              end
+            end
+            raise "Hard disk #{disk_number} not found" unless found
+            true
+          end
+
+          def add_hard_disk(size)
+            new_hard_disk = last_hard_disk.dup
+            new_hard_disk[:capacity] = size
+            new_hard_disk[:name] = increase_hard_disk_name(new_hard_disk[:name])
+            new_hard_disk[:address_on_parent] += 1
+            new_hard_disk[:id] += 1
+            @items << new_hard_disk
+          end
+
+          def delete_hard_disk(disk_number)
+            @items.delete_if {|item| item[:resource_type] == 17 && item[:name] =~ /#{disk_number}$/ }
+          end
+
+          def disks
+            { :disks => @items }
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            @items.each do |item|
+              output << case item[:resource_type]
+                        when 6
+                          scsi_controller(item)
+                        when 17
+                          hard_disk_item(item)
+                        when 5
+                          ide_controller_item(item)
+                        end
+            end
+            output << tail
+            output
+          end
+
+          def header
+            <<-END
+            <vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+              xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+              type="application/vnd.vmware.vcloud.rasdItemsList+xml">
+            END
+          end
+
+          def tail
+            <<-END
+            </vcloud:RasdItemsList>
+            END
+          end
+
+          def hard_disk_item(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:AddressOnParent>#{opts[:address_on_parent]}</rasd:AddressOnParent>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:HostResource vcloud:capacity=\"#{opts[:capacity]}\" vcloud:busSubType=\"#{opts[:bus_sub_type]}\" vcloud:busType=\"#{opts[:bus_type]}\"></rasd:HostResource>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:Parent>#{opts[:parent]}</rasd:Parent>
+              <rasd:ResourceType>17</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          def ide_controller_item(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:Address>#{opts[:address]}</rasd:Address>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:ResourceType>5</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          def scsi_controller(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:Address>#{opts[:address]}</rasd:Address>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:ResourceSubType>#{opts[:resource_sub_type]}</rasd:ResourceSubType>
+              <rasd:ResourceType>6</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          # helpers
+
+          def last_hard_disk
+             hard_disks = @items.select{|item| item[:resource_type] == 17}
+             names = hard_disks.map{|item| item[:name] }
+             only_numbers = names.map{|b| b.scan(/\d+/).first.to_i} # extract numbers
+             last_number = only_numbers.sort.last # get the last number
+             hard_disks.find{|hard_disk| hard_disk[:name] =~ /#{last_number}$/  }
+          end
+
+          def increase_hard_disk_name(hard_disk_name)
+            hard_disk_name.gsub(/(\d+)$/) { $1.to_i + 1 }
+          end
+        end
+      end
+    end
+  end
+end