vmware-vra 2.6.1 → 3.0.0

data/lib/vra/deployment_request.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+#
+# Author:: Ashique Saidalavi (<ashique.saidalavi@progress.com>)
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'ffi_yajl' unless defined?(FFI_Yajl)
+
+# Overriding the hash object to add the deep_merge method
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    merge(second, &merger)
+  end
+end
+
+module Vra
+  # class that handles the deployment request with catalog
+  class DeploymentRequest
+    attr_reader :catalog_id
+    attr_accessor :image_mapping, :name, :flavor_mapping,
+                  :project_id, :version, :count
+
+    def initialize(client, catalog_id, opts = {})
+      @client            = client
+      @catalog_id        = catalog_id
+      @image_mapping     = opts[:image_mapping]
+      @name              = opts[:name]
+      @flavor_mapping    = opts[:flavor_mapping]
+      @project_id        = opts[:project_id]
+      @version           = opts[:version]
+      @count             = opts[:count] || 1
+      @additional_params = opts[:additional_params] || Vra::RequestParameters.new
+    end
+
+    def submit
+      validate!
+      begin
+        response = send_request!
+      rescue Vra::Exception::HTTPError => e
+        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']
+      Vra::Deployment.new(client, id: request_id)
+    end
+
+    def set_parameter(key, type, value)
+      @additional_params.set(key, type, value)
+    end
+
+    def set_parameters(key, value_data)
+      @additional_params.set_parameters(key, value_data)
+    end
+
+    def delete_parameter(key)
+      @additional_params.delete(key)
+    end
+
+    def parameters
+      @additional_params.to_vra
+    end
+
+    def hash_parameters
+      @additional_params.to_h
+    end
+
+    private
+
+    attr_reader :client
+
+    def validate!
+      missing_params = []
+      %i[image_mapping flavor_mapping name project_id version].each do |arg|
+        missing_params << arg if send(arg).nil?
+      end
+
+      return if missing_params.empty?
+
+      raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}"
+    end
+
+    def send_request!
+      client.http_post!(
+        "/catalog/api/items/#{catalog_id}/request",
+        FFI_Yajl::Encoder.encode(request_payload)
+      )
+    end
+
+    def request_payload
+      {
+        'deploymentName': name,
+        'projectId': project_id,
+        'version': version,
+        'inputs': {
+          'count': count,
+          'image': image_mapping,
+          'flavor': flavor_mapping
+        }
+      }.deep_merge(parameters)
+    end
+  end
+end

data/lib/vra/{resources.rb → deployments.rb}

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-
 #
-# Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Author:: Ashique Saidalavi (<ashique.saidalavi@progress.com>)
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,29 +16,39 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module Vra
-  class Resources
-    attr_reader :client
-
+  # class that represents the Deployments Object
+  class Deployments
     def initialize(client)
       @client = client
     end
 
-    # @return [Array[Vra::Resource]] - returns an array of all the resources owned by the user
-    # @param [Vra::Client]
-    def self.all(client)
-      items = client.http_get_paginated_array!("/catalog-service/api/consumer/resources")
-      items.map { |item| Vra::Resource.new(client, data: item) }
+    def by_id(dep_id)
+      Vra::Deployment.new(client, id: dep_id)
+    end
+
+    def all
+      fetch_all_resources
     end
 
-    # @return [Array[Vra::Resource]] - returns an array of all the resources owned by the user
-    def all_resources
-      self.class.all(client)
+    class << self
+      def all(client)
+        new(client).all
+      end
+
+      def by_id(client, id)
+        new(client).by_id(id)
+      end
     end
 
-    def by_id(id)
-      Vra::Resource.new(client, id: id)
+    private
+
+    attr_reader :client
+
+    def fetch_all_resources
+      client
+        .http_get_paginated_array!('/deployment/api/deployments')
+        .map! { |x| Vra::Deployment.new(client, data: x) }
     end
   end
 end

data/lib/vra/exceptions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 
-require "ffi_yajl"
+require "ffi_yajl" unless defined?(FFI_Yajl)
 
 module Vra
   module Exception

data/lib/vra/http.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
-require "net/http"
-require "openssl"
+
+require 'net/http' unless defined?(Net::HTTP)
+require 'openssl' unless defined?(OpenSSL)
+require 'ffi_yajl' unless defined?(FFI_Yajl)
+require 'json'
 
 module Vra
   module Http
@@ -8,7 +11,13 @@ module Vra
       request = Request.new(params)
       response = request.call
       response = response.forward(request).call until response.final?
+      if ENV["VRA_HTTP_TRACE"]
+        puts "#{request.params[:method].upcase} #{request.params[:url]}" unless request.params.nil?
+        puts ">>>>> #{JSON.parse(request.params[:payload]).to_json.gsub(/\"password\":\"(.+)\",/, '"password":"********",' )}" unless request.params[:payload].nil?
+        puts "<<<<< #{JSON.parse(response.body).to_json}" unless response.body.nil?
+      end
       raise error(response) unless response.success?
+
       response
     end
 
@@ -24,7 +33,7 @@ module Vra
       end
 
       def redirectable?
-        [:get, :head].include?(params[:method])
+        %i{get head}.include?(params[:method])
       end
 
       def redirect_to(location)
