kitchen-vra 2.7.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0bbd05938738944f5f2eda7e6700dce159eaa21e842369c24817f7a9d08953
-  data.tar.gz: ca72c71e4a05482a568480c8aeb9f63ea9ef211762aecaa6f69915e8e8eab29c
+  metadata.gz: 2dd5eb1c44307d885cafca15ead2050b18cc44339d1ee0ef2cae0729c02b1fb0
+  data.tar.gz: 406983722267fe198f460fb24e38726b7534d6ab722b5a7b9fda96028c4df3c4
 SHA512:
-  metadata.gz: 23569b112d12feae0c5828cdf5b2b7df0c26326047f694a35252605f9769b137b79d398f5d367f310fe8ecf74677297b06fce6be6998f9ad0b4dfb7792fe7cd1
-  data.tar.gz: e3a6e753cdcd958eaabf481ca1d1a5c76ce754d72960cda3dabe9b024eb4c958ef88047f860f2f2addcc0d1a9f79b82a45081fedd61993c0e36e0d48c6e1a5fb
+  metadata.gz: c1258498bd2583ffa37232dd4b2a0f47e6f37e035edd597947b887a32ce74c830b450893c7d6489b70dd5666b893a4f3ccf94fd58c842ac0676341774ee5d174
+  data.tar.gz: ef96e597cf8289935c79491951c0aba5c6156c3d8e0e0aa5b73e6aadbe996db6fd7ed8dc2d6e973390fc374e7b91896445558f6928288158c912204f6ae29e1b

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.7', '3.0']
+    name: Lint & Test with Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [v3.0.0](https://github.com/chef-partners/kitchen-vra/tree/v3.0.0)
+
+[Full Changelog](https://github.com/chef-partners/kitchen-vra/compare/v2.7.1...v3.0.0)
+
+- kitchen-vra now supports VMware vRealize Automation 8. See the readme of kitchen.ci driver documentation for new configuration options necessary for use with vRA 8. If you need support for vRA 7 make sure to pin to an earlier release.
+
 ## [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)

data/Gemfile

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

data/README.md

@@ -50,7 +50,7 @@ If you don't want to explicitly specify username and password in the kitchen.yml
     $ 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.
+Then configure your platforms. You will need to specify project_id, image_mapping, flavor_mapping and version for the platform. image_mapping specifies the OS image for a machine and the flavor_mapping specifies the CPU count and RAM of the machine. 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
@@ -58,22 +58,25 @@ platforms:
   - name: centos6
     driver:
       catalog_id: e9db1084-d1c6-4c1f-8e3c-eb8f3dc574f9
+      project_id: 6ba69375-79d5-42c3-a099-7d32739f71a9
+      image_mapping: SQL 2016
+      flavor_mapping: Small
+      version: 1
   - name: centos7
     driver:
       catalog_name: my_catalog_name
+      project_id: 6ba69375-79d5-42c3-a099-7d32739f71a9
+      image_mapping: VRA-nc-lnx-ce8.4-Docker
+      flavor_mapping: Small
+      version: 1
 ```
 
 
 
 Other options that you can set include:
 
- * **lease_days**: number of days to request for a lease, if your catalog item / blueprint requires it
  * **request_timeout**: amount of time, in seconds, to wait for a vRA request to complete. Default is 600 seconds.
  * **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.
@@ -86,13 +89,16 @@ These settings can be set globally under the top-level `driver` section, or they
 ```yaml
 driver:
   name: vra
-  cpus: 1
 
 platforms:
   - name: small
     driver:
       catalog_name: my_catalog_name_small
       catalog_id: 8a189191-fea6-43eb-981e-ee0fa40f8f57
+      project_id: 6ba69375-79d5-42c3-a099-7d32739f71a9
+      image_mapping: SQL 2016
+      flavor_mapping: Small
+      version: 1
       extra_parameters:
         mycustompropname:
           type: string
@@ -104,7 +110,10 @@ platforms:
     driver:
       catalog_name: my_catalog_name_large
       catalog_id: 1d7c6122-18fa-4ed6-bd13-8a33b6c6ed50
-      cpus: 2
+      project_id: 6ba69375-79d5-42c3-a099-7d32739f71a9
+      image_mapping: VRA-nc-lnx-ce8.4-Docker
+      flavor_mapping: Large
+      version: 1
       subtenant_name: my_subtenant_name
       extra_parameters:
         mycustompropname:
@@ -119,7 +128,7 @@ platforms:
 
 Author:: Chef Partner Engineering (<partnereng@chef.io>)
 
-Copyright:: Copyright (c) 2015-2019 Chef Software, Inc.
+Copyright:: Copyright (c) 2022 Chef Software, Inc.
 
 License:: Apache License, Version 2.0
 

data/Rakefile

@@ -1,21 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "chefstyle"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:style)
 
-begin
-  require 'github_changelog_generator/task'
-
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.future_release = Kitchen::Driver::VRA_VERSION
-    config.issues = true
-  end
-rescue LoadError
-  puts 'github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs'
-end
-
-task default: %i[spec style]
+task default: %i{spec style}

data/kitchen-vra.gemspec

@@ -1,35 +1,35 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kitchen/driver/vra_version'
+require "kitchen/driver/vra_version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'kitchen-vra'
+  spec.name          = "kitchen-vra"
   spec.version       = Kitchen::Driver::VRA_VERSION
-  spec.authors       = ['Chef Partner Engineering']
-  spec.email         = ['partnereng@chef.io']
-  spec.summary       = 'A Test Kitchen driver for VMware vRealize Automation (vRA)'
+  spec.authors       = ["Chef Partner Engineering"]
+  spec.email         = ["partnereng@chef.io"]
+  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.homepage      = "https://github.com/chef-partners/kitchen-vra"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'test-kitchen'
-  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 '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.49.0'
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.add_dependency "test-kitchen"
+  spec.add_dependency "vmware-vra", "~> 3.0" # 3.0 required for vRA 8.x
+  spec.add_dependency "highline"
+  spec.add_dependency "rack", "~> 1.6"
+  spec.add_dependency "ffi-yajl", ">= 2.2.3", "< 2.5.0"
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "rake",      "~> 13.0"
+  spec.add_development_dependency "rspec",     "~> 3.2"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "webmock",   "~> 3.14"
+  spec.add_development_dependency "chefstyle", "~> 2.2.1"
 end

data/lib/kitchen/driver/vra.rb

@@ -18,13 +18,13 @@
 # limitations under the License.
 #
 
-require 'kitchen'
-require 'highline/import'
-require 'openssl'
-require 'base64'
-require 'digest/sha1'
-require 'vra'
-require_relative 'vra_version'
+require "kitchen"
+require "highline/import"
+require "openssl" unless defined?(OpenSSL)
+require "base64" unless defined?(Base64)
+require "digest/sha1" unless defined?(Digest::SHA1)
+require "vra"
+require_relative "vra_version"
 
 module Kitchen
   module Driver
@@ -36,6 +36,11 @@ module Kitchen
       default_config :password, nil
       required_config :base_url
       required_config :tenant
+      required_config :project_id
+      required_config :image_mapping
+      required_config :flavor_mapping
+      required_config :version
+
       default_config :catalog_id, nil
       default_config :catalog_name, nil
 
@@ -45,18 +50,13 @@ module Kitchen
       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]
