fog-vcloud-director 0.1.0

data/lib/fog/vcloud_director/requests/compute/get_vapp.rb

@@ -0,0 +1,176 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a vApp or VM.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VApp.html
+        # @since vCloud API version 0.9
+        def get_vapp(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}"
+          )
+          ensure_list! response.body, :Children, :Vm
+          response
+        end
+      end
+
+      class Mock
+
+        def get_vapp(id)
+
+          # Retrieve a vApp or VM.
+          #
+
+          case id
+          when /^vapp-/
+            body = get_mock_vapp_body(id)
+          when /^vm-/
+            body = get_mock_vm_body(id)
+          else
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+
+        end
+
+        def get_mock_vm_body(id)
+          unless vm = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body = {
+            :name => vm[:name],
+            :href => make_href("vApp/#{id}"),
+            :type => "application/application/vnd.vmware.vcloud.vm+xml",
+            :status => vm[:status],
+            :deployed => vm[:deployed],
+            :needsCustomization => vm[:needs_customization],
+            :Description => vm[:description],
+            :"ovf:VirtualHardwareSection" => get_vm_virtual_hardware_section_body(id, vm),
+            :"ovf:OperatingSystemSection" => get_vm_operating_system_section_body(id, vm),
+            :NetworkConnectionSection     => get_vm_network_connection_section_body(id, vm),
+            :GuestCustomizationSection    => get_vm_guest_customization_section_body(id, vm),
+            :RuntimeInfoSection           => get_vm_runtime_info_section_body(id, vm),
+            :SnapshotSection              => get_snapshot_section_body(id),
+            :DateCreated       => vm[:date_created], # eg "2014-03-16T10:52:31.874Z"
+            :VAppScopedLocalId => vm[:parent_vapp].split('-').last, # strip the vapp- prefix
+            :"ovfenv:Environment" => get_vm_ovfenv_environment_section_body(id, vm),
+            :VmCapabilities => get_vm_capabilities_section_body(id, vm),
+            :StorageProfile => get_vm_storage_profile_section_body(id, vm),
+          }
+          body
+        end
+
+        def get_mock_vapp_body(id)
+
+          unless vapp = data[:vapps][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body = {
+            :deployed => "true",
+            :status => vapp[:status],
+            :name => vapp[:name],
+            :type => "application/vnd.vmware.vcloud.vApp+xml",
+            :href => make_href("vApp/#{id}"),
+            :LeaseSettingsSection => get_vapp_lease_settings_section_body(id),
+            :"ovf:StartupSection" => get_vapp_ovf_startup_section_body(id, vapp),
+            :"ovf:NetworkSection" => get_vapp_ovf_network_section_body(id, vapp),
+            :NetworkConfigSection => get_vapp_network_config_section_body(id, vapp),
+            :SnapshotSection      => get_snapshot_section_body(id),
+            :DateCreated => vapp[:date_created], # eg "2014-03-16T10:52:31.874Z"
+            :Owner => get_owner_section_body(id),
+            :InMaintenanceMode => "false",
+            :Children => {
+              :Vm => get_vapp_children_vms_body(id)
+            },
+          }
+          body
+        end
+
+        def get_vapp_ovf_network_section_body(id, vapp)
+          {}
+        end
+
+        def get_vapp_children_vms_body(id)
+          child_vms = data[:vms].select do |vm_id, vm_details|
+            vm_details[:parent_vapp] == id
+          end
+          if RUBY_VERSION.to_f < 1.9
+            # 1.8 Hash.select returns an Array of [k,v] pairs.
+            child_vms = Hash[child_vms]
+          end
+          child_vms.keys.collect do |vm_id|
+            get_mock_vm_body(vm_id)
+          end
+        end
+
+        def get_vm_ovfenv_environment_section_body(id, vm)
+          # TODO: I'm pretty sure this is just repeating info in other
+          # sections, and the OVF part of VMs is extremely verbose. It's
+          # likely to not be needed in Mock mode
+          {}
+        end
+
+        def get_vm_storage_profile_section_body(id, vm)
+          {
+            :type => "application/vnd.vmware.vcloud.vdcStorageProfile+xml",
+            :name => "Mock Storage Profile",
+            :href => make_href("vdcStorageProfile/12345678-1234-1234-1234-1234500e49a8"),
+          }
+        end
+
+        def get_vm_virtual_hardware_section_body(id, vm)
+
+          {:xmlns_ns12=>"http://www.vmware.com/vcloud/v1.5",
+           :ovf_transport=>"",
+           :ns12_href => make_href("vApp/#{id}/virtualHardwareSection/"),
+           :ns12_type=>"application/vnd.vmware.vcloud.virtualHardwareSection+xml",
+           :"ovf:Info"=>"Virtual hardware requirements",
+           :"ovf:System"=>{
+             :"vssd:ElementName"=>"Virtual Hardware Family",
+             :"vssd:InstanceID"=>"0",
+             :"vssd:VirtualSystemIdentifier" => vm[:name],
+             :"vssd:VirtualSystemType"=>"vmx-08"
+           },
+           :"ovf:Item" => get_vm_ovf_item_list(id, vm),
+          }
+        end
+
+        def get_vm_ovf_item_list(id, vm)
+          [
+            get_network_cards_rasd_items_list_body(id, vm),
+            get_disks_rasd_items_list_body(id, vm),
+            get_media_rasd_item_cdrom_body(id, vm),
+            get_media_rasd_item_floppy_body(id, vm),
+            get_cpu_rasd_item_body(id, vm),
+            get_memory_rasd_item_body(id, vm),
+          ].compact.flatten
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_metadata.rb

@@ -0,0 +1,84 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with the vApp or VM.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppMetadata.html
+        # @since vCloud API version 1.5
+        def get_vapp_metadata(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/metadata/"
+          )
+          ensure_list! response.body, :MetadataEntry
+          response
+        end
+      end
+
+      class Mock
+
+        def get_vapp_metadata(id)
+          unless vm_or_vapp = data[:vapps][id] || vm_or_vapp = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body = {
+            :xmlns=>xmlns,
+            :xmlns_xsi=>xmlns_xsi,
+            :type=>"application/vnd.vmware.vcloud.metadata+xml",
+            :href=>make_href("vApp/#{id}/metadata"),
+            :xsi_schemaLocation=>xsi_schema_location,
+            :Link=>
+             [{:rel=>"up",
+               :type=>"application/vnd.vmware.vcloud.vApp+xml",
+               :href=>make_href("/vApp/#{id}")},
+              {:rel=>"add",
+               :type=>"application/vnd.vmware.vcloud.metadata+xml",
+               :href=>make_href("vApp/#{id}/metadata")}],
+            :MetadataEntry=>get_metadata_entries(vm_or_vapp[:metadata], id)
+          }
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+
+        private
+
+        def get_metadata_entries(metadata, id)
+          metadata_entries = []
+
+          for key, value in metadata do
+          metadata_entries << {:type=>"application/vnd.vmware.vcloud.metadata.value+xml",
+              :href=>make_href("vApp/#{id}/metadata/#{key}"),
+              :Link=>
+                [{:rel=>"up",
+                  :type=>"application/vnd.vmware.vcloud.metadata+xml",
+                  :href=>make_href("vApp/#{id}/metadata")},
+                 {:rel=>"edit",
+                  :type=>"application/vnd.vmware.vcloud.metadata.value+xml",
+                  :href=>make_href("vApp/#{id}/metadata/#{key}")},
+                 {:rel=>"remove",
+                  :href=>make_href("vApp/#{id}/metadata/#{key}")}],
+              :Key=>"#{key}",
+              :TypedValue=>{:xsi_type=>"MetadataStringValue", :Value=>"#{metadata[key]}"}}
+          end
+          metadata_entries
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_metadata_item_metadata.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key from vApp or VM metadata.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @param [String] key Key of the metadata.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def get_vapp_metadata_item_metadata(id, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_ovf_descriptor.rb

@@ -0,0 +1,24 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the OVF descriptor of a vApp directly.
+        #
+        # @param [String] id Object identifier of the vApp.
+        # @return [Excon::Response]
+        #   * body<~String> - the OVF descriptor.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppOvfDescriptor.html
+        # @since vCloud API version 5.1
+        def get_vapp_ovf_descriptor(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :path       => "vApp/#{id}/ovf"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_owner.rb

@@ -0,0 +1,58 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the owner of a vApp.
+        #
+        # @param [String] id Object identifier of the vApp.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppOwner.html
+        # @since vCloud API version 1.5
+        def get_vapp_owner(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/owner"
+          )
+        end
+      end
+
+      class Mock
+        def get_vapp_owner(id)
+
+          type = 'application/vnd.vmware.vcloud.owner+xml'
+
+          unless vapp = data[:vapps][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{type};version=#{api_version}"},
+            :body => get_owner_section_body(id)
+          )
+
+        end
+
+        def get_owner_section_body(id)
+          {
+            :type => 'application/vnd.vmware.vcloud.owner+xml',
+            :User => {
+              :type => "application/vnd.vmware.admin.user+xml",
+              :name => "mockuser",
+              :href => make_href("user/12345678-1234-1234-1234-12345678df2b"),
+            }
+          }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_template.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a vApp template.
+        #
+        # @param [String] id Object identifier of the vApp template.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppTemplate.html
+        # @since vCloud API version 0.9
+        def get_vapp_template(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_template_customization_system_section.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves the customization section of a vApp template.
+        #
+        # @param [String] id Object identifier of the vApp template.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppTemplateCustomizationSystemSection.html
+        # @since vCloud API version 1.0
+        def get_vapp_template_customization_system_section(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/customizationSection"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_vapp_template_metadata.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with the vApp template or VM.
+        #
+        # @param [String] id Object identifier of the vApp template or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppTemplateMetadata.html
+        # @since vCloud API version 1.5
+        def get_vapp_template_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/metadata/"
+          )
+        end
+      end
+    end
+  end
+end