kitchen-vra 2.3.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e4cfc4ac71a96821a3b283979f4f02a37c2ea71
-  data.tar.gz: 1d1029f7792c46a8c4cbe8e19d45418dc6969617
+SHA256:
+  metadata.gz: 4d0bbd05938738944f5f2eda7e6700dce159eaa21e842369c24817f7a9d08953
+  data.tar.gz: ca72c71e4a05482a568480c8aeb9f63ea9ef211762aecaa6f69915e8e8eab29c
 SHA512:
-  metadata.gz: ce5a986c98e748a248d9053f989b6480620d5307e2211636ac59dfc4ca861d221cc8b0f71c421575e5baefd0626b0228751fa6308ed2ce5b6c04e7a892672456
-  data.tar.gz: 96caae81ee6b15e35d26e28e44915d2176964bc46d253aa7f2e8dc2f04e007674f32175af23205cb1e0fec155677c9a98a553179239e7f3509f7ce61affe63fe
+  metadata.gz: 23569b112d12feae0c5828cdf5b2b7df0c26326047f694a35252605f9769b137b79d398f5d367f310fe8ecf74677297b06fce6be6998f9ad0b4dfb7792fe7cd1
+  data.tar.gz: e3a6e753cdcd958eaabf481ca1d1a5c76ce754d72960cda3dabe9b024eb4c958ef88047f860f2f2addcc0d1a9f79b82a45081fedd61993c0e36e0d48c6e1a5fb

data/.rubocop.yml

@@ -1,19 +1,32 @@
 AllCops:
   DisplayCopNames: true
 Metrics/AbcSize:
-  Max: 50
+  Max: 100
 Metrics/ClassLength:
   Max: 125
+Metrics/CyclomaticComplexity:
+  Max: 20
+Metrics/MethodLength:
+  Exclude:
+    - '**/*.rb'
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 30
 Metrics/LineLength:
-  Max: 130
+  Max: 200
 Metrics/MethodLength:
   Max: 25
 Style/Documentation:
   Enabled: false
+Style/EndOfLine:
+  EnforcedStyle: lf
 Style/SignalException:
   Enabled: false
-Style/SpaceInsideBrackets:
+Layout/SpaceInsideBrackets:
+  Enabled: false
+Style/MutableConstant:
   Enabled: false
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
+ 

data/CHANGELOG.md

@@ -1,7 +1,38 @@
 # Change Log
 
