vmware-vra 2.7.0 → 3.0.1

data/lib/vra/catalog_item.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,114 +17,68 @@
 # limitations under the License.
 #
 
-require "ffi_yajl"
+require "ffi_yajl" unless defined?(FFI_Yajl)
 require "vra/catalog"
 
 module Vra
-  class CatalogItem
-    attr_reader :id, :client
-    def initialize(client, opts)
-      @client            = client
-      @id                = opts[:id]
-      @catalog_item_data = opts[:data]
+  # Class that represents the Catalog Item
+  class CatalogItem < Vra::CatalogBase
+    INDEX_URL = '/catalog/api/admin/items'
 
-      if @id.nil? && @catalog_item_data.nil?
-        raise ArgumentError, "must supply an id or a catalog item data hash"
-      end
+    attr_reader :project_id
 
-      if !@id.nil? && !@catalog_item_data.nil?
-        raise ArgumentError, "must supply an id OR a catalog item data hash, not both"
-      end
+    def initialize(client, opts = {})
+      super
+      @project_id = opts[:project_id]
+      validate!
 
-      if @catalog_item_data.nil?
+      if @data.nil?
         fetch_catalog_item
       else
-        @id = @catalog_item_data["id"]
+        @id = @data['id']
       end
     end
 
     def fetch_catalog_item
-      @catalog_item_data = client.get_parsed("/catalog-service/api/consumer/catalogItems/#{id}")
+      @data = client.get_parsed("/catalog/api/admin/items/#{id}")
     rescue Vra::Exception::HTTPNotFound
       raise Vra::Exception::NotFound, "catalog ID #{id} does not exist"
     end
 
     def name
-      @catalog_item_data["name"]
+      data['name']
     end
 
     def description
-      @catalog_item_data["description"]
-    end
-
-    def status
-      @catalog_item_data["status"]
+      data['description']
     end
 
-    def organization
-      return {} if @catalog_item_data["organization"].nil?
-
-      @catalog_item_data["organization"]
+    def source_id
+      data['sourceId']
     end
 
-    def tenant_id
-      organization["tenantRef"]
+    def source_name
+      data['sourceName']
     end
 
-    def tenant_name
-      organization["tenantLabel"]
+    def source
+      @source ||= Vra::CatalogSource.new(client, id: source_id)
     end
 
-    def subtenant_id
-      organization["subtenantRef"]
+    def type
+      @type ||= Vra::CatalogType.new(client, data: data['type'])
     end
 
-    def subtenant_name
-      organization["subtenantLabel"]
+    def icon_id
+      data['iconId']
     end
 
-    def blueprint_id
-      @catalog_item_data["providerBinding"]["bindingId"]
+    def entitle!(opts = {})
+      super(opts.merge(type: 'CatalogItemIdentifier'))
     end
 
-    # @param [String] - the id of the catalog item
-    # @param [Vra::Client] - a vra client object
-    # @return [String] - returns a json string of the catalog template
-    def self.dump_template(client, id)
-      response = client.http_get("/catalog-service/api/consumer/entitledCatalogItems/#{id}/requests/template")
-      response.body
-    end
-
-    # @param client [Vra::Client] - a vra client object
-    # @param id [String] - the id of the catalog item
-    # @param filename [String] - the name of the file you want to output the template to
-    # if left blank, will default to the id of the item
-    # @note outputs the catalog template to a file in serialized format
-    def self.write_template(client, id, filename = nil)
-      filename ||= "#{id}.json"
-      begin
-        contents = dump_template(client, id)
-        data = JSON.parse(contents)
-        pretty_contents = JSON.pretty_generate(data)
-        File.write(filename, pretty_contents)
-        return filename
-      rescue Vra::Exception::HTTPError => e
-        raise e
-      end
-    end
-
-    # @param [Vra::Client] - a vra client object
-    # @param [String] - the directory path to write the files to
-    # @param [Boolean] - set to true if you wish the file name to be the id of the catalog item
-    # @return [Array[String]] - a array of all the files that were generated
-    def self.dump_templates(client, dir_name = "vra_templates", use_id = false)
-      FileUtils.mkdir_p(dir_name) unless File.exist?(dir_name)
-      client.catalog.entitled_items.map do |c|
-        id = use_id ? c.id : c.name.tr(" ", "_")
-        filename = File.join(dir_name, "#{id}.json").downcase
-        write_template(client, c.id, filename)
-        filename
-      end
+    def self.entitle!(client, id)
+      new(client, id: id).entitle!
     end
   end
 end

data/lib/vra/catalog_source.rb

