fog-vcloud-director 0.1.0

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

@@ -0,0 +1,173 @@
+require 'builder'
+
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        require 'fog/vcloud_director/generators/compute/instantiate_vapp_template_params'
+        # Create a vApp from a vApp template.
+        #
+        # The response includes a Task element. You can monitor the task to to
+        # track the creation of the vApp.
+        #
+        # @param [String] vapp_name
+        # @param [String] template_id
+        # @param [Hash] options
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-InstantiateVAppTemplate.html
+        # @since vCloud API version 0.9
+        def instantiate_vapp_template(vapp_name, template_id, options={})
+          params = populate_uris(options.merge(:vapp_name => vapp_name, :template_id => template_id))
+
+          # @todo Move all the logic to a generator.
+          data = generate_instantiate_vapp_template_request(params)
+
+          request(
+            :body    => data,
+            :expects => 201,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vdc/#{params[:vdc_id]}/action/instantiateVAppTemplate"
+          )
+        end
+
+        private
+
+        def populate_uris(options = {})
+          options[:vdc_id] || raise("vdc_id option is required")
+          options[:vdc_uri] =  vdc_end_point(options[:vdc_id])
+          options[:network_uri] = network_end_point(options[:network_id]) if options[:network_id]
+          options[:template_uri] = vapp_template_end_point(options[:template_id]) || raise("template_id option is required")
+          options
+        end
+
+        def generate_instantiate_vapp_template_request(options ={})        
+          
+          #overriding some params so they work with new standardised generator
+          options[:InstantiationParams] = 
+          {
+            :NetworkConfig => 
+              [{
+              :networkName => options[:network_name],
+              :networkHref => options[:network_uri],
+              :fenceMode => 'bridged'
+              }]
+          } unless options[:InstantiationParams]
+          options[:name] = options.delete(:vapp_name) if options[:vapp_name]
+          options[:Description] = options.delete(:description) unless options[:Description]
+          if options[:vms_config] then
+            options[:source_vms] = options.delete(:vms_config)
+            options[:source_vms].each_with_index {|vm, i|options[:source_vms][i][:StorageProfileHref] = options[:source_vms][i].delete(:storage_profile_href) }
+          end
+          options[:Source] = options.delete(:template_uri) if options[:template_uri]
+            
+              
+
+          
+          Fog::Generators::Compute::VcloudDirector::InstantiateVappTemplateParams.new(options).generate_xml
+
+
+
+        end
+
+        def xmlns
+          {
+            'xmlns'     => "http://www.vmware.com/vcloud/v1.5",
+            "xmlns:ovf" => "http://schemas.dmtf.org/ovf/envelope/1",
+            "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+            "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema"
+          }
+        end
+
+        def vdc_end_point(vdc_id = nil)
+          end_point + ( vdc_id ? "vdc/#{vdc_id}" : "vdc" )
+        end
+
+        def network_end_point(network_id = nil)
+          end_point + ( network_id ? "network/#{network_id}" : "network" )
+        end
+
+        def vapp_template_end_point(vapp_template_id = nil)
+          end_point + ( vapp_template_id ? "vAppTemplate/#{vapp_template_id}" : "vAppTemplate" )
+        end
+
+        def endpoint
+          end_point
+        end
+      end
+      
+      class Mock
+        # Assume the template is a single VM with one network interface and one disk.
+        def instantiate_vapp_template(vapp_name, template_id, options={})          
+          unless data[:catalog_items].values.find {|i| i[:template_id] == template_id}
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'No such template.'
+            )
+          end
+          unless vdc = data[:vdcs][options[:vdc_id]]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'No such VDC.'
+            )
+          end
+          
+          vapp_uuid = uuid
+          vapp_id   = "vapp-#{vapp_uuid}"
+          owner = {
+            :href => make_href("vApp/#{vapp_id}"),
+            :type => 'application/vnd.vmware.vcloud.vm+xml'
+          }
+          task_id = enqueue_task(
+            "Creating Virtual Application #{vapp_name}(#{vapp_uuid})", 'vdcInstantiateVapp', owner,
+            :on_success => lambda do
+              # Add to the VDC
+              data[:vapps][vapp_id] = {
+                :name => vapp_name,
+                :vdc_id => options[:vdc_id],
+                :description => 'From Template',
+                :networks => [
+                  {:parent_id => default_network_uuid }
+                ]
+              }
+              vm_id = "vm-#{uuid}"
+              data[:vms][vm_id] = {
+                :name => vapp_name,
+                :parent_vapp => vapp_id,
+                :nics => [
+                  {
+                    :network_name => 'Default Network',
+                    :mac_address  => '7d:68:a2:a0:a4:f8',
+                    :ip_address   => nil
+                  }
+                ]
+              }
+              data[:disks][uuid] = {
+                :name => 'Hard Disk 1',
+                :capacity => 10240,
+                :parent_vm => vm_id
+              }
+            end
+          )
+          body = {
+            :href => make_href("vApp/#{vapp_id}"),
+            :Tasks => {
+              :Task => {
+                :xmlns => xmlns,
+                :xmlns_xsi => xmlns_xsi,
+                :xsi_schemaLocation => xsi_schema_location,
+              }.merge(task_body(task_id))
+            }
+          }
+
+          Excon::Response.new(
+            :status => 202,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a screen ticket that you can use with the VMRC browser
+        # plug-in to gain access to the console of a running VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::Conflict]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-AcquireTicket.html
+        # @since vCloud API version 0.9
+        def post_acquire_ticket(id)
+          request(
+            :expects => 200,
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/screen/action/acquireTicket"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Answer a question being asked by a VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @param [Integer] choice_id Choice ID of this answer.
+        # @param [String] question_id Question ID of the question.
+        # @return [Excon::Response]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-AnswerVmPendingQuestion.html
+        # @since vCloud API version 0.9
+        def post_answer_pending_vm_question(id, choice_id, question_id)
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5'
+            }
+            VmAnswerQuestion(attrs) {
+              ChoiceId choice_id
+              QuestionId question_id
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 204, # this might be wrong
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.vmPendingAnswer+xml'},
+            :method  => 'POST',
+            :path    => "vApp/#{id}/quesiton/action/answer"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Attach a disk to a VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @param [String] disk_id Object identifier of the disk.
+        # @param [Hash] options
+        # @option options [Integer] :BusNumber Bus number on which to place the
+        #   disk controller. If empty or missing, the system assigns a bus
+        #   number and a unit number on that bus.
+        # @option options [Integer] :BusNumber Unit number (slot) on the bus
+        #   specified by :BusNumber. Ignored if :BusNumber is empty or missing.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-AttachDisk.html
+        # @since vCloud API version 5.1
+        def post_attach_disk(id, disk_id, options={})
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5'
+            }
+            DiskAttachOrDetachParams(attrs) {
+              Disk(:href => "#{end_point}disk/#{disk_id}")
+              if options.key?(:BusNumber)
+                BusNumber options[:BusNumber]
+              end
+              if options.key?(:UnitNumber)
+                BusNumber options[:UnitNumber]
+              end
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 202,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.diskAttachOrDetachParams+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/disk/action/attach"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :post_task_cancel, :post_cancel_task
+
+        # Cancel a task.
+        #
+        # @param [String] id Object identifier of the task.
+        # @return [Excon::Response]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-CancelTask.html
+        # @since vCloud API version 1.5
+        def post_cancel_task(id)
+          request(
+            :expects => 204,
+            :method  => 'POST',
+            :path    => "task/#{id}/action/cancel"
+          )
+        end
+      end
+
+      class Mock
+        def post_cancel_task(id)
+          unless task = data[:tasks][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'No access to entity "com.vmware.vcloud.entity.task:%s"' % id
+            )
+          end
+
+          # @note Tasks don't actually get cancelled (confirmed VCloud Director
+          #   bug) so we'll emulate that. Set the flag and we're done!
+          task[:cancel_requested] = true
+
+          Excon::Response.new(
+            :status => 204
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Create a vApp template from a vApp.
+        #
+        # The response includes a Task element. You can monitor the task to to
+        # track the creation of the vApp template.
+        #
+        # @param [String] vdc_id Object identifier of the vDC.
+        # @param [String] name Name of the vApp template.
+        # @param [String] source_id Object identifier of the vApp to capture.
+        # @param [Hash] options
+        # @option options [String] :Description Optional description.
+        # @option options [Hash] :LeaseSettingsSection
+        #   * :StorageLeaseInSeconds<~Integer> - Storage lease in seconds.
+        # @option options [Hash] :CustomizationSection
+        #   * :goldMaster<~Boolean> - True if this template is a gold master.
+        #   * :CustomizeOnInstantiate<~Boolean> - True if instantiating this
+        #     template applies customization settings. Otherwise, instantiation
+        #     creates an identical copy.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-CaptureVApp.html
+        # @since vCloud API version 0.9
+        def post_capture_vapp(vdc_id, name, source_id, options={})
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5',
+              'xmlns:ovf' => 'http://schemas.dmtf.org/ovf/envelope/1',
+              :name => name
+            }
+            CaptureVAppParams(attrs) {
+              if options.key?(:Description)
+                Description options[:Description]
+              end
+              Source(:href => "#{end_point}vApp/#{source_id}")
+              if section = options[:LeaseSettingsSection]
+                LeaseSettingsSection {
+                  self['ovf'].Info 'Lease settings section'
+                  if section.key?(:StorageLeaseInSeconds)
+                    StorageLeaseInSeconds section[:StorageLeaseInSeconds]
+                  end
+                }
+              end
+              if section = options[:CustomizationSection]
+                attrs = {}
+                attrs[:goldMaster] = section[:goldMaster] if section.key?(:goldMaster)
+                CustomizationSection(attrs) {
+                  self['ovf'].Info 'VApp template customization section'
+                  CustomizeOnInstantiate section[:CustomizeOnInstantiate]
+                }
+              end
+            }
+          end.to_xml
+
+          request(
+            :body    => body,
+            :expects => 201,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.captureVAppParams+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vdc/#{vdc_id}/action/captureVApp"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Perform storage profile compliance check on a VM.
+        #
+        # This operation is asynchronous and return a task. When the task
+        # completes, the compliance check on the VM has been completed and the
+        # results can be retrieved.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-CheckVmCompliance.html
+        # @since vCloud API version 5.1
+        def post_check_vm_compliance(id)
+          request(
+            :expects => 202,
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/action/checkCompliance"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Create a copy of a media object.
+        #
+        # The response includes a Task element. You can monitor the task to to
+        # track the creation of the vApp template.
+        #
+        # @param [String] vdc_id Object identifier of the vDC.
+        # @param [String] source_id Object identifier of the source media
+        #   object.
+        # @param [Hash] options
+        # @option options [String] :Description Optional description.
+        # @option options [Boolean] :IsSourceDelete A value of true deletes the
+        #   Source object after successful completion of the copy operation.
+        #   Defaults to false if empty or missing.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/POST-CloneMedia.html
+        # @since vCloud API version 0.9
+        def post_clone_media(vdc_id, source_id, options={})
+          body = Nokogiri::XML::Builder.new do
+            attrs = {
+              :xmlns => 'http://www.vmware.com/vcloud/v1.5'
+            }
+            CloneMediaParams(attrs) {
+              if options.key?(:Description)
+                Description options[:Description]
+              end
+              Source(:href => "#{end_point}media/#{source_id}")
+              if options.key?(:IsSourceDelete)
+                IsSourceDelete options[:IsSourceDelete]
+              end
+            }
+          end.to_xml
+
+          response = request(
+            :body    => body,
+            :expects => 201,
+            :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.cloneMediaParams+xml'},
+            :method  => 'POST',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vdc/#{vdc_id}/action/cloneMedia"
+          )
+          ensure_list! response.body, :Files, :File
+          response
+        end
+      end
+
+      class Mock
+        def post_clone_media(vdc_id, source_id, options={})
+          # TODO: check this happens.
+          unless source_media = data[:medias][source_id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.media:#{source_id})\"."
+            )
+          end
+          unless data[:vdcs][vdc_id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.vdc:#{vdc_id})\"."
+            )
+          end
+
+          media_id = uuid
+          media_name = "#{source_media[:name]}-copy-#{uuid}"
+
+          owner = {
+            :href => make_href("media/#{media_id}"),
+            :type => 'application/vnd.vmware.vcloud.media+xml'
+          }
+          task_id = enqueue_task(
+            "Copy Media File #{media_name}(#{media_id})", 'vdcCopyMedia', owner,
+            :on_success => lambda do
+              data[:medias][media_id][:status] = 1
+            end
+          )
+
+          media = source_media.dup.merge(
+            :name => media_name,
+            :status => 0,
+            :tasks => [task_id]
+          )
+          data[:medias][media_id] = media
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location
+          }.merge(media_body(media_id))
+
+          Excon::Response.new(
+            :status => 201,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end