fog-vcloud-director 0.1.0

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

@@ -0,0 +1,168 @@
+require 'date'
+
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a task.
+        #
+        # @param [String] id The object identifier of the task.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :id<~String> - The entity identifier, expressed in URN format.
+        #       The value of this attribute uniquely identifies the entity,
+        #       persists for the life of the entity, and is never reused.
+        #     * :operationKey<~String> - Optional unique identifier to support
+        #       idempotent semantics for create and delete operations.
+        #     * :name<~String> - The name of the entity.
+        #     * :cancelRequested<~String> - Whether user has requested this
+        #       processing to be canceled.
+        #     * :endTime<~String> - The date and time that processing of the
+        #       task was completed. May not be present if the task is still
+        #       being executed.
+        #     * :expiryTime<~String> - The date and time at which the task
+        #       resource will be destroyed and no longer available for
+        #       retrieval. May not be present if the task has not been executed
+        #       or is still being executed.
+        #     * :operation<~String> - A message describing the operation that
+        #       is tracked by this task.
+        #     * :operationName<~String> - The short name of the operation that
+        #       is tracked by this task.
+        #     * :serviceNamespace<~String> - Identifier of the service that
+        #       created the task.
+        #     * :startTime<~String> - The date and time the system started
+        #       executing the task. May not be present if the task has not been
+        #       executed yet.
+        #     * :status<~String> - The execution status of the task.
+        #     * :Link<~Array<Hash>>:
+        #     * :Description<~String> - Optional description.
+        #     * :Owner<~Hash> - Reference to the owner of the task. This is
+        #       typically the object that the task is creating or updating.
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :name<~String> - Contains the name of the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #     * :Error<~Hash> - Represents error information from a failed
+        #       task.
+        #       * :majorErrorCode<~String> - The class of the error. Matches
+        #         the HTTP status code.
+        #       * :message<~String> - An one line, human-readable message
+        #         describing the error that occurred.
+        #       * :minorErrorCode<~String> - Resource-specific error code.
+        #       * :stackTrace<~String> - The stack trace of the exception.
+        #       * :vendorSpecificErrorCode<~String> - A vendor- or
+        #         implementation-specific error code that can reference
+        #         specific modules or source lines for diagnostic purposes.
+        #     * :User<~Hash> - The user who started the task.
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :name<~String> - Contains the name of the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #     * :Organization<~Hash> - The organization to which the :User
+        #       belongs.
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :name<~String> - Contains the name of the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #     * :Progress<~String> - Read-only indicator of task progress as an
+        #       approximate percentage between 0 and 100. Not available for all
+        #       tasks.
+        #     * :Params
+        #     * :Details<~String> - Detailed message about the task. Also
+        #       contained by the :Owner entity when task status is preRunning.
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Task.html
+        # @since vCloud API version 0.9
+        def get_task(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "task/#{id}"
+          )
+
+          # vCloud Director bug: Owner may be absent for some tasks, fix
+          # targeted for 5.1.3 (due out at the beginning Q1 2014).
+          #
+          # We'd prefer that Owner is always present; if nothing else, this
+          # let's the tests pass.
+          response.body[:Owner] ||= {:href => '', :name => nil, :type => nil}
+
+          response
+        end
+      end
+
+      class Mock
+        def get_task(id)
+          unless data[:tasks][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location
+          }.merge(task_body(id))
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Type' => "application/#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+
+        private
+
+        # @param [String] id Object identifier of the task.
+        # @return [Hash]
+        def task_body(id)
+          task = data[:tasks][id]
+
+          body = {
+            :href => make_href("tasks/#{id}"),
+            :type => 'application/vnd.vmware.vcloud.task+xml',
+            :id => "urn:vcloud:tasl:#{id}",
+            :name => task[:name],
+            :cancelRequested => task[:cancel_requested].to_s,
+            :expiryTime => task[:expiry_time].strftime('%Y-%m-%dT%H:%M:%S%z'),
+            :operation => task[:operation],
+            :operationName => task[:operation_name],
+            :serviceNamespace => task[:service_namespace],
+            :status => task[:status],
+            :Link => [],
+            :Owner => task[:owner],
+            :User => { # for now, always the current user
+              :href => make_href("admin/user/#{user_uuid}"),
+              :name => user_name,
+              :type => 'application/vnd.vmware.admin.user+xml',
+            },
+            :Organization => { # for now, always the current org
+              :href => make_href("org/#{data[:org][:uuid]}"),
+              :name => data[:org][:name],
+              :type => 'application/vnd.vmware.vcloud.org+xml',
+            },
+            :Progress => task[:progress].to_s,
+            :Details => task[:details] || '',
+          }
+          body[:endTime] = task[:end_time].strftime('%Y-%m-%dT%H:%M:%S%z') if task[:end_time]
+          body[:startTime] = task[:start_time].strftime('%Y-%m-%dT%H:%M:%S%z') if task[:start_time]
+          body[:Description] = task[:description] if task[:description]
+
+          if task[:status] == 'running'
+            body[:Link] << {
+              :href => make_href("task/#{id}/action/cancel"),
+              :type => 'application/vnd.vmware.vcloud.task+xml',
+              :rel => 'cancel',
+            }
+          end
+
+          body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_tasks_list, :get_task_list
+
+        # Retrieve a list of this organization's queued, running, or recently
+        # completed tasks.
+        #
+        # @param [String] id Object identifier of the organization.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :id<~String> - The entity identifier, expressed in URN format.
+        #       The value of this attribute uniquely identifies the entity,
+        #       persists for the life of the entity, and is never reused.
+        #     * :name<~String> - The name of the entity.
+        #     * :Task<~Array<Hash>>:
+        #       * :href<~String> - The URI of the entity.
+        #       * :type<~String> - The MIME type of the entity.
+        #       * :id<~String> - The entity identifier, expressed in URN
+        #         format. The value of this attribute uniquely identifies the
+        #         entity, persists for the life of the entity, and is never
+        #         reused.
+        #       * :operationKey<~String> - Optional unique identifier to
+        #         support idempotent semantics for create and delete
+        #         operations.
+        #       * :name<~String> - The name of the entity.
+        #       * :cancelRequested<~String> - Whether user has requested this
+        #         processing to be canceled.
+        #       * :endTime<~String> - The date and time that processing of the
+        #         task was completed. May not be present if the task is still
+        #         being executed.
+        #       * :expiryTime<~String> - The date and time at which the task
+        #         resource will be destroyed and no longer available for
+        #         retrieval. May not be present if the task has not been
+        #         executed or is still being executed.
+        #       * :operation<~String> - A message describing the operation that
+        #         is tracked by this task.
+        #       * :operationName<~String> - The short name of the operation
+        #         that is tracked by this task.
+        #       * :serviceNamespace<~String> - Identifier of the service that
+        #         created the task.
+        #       * :startTime<~String> - The date and time the system started
+        #         executing the task. May not be present if the task has not
+        #         been executed yet.
+        #       * :status<~String> - The execution status of the task.
+        #       * :Link<~Array<Hash>>:
+        #       * :Description<~String> - Optional description.
+        #       * :Owner<~Hash> - Reference to the owner of the task. This is
+        #         typically the object that the task is creating or updating.
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #       * :Error<~Hash> - Represents error information from a failed
+        #         task.
+        #         * :majorErrorCode<~String> - The class of the error.  Matches
+        #           the HTTP status code.
+        #         * :message<~String> - An one line, human-readable message
+        #           describing the error that occurred.
+        #         * :minorErrorCode<~String> - Resource-specific error code.
+        #         * :stackTrace<~String> - The stack trace of the exception.
+        #         * :vendorSpecificErrorCode<~String> - A vendor- or
+        #           implementation-specific error code that can reference
+        #           specific modules or source lines for diagnostic purposes.
+        #       * :User<~Hash> - The user who started the task.
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #       * :Organization<~Hash> - The organization to which the :User
+        #         belongs.
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #       * :Progress<~String> - Read-only indicator of task progress as
+        #         an approximate percentage between 0 and 100. Not available
+        #         for all tasks.
+        #       * :Params
+        #       * :Details<~String> - Detailed message about the task. Also
+        #         contained by the :Owner entity when task status is
+        #         preRunning.
+        #
+        # @raise [Fog::Compute::VcloudDirector::BadRequest]
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-TaskList.html
+        # @since vCloud API version 0.9
+        def get_task_list(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "tasksList/#{id}"
+          )
+          ensure_list! response.body, :Task
+          response
+        end
+      end
+
+      class Mock
+        def get_task_list(id)
+          unless id == data[:org][:uuid]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"com.vmware.vcloud.entity.org:#{id}\"."
+            )
+          end
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location,
+            :href => make_href("tasksList/#{id}"),
+            :type => "application/vnd.vmware.vcloud.tasksList+xml",
+            :name => "Tasks Lists",
+            :Task => data[:tasks].keys.map {|task_id| task_body(task_id)}
+          }
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        require 'fog/vcloud_director/parsers/compute/vm'
+
+        # Retrieve a vApp or VM.
+        #
+        # @note This should probably be deprecated.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see #get_vapp
+        def get_vm(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Compute::VcloudDirector::Vm.new,
+            :path       => "vAppTemplate/#{id}"
+          )
+        end
+      end
+      class Mock
+        def get_vm(id)
+          vapp = get_vapp(id).body
+          vm = parse_vapp_to_vm(vapp)
+          body = {:type => vapp[:type], :vm => vm}
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+        
+        # Mock equivalent of Fog::Parsers::Compute::VcloudDirector::Vm
+        def parse_vapp_to_vm(vapp)
+          parser = Fog::Parsers::Compute::VcloudDirector::Vm.new
+          vm = vapp.select {|k| [:href, :name, :status, :type].include? k}
+          network = vapp[:NetworkConnectionSection]
+          vm.merge({
+            :id => vapp[:href].split('/').last,
+            :status => parser.human_status(vapp[:status]),
+            :ip_address => network[:NetworkConnection][:IpAddress],
+            :description => vapp[:Description],
+            :cpu => get_hardware(vapp, 3),
+            :memory => get_hardware(vapp, 4),
+            :disks => get_disks(vapp),
+            :links => [vapp[:GuestCustomizationSection][:Link]],
+          })
+        end
+        
+        def get_hardware(vapp, resource_type)
+          hardware = vapp[:"ovf:VirtualHardwareSection"][:"ovf:Item"]
+          item = hardware.find {|h| h[:"rasd:ResourceType"].to_i == resource_type}
+          if item and item.key? :"rasd:VirtualQuantity"
+            item[:"rasd:VirtualQuantity"].to_i
+          else
+            nil
+          end
+        end
+        
+        def get_disks(vapp)
+          hardware = vapp[:"ovf:VirtualHardwareSection"][:"ovf:Item"]
+          disks = hardware.select {|h| h[:"rasd:ResourceType"].to_i == 17}
+          disks.map {|d| {d[:"rasd:ElementName"] => d[:"rasd:HostResource"][:ns12_capacity].to_i}}
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        require 'fog/vcloud_director/parsers/compute/vms'
+
+        # Retrieve a vApp or VM.
+        #
+        # @note This should probably be deprecated.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see #get_vapp
+        def get_template_vms(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Compute::VcloudDirector::Vms.new,
+            :path       => "vAppTemplate/#{id}"
+          )
+        end
+      end
+      class Mock
+        def get_vms(id)
+          vapptemplate = get_vapp(id).body
+          parser = Fog::Parsers::Compute::VcloudDirector::Vms.new
+          vms  = vapp[:Children][:Vm].map {|child| parse_vapp_to_vm(child) }
+          body = {:type => vapp[:type], :vms => vms}
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a thumbnail image of a VM console.
+        #
+        # The content type of the response can be any of `image/png`,
+        # `image/gif`.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~String> - the thumbnail image.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Thumbnail.html
+        # @since vCloud API version 0.9
+        def get_thumbnail(id)
+          request(
+            :expects    => 200,
+            :headers    => {'Accept' => "image/*;version=#{@api_version}"},
+            :idempotent => true,
+            :method     => 'GET',
+            :path       => "vApp/#{id}/screen"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of users for organization the org admin belongs to
+        # by using REST API general QueryHandler.
+        #
+        # @param [Hash] options
+        # @option options [String] :sortAsc (Sorted by database ID) Sort
+        #   results by attribute-name in ascending order. attribute-name cannot
+        #   include metadata.
+        # @option options [String] :sortDesc (Sorted by database ID) Sort
+        #   results by attribute-name in descending order. attribute-name
+        #   cannot include metadata.
+        # @option options [Integer] :page (1) If the query results span
+        #   multiple pages, return this page.
+        # @option options [Integer] :pageSize (25) Number of results per page,
+        #   to a maximum of 128.
+        # @option options [String] :format (records) One of the following
+        #   types:
+        #   - *references* Returns a reference to each object, including its
+        #     :name, :type, and :href attributes.
+        #   - *records* Returns all database records for each object, with each
+        #     record as an attribute.
+        #   - *idrecords* Identical to the records format, except that object
+        #     references are returned in :id format rather than :href format.
+        # @option options [Array<String>] :fields (all static attribute names)
+        #   List of attribute names or metadata key names to return.
+        # @option options [Integer] :offset (0) Integer value specifying the
+        #   first record to return. Record numbers < offset are not returned.
+        # @option options [String] :filter (none) Filter expression.
+        # @return [Excon::Response]
+        #   * hash<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :name<~String> - Query name that generated this result set.
+        #     * :page<~String> - Page of the result set that this container
+        #       holds. The first page is page number 1.
+        #     * :pageSize<~String> - Page size, as a number of records or
+        #       references.
+        #     * :total<~String> - Total number of records or references in the
+        #       container.
+        #     * :Link<~Array<Hash>>:
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #       * :rel<~String> - Defines the relationship of the link to the
+        #         object that contains it.
+        #     * :UserRecord<~Array<Hash>>:
+        #       * TODO
+        #     * :firstPage<~Integer> - First page in the result set.
+        #     * :previousPage<~Integer> - Previous page in the result set.
+        #     * :nextPage<~Integer> - Next page in the result set.
+        #     * :lastPage<~Integer> - Last page in the result set.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-UsersFromQuery-query.html
+        # @since vCloud API version 1.5
+        def get_users_from_query(options={})
+          query = []
+          query << "sortAsc=#{options[:sortAsc]}" if options[:sortAsc]
+          query << "sortDesc=#{options[:sortDesc]}" if options[:sortDesc]
+          query << "page=#{options[:page]}" if options[:page]
+          query << "pageSize=#{options[:pageSize]}" if options[:pageSize]
+          query << "format=#{options[:format]}" if options[:format]
+          query << "fields=#{Array(options[:fields]).join(',')}" if options[:fields]
+          query << "offset=#{options[:offset]}" if options[:offset]
+          query << "filter=#{options[:filter]}" if options[:filter]
+
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'admin/users/query',
+            :query      => query.map {|q| URI.escape(q)}.join('&')
+          )
+          ensure_list! response.body, :Link
+          ensure_list! response.body,
+            response.body[:type] == 'application/vnd.vmware.vcloud.query.references+xml' ?
+              :UserReference : :UserRecord
+
+          %w[firstPage previousPage nextPage lastPage].each do |rel|
+            if link = response.body[:Link].find {|l| l[:rel] == rel}
+              href = Nokogiri::XML.fragment(link[:href])
+              query = CGI.parse(URI.parse(href.text).query)
+              response.body[rel.to_sym] = query['page'].first.to_i
+              response.body[:pageSize] ||= query['pageSize'].first.to_i
+            end
+          end
+
+          response
+        end
+      end
+    end
+  end
+end