+      default_config :deployment_name do |driver|
+        driver&.instance&.platform&.name
       end
-      default_config :lease_days, nil
-      default_config :notes, nil
       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 +65,21 @@ module Kitchen
       default_config :dns_suffix, nil
 
       def name
-        'vRA'
+        "vRA"
       end
 
       def check_config(force_change = false)
-        config[:username] = config[:username] || ENV['VRA_USER_NAME']
-        config[:password] = config[:password] || ENV['VRA_USER_PASSWORD']
+        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
+        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 = OpenSSL::Cipher.new("cip-her-aes")
         cipher.encrypt
         cipher.key = Digest::SHA1.hexdigest(config[:base_url])
         iv_user = cipher.random_iv
@@ -89,21 +89,21 @@ module Kitchen
         cipher.iv = iv_pwd
         password = cipher.update(config[:password]) + cipher.final
         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 = File.open(".kitchen/cached_vra", "w")
         file.write(output)
         file.close
       rescue
-        puts 'Unable to save credentials'
+        puts "Unable to save credentials"
       end
 
       def c_load
-        if File.exist? '.kitchen/cached_vra'
-          encrypted = File.read('.kitchen/cached_vra')
-          iv_user = Base64.decode64(encrypted.split(':')[0] + '\n')
-          username = Base64.decode64(encrypted.split(':')[1] + "\n")
-          iv_pwd = Base64.decode64(encrypted.split(':')[2] + "\n")
-          password = Base64.decode64(encrypted.split(':')[3] + "\n")
-          cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
+        if File.exist? ".kitchen/cached_vra"
+          encrypted = File.read(".kitchen/cached_vra")
+          iv_user = Base64.decode64(encrypted.split(":")[0] + '\n')
+          username = Base64.decode64(encrypted.split(":")[1] + "\n")
+          iv_pwd = Base64.decode64(encrypted.split(":")[2] + "\n")
+          password = Base64.decode64(encrypted.split(":")[3] + "\n")
+          cipher = OpenSSL::Cipher.new("cip-her-aes")
           cipher.decrypt
           cipher.key = Digest::SHA1.hexdigest(config[:base_url])
           cipher.iv = iv_user