@@ -0,0 +1,116 @@
+# 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)
+
+module Vra
+  # Class that represents the Catalog Source
+  class CatalogSource < Vra::CatalogBase
+    INDEX_URL = '/catalog/api/admin/sources'
+
+    # @param client [Vra::Client] - a vra client object
+    # @param opts [Hash] - Contains the either id of the catalog or the data hash
+    # Either one of id or data hash is required, must not supply both
+    def initialize(client, opts)
+      super
+      validate!
+      fetch_data
+    end
+
+    def name
+      data['name']
+    end
+
+    def catalog_type_id
+      data['typeId']
+    end
+
+    def catalog_type
+      @catalog_type ||= Vra::CatalogType.new(client, id: catalog_type_id)
+    end
+
+    def config
+      data['config']
+    end
+
+    def global?
+      data['global'] == true
+    end
+
+    def project_id
+      config['sourceProjectId']
+    end
+
+    def entitle!(opts = {})
+      super(opts.merge(type: 'CatalogSourceIdentifier'))
+    end
+
+    class << self
+      # Method to create a catalog source
+      def create(client, opts)
+        validate_create!(opts)
+
+        response = client.http_post(
+          '/catalog/api/admin/sources',
+          FFI_Yajl::Encoder.encode(create_params(opts)),
+          opts[:skip_auth] || false
+        )
+
+        return false unless response.success?
+
+        new(client, data: FFI_Yajl::Parser.parse(response.body))
+      end
+
+      def entitle!(client, id)
+        new(client, id: id).entitle!
+      end
+
+      private
+
+      def validate_create!(opts)
+        %i[name catalog_type_id project_id].each do |arg|
+          raise ArgumentError, "#{arg} param is required to perform the create action" unless opts.key?(arg)
+        end
+      end
+
+      def create_params(opts)
+        {
+          'name': opts[:name],
+          'typeId': opts[:catalog_type_id],
+          'config': {
+            'sourceProjectId': opts[:project_id]
+          }
+        }
+      end
+    end
+
+    private
+
+    def fetch_data
+      fetch_catalog_data && return if data.nil?
+
+      @id = data['id']
+    end
+
+    def fetch_catalog_data
+      @data = client.get_parsed("/catalog/api/admin/sources/#{id}")
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "catalog source ID #{id} does not exist"
+    end
+  end
+end

data/lib/vra/catalog_type.rb

@@ -0,0 +1,56 @@
+# 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.
+#
+module Vra
+  # Class that represents the Catalog Type
+  class CatalogType < Vra::CatalogBase
+    INDEX_URL = '/catalog/api/types'
+
+    def initialize(client, opts = {})
+      super
+      validate!
+      fetch_data
+    end
+
+    def name
+      data['name']
+    end
+
+    def base_url
+      data['baseUri']
+    end
+
+    def config_schema
+      data['configSchema']
+    end
+
+    def icon_id
+      data['iconId']
+    end
+
+    private
+
+    def fetch_data
+      @id = data['id'] and return unless data.nil?
+
+      @data = client.get_parsed("/catalog/api/types/#{id}")
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "catalog type ID #{id} does not exist"
+    end
+  end
+end

data/lib/vra/client.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,22 +17,27 @@
 # limitations under the License.
 #
 
-require "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'
+
     attr_accessor :page_size
 
     def initialize(opts)
-      @base_url     = opts[:base_url]
-      @username     = opts[:username]
-      @password     = PasswordMasker.new(opts[:password])
-      @tenant       = opts[:tenant]
-      @verify_ssl   = opts.fetch(:verify_ssl, true)
-      @bearer_token = PasswordMasker.new(nil)
-      @page_size    = opts.fetch(:page_size, 20)
+      @base_url      = opts[:base_url]
+      @username      = opts[:username]
+      @password      = PasswordMasker.new(opts[:password])
+      @tenant        = opts[:tenant]
+      @verify_ssl    = opts.fetch(:verify_ssl, true)
+      @refresh_token = PasswordMasker.new(nil)
+      @access_token  = PasswordMasker.new(nil)
+      @page_size     = opts.fetch(:page_size, 20)
 
       validate_client_options!
     end
@@ -43,15 +48,11 @@ module Vra
     #
 
     def catalog
-      Vra::Catalog.new(self)
-    end
-
-    def requests(*args)
-      Vra::Requests.new(self, *args)
+      @catalog ||= Vra::Catalog.new(self)
     end
 
-    def resources(*args)
-      Vra::Resources.new(self, *args)
+    def deployments
+      @deployments ||= Vra::Deployments.new(self)
     end
 
     #########################
@@ -59,55 +60,73 @@ module Vra
     # client methods
     #
 
-    def bearer_token
-      @bearer_token.value
+    def access_token
+      @access_token.value
+    end
+
+    def refresh_token
+      @refresh_token.value
+    end
+
+    def access_token=(value)
+      @access_token.value = value
     end
 
-    def bearer_token=(value)
-      @bearer_token.value = value
+    def refresh_token=(value)
+      @refresh_token.value = value
     end
 
-    def bearer_token_request_body
+    def token_params
       {
-        "username" => @username,
-        "password" => @password.value,
-        "tenant" => @tenant,
+        'username': @username,
+        'password': @password.value,
+        'tenant': @tenant
       }
     end
 
     def request_headers
-      headers = {}
-      headers["Accept"]        = "application/json"
-      headers["Content-Type"]  = "application/json"
-      headers["Authorization"] = "Bearer #{@bearer_token.value}" unless @bearer_token.value.nil?
+      headers                   = {}
+      headers['Accept']         = 'application/json'
+      headers['Content-Type']   = 'application/json'
+      headers['csp-auth-token'] = @access_token.value unless @access_token.value.nil?
+
       headers
     end
 
     def authorize!