-## [2.3.0](https://github.com/chef-partners/kitchen-vra/tree/2.3.0) (2017-07-14)
-[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.2.0...2.3.0)
+## [v2.7.1](https://github.com/chef-partners/kitchen-vra/tree/v2.7.1)
+
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.7.0...v2.7.1)
+
+- Pin vmware-vra gem dep to < 3 to prevent pulling in the new release
+
+## [v2.7.0](https://github.com/chef-partners/kitchen-vra/tree/v2.7.0)
+
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.6.0...v2.7.0)
+
+- Accept shirt size option available in blueprint as input in kitchen.yml 
+
+## [v2.5.0](https://github.com/chef-partners/kitchen-vra/tree/v2.5.0)
+
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.4.0...v2.5.0)
+
+**Closed issues:**
+
+- Feature Query: Support for Capture Snapshot & Restore Snapshot [\#27](https://github.com/chef-partners/kitchen-vra/issues/27)
+
+**Merged pull requests:**
+
+- Accept subtenant name as input in kitchen.yml [\#28](https://github.com/chef-partners/kitchen-vra/pull/28) ([vinuphilip](https://github.com/vinuphilip))
+
+## [v2.4.0](https://github.com/chef-partners/kitchen-vra/tree/v2.4.0) (2018-01-22)
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.3.0...v2.4.0)
+
+**Merged pull requests:**
+
+- Kitchen vRA enahancements [\#26](https://github.com/chef-partners/kitchen-vra/pull/26) ([rupeshpatel88](https://github.com/rupeshpatel88))
+
+## [v2.3.0](https://github.com/chef-partners/kitchen-vra/tree/v2.3.0) (2017-07-14)
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.2.0...v2.3.0)
 
 **Merged pull requests:**
 
@@ -82,4 +113,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -36,7 +36,22 @@ driver:
   verify_ssl: true
 ```
 
-Then configure your platforms. A catalog_id is required for each platform:
+If you want username and password to be prompted, remove usename and password in your .kitchen.yml as shown below:
+
+```yaml
+driver:
+  name: vra
+  tenant: mytenant
+  base_url: https://vra.corp.local
+  verify_ssl: true
+```
+If you don't want to explicitly specify username and password in the kitchen.yml, you have an option to set it in the environment variable as 
+
+    $ export VRA_USER_NAME='myuser@corp.local'
+    $ export VRA_USER_PASSWORD='mypassword'
+
+Then configure your platforms. Either a catalog_id or a catalog_name is required for each platform. If both catalog_id and catalog_name are mentioned in .kitchen.yml then catalog_name would be used to derive the catalog_id and this catalog_id would override the catalog_id being passed in .kitchen.yml. In the below example as can be seen we are using catalog_id for centos6 driver while catalog_name for the centos7 driver just to demonstrate that we can use either of the two.
+
 
 ```yaml
 platforms:
@@ -45,9 +60,11 @@ platforms:
       catalog_id: e9db1084-d1c6-4c1f-8e3c-eb8f3dc574f9
   - name: centos7
     driver:
-      catalog_id: c4211950-ab07-42b1-ba80-8f5d3f2c8251
+      catalog_name: my_catalog_name
 ```
 
+
+
 Other options that you can set include:
 
  * **lease_days**: number of days to request for a lease, if your catalog item / blueprint requires it
@@ -55,12 +72,14 @@ Other options that you can set include:
  * **server_ready_retries**: Number of times to retry the "waiting for server to be ready" check. In some cases, this will error out immediately due to DNS propagation issues, etc. Setting this to a number greater than 0 will retry the `wait_until_ready` method with a growing sleep in between each attempt. Defaults to 1. Set to 0 to disable any retrying of the `wait_until_ready` method.
  * **cpus**: number of CPUs the host should have
  * **memory**: amount of RAM, in MB, the host should have
+ * **shirt_size**: This parameter corresponds to shirt size option of vRA available on blueprint like ValueSet.Large, ValueSet.Small etc. As shirt size is a combination of memory and RAM, hence while using this no need to use cpus and memory parameter. This shirt size option helps in standardizing the sizing available for end users
  * **requested_for**: the vRA login ID to list as the owner of this resource. Defaults to the vRA username configured in the `driver` section.
  * **subtenant_id**: the Business Group ID to list as the owner. This is required if the catalog item is a shared/global item; we are unable to determine the subtenant_id from the catalog, and vRA requires it to be set on every request.
+ * **subtenant_name**: the Business Group Name as the owner. This can be passed instead of subtenant_id and would act as a more friendly name. subtenant_id would be internally retrieved based on the provided subtenant_name. In case both subtenant_id and subtenant_name are passed, subtenant_name would take the precendence and would try to retrieve subtenant_id based on subtenant_name passed.
  * **private_key_path**: path to the SSH private key to use when logging in. Defaults to '~/.ssh/id_rsa' or '~/.ssh/id_dsa', preferring the RSA key. Only applies to instances where SSH transport is used; i.e., does not apply to Windows hosts with the WinRM transport configured.
  * **use_dns**: Defaults to `false`.  Set to `true` if vRA doesn't manage vm ip addresses.  This will cause kitchen to attempt to connect via hostname.
  * **dns_suffix**: Defaults to `nil`.  Set to your domain suffix, for example 'mydomain.com'.  This only takes effect when `use_dns` == true and is appended to the hostname returned by vRA.
- * **extra_parameters**: a hash of other data to set on a catalog request, most notably custom properties. Allows updates to existing properties on the blueprint as well as the addition of new properties. The vRA REST API expects 'provider-' appended to the front of a property name; each key in the hash is the property name, and the value is a another hash containing the value data type and the value itself.
+ * **extra_parameters**: a hash of other data to set on a catalog request, most notably custom properties. Allows updates to existing properties on the blueprint as well as the addition of new properties. Each key in the hash is the property name, and the value is a another hash containing the value data type and the value itself. It is possible to use a `~` to add nested parameters.
 
 These settings can be set globally under the top-level `driver` section, or they can be set on each platform, which allows you to set globals and then override them. For example, this configuration would set the CPU count to 1 except on the "large" platform:
 
@@ -72,23 +91,26 @@ driver:
 platforms:
   - name: small
     driver:
+      catalog_name: my_catalog_name_small
       catalog_id: 8a189191-fea6-43eb-981e-ee0fa40f8f57
       extra_parameters:
-        provider-mycustompropname:
+        mycustompropname:
           type: string
           value: smallvalue
-        provider-Vrm.DataCenter.Location:
+        Vrm.DataCenter.Location:
           type: string
           value: Non-Prod
   - name: large
     driver:
+      catalog_name: my_catalog_name_large
       catalog_id: 1d7c6122-18fa-4ed6-bd13-8a33b6c6ed50
       cpus: 2
+      subtenant_name: my_subtenant_name
       extra_parameters:
-        provider-mycustompropname:
+        mycustompropname:
           type: string
           value: largevalue
-        provider-Vrm.DataCenter.Location:
+        Vrm.DataCenter.Location:
           type: string
           value: Prod
 ```
@@ -97,7 +119,7 @@ platforms:
 
 Author:: Chef Partner Engineering (<partnereng@chef.io>)
 
-Copyright:: Copyright (c) 2015-2017 Chef Software, Inc.
+Copyright:: Copyright (c) 2015-2019 Chef Software, Inc.
 
 License:: Apache License, Version 2.0
 

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -17,4 +18,4 @@ rescue LoadError
   puts 'github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs'
 end
 
-task default: [ :spec, :style ]
+task default: %i[spec style]

data/kitchen-vra.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 # frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'kitchen/driver/vra_version'
@@ -12,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A Test Kitchen driver for VMware vRealize Automation (vRA)'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/chef-partners/kitchen-vra'
-  spec.license       = 'Apache 2.0'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = []
@@ -20,15 +21,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'test-kitchen'
-  spec.add_dependency 'vmware-vra', '~> 2'
+  spec.add_dependency 'vmware-vra', '~> 2', '< 3' # 3.0 and newer is not supported
   spec.add_dependency 'highline'
   spec.add_dependency 'rack', '~> 1.6' unless RUBY_VERSION.index('2.0.').nil?
   spec.add_dependency 'ffi-yajl', '~> 2.2.3' unless RUBY_VERSION.index('2.0.').nil?
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '>= 1.7'
   spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'rake',      '~> 10.0'
   spec.add_development_dependency 'rspec',     '~> 3.2'
   spec.add_development_dependency 'simplecov', '~> 0.10'
   spec.add_development_dependency 'webmock',   '~> 1.21'
-  spec.add_development_dependency 'rubocop',   '~> 0.35'
+  spec.add_development_dependency 'rubocop',   '~> 0.49.0'
 end

data/lib/kitchen/driver/vra.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.
@@ -31,19 +32,22 @@ module Kitchen
       kitchen_driver_api_version 2
       plugin_version Kitchen::Driver::VRA_VERSION
 
-      default_config :username, ''
-      default_config :password, ''
+      default_config :username, nil
+      default_config :password, nil
       required_config :base_url
       required_config :tenant
-      required_config :catalog_id
+      default_config :catalog_id, nil
+      default_config :catalog_name, nil
 
-      default_config :subtenant, nil
+      default_config :subtenant_id, nil
+      default_config :subtenant_name, nil
       default_config :verify_ssl, true
       default_config :request_timeout, 600
       default_config :request_refresh_rate, 2
       default_config :server_ready_retries, 1
       default_config :cpus, 1
       default_config :memory, 1024
+      default_config :shirt_size, nil
       default_config :requested_for do |driver|
         driver[:username]
       end
@@ -52,7 +56,7 @@ module Kitchen
       default_config :cache_credentials, false
       default_config :extra_parameters, {}
       default_config :private_key_path do
-        %w(id_rsa id_dsa).map do |key|
+        %w[id_rsa id_dsa].map do |key|
           file = File.expand_path("~/.ssh/#{key}")
           file if File.exist?(file)
         end.compact.first
@@ -65,21 +69,26 @@ module Kitchen
       end
 
       def check_config(force_change = false)
-        c_load
-        config[:username] = ask('Enter Username: ') if config[:username].eql?('') || force_change
-        config[:password] = ask('Enter password: ') { |q| q.echo = '*' } if config[:password].eql?('') || force_change
-        c_save
+        config[:username] = config[:username] || ENV['VRA_USER_NAME']
+        config[:password] = config[:password] || ENV['VRA_USER_PASSWORD']
+        c_load if config[:username].nil? && config[:password].nil?
+
+        config[:username] = ask('Enter Username: e.g. username@domain') if config[:username].nil? || force_change
+        config[:password] = ask('Enter password: ') { |q| q.echo = '*' } if config[:password].nil? || force_change
+        c_save if config[:cache_credentials]
       end
 
       def c_save
         cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
         cipher.encrypt
         cipher.key = Digest::SHA1.hexdigest(config[:base_url])
-        iv = cipher.random_iv
-        cipher.iv = iv
+        iv_user = cipher.random_iv
+        cipher.iv = iv_user
         username = cipher.update(config[:username]) + cipher.final
+        iv_pwd = cipher.random_iv
+        cipher.iv = iv_pwd
         password = cipher.update(config[:password]) + cipher.final
-        output = "#{Base64.encode64(iv).strip!}:#{Base64.encode64(username).strip!}:#{Base64.encode64(password).strip!}"
+        output = "#{Base64.encode64(iv_user).strip!}:#{Base64.encode64(username).strip!}:#{Base64.encode64(iv_pwd).strip!}:#{Base64.encode64(password).strip!}"
         file = File.open('.kitchen/cached_vra', 'w')
         file.write(output)
         file.close
@@ -90,14 +99,16 @@ module Kitchen
       def c_load
         if File.exist? '.kitchen/cached_vra'
           encrypted = File.read('.kitchen/cached_vra')
-          iv = Base64.decode64(encrypted.split(':')[0] + '\n')
+          iv_user = Base64.decode64(encrypted.split(':')[0] + '\n')
           username = Base64.decode64(encrypted.split(':')[1] + "\n")
-          password = Base64.decode64(encrypted.split(':')[2] + "\n")
+          iv_pwd = Base64.decode64(encrypted.split(':')[2] + "\n")
+          password = Base64.decode64(encrypted.split(':')[3] + "\n")
           cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
           cipher.decrypt
           cipher.key = Digest::SHA1.hexdigest(config[:base_url])
-          cipher.iv = iv
+          cipher.iv = iv_user
           config[:username] = cipher.update(username) + cipher.final
+          cipher.iv = iv_pwd
           config[:password] = cipher.update(password) + cipher.final
         end
       rescue
@@ -191,17 +202,43 @@ module Kitchen
         info("Destroy request #{destroy_request.id} submitted.")
         wait_for_request(destroy_request)
         info('Destroy request complete.')
+
+        File.delete('.kitchen/cached_vra') if File.exist?('.kitchen/cached_vra')
+        info('Removed cached file')
       end
 
-      def catalog_request
+      def catalog_request # rubocop:disable Metrics/MethodLength
+        unless config[:catalog_name].nil?
+          info('Fetching Catalog ID by Catalog Name')
+          response =  vra_client.catalog.fetch_catalog_items(config[:catalog_name])
+          parsed_json = JSON.parse(response.body)
+          begin
+            config[:catalog_id] = parsed_json['content'][0]['catalogItemId']
+          rescue
+            puts "Unable to retrieve Catalog ID from Catalog Name: #{config[:catalog_name]}"
+          end
+        end
+
         catalog_request = vra_client.catalog.request(config[:catalog_id])
 
         catalog_request.cpus          = config[:cpus]
         catalog_request.memory        = config[:memory]
+        catalog_request.shirt_size    = config[:shirt_size]	unless config[:shirt_size].nil?
         catalog_request.requested_for = config[:requested_for]
         catalog_request.lease_days    = config[:lease_days]    unless config[:lease_days].nil?
         catalog_request.notes         = config[:notes]         unless config[:notes].nil?
-        catalog_request.subtenant_id  = config[:subtenant_id]  unless config[:subtenant_id].nil?
+
+        unless config[:subtenant_name].nil?
+          info('Fetching Subtenant ID by Subtenant Name')
+          response = vra_client.fetch_subtenant_items(config[:tenant], config[:subtenant_name])
+          parsed_json = JSON.parse(response.body)
+          begin
+            config[:subtenant_id] = parsed_json['content'][0]['id']
+          rescue
+            puts "Unable to retrieve Subtenant ID from Subtenant Name: #{config[:subtenant_name]}"
+          end
+        end
+        catalog_request.subtenant_id = config[:subtenant_id] unless config[:subtenant_id].nil?
 
         config[:extra_parameters].each do |key, value_data|
           catalog_request.set_parameters(key, value_data)
@@ -211,7 +248,7 @@ module Kitchen
       end
 
       def vra_client
-        check_config false if config[:cache_credentials]
+        check_config config[:cache_credentials]
         @client ||= ::Vra::Client.new(
           base_url:   config[:base_url],
           username:   config[:username],

data/lib/kitchen/driver/vra_version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.
@@ -19,6 +20,6 @@
 
 module Kitchen
   module Driver
-    VRA_VERSION = '2.3.0'
+    VRA_VERSION = '2.7.1'
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.

data/spec/vra_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.
@@ -399,7 +400,7 @@ describe Kitchen::Driver::Vra do
       allow(driver).to receive(:vra_client).and_return(vra_client)
       allow(vra_client).to receive(:catalog).and_return(catalog)
       allow(catalog).to receive(:request).and_return(catalog_request)
-      [ :cpus=, :memory=, :requested_for=, :lease_days=, :notes=, :subtenant_id=, :set_parameter ].each do |method|
+      %i[cpus= memory= requested_for= lease_days= notes= subtenant_id= set_parameter].each do |method|
         allow(catalog_request).to receive(method)
       end
     end
@@ -457,8 +458,8 @@ describe Kitchen::Driver::Vra do
       end
 
       it 'sets extra parmeters' do
-        expect(catalog_request).to receive(:set_parameter).with('key1', 'string', 'value1')
-        expect(catalog_request).to receive(:set_parameter).with('key2', 'integer', 123)
+        expect(catalog_request).to receive(:set_parameters).with('key1', type: 'string', value: 'value1')
+        expect(catalog_request).to receive(:set_parameters).with('key2', type: 'integer', value: 123)
         driver.catalog_request
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vra
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Chef Partner Engineering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -56,14 +62,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
@@ -142,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: 0.49.0
 description: A Test Kitchen driver for VMware vRealize Automation (vRA)
 email:
 - partnereng@chef.io
@@ -174,9 +180,9 @@ files:
 - spec/vra_spec.rb
 homepage: https://github.com/chef-partners/kitchen-vra
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,9 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A Test Kitchen driver for VMware vRealize Automation (vRA)
 test_files: