vmware-vra 3.1.2 → 3.2.0

data/lib/vra/client.rb

@@ -17,15 +17,15 @@
 # limitations under the License.
 #
 
-require 'ffi_yajl' unless defined?(FFI_Yajl)
-require 'passwordmasker'
-require 'vra/http'
+require "ffi_yajl" unless defined?(FFI_Yajl)
+require "passwordmasker"
+require "vra/http"
 
 module Vra
   class Client
-    REFRESH_TOKEN_URL = '/csp/gateway/am/api/login?access_token'
-    ACCESS_TOKEN_URL = '/iaas/api/login'
-    ROLES_URL = '/csp/gateway/am/api/loggedin/user/orgs'
+    REFRESH_TOKEN_URL = "/csp/gateway/am/api/login?access_token"
+    ACCESS_TOKEN_URL = "/iaas/api/login"
+    ROLES_URL = "/csp/gateway/am/api/loggedin/user/orgs"
 
     attr_accessor :page_size
 
@@ -33,7 +33,8 @@ module Vra
       @base_url      = opts[:base_url]
       @username      = opts[:username]
       @password      = PasswordMasker.new(opts[:password])
-      @tenant        = opts[:tenant]
+      @domain        = fetch_domain(opts)
+
       @verify_ssl    = opts.fetch(:verify_ssl, true)
       @refresh_token = PasswordMasker.new(nil)
       @access_token  = PasswordMasker.new(nil)
@@ -80,15 +81,15 @@ module Vra
       {
         'username': @username,
         'password': @password.value,
-        'tenant': @tenant
+        'domain': @domain,
       }
     end
 
     def request_headers
       headers                   = {}
-      headers['Accept']         = 'application/json'
-      headers['Content-Type']   = 'application/json'
-      headers['Authorization']  = 'Bearer ' + @access_token.value unless @access_token.value.nil?
+      headers["Accept"]         = "application/json"
+      headers["Content-Type"]   = "application/json"
+      headers["Authorization"]  = "Bearer " + @access_token.value unless @access_token.value.nil?
 
       headers
     end
@@ -96,7 +97,7 @@ module Vra
     def authorize!
       generate_access_token unless authorized?
 
-      raise Vra::Exception::Unauthorized, 'Unable to authorize against vRA' unless authorized?
+      raise Vra::Exception::Unauthorized, "Unable to authorize against vRA" unless authorized?
     end
 
     def authorized?
@@ -119,14 +120,14 @@ module Vra
       raise Vra::Exception::Unauthorized, "Unable to get the refresh token: #{refresh_response.body}" unless refresh_response.success_ok?
 
       refresh_response_body = FFI_Yajl::Parser.parse(refresh_response.body)
-      @refresh_token.value = refresh_response_body['refresh_token']
+      @refresh_token.value = refresh_response_body["refresh_token"]
 
       # Second Step: Sending the refresh token to a separate endpoint to get an Access Token
       access_response = http_post(ACCESS_TOKEN_URL, "{ \"refreshToken\": \"#{@refresh_token.value}\" }", :skip_auth)
       raise Vra::Exception::Unauthorized, "Unable to get the access token: #{access_response.body}" unless access_response.success_ok?
 
       access_response_body = FFI_Yajl::Parser.parse(access_response.body)
-      @access_token.value = access_response_body['token']
+      @access_token.value = access_response_body["token"]
     end
 
     def full_url(path)
@@ -231,7 +232,7 @@ module Vra
 
     def validate_client_options!
       raise ArgumentError, "Username and password are required" if @username.nil? || @password.value.nil?
-      raise ArgumentError, "A tenant is required" if @tenant.nil?
+      raise ArgumentError, "A domain is required" if @domain.nil?
       raise ArgumentError, "A base URL is required" if @base_url.nil?
       raise ArgumentError, "Base URL #{@base_url} is not a valid URI." unless valid_uri?(@base_url)
     end
@@ -242,5 +243,15 @@ module Vra
     rescue URI::InvalidURIError
       false
     end
+
+    private
+
+    # This is for backward compatibility, if someone still uses tenant key to pass the domain,
+    # it should also work.
+    def fetch_domain(opts)
+      return opts[:tenant] if opts.key?(:tenant) && !opts.key?(:domain)
+
+      opts[:domain]
+    end
   end
 end

data/lib/vra/deployment.rb