@@ -55,6 +64,7 @@ module Vra
           get: Net::HTTP::Get,
           head: Net::HTTP::Head,
           post: Net::HTTP::Post,
+          delete: Net::HTTP::Delete
         }.fetch(method, nil)
 
         raise "Unknown HTTP method #{method}!" unless type
@@ -70,6 +80,7 @@ module Vra
 
       def verify_ssl?
         return true if params[:verify_ssl].nil?
+
         params[:verify_ssl]
       end
     end
@@ -84,6 +95,7 @@ module Vra
       def forward(request)
         if redirect?
           raise Http.error(self) unless request.redirectable?
+
           request.redirect_to(location)
         elsif see_other?
           request.see_other(location)
@@ -134,13 +146,14 @@ module Vra
     end
 
     class Error < StandardError
+      attr_reader :http_code, :response
+
       def self.from_response(http_response)
-        new(http_response.message, http_response.code, http_response.body)
+        body = FFI_Yajl::Parser.parse(http_response.body) || {}
+        message = body['message'] || body['serverMessage']
+        new(message, http_response.code, body)
       end
 
-      attr_reader :http_code
-      attr_reader :response
-
       def initialize(message, http_code, response)
         super(message)
         @http_code = http_code

data/lib/vra/request.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,23 +17,34 @@
 # limitations under the License.
 #
 
-require "ffi_yajl"
-
 module Vra
+  # class to represent the Deployment request
   class Request
-    attr_reader :client, :id
-    def initialize(client, id)
-      @client = client
-      @id     = id
+    attr_reader :id, :deployment_id
+
+    def initialize(client, deployment_id, opts = {})
+      @client             = client
+      @deployment_id      = deployment_id
+      @id                 = opts[:id]
+      @request_data       = opts[:data]
+
+      if @request_data.nil?
+        refresh
+      else
+        @id = @request_data['id']
+      end
+    end
+
+    def requested_by
+      request_data['requestedBy']
+    end
 
-      @request_data       = nil
-      @status             = nil
-      @completion_state   = nil
-      @completion_details = nil
+    def name
+      request_data['name']
     end
 
     def refresh
-      @request_data = client.get_parsed("/catalog-service/api/consumer/requests/#{@id}")
+      @request_data = client.get_parsed("/deployment/api/deployments/#{deployment_id}/requests/#{id}?deleted=true")
     rescue Vra::Exception::HTTPNotFound
       raise Vra::Exception::NotFound, "request ID #{@id} is not found"
     end
@@ -50,7 +61,7 @@ module Vra
       refresh_if_empty
       return if request_empty?
 
-      @request_data["phase"]
+      request_data['status']
     end
 
     def completed?
@@ -58,34 +69,15 @@ module Vra
     end
 
     def successful?
-      status == "SUCCESSFUL"
+      status == 'SUCCESSFUL'
     end
 
     def failed?
-      status == "FAILED"
-    end
-
-    def completion_state
-      refresh_if_empty
-      return if request_empty?
-
-      @request_data["requestCompletion"]["requestCompletionState"]
+      status == 'FAILED'
     end
 
-    def completion_details
-      refresh_if_empty
-      return if request_empty?
-
-      @request_data["requestCompletion"]["completionDetails"]
-    end
+    private
 
-    def resources
-      begin
-        request_resources = client.http_get_paginated_array!("/catalog-service/api/consumer/requests/#{@id}/resources")
-      rescue Vra::Exception::HTTPNotFound
-        raise Vra::Exception::NotFound, "resources for request ID #{@id} are not found"
-      end
-      request_resources.map { |resource| Vra::Resource.new(client, data: resource) }
-    end
+    attr_reader :request_data, :client
   end
 end

data/lib/vra/request_parameters.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -51,7 +51,7 @@ module Vra
 
     def set(key, type, value)
       if key.to_s.include? "~"
-        split_key = key.split("~")
+        split_key = key.to_s.split("~")
         parent = nil
         split_key.each_with_index do |item, index|
           if index == 0
@@ -93,11 +93,11 @@ module Vra
 
     def to_vra
       hash = {
-        "data" => {},
+        'inputs': {}
       }
 
-      @entries.each do |k, v|
-        hash["data"].merge!(v.to_vra)
+      @entries.each do |_, v|
+        hash[:inputs].merge!(v.to_vra)
       end
 
       hash
@@ -120,7 +120,7 @@ module Vra
     def to_h
       hash = {}
 
-      if @children.count > 0
+      if @children.count.positive?
         hash[@key] = {}
 
         @children.each do |c|
@@ -135,28 +135,29 @@ module Vra
 
     def to_vra
       hash = {}
-
-      if @children.count > 0
+      if @children.count.positive?
         hash[@key] = {}
 
-        hash[@key]["data"] = {}
+        hash[@key]['inputs'] = {}
 
         @children.each do |c|
-          hash[@key]["data"].merge!(c.to_vra)
+          hash[@key]['inputs'].merge!(c.to_vra)
         end
       else
         hash[@key] = format_value
       end
 
-      hash
+      hash.each_with_object({}) { |(key, value), h| h[key.to_s] = value }
     end
 
     def format_value
       case @type
-      when "integer"
+      when 'integer'
         @value.to_i
-      when "string"
+      when 'string'
         @value
+      when 'boolean'
+        @value.to_s == 'true'
       else
         @value
       end