vmware-vra 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d18c9dda0b686aad417c4f46c36c3c3a23f4523e68f78d1715f86f24a0a1ef4
-  data.tar.gz: aff6ebd90a5b5ecbc43e249065a04ac34f8978c151dd27869e11378bfd08adc8
+  metadata.gz: 0e0045f6ebfa8fa27f8842d7d99cab6caebbfed8dde6143caeca4f3586b84e89
+  data.tar.gz: f44441731dd50642476d4a47c0e5d7c0d2bd957cb262cd10f566011ff902b299
 SHA512:
-  metadata.gz: 2dfd08b68a8ee04d9c657e4776b02a3a8edfc6e74f21dde0faff948a1d279a617010563beeb6c83e9602db26259abf9547e506cec4dea5012e989547a67481aa
-  data.tar.gz: 1d3c7f0a3003185dc8e82fa2e5be29462b1957c56a4d231a081fae82e6641b728a6022cbc8356efada6e8b41b4f414c7982d1b2c24722bca84c4ac0b79682b1d
+  metadata.gz: ae31f69005d0e71b02712f75486619e8e68b22265ba5d45874a7f96e2c83ee75f5eea71d9c0bcd6eb8bad93bc8e3cf254b1fb1b2d2d0dbefb1447a7b3f26419d
+  data.tar.gz: c8c59ca96efa6784ddcad31204fa1e23b2c9119e5173a829cd87fdfb4f08fefd0af0eb84366593f3f731259da3b71c840e9471e743852acdd80a52fc68734e8b

data/.github/workflows/linters.yml

@@ -0,0 +1,9 @@
+---
+name: 'Test'
+
+'on':
+  pull_request:
+
+jobs:
+  lint-unit:
+    uses: test-kitchen/.github/.github/workflows/lint-unit.yml@main

data/.markdownlint.yaml

@@ -0,0 +1,5 @@
+---
+MD012: false
+MD013: false
+MD024: false
+MD036: false

data/.mdlrc