@@ -112,30 +112,31 @@ module Kitchen
           config[:password] = cipher.update(password) + cipher.final
         end
       rescue
-        puts 'Failed to load cached credentials'
+        puts "Failed to load cached credentials"
       end
 
       def create(state)
-        return if state[:resource_id]
+        return if state[:deployment_id]
 
         server = request_server
-        state[:resource_id] = server.id
+        state[:deployment_id] = server.deployment_id
         state[:hostname]    = hostname_for(server)
         state[:ssh_key]     = config[:private_key_path] unless config[:private_key_path].nil?
 
         wait_for_server(state, server)
-        info("Server #{server.id} (#{server.name}) ready.")
+        info("Server #{server.deployment_id} (#{server.name}) ready.")
       end
 
       def hostname_for(server)
         if config[:use_dns]
-          raise 'No server name returned for the vRA request' if server.name.nil?
+          raise "No server name returned for the vRA request" if server.name.nil?
+
           return config[:dns_suffix] ? "#{server.name}.#{config[:dns_suffix]}" : server.name
         end
 
-        ip_address = server.ip_addresses.first
+        ip_address = server.ip_address
         if ip_address.nil?
-          warn("Server #{server.id} has no IP address. Falling back to server name (#{server.name})...")
+          warn("Server #{server.deployment_id} has no IP address. Falling back to server name (#{server.name})...")
           server.name
         else
           ip_address
@@ -143,16 +144,18 @@ module Kitchen
       end
 
       def request_server
-        info('Building vRA catalog request...')
-        submitted_request = catalog_request.submit
-        info("Catalog request #{submitted_request.id} submitted.")
+        info("Building vRA catalog request...")
+
+        deployment_request = catalog_request.submit
 
-        wait_for_request(submitted_request)
-        raise "The vRA request failed: #{submitted_request.completion_details}" if submitted_request.failed?
+        info("Catalog request #{deployment_request.id} submitted.")
 
-        servers = submitted_request.resources.select(&:vm?)
-        raise 'The vRA request created more than one server. The catalog blueprint should only return one.' if servers.size > 1
-        raise 'the vRA request did not create any servers.' if servers.size.zero?
+        wait_for_request(deployment_request)
+        raise "The vRA request failed: #{deployment_request.completion_details}" if deployment_request.failed?
+
+        servers = deployment_request.resources.select(&:vm?)
+        raise "The vRA request created more than one server. The catalog blueprint should only return one." if servers.size > 1
+        raise "the vRA request did not create any servers." if servers.size == 0
 
         servers.first
       end
@@ -172,7 +175,7 @@ module Kitchen
           sleep_time += 5 if sleep_time < 30
 
           if try > config[:server_ready_retries]
-            error('Retries exceeded. Destroying server...')
+            error("Retries exceeded. Destroying server...")
             destroy(state)
             raise
           else
@@ -184,56 +187,57 @@ module Kitchen
       end
 
       def destroy(state)
-        return if state[:resource_id].nil?
+        return if state[:deployment_id].nil?
 
         begin
-          server = vra_client.resources.by_id(state[:resource_id])
+          server = vra_client.deployments.by_id(state[:deployment_id])
         rescue ::Vra::Exception::NotFound
-          warn("No server found with ID #{state[:resource_id]}, assuming it has been destroyed already.")
+          warn("No server found with ID #{state[:deployment_id]}, assuming it has been destroyed already.")
           return
         end
 
         begin
           destroy_request = server.destroy
         rescue ::Vra::Exception::NotFound
-          info('Server not found, or no destroy action available, perhaps because it is already destroyed.')
+          info("Server not found, or no destroy action available, perhaps because it is already destroyed.")
           return
         end
         info("Destroy request #{destroy_request.id} submitted.")
         wait_for_request(destroy_request)
-        info('Destroy request complete.')
+        info("Destroy request complete.")
 
-        File.delete('.kitchen/cached_vra') if File.exist?('.kitchen/cached_vra')
-        info('Removed cached file')
+        File.delete(".kitchen/cached_vra") if File.exist?(".kitchen/cached_vra")
+        info("Removed cached file")
       end
 
       def catalog_request # rubocop:disable Metrics/MethodLength
         unless config[:catalog_name].nil?
-          info('Fetching Catalog ID by Catalog Name')
+          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']
+            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])
+        deployment_params = {
+          image_mapping: config[:image_mapping],
+          flavor_mapping: config[:flavor_mapping],
+          name: config[:deployment_name],
+          project_id: config[:project_id],
+          version: config[:version],
+        }
 
-        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 = vra_client.catalog.request(config[:catalog_id], deployment_params)
 
         unless config[:subtenant_name].nil?
-          info('Fetching Subtenant ID by Subtenant Name')
+          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']
+            config[:subtenant_id] = parsed_json["content"][0]["id"]
           rescue
             puts "Unable to retrieve Subtenant ID from Subtenant Name: #{config[:subtenant_name]}"
           end
@@ -263,9 +267,10 @@ module Kitchen
       def wait_for_request(request)
         # config = check_config config
 
-        last_status = ''
+        last_status = ""
         wait_time   = config[:request_timeout]
         sleep_time  = config[:request_refresh_rate]
+
         Timeout.timeout(wait_time) do
           loop do
             request.refresh

data/lib/kitchen/driver/vra_version.rb

@@ -20,6 +20,6 @@
 
 module Kitchen
   module Driver
-    VRA_VERSION = '2.7.1'
+    VRA_VERSION = "3.0.0"
   end
 end

data/spec/spec_helper.rb

@@ -18,14 +18,14 @@
 # limitations under the License.
 #
 
-require 'webmock/rspec'
+require "webmock/rspec"
 
 WebMock.disable_net_connect!(allow_localhost: true)
 
-if ENV['COVERAGE']
-  require 'simplecov'
-  SimpleCov.profiles.define 'gem' do
-    command_name 'Specs'
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.profiles.define "gem" do
+    command_name "Specs"
   end
-  SimpleCov.start 'gem'
+  SimpleCov.start "gem"
 end