@@ -22,7 +22,7 @@ require "ffi_yajl" unless defined?(FFI_Yajl)
 module Vra
   # Class that represents the Deployment Object
   class Deployment
-    INDEX_URL = '/deployment/api/deployments'
+    INDEX_URL = "/deployment/api/deployments"
 
     attr_reader :id
 
@@ -35,40 +35,44 @@ module Vra
       if @data.nil?
         refresh
       elsif @id.nil?
-        @id = @data['id']
+        @id = @data["id"]
       end
     end
 
     def name
-      @data['name']
+      @data["name"]
     end
 
     def description
-      @data['description']
+      @data["description"]
     end
 
     def org_id
-      @data['orgId']
+      @data["orgId"]
     end
 
     def blueprint_id
-      @data['blueprintId']
+      @data["blueprintId"]
     end
 
     def owner
-      @data['ownedBy']
+      @data["ownedBy"]
     end
 
     def status
-      @data['status']
+      @data["status"]
     end
 
     def successful?
-      status == 'CREATE_SUCCESSFUL'
+      status == "CREATE_SUCCESSFUL"
     end
 
     def failed?
-      status == 'CREATE_FAILED'
+      status == "CREATE_FAILED"
+    end
+
+    def completion_details
+      requests.last.details
     end
 
     def completed?
@@ -80,16 +84,16 @@ module Vra
     end
 
     def action_id_by_name(action_name)
-      action = actions.find { |x| x['name'] == action_name}
+      action = actions.find { |x| x["name"] == action_name }
       return if action.nil?
 
-      action['id']
+      action["id"]
     end
 
     def resources
       response = client.get_parsed("/deployment/api/deployments/#{id}/resources")
 
-      response['content'].map! { |x| Vra::Resource.new(client, id, data: x) }
+      response["content"].map! { |x| Vra::Resource.new(client, id, data: x) }
     end
 
     def resource_by_id(res_id)
@@ -99,7 +103,7 @@ module Vra
     def requests
       response = client.get_parsed("/deployment/api/deployments/#{id}/requests")
 
-      response['content'].map! { |x| Vra::Request.new(client, id, id: x['id'], data: x) }
+      response["content"].map! { |x| Vra::Request.new(client, id, id: x["id"], data: x) }
     end
 
     def refresh
@@ -108,22 +112,22 @@ module Vra
       raise Vra::Exception::NotFound, "deployment with ID #{id} does not exist"
     end
 
-    def destroy(reason = '')
-      action_id = action_id_by_name('Delete')
+    def destroy(reason = "")
+      action_id = action_id_by_name("Delete")
       raise Vra::Exception::NotFound, "No destroy action found for resource #{@id}" if action_id.nil?
 
       submit_action_request(action_id, reason)
     end
 
-    def power_off(reason = '')
-      action_id = action_id_by_name('PowerOff')
+    def power_off(reason = "")
+      action_id = action_id_by_name("PowerOff")
       raise Vra::Exception::NotFound, "No power-off action found for resource #{@id}" if action_id.nil?
 
       submit_action_request(action_id, reason)
     end
 
     def power_on(reason = nil)
-      action_id = action_id_by_name('PowerOn')
+      action_id = action_id_by_name("PowerOn")
       raise Vra::Exception::NotFound, "No power-on action found for resource #{@id}" if action_id.nil?
 
       submit_action_request(action_id, reason)
@@ -134,7 +138,7 @@ module Vra
     attr_reader :client, :data
 
     def validate!
-      raise ArgumentError, 'must supply id or data hash' if @id.nil? && @data.nil?
+      raise ArgumentError, "must supply id or data hash" if @id.nil? && @data.nil?
     end
 
     def submit_action_request(action_id, reason)
@@ -148,7 +152,7 @@ module Vra
       {
         "actionId": action_id,
         "inputs": {},
-        "reason": reason
+        "reason": reason,
       }
     end
   end

data/lib/vra/deployment_request.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'ffi_yajl' unless defined?(FFI_Yajl)
+require "ffi_yajl" unless defined?(FFI_Yajl)
 
 # Overriding the hash object to add the deep_merge method
 class ::Hash
@@ -50,12 +50,12 @@ module Vra
       begin
         response = send_request!
       rescue Vra::Exception::HTTPError => e
-        raise Vra::Exception::RequestError, "Unable to submit request: #{e.message}, trace: #{e.errors.join(', ')}"
+        raise Vra::Exception::RequestError, "Unable to submit request: #{e.message}, trace: #{e.errors.join(", ")}"
       rescue StandardError => e
         raise e, e.message
       end
 
-      request_id = FFI_Yajl::Parser.parse(response)[0]['deploymentId']
+      request_id = FFI_Yajl::Parser.parse(response)[0]["deploymentId"]
       Vra::Deployment.new(client, id: request_id)
     end
 
@@ -85,21 +85,20 @@ module Vra
 
     def validate!
       missing_params = []
-      %i[image_mapping flavor_mapping name project_id].each do |arg|
+      %i{image_mapping flavor_mapping name project_id}.each do |arg|
         missing_params << arg if send(arg).nil?
       end
 
       unless missing_params.empty?
-        raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}"
+        raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(", ")}"
       end
 
       # If the user doesn't supply the catalog version, fetch the latest version and use it
       # and if the API was unable to find a valid version, alert the user.
       return unless @version.nil?
 
-
       @version = CatalogItem.fetch_latest_version(client, catalog_id)
-      raise ArgumentError, 'Unable to fetch a valid catalog version' if @version.nil?
+      raise ArgumentError, "Unable to fetch a valid catalog version" if @version.nil?
     end
 
     def send_request!
@@ -117,8 +116,8 @@ module Vra
         'inputs': {
           'count': count,
           'image': image_mapping,
-          'flavor': flavor_mapping
-        }
+          'flavor': flavor_mapping,
+        },
       }.deep_merge(parameters)
     end
   end

data/lib/vra/deployments.rb

@@ -47,7 +47,7 @@ module Vra
 
     def fetch_all_resources
       client
-        .http_get_paginated_array!('/deployment/api/deployments')
+        .http_get_paginated_array!("/deployment/api/deployments")
         .map! { |x| Vra::Deployment.new(client, data: x) }
     end
   end

data/lib/vra/http.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'net/http' unless defined?(Net::HTTP)
-require 'openssl' unless defined?(OpenSSL)
-require 'ffi_yajl' unless defined?(FFI_Yajl)
-require 'json'
+require "net/http" unless defined?(Net::HTTP)
+require "openssl" unless defined?(OpenSSL)
+require "ffi_yajl" unless defined?(FFI_Yajl)
+require "json" unless defined?(JSON)
 
 module Vra
   module Http
@@ -64,7 +64,7 @@ module Vra
           get: Net::HTTP::Get,
           head: Net::HTTP::Head,
           post: Net::HTTP::Post,
-          delete: Net::HTTP::Delete
+          delete: Net::HTTP::Delete,
         }.fetch(method, nil)
 
         raise "Unknown HTTP method #{method}!" unless type
@@ -150,7 +150,7 @@ module Vra
 
       def self.from_response(http_response)
         body = FFI_Yajl::Parser.parse(http_response.body) || {}
-        message = body['message'] || body['serverMessage']
+        message = body["message"] || body["serverMessage"]
         new(message, http_response.code, body)
       end
 

data/lib/vra/request.rb

@@ -31,16 +31,16 @@ module Vra
       if @request_data.nil?
         refresh
       else
-        @id = @request_data['id']
+        @id = @request_data["id"]
       end
     end
 
     def requested_by
-      request_data['requestedBy']
+      request_data["requestedBy"]
     end
 
     def name
-      request_data['name']
+      request_data["name"]
     end
 
     def refresh
@@ -61,7 +61,7 @@ module Vra
       refresh_if_empty
       return if request_empty?
 
-      request_data['status']
+      request_data["status"]
     end
 
     def completed?
@@ -69,11 +69,15 @@ module Vra
     end
 
     def successful?
-      status == 'SUCCESSFUL'
+      status == "SUCCESSFUL"
     end
 
     def failed?
-      status == 'FAILED'
+      status == "FAILED"
+    end
+
+    def details
+      request_data["details"]
     end
 
     private

data/lib/vra/request_parameters.rb

@@ -93,7 +93,7 @@ module Vra
 
     def to_vra
       hash = {
-        'inputs': {}
+        'inputs': {},
       }
 
       @entries.each do |_, v|
@@ -120,7 +120,7 @@ module Vra
     def to_h
       hash = {}
 
-      if @children.count.positive?
+      if @children.count > 0
         hash[@key] = {}
 
         @children.each do |c|
@@ -135,13 +135,13 @@ module Vra
 
     def to_vra
       hash = {}
-      if @children.count.positive?
+      if @children.count > 0
         hash[@key] = {}
 
-        hash[@key]['inputs'] = {}
+        hash[@key]["inputs"] = {}
 
         @children.each do |c|
-          hash[@key]['inputs'].merge!(c.to_vra)
+          hash[@key]["inputs"].merge!(c.to_vra)
         end
       else
         hash[@key] = format_value
@@ -152,12 +152,12 @@ module Vra
 
     def format_value
       case @type
-      when 'integer'
+      when "integer"
         @value.to_i
-      when 'string'
+      when "string"
         @value
-      when 'boolean'
-        @value.to_s == 'true'
+      when "boolean"
+        @value.to_s == "true"
       else
         @value
       end

data/lib/vra/resource.rb

@@ -21,10 +21,10 @@ require "ffi_yajl" unless defined?(FFI_Yajl)
 
 module Vra
   class Resource
-    VM_TYPES = %w[
+    VM_TYPES = %w{
       Cloud.vSphere.Machine
       Cloud.Machine
-    ].freeze
+    }.freeze
 
     attr_reader :client, :deployment_id, :id, :resource_data
 
@@ -35,13 +35,13 @@ module Vra
       @resource_data    = opts[:data]
       @resource_actions = []
 
-      raise ArgumentError, 'must supply an id or a resource data hash' if @id.nil? && @resource_data.nil?
-      raise ArgumentError, 'must supply an id OR a resource data hash, not both' if !@id.nil? && !@resource_data.nil?
+      raise ArgumentError, "must supply an id or a resource data hash" if @id.nil? && @resource_data.nil?
+      raise ArgumentError, "must supply an id OR a resource data hash, not both" if !@id.nil? && !@resource_data.nil?
 
       if @resource_data.nil?
         fetch_resource_data
       else
-        @id = @resource_data['id']
+        @id = @resource_data["id"]
       end
     end
 
@@ -54,40 +54,40 @@ module Vra
     alias refresh fetch_resource_data
 
     def name
-      resource_data['name']
+      resource_data["name"]
     end
 
     def status
-      resource_data['syncStatus']
+      resource_data["syncStatus"]
     end
 
     def properties
-      resource_data['properties']
+      resource_data["properties"]
     end
 
     def vm?
-      VM_TYPES.include?(resource_data['type'])
+      VM_TYPES.include?(resource_data["type"])
     end
 
     def owner_names
-      properties['Owner']
+      properties["Owner"]
     end
 
     def project_id
-      properties['project']
+      properties["project"]
     end
 
     def network_interfaces
       return unless vm?
 
-      network_list = properties['networks']
+      network_list = properties["networks"]
       return if network_list.nil?
 
       network_list.each_with_object([]) do |item, nics|
         nics << {
-          'NETWORK_NAME' => item['name'],
-          'NETWORK_ADDRESS' => item['address'],
-          'NETWORK_MAC_ADDRESS' => item['mac_address']
+          "NETWORK_NAME" => item["name"],
+          "NETWORK_ADDRESS" => item["address"],
+          "NETWORK_MAC_ADDRESS" => item["mac_address"],
         }
       end
     end
@@ -95,7 +95,7 @@ module Vra
     def ip_address
       return if !vm? || network_interfaces.nil?
 
-      properties['address']
+      properties["address"]
     end
   end
 end

data/lib/vra/version.rb

@@ -18,5 +18,5 @@
 #
 
 module Vra
-  VERSION = "3.1.2"
+  VERSION = "3.2.0"
 end

data/lib/vra.rb

@@ -17,17 +17,17 @@
 # limitations under the License.
 #
 
-require 'vra/catalog_base'
-require 'vra/catalog'
-require 'vra/catalog_item'
-require 'vra/catalog_source'
-require 'vra/catalog_type'
-require 'vra/deployment_request'
-require 'vra/deployment'
-require 'vra/deployments'
-require 'vra/client'
-require 'vra/exceptions'
-require 'vra/request'
-require 'vra/request_parameters'
-require 'vra/resource'
-require 'vra/version'
+require "vra/catalog_base"
+require "vra/catalog"
+require "vra/catalog_item"
+require "vra/catalog_source"
+require "vra/catalog_type"
+require "vra/deployment_request"
+require "vra/deployment"
+require "vra/deployments"
+require "vra/client"
+require "vra/exceptions"
+require "vra/request"
+require "vra/request_parameters"
+require "vra/resource"
+require "vra/version"