@@ -0,0 +1 @@
+rules "~MD036", "~MD013", "~MD024", "~MD029"

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [3.2.0](https://github.com/test-kitchen/vmware-vra-gem/tree/v3.2.0) (2022-12-19)
+
+- Updated the tenant attribute to domain
+
+[Full Changelog](https://github.com/test-kitchen/vmware-vra-gem/compare/v3.1.3...v3.2.0)
+
+## [3.1.3](https://github.com/test-kitchen/vmware-vra-gem/tree/v3.1.3) (2022-05-26)
+
+- Use regular admin catalog endpoint to fetch catalog items
+- Fixed the issue with multi-tenancy
+- Fix chefstyle issues and optimise workflow
+
+[Full Changelog](https://github.com/test-kitchen/vmware-vra-gem/compare/v3.1.2...v3.1.3)
+
 
 ## [3.1.2] (2022-03-28)
 
@@ -298,6 +312,7 @@
 - Add support for Infrastructure.Cloud resources [\#15](https://github.com/test-kitchen/vmware-vra-gem/pull/15) ([adamleff](https://github.com/adamleff))
 
 ## [v1.4.0](https://github.com/test-kitchen/vmware-vra-gem/tree/v1.4.0) (2015-11-13)
+
 [Full Changelog](https://github.com/test-kitchen/vmware-vra-gem/compare/v1.3.0...v1.4.0)
 
 **Closed issues:**

data/README.md

@@ -1,4 +1,5 @@
 # VMware vRA Gem
+
 [![Gem Version](https://badge.fury.io/rb/vmware-vra.svg)](http://badge.fury.io/rb/vmware-vra)
 
 Client gem for interacting with VMware's vRealize Automation application.
@@ -27,55 +28,60 @@ gem 'vmware-vra'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install vmware-vra
+```shell
+gem install vmware-vra
+```
 
 ## Usage
 
 First, load in the gem.
 
-```
+```shell
 require 'vra'
 => true
 ```
 
-Then, set up your client object. You will need to know your tenant ID from your vRA administrator.
+Then, set up your client object. You will need to know your domain from your vRA administrator.
 
-```
-client = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true)
+```shell
+client = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', domain: 'domain.corp.local', base_url: 'https://vra.corp.local', verify_ssl: true)
 => #<Vra::Client:0x000000034c0df8 ... >
 ```
-### Catalog Types:
+
+### Catalog Types
 
 To list all the catalog types:
 
-```
+```shell
 client.catalog.all_types
  => [#<Vra::CatalogType:0x00007fcde6855370 @id="com.vmw.vro.workflow", @data={"id"=>"com.vmw.vro.workflow", ... ]
 ```
 
-### Catalog Sources:
+### Catalog Sources
 
 To list all the catalog sources:
 
-```
+```shell
 client.catalog.all_sources
 [#<Vra::CatalogSource:0x00007fcde3948c30 @id="2f5b2d5c-6dc2-4ea7-b304-cd8fea5ede0f", @data= ...]
 ```
 
 And to list the sources that are entitled only:
 
-```
+```shell
 client.catalog.entitled_sources(project_id)
 => [#<Vra::CatalogSource:0x00007fcde2a28c00 @id="18102dc2-9e48-487a-93a8-aafab2ecc05 ...]
 ```
 
 Creating a new source can be done as follows:
 
-```
+```shell
 source = Vra::CatalogSource.create(client, name: 'New source', catalog_type_id: 'com.vmw.vro.workflow', project_id: project_id)
  => #<Vra::CatalogSource:0x00007fad651f63b8 ... >
 ```
@@ -84,21 +90,21 @@ source = Vra::CatalogSource.create(client, name: 'New source', catalog_type_id:
 
 To list all items in the catalog:
 
-```
+```shell
 client.catalog.all_items
  => [#<Vra::CatalogItem:0x00007fe583863b28>, #<Vra::CatalogItem:0x00007fe583863ad8 ... ]
 ```
 
 To only list the items in the catalog for which you are entitled to request:
 
-```
+```shell
 client.catalog.entitled_items(project_id)
 => [#<Vra::CatalogItem:0x00007fe583863b28>, #<Vra::CatalogItem:0x00007fe583863ad8 ... ]
 ```
 
 To retrive catalog id from catalog name:
 
-```
+```shell
 client.catalog.fetch_catalog_items('centos')
  =>
 [#<Vra::CatalogItem:0x00007fb734110f60
@@ -110,9 +116,10 @@ client.catalog.fetch_catalog_items('centos')
 ```
 
 ### Requesting Deployments
+
 When you are ready to request a deployment using a catalog, create a new deployment object:
 
-```
+```shell
 request = client.catalog.request(
   catalog_id, 
   image_mapping: 'VRA-nc-lnx-ce8.4-Docker',
@@ -125,16 +132,17 @@ 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. 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.
 
 If your catalog blueprint item requires additional parameters to successfully submit your request, you may add them:
 
-```
+```shell
 request.set_parameter('my_parameter', 'string', 'my value')
 ```
 
@@ -142,7 +150,7 @@ request.set_parameter('my_parameter', 'string', 'my value')
 
 Now, submit your request!  The client will return a new "Deployment" object you can use to query for status.
 
-```
+```shell
 deployment = catalog_request.submit
 => #<Vra::Deployment:0x000000027caea0 ... >
 
@@ -152,14 +160,14 @@ deployment.status
 
 You can refresh your deployment object to get the latest status:
 
-```
+```shell
 deployment.refresh && deployment.status
 => "SUCCESSFUL"
 ```
 
 You can also save the deployment ID for later, and create a new deployment object at your leisure to follow-up on your deployment request:
 
-```
+```shell
 deployment.id
 => "aed22465-02db-481d-b55a-cefe216096a2"
 
@@ -171,9 +179,10 @@ new_deployment.status
 ```
 
 ### Deployment Resources
+
 When the deployment request is successful, you can query the resources created as the result of your request. Assuming that the catalog item blueprint we requested only creates a single VM, we can get that resource and learn more information about it:
 
-```
+```shell
 resource = deployment.resources.first
 => #<Vra::Resource:0x00000006772e68 ... >
 
@@ -189,7 +198,7 @@ resource.name
 
 If you have the resource_id and the deployment object, you can fetch the resources details as follows
 
-```
+```shell
 resource.id
 => "331fd10b-f2a2-40ae-86bc-1255c1ee9a6d"
 
@@ -202,10 +211,10 @@ new_resource.name
 
 ### Deleting a deployment from vRA
 
-When you no longer need the VM, you can destroy the deployment which will delete all the associated resources as well. 
+When you no longer need the VM, you can destroy the deployment which will delete all the associated resources as well.
 The method will return a request object you can query for status:
 
-```
+```shell
 destroy_req = deployment.destroy
 => #<Vra::Request:0x00000006ea90d8 ... >
 
@@ -215,7 +224,7 @@ destroy_req.status
 
 You can also list all resources and requests you have permission to see with these methods:
 
-```
+```shell
 deployment.resources
 deployment.requests
 ```
@@ -225,7 +234,7 @@ deployment.requests
 vRA paginates API requests where lists of items are returned.  By default, this gem will ask vRA to provide items in groups of 20.  However, as reported in [Issue 10](https://github.com/chef-partners/vmware-vra-gem/issues/10), it appears vRA may have a pagination bug.  You can change the default page size from 20 to a value of your choice by passing in a `page_size` option when setting up the client:
 
 ```ruby
-vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true, page_size: 100)
+vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', domain: 'domain.corp.local', base_url: 'https://vra.corp.local', verify_ssl: true, page_size: 100)
 ```
 
 ... or setting `page_size` on the client object after you've created it:
@@ -239,11 +248,13 @@ client.page_size = 100
 To aid diagnosis of deep API issues, set the following environment variable to enable logging of all API requests. Note that this will include requests to retrieve the bearer token.
 
 MacOS/Linux:
+
 ```ruby
 export VRA_HTTP_TRACE=1
 ```
 
 Windows:
+
 ```powershell
 $env:VRA_HTTP_TRACE=1
 ```
@@ -259,7 +270,7 @@ 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
 
-```
+```text
 http://www.apache.org/licenses/LICENSE-2.0
 ```
 
@@ -270,7 +281,7 @@ and limitations under the License.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/vmware-vra-gem/fork )
+1. Fork it ( <https://github.com/[my-github-username]/vmware-vra-gem/fork> )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -4,9 +4,9 @@ require "rspec/core/rake_task"
 require "chefstyle"
 require "rubocop/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:test)
 RuboCop::RakeTask.new do |task|
   task.options << "--display-cop-names"
 end
 
-task default: %i{spec rubocop}
+task default: %i{test rubocop}

data/lib/vra/catalog.rb

@@ -15,7 +15,6 @@
 # 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 Catalog
@@ -38,11 +37,11 @@ module Vra
     end
 
     def entitled_sources(project_id)
-      fetch_entitlements(project_id, 'CatalogSourceIdentifier')
+      fetch_entitlements(project_id, "CatalogSourceIdentifier")
     end
 
     def entitled_items(project_id)
-      fetch_entitlements(project_id, 'CatalogItemIdentifier')
+      fetch_entitlements(project_id, "CatalogItemIdentifier")
     end
 
     def request(*args)
@@ -52,7 +51,7 @@ module Vra
     def fetch_catalog_items(catalog_name)
       fetch_resources(
         Vra::CatalogItem,
-        '/catalog/api/admin/items',
+        "/catalog/api/items",
         "search=#{catalog_name}"
       )
     end
@@ -66,12 +65,12 @@ module Vra
     end
 
     def fetch_entitlements(project_id, type)
-      klass = type == 'CatalogSourceIdentifier' ? Vra::CatalogSource : Vra::CatalogItem
+      klass = type == "CatalogSourceIdentifier" ? Vra::CatalogSource : Vra::CatalogItem
 
       client
         .get_parsed("/catalog/api/admin/entitlements?projectId=#{project_id}")
-        .select { |x| x['definition']['type'] == type }
-        .map! { |x| klass.new(client, data: x['definition']) }
+        .select { |x| x["definition"]["type"] == type }
+        .map! { |x| klass.new(client, data: x["definition"]) }
     end
   end
 end

data/lib/vra/catalog_base.rb

@@ -45,8 +45,8 @@ 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, not both' if !@id.nil? && !@data.nil?
+      raise ArgumentError, "must supply id or data hash" if @id.nil? && @data.nil?
+      raise ArgumentError, "must supply id or data hash, not both" if !@id.nil? && !@data.nil?
     end
 
     def entitle_params(type)
@@ -54,8 +54,8 @@ module Vra
         'projectId': project_id,
         'definition': {
           'type': type,
-          'id': id
-        }
+          'id': id,
+        },
       }
     end
   end

data/lib/vra/catalog_item.rb

@@ -23,7 +23,7 @@ require "vra/catalog"
 module Vra
   # Class that represents the Catalog Item
   class CatalogItem < Vra::CatalogBase
-    INDEX_URL = '/catalog/api/admin/items'
+    INDEX_URL = "/catalog/api/items"
 
     attr_reader :project_id
 
@@ -35,30 +35,30 @@ module Vra
       if @data.nil?
         fetch_catalog_item
       else
-        @id = @data['id']
+        @id = @data["id"]
       end
     end
 
     def fetch_catalog_item
-      @data = client.get_parsed("/catalog/api/admin/items/#{id}")
+      @data = client.get_parsed("/catalog/api/items/#{id}")
     rescue Vra::Exception::HTTPNotFound
       raise Vra::Exception::NotFound, "catalog ID #{id} does not exist"
     end
 
     def name
-      data['name']
+      data["name"]
     end
 
     def description
-      data['description']
+      data["description"]
     end
 
     def source_id
-      data['sourceId']
+      data["sourceId"]
     end
 
     def source_name
-      data['sourceName']
+      data["sourceName"]
     end
 
     def source
@@ -66,21 +66,21 @@ module Vra
     end
 
     def type
-      @type ||= Vra::CatalogType.new(client, data: data['type'])
+      @type ||= Vra::CatalogType.new(client, data: data["type"])
     end
 
     def icon_id
-      data['iconId']
+      data["iconId"]
     end
 
     def versions
       client
         .http_get_paginated_array!("/catalog/api/items/#{id}/versions")
-        .map { |v| v['id'] }
+        .map { |v| v["id"] }
     end
 
     def entitle!(opts = {})
-      super(opts.merge(type: 'CatalogItemIdentifier'))
+      super(opts.merge(type: "CatalogItemIdentifier"))
     end
 
     class << self
@@ -89,7 +89,7 @@ module Vra
       end
 
       def fetch_latest_version(client, id)
-        new(client, data: { 'id' => id }).versions&.first
+        new(client, data: { "id" => id }).versions&.first
       end
     end
   end

data/lib/vra/catalog_source.rb

@@ -16,12 +16,12 @@
 # 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)
 
 module Vra
   # Class that represents the Catalog Source
   class CatalogSource < Vra::CatalogBase
-    INDEX_URL = '/catalog/api/admin/sources'
+    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
@@ -33,11 +33,11 @@ module Vra
     end
 
     def name
-      data['name']
+      data["name"]
     end
 
     def catalog_type_id
-      data['typeId']
+      data["typeId"]
     end
 
     def catalog_type
@@ -45,19 +45,19 @@ module Vra
     end
 
     def config
-      data['config']
+      data["config"]
     end
 
     def global?
-      data['global'] == true
+      data["global"] == true
     end
 
     def project_id
-      config['sourceProjectId']
+      config["sourceProjectId"]
     end
 
     def entitle!(opts = {})
-      super(opts.merge(type: 'CatalogSourceIdentifier'))
+      super(opts.merge(type: "CatalogSourceIdentifier"))
     end
 
     class << self
@@ -66,7 +66,7 @@ module Vra
         validate_create!(opts)
 
         response = client.http_post(
-          '/catalog/api/admin/sources',
+          "/catalog/api/admin/sources",
           FFI_Yajl::Encoder.encode(create_params(opts)),
           opts[:skip_auth] || false
         )
@@ -83,7 +83,7 @@ module Vra
       private
 
       def validate_create!(opts)
-        %i[name catalog_type_id project_id].each do |arg|
+        %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
@@ -93,8 +93,8 @@ module Vra
           'name': opts[:name],
           'typeId': opts[:catalog_type_id],
           'config': {
-            'sourceProjectId': opts[:project_id]
-          }
+            'sourceProjectId': opts[:project_id],
+          },
         }
       end
     end
@@ -104,7 +104,7 @@ module Vra
     def fetch_data
       fetch_catalog_data && return if data.nil?
 
-      @id = data['id']
+      @id = data["id"]
     end
 
     def fetch_catalog_data

data/lib/vra/catalog_type.rb

@@ -19,7 +19,7 @@
 module Vra
   # Class that represents the Catalog Type
   class CatalogType < Vra::CatalogBase
-    INDEX_URL = '/catalog/api/types'
+    INDEX_URL = "/catalog/api/types"
 
     def initialize(client, opts = {})
       super
@@ -28,25 +28,25 @@ module Vra
     end
 
     def name
-      data['name']
+      data["name"]
     end
 
     def base_url
-      data['baseUri']
+      data["baseUri"]
     end
 
     def config_schema
-      data['configSchema']
+      data["configSchema"]
     end
 
     def icon_id
-      data['iconId']
+      data["iconId"]
     end
 
     private
 
     def fetch_data
-      @id = data['id'] and return unless data.nil?
+      @id = data["id"] and return unless data.nil?
 
       @data = client.get_parsed("/catalog/api/types/#{id}")
     rescue Vra::Exception::HTTPNotFound