fog 1.16.0 → 1.17.0

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

@@ -7,6 +7,17 @@ module Fog
         # @param [String] id Object identifier of the media object.
         # @return [Excon::Response]
         #   * body<~Hash>:
+        #     * :href<~String> - The URI of the media object.
+        #     * :type<~String> - The MIME type of the media object.
+        #     * :Link<~Hash>:
+        #       * :href<~String> -
+        #       * :type<~String> -
+        #       * :rel<~String> -
+        #     * :User<~Hash> - Reference to the user who is the owner of this
+        #       media object.
+        #       * :href<~String> - The URI of the user.
+        #       * :name<~String> - The name of the user.
+        #       * :type<~String> - The MIME type of the user.
         #
         # @raise [Fog::Compute::VcloudDirector::Forbidden]
         #
@@ -25,14 +36,33 @@ module Fog
 
       class Mock
         def get_media_owner(id)
-          unless media = data[:medias][id]
+          unless data[:medias][id]
             raise Fog::Compute::VcloudDirector::Forbidden.new(
-              "No access to entity \"com.vmware.vcloud.entity.media:#{id}\"."
+              'No access to entity "com.vmware.vcloud.entity.media:%s".' % id
             )
           end
 
-          Fog::Mock.not_implemented
-          media.is_used_here # avoid warning from syntax checker
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location,
+            :Link => {
+              :href => make_href("media/#{id}"),
+              :type => 'application/vnd.vmware.vcloud.media+xml',
+              :rel => 'up'
+            },
+            :User => {
+              :href => make_href("admin/user/#{user_uuid}"),
+              :name => user_name,
+              :type => 'application/vnd.vmware.admin.user+xml',
+            }
+          }
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{@version}"},
+            :body => body
+          )
         end
       end
     end

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

@@ -1,3 +1,5 @@
+require 'date'
+
 module Fog
   module Compute
     class VcloudDirector
@@ -7,6 +9,66 @@ module Fog
         # @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]
         #
@@ -25,14 +87,71 @@ module Fog
 
       class Mock
         def get_task(id)
-          unless task = data[:tasks][id]
+          unless data[:tasks][id]
             raise Fog::Compute::VcloudDirector::Forbidden.new(
               'This operation is denied.'
             )
           end
 
-          Fog::Mock.not_implemented
-          task.is_used_here # avoid warning from syntax checker
+          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

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

@@ -11,7 +11,78 @@ module Fog
         # @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
@@ -37,43 +108,15 @@ module Fog
             )
           end
 
-          body =
-            {:xmlns=>xmlns,
-             :xmlns_xsi=>xmlns_xsi,
-             :name=>"Tasks Lists",
-             :type=>"application/vnd.vmware.vcloud.tasksList+xml",
-             :href=>make_href("tasksList/#{id}"),
-             :xsi_schemaLocation=>xsi_schema_location}
-
-          tasks = data[:tasks].map do |task_id, task|
-            {:status => task[:status],
-             :startTime => task[:startTime].iso8601,
-             :operationName => task[:operationName],
-             :operation => task[:operation],
-             :expiryTime => task[:expiryTime].utc.iso8601,
-             :endTime => task[:endTime].iso8601,
-             :cancelRequested => task[:cancelRequested].to_s,
-             :name => task[:name],
-             :id => "urn:vcloud:task:#{id}",
-             :type => 'application/vnd.vmware.vcloud.task+xml',
-             :href => make_href("task/#{task_id}"),
-             :Owner =>
-              {:type => "application/vnd.vmware.vcloud.vApp+xml",
-               :name => "vApp_#{user_name}_0",
-               :href=> make_href("vApp/vapp-#{uuid}")},
-             :User =>
-              {:type => "application/vnd.vmware.admin.user+xml",
-               :name => user_name,
-               :href => make_href("admin/user/#{user_uuid}")},
-             :Organization =>
-              {:type => "application/vnd.vmware.vcloud.org+xml",
-               :name => org_name,
-               :href => make_href("org/#{org_uuid}")},
-             :Progress => task[:Progress].to_s,
-             :Details => task[:Details] || ''}
-          end
-          tasks = tasks.first if tasks.size == 1
-          body[:Task] = tasks
+          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,

data/lib/fog/vcloud_director/requests/compute/{get_vms_disks_attached_to.rb → get_vms_disk_attached_to.rb}

@@ -10,14 +10,28 @@ module Fog
         #
         # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VmsDisksAttachedTo.html
         # @since vCloud API version 5.1
-        def get_vms_disks_attached_to(id)
-          request(
+        def get_vms_disk_attached_to(id)
+          response = request(
             :expects    => 200,
             :idempotent => true,
             :method     => 'GET',
             :parser     => Fog::ToHashDocument.new,
             :path       => "disk/#{id}/attachedVms"
           )
+          ensure_list! response.body, :VmReference
+          response
+        end
+      end
+
+      class Mock
+        def get_vms_disk_attached_to(id)
+          unless data[:disks][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'No access to entity "com.vmware.vcloud.entity.disk:%s".' % id
+            )
+          end
+
+          Fog::Mock.not_implemented
         end
       end
     end

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

@@ -20,6 +20,24 @@ module Fog
           )
         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_clone_media.rb

@@ -36,7 +36,7 @@ module Fog
             }
           end.to_xml
 
-          request(
+          response = request(
             :body    => body,
             :expects => 201,
             :headers => {'Content-Type' => 'application/vnd.vmware.vcloud.cloneMediaParams+xml'},
@@ -44,6 +44,57 @@ module Fog
             :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