vmware-vra 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3671834fbc97510772f7d42d524f2775789c7ac0fe7f29c80dad8c64effe3b6
-  data.tar.gz: 394929c607677c9c2341e9a6060e9341810f2a8941111247e2fe1e1f71ce5afb
+  metadata.gz: '04187d64c2726dfbe9dcf8128710daa94c17593d17da436b4c797932d7399f39'
+  data.tar.gz: 2456b3f5fb84a99f12493ba357e8603d2bfb42c42858139bc53fcbd60b8f8984
 SHA512:
-  metadata.gz: a04bbf0434372a58119367bb5f3d9f35c10fff450263e14f92fac6bc78082a74d0ca8fbca713b4ae7a1c0fdc1e1a40a953b321b21be32bfd0996db3cf107d776
-  data.tar.gz: 3f3646d1aa4fb7d15fd451fce246ab9ccb1e4828dfd4e13110abdb5ce552a3c4a158fb3ff8ab6a6139154af6fec3c57646566876ae4af2c6414bd6f5fb5284b7
+  metadata.gz: 9820fab88049710e06f5814994d6a215338d7039e775523d27c32fbaf6e80463721d9ae5bce0e876a3b5236a14009d6350a2abb7716cda6f10f15e05676107dd
+  data.tar.gz: '0998fa84339c1f467d585041b2b1b4f8dbc0eae3b70f9fd03c7fcb5ea37afd280d61a58fc10fe4d1cd389e782430c532b639f02d09ec888fa3b52b31a71b8f2c'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [3.1.1](https://github.com/chef-partners/vmware-vra-gem/tree/v3.1.1) (2022-03-01)
+
+- Send Authorization: Bearer header instead of csp-auth-token for greater compatibility [@oshvarts]
+
+## [3.1.0](https://github.com/chef-partners/vmware-vra-gem/tree/v3.1.0) (2022-01-30)
+[Full Changelog](https://github.com/chef-partners/vmware-vra-gem/compare/v3.0.1...v3.1.0)
+
+- Make the version param optional in deployment request api 
+
+## [3.0.1](https://github.com/chef-partners/vmware-vra-gem/tree/v3.0.1) (2022-01-25)
+[Full Changelog](https://github.com/chef-partners/vmware-vra-gem/compare/v3.0.0...v3.0.1)
+
+- Fix access token workflow to work with VRA8
+
 ## [3.0.0](https://github.com/chef-partners/vmware-vra-gem/tree/v3.0.0) (2022-01-18)
 [Full Changelog](https://github.com/chef-partners/vmware-vra-gem/compare/v2.7.2...v3.0.0)
 

data/README.md

@@ -125,8 +125,10 @@ request = client.catalog.request(
 #<Vra::DeploymentRequest:0x00007fb7340b7438
 ...
 ```
-To request a deployment from a catalog item, you can use the above method with a project ID that has a cloud template version released to the project. 
-The ID of the catalog item from which you are requesting the deployment should be also included, and the version of the released cloud template. 
+To request a deployment from a catalog item, you can use the above method with a project ID that has a cloud template version released to the project.
+
+The ID of the catalog item from which you are requesting the deployment should be also included, and the version of the released cloud template. If the user doesn't specify a version explicitly, the latest version will be fetched automatically and will be used for the request.
+ 
 Additionally, the name of the deployment should be specified and it should be unique.
 The image mapping specifies the OS image for a VM and the flavor mapping specifies the CPU count and RAM of a VM.
 

data/lib/vra/catalog_item.rb

@@ -73,12 +73,24 @@ module Vra
       data['iconId']
     end
 
+    def versions
+      client
+        .http_get_paginated_array!("/catalog/api/items/#{id}/versions")
+        .map { |v| v['id'] }
+    end
+
     def entitle!(opts = {})
       super(opts.merge(type: 'CatalogItemIdentifier'))
     end
 
-    def self.entitle!(client, id)
-      new(client, id: id).entitle!
+    class << self
+      def entitle!(client, id)
+        new(client, id: id).entitle!
+      end
+
+      def fetch_latest_version(client, id)
+        new(client, data: { 'id' => id }).versions&.first
+      end
     end
   end
 end

data/lib/vra/client.rb

@@ -23,7 +23,8 @@ require 'vra/http'
 
 module Vra
   class Client
-    ACCESS_TOKEN_URL = '/csp/gateway/am/api/login?access_token'
+    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
@@ -87,7 +88,7 @@ module Vra
       headers                   = {}
       headers['Accept']         = 'application/json'
       headers['Content-Type']   = 'application/json'
-      headers['csp-auth-token'] = @access_token.value unless @access_token.value.nil?
+      headers['Authorization']  = 'Bearer ' + @access_token.value unless @access_token.value.nil?
 
       headers
     end
@@ -106,17 +107,26 @@ module Vra
     end
 
     def generate_access_token
+      @refresh_token.value = nil
       @access_token.value = nil
       validate_client_options!
 
-      response = http_post(ACCESS_TOKEN_URL,
+      # 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)
-      raise Vra::Exception::Unauthorized, "Unable to get the access token: #{response.body}" unless response.success_ok?
+      raise Vra::Exception::Unauthorized, "Unable to get the refresh token: #{refresh_response.body}" unless refresh_response.success_ok?
 
-      response_body = FFI_Yajl::Parser.parse(response.body)
-      @access_token.value = response_body['access_token']
-      @refresh_token.value = response_body['refresh_token']
+      refresh_response_body = FFI_Yajl::Parser.parse(refresh_response.body)
+      @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']
     end
 
     def full_url(path)

data/lib/vra/deployment_request.rb

@@ -85,13 +85,21 @@ module Vra
 
     def validate!
       missing_params = []
-      %i[image_mapping flavor_mapping name project_id version].each do |arg|
+      %i[image_mapping flavor_mapping name project_id].each do |arg|
         missing_params << arg if send(arg).nil?
       end
 
-      return if missing_params.empty?
+      unless missing_params.empty?
+        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?
+
 
-      raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}"
+      @version = CatalogItem.fetch_latest_version(client, catalog_id)
+      raise ArgumentError, 'Unable to fetch a valid catalog version' if @version.nil?
     end
 
     def send_request!

data/lib/vra/version.rb

@@ -18,5 +18,5 @@
 #
 
 module Vra
-  VERSION = "3.0.0"
+  VERSION = "3.1.1"
 end

data/spec/catalog_item_spec.rb

@@ -122,4 +122,37 @@ describe Vra::CatalogItem do
       expect(catalog_item.type).to be_a(Vra::CatalogType)
     end
   end
+
+  describe '#versions' do
+    let(:versions_response) do
+      [{ id: '2', description: 'v2.0' }, { id: '1', description: 'v1.0' }]
+    end
+
+    before do
+      allow(client).to receive(:authorized?).and_return(true)
+    end
+
+    it 'should call the api to fetch the versions' do
+      expect(client)
+        .to receive(:http_get_paginated_array!)
+        .with('/catalog/api/items/catalog-12345/versions')
+        .and_return(versions_response)
+
+      described_class.fetch_latest_version(client, 'catalog-12345')
+    end
+
+    it 'should return the correct version' do
+      stub_request(:get, client.full_url('/catalog/api/items/catalog-12345/versions?$skip=0&$top=20'))
+        .to_return(
+          status: 200,
+          body: {
+            content: versions_response,
+            totalPages: 1
+          }.to_json,
+          headers: {}
+        )
+
+      expect(described_class.fetch_latest_version(client, 'catalog-12345')).to eq('2')
+    end
+  end
 end

data/spec/client_spec.rb

@@ -54,16 +54,16 @@ describe Vra::Client do
   end
 
   describe '#request_headers' do
-    context 'when bearer token exists' do
+    context 'when access token exists' do
       it 'has an Authorization header' do
         client.access_token = '12345'
-        expect(client.request_headers.key?('csp-auth-token')).to be true
+        expect(client.request_headers.key?('Authorization')).to be true
       end
     end
 
     context 'when access token does not exist' do
       it 'does not have an Authorization header' do
-        expect(client.request_headers.key?('csp-auth-token')).to be false
+        expect(client.request_headers.key?('Authorization')).to be false
       end
     end
   end
@@ -131,7 +131,7 @@ describe Vra::Client do
     end
   end
 
-  describe '#generate_bearer_token' do
+  describe '#generate_access_token' do
     let(:payload) do
       {
         username: 'user@corp.local',
@@ -148,23 +148,37 @@ describe Vra::Client do
       }.to_json
     end
 
+    let(:refresh_response_body) { { token: '123456' }.to_json }
+
     it 'posts to the tokens API endpoint' do
       response = double('response', code: 200, body: success_response, success_ok?: true)
+      refresh_response = double('response', code: 200, body: refresh_response_body, success_ok?: true)
+      # First request to generate the refresh token
       expect(Vra::Http).to receive(:execute)
         .with(method: :post,
-              url: client.full_url(described_class::ACCESS_TOKEN_URL),
+              url: client.full_url(described_class::REFRESH_TOKEN_URL),
               payload: payload,
               headers: anything,
               verify_ssl: true)
         .and_return(response)
 
+      # Second request to generate access token
+      expect(Vra::Http).to receive(:execute)
+        .with(method: :post,
+              url: client.full_url(described_class::ACCESS_TOKEN_URL),
+              payload: "{ \"refreshToken\": \"654321\" }",
+              headers: anything,
+              verify_ssl: true)
+        .and_return(refresh_response)
+
       client.generate_access_token
     end
 
     context 'when token is generated successfully' do
       it 'sets the token' do
         response = double('response', code: 200, body: success_response, success_ok?: true)
-        allow(Vra::Http).to receive(:execute).and_return(response)
+        refresh_response = double('response', code: 200, body: refresh_response_body, success_ok?: true)
+        allow(Vra::Http).to receive(:execute).twice.and_return(response, refresh_response)
 
         client.generate_access_token
 

data/spec/deployment_request_spec.rb

@@ -70,6 +70,45 @@ describe Vra::DeploymentRequest do
 
       expect { request.send(:validate!) }.not_to raise_error(ArgumentError)
     end
+
+    context 'versions' do
+      let(:dep_request) do
+        described_class.new(
+          client,
+          catalog_id,
+          image_mapping: 'centos',
+          name: 'sample dep',
+          flavor_mapping: 'small',
+          project_id: 'pro-123'
+        )
+      end
+
+      before do
+        allow(client).to receive(:authorized?).and_return(true)
+      end
+
+      it 'should not call the api to fetch versions if provided in the params' do
+        expect(client).not_to receive(:http_get_paginated_array!)
+
+        dep_request.version = '1'
+        dep_request.send(:validate!)
+      end
+
+      it 'should fetch version from api if version is blank' do
+        expect(client).to receive(:http_get_paginated_array!).and_return([{ 'id' => '2', 'description' => 'v2.0' }])
+
+        dep_request.send(:validate!)
+        expect(dep_request.version).to eq('2')
+      end
+
+      it 'should raise an exception if no valid versions found' do
+        expect(client).to receive(:http_get_paginated_array!).and_return([])
+
+        expect { dep_request.send(:validate!) }
+          .to raise_error(ArgumentError)
+          .with_message('Unable to fetch a valid catalog version')
+      end
+    end
   end
 
   describe '#additional parameters' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Adam Leff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-yajl
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Client gem for interacting with VMware vRealize Automation.