-      generate_bearer_token unless authorized?
+      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?
-      return false if @bearer_token.value.nil?
+      return false if @access_token.value.nil?
 
-      response = http_head("/identity/api/tokens/#{@bearer_token.value}", :skip_auth)
-      response.success_no_content?
+      response = http_head(ROLES_URL, :skip_auth)
+      response.success?
     end
 
-    def generate_bearer_token
-      @bearer_token.value = nil
+    def generate_access_token
+      @refresh_token.value = nil
+      @access_token.value = nil
       validate_client_options!
 
-      response = http_post("/identity/api/tokens",
-                           FFI_Yajl::Encoder.encode(bearer_token_request_body),
+      # VRA 8 has a two-step authentication process - This probably breaks VRA7, who knows?!?
+      # First step: Sending Username/Password to get a Refresh Token
+      refresh_response = http_post(REFRESH_TOKEN_URL,
+                           FFI_Yajl::Encoder.encode(token_params),
                            :skip_auth)
-      unless response.success_ok?
-        raise Vra::Exception::Unauthorized, "Unable to get bearer token: #{response.body}"
-      end
+      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']
 
-      @bearer_token.value = FFI_Yajl::Parser.parse(response.body)["id"]
+      # 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']
     end
 
     def full_url(path)
@@ -140,21 +159,26 @@ module Vra
       response.body
     end
 
+    def http_delete(path, skip_auth = nil)
+      http_fetch(:delete, path, skip_auth)
+    end
+
     def get_parsed(path)
       FFI_Yajl::Parser.parse(http_get!(path))
     end
 
-    def http_get_paginated_array!(path)
+    def http_get_paginated_array!(path, filter = nil)
       items = []
-      page = 1
-      base_path = path + "?limit=#{page_size}"
+      page = 0
+      base_path = path + "?$top=#{page_size}"
+      base_path += "&#{filter}" if filter
 
       loop do
-        response = get_parsed("#{base_path}&page=#{page}")
+        response = get_parsed("#{base_path}&$skip=#{page * page_size}")
         items += response["content"]
 
-        break if page >= response["metadata"]["totalPages"]
         page += 1
+        break if page >= response["totalPages"]
       end
 
       if items.uniq!
@@ -218,10 +242,5 @@ module Vra
     rescue URI::InvalidURIError
       false
     end
-
-    def fetch_subtenant_items(tenant, subtenant_name)
-      http_get("/identity/api/tenants/#{tenant}/subtenants?%24filter=name+eq+'#{subtenant_name}'")
-    end
-
   end
 end

data/lib/vra/deployment.rb

@@ -0,0 +1,155 @@
+# 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)
+
+module Vra
+  # Class that represents the Deployment Object
+  class Deployment
+    INDEX_URL = '/deployment/api/deployments'
+
+    attr_reader :id
+
+    def initialize(client, opts = {})
+      @client = client
+      @id     = opts[:id]
+      @data   = opts[:data]
+      validate!
+
+      if @data.nil?
+        refresh
+      elsif @id.nil?
+        @id = @data['id']
+      end
+    end
+
+    def name
+      @data['name']
+    end
+
+    def description
+      @data['description']
+    end
+
+    def org_id
+      @data['orgId']
+    end
+
+    def blueprint_id
+      @data['blueprintId']
+    end
+
+    def owner
+      @data['ownedBy']
+    end
+
+    def status
+      @data['status']
+    end
+
+    def successful?
+      status == 'CREATE_SUCCESSFUL'
+    end
+
+    def failed?
+      status == 'CREATE_FAILED'
+    end
+
+    def completed?
+      successful? || failed?
+    end
+
+    def actions
+      @actions = client.get_parsed("/deployment/api/deployments/#{id}/actions")
+    end
+
+    def action_id_by_name(action_name)
+      action = actions.find { |x| x['name'] == action_name}
+      return if action.nil?
+
+      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) }
+    end
+
+    def resource_by_id(res_id)
+      Vra::Resource.new(client, id, id: res_id)
+    end
+
+    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) }
+    end
+
+    def refresh
+      @data = client.get_parsed("/deployment/api/deployments/#{id}")
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "deployment with ID #{id} does not exist"
+    end
+
+    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')
+      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')
+      raise Vra::Exception::NotFound, "No power-on action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id, reason)
+    end
+
+    private
+
+    attr_reader :client, :data
+
+    def validate!
+      raise ArgumentError, 'must supply id or data hash' if @id.nil? && @data.nil?
+    end
+
+    def submit_action_request(action_id, reason)
+      response = client.http_post!("/deployment/api/deployments/#{id}/requests",
+                                   FFI_Yajl::Encoder.encode(submit_action_payload(action_id, reason)))
+
+      Vra::Request.new(client, id, data: FFI_Yajl::Parser.parse(response))
+    end
+
+    def submit_action_payload(action_id, reason)
+      {
+        "actionId": action_id,
+        "inputs": {},
+        "reason": reason
+      }
+    end
+  end
+end