vmware-vra 2.7.2 → 3.0.0

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");

data/lib/vra/http.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
-require "net/http" unless defined?(Net::HTTP)
-require "openssl" unless defined?(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
@@ -61,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
@@ -142,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" unless defined?(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");
@@ -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,13 +135,13 @@ 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
@@ -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

@@ -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");
@@ -21,252 +21,81 @@ require "ffi_yajl" unless defined?(FFI_Yajl)
 
 module Vra
   class Resource
-    attr_reader :client, :id, :resource_data
+    VM_TYPES = %w[
+      Cloud.vSphere.Machine
+      Cloud.Machine
+    ].freeze
 
-    def initialize(client, opts)
+    attr_reader :client, :deployment_id, :id, :resource_data
+
+    def initialize(client, deployment_id, opts = {})
       @client           = client
+      @deployment_id    = deployment_id
       @id               = opts[:id]
       @resource_data    = opts[:data]
       @resource_actions = []
 
-      if @id.nil? && @resource_data.nil?
-        raise ArgumentError, "must supply an id or a resource data hash"
-      end
-
-      if !@id.nil? && !@resource_data.nil?
-        raise ArgumentError, "must supply an id OR a resource data hash, not both"
-      end
+      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
 
-    # @param client [Vra::Client]
-    # @param name [String] - the hostname of the client you wish to lookup
-    # @preturn [Vra::Resource] - return nil if not found, otherwise the resource associated with the name
-    def self.by_name(client, name)
-      raise ArgumentError.new("name cannot be nil") if name.nil?
-      raise ArgumentError.new("client cannot be nil") if client.nil?
-
-      Resources.all(client).find { |r| r.name.downcase =~ /#{name.downcase}/ }
-    end
-
     def fetch_resource_data
-      @resource_data = client.get_parsed("/catalog-service/api/consumer/resources/#{@id}")
+      @resource_data = client.get_parsed("/deployment/api/deployments/#{deployment_id}/resources/#{id}")
     rescue Vra::Exception::HTTPNotFound
       raise Vra::Exception::NotFound, "resource ID #{@id} does not exist"
     end
+
     alias refresh fetch_resource_data
 
     def name
-      resource_data["name"]
-    end
-
-    def description
-      resource_data["description"]
+      resource_data['name']
     end
 
     def status
-      resource_data["status"]
+      resource_data['syncStatus']
     end
 
-    def vm?
-      %w{Infrastructure.Virtual Infrastructure.Cloud}.include?(resource_data["resourceTypeRef"]["id"])
+    def properties
+      resource_data['properties']
     end
 
-    def organization
-      return {} if resource_data["organization"].nil?
-
-      resource_data["organization"]
-    end
-
-    def tenant_id
-      organization["tenantRef"]
-    end
-
-    def tenant_name
-      organization["tenantLabel"]
-    end
-
-    def subtenant_id
-      organization["subtenantRef"]
-    end
-
-    def subtenant_name
-      organization["subtenantLabel"]
-    end
-
-    def catalog_item
-      return {} if resource_data["catalogItem"].nil?
-
-      resource_data["catalogItem"]
-    end
-
-    def catalog_id
-      catalog_item["id"]
-    end
-
-    def catalog_name
-      catalog_item["label"]
-    end
-
-    def owner_ids
-      resource_data["owners"].map { |x| x["ref"] }
+    def vm?
+      VM_TYPES.include?(resource_data['type'])
     end
 
     def owner_names
-      resource_data["owners"].map { |x| x["value"] }
-    end
-
-    def machine_status
-      status = resource_data["resourceData"]["entries"].find { |x| x["key"] == "MachineStatus" }
-      raise "No MachineStatus entry available for resource" if status.nil?
-
-      status["value"]["value"]
-    end
-
-    def machine_on?
-      machine_status == "On"
-    end
-
-    def machine_off?
-      machine_status == "Off"
+      properties['Owner']
     end
 
-    def machine_turning_on?
-      machine_status == "TurningOn" || machine_status == "MachineActivated"
-    end
-
-    def machine_turning_off?
-      %w{TurningOff ShuttingDown}.include?(machine_status)
-    end
-
-    def machine_in_provisioned_state?
-      machine_status == "MachineProvisioned"
+    def project_id
+      properties['project']
     end
 
     def network_interfaces
       return unless vm?
 
-      network_list = resource_data["resourceData"]["entries"].find { |x| x["key"] == "NETWORK_LIST" }
+      network_list = properties['networks']
       return if network_list.nil?
 
-      network_list["value"]["items"].each_with_object([]) do |item, nics|
-        nic = {}
-        item["values"]["entries"].each do |entry|
-          key = entry["key"]
-          value = entry["value"]["value"]
-          nic[key] = value
-        end
-
-        nics << nic
+      network_list.each_with_object([]) do |item, nics|
+        nics << {
+          'NETWORK_NAME' => item['name'],
+          'NETWORK_ADDRESS' => item['address'],
+          'NETWORK_MAC_ADDRESS' => item['mac_address']
+        }
       end
     end
 
-    def ip_addresses
+    def ip_address
       return if !vm? || network_interfaces.nil?
 
-      addrs = []
-
-      request_id = @resource_data["requestId"]
-
-      print "Waiting For vRA to collect the IP"
-
-      loop do
-        resource_views = @client.http_get("/catalog-service/api/consumer/requests/#{request_id}/resourceViews")
-
-        JSON.parse(resource_views.body)["content"].each do |content|
-          if content.key?("data") &&
-              !(content["data"]["ip_address"].nil? ||
-                content["data"]["ip_address"] == "")
-            addrs << content["data"]["ip_address"]
-          end
-        end
-
-        break unless addrs.empty?
-
-        sleep 10
-      end
-
-      addrs
-    end
-
-    def actions
-      # if this Resource instance was created with data from a "all_resources" fetch,
-      # it is likely missing operations data because the vRA API is not pleasant sometimes.
-      fetch_resource_data if resource_data["operations"].nil?
-
-      resource_data["operations"]
-    end
-
-    def action_id_by_name(name)
-      return if actions.nil?
-
-      action = actions.find { |x| x["name"] == name }
-      return if action.nil?
-
-      action["id"]
-    end
-
-    def destroy
-      action_id = action_id_by_name("Destroy")
-      raise Vra::Exception::NotFound, "No destroy action found for resource #{@id}" if action_id.nil?
-
-      submit_action_request(action_id)
-    end
-
-    def shutdown
-      action_id = action_id_by_name("Shutdown")
-      raise Vra::Exception::NotFound, "No shutdown action found for resource #{@id}" if action_id.nil?
-
-      submit_action_request(action_id)
-    end
-
-    def poweroff
-      action_id = action_id_by_name("Power Off")
-      raise Vra::Exception::NotFound, "No power-off action found for resource #{@id}" if action_id.nil?
-
-      submit_action_request(action_id)
-    end
-
-    def poweron
-      action_id = action_id_by_name("Power On")
-      raise Vra::Exception::NotFound, "No power-on action found for resource #{@id}" if action_id.nil?
-
-      submit_action_request(action_id)
-    end
-
-    def action_request_payload(action_id)
-      {
-        "@type" => "ResourceActionRequest",
-        "resourceRef" => {
-          "id" => @id,
-        },
-        "resourceActionRef" => {
-          "id" => action_id,
-        },
-        "organization" => {
-          "tenantRef" => tenant_id,
-          "tenantLabel" => tenant_name,
-          "subtenantRef" => subtenant_id,
-          "subtenantLabel" => subtenant_name,
-        },
-        "state" => "SUBMITTED",
-        "requestNumber" => 0,
-        "requestData" => {
-          "entries" => [],
-        },
-      }
-    end
-
-    def submit_action_request(action_id)
-      payload = action_request_payload(action_id).to_json
-      response = client.http_post("/catalog-service/api/consumer/requests", payload)
-      request_id = response.location.split("/")[-1]
-      Vra::Request.new(client, request_id)
+      properties['address']
     end
   end
 end

data/lib/vra/version.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");
@@ -18,5 +18,5 @@
 #
 
 module Vra
-  VERSION = "2.7.2"
+  VERSION = "3.0.0"
 end

data/lib/vra.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,14 +17,17 @@
 # limitations under the License.
 #
 
-require "vra/catalog"
-require "vra/catalog_item"
-require "vra/catalog_request"
-require "vra/client"
-require "vra/exceptions"
-require "vra/request"
-require "vra/request_parameters"
-require "vra/requests"
-require "vra/resource"
-require "vra/resources"
-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'