knife-vrealize 3.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 267c713a407cd2265caf2e14a8fe31cfd9b5014e
-  data.tar.gz: b84bf831de2c95d2c302ff5bd1fcadf6ad8aafa1
+SHA256:
+  metadata.gz: 26774900025bacb20c92669ec354fa5eecf896a05e5dc0360639bc3c58b58998
+  data.tar.gz: c374fd4befb4616243716ddd664a509f13c33d9a1254d1c0af3985103604c7dd
 SHA512:
-  metadata.gz: 2b50faa246e6875d2f9d25b3612236943a316c759e5dc65adb6a78fc260eab8347d0ed44a334b719982ef51fbaf9600afa954aa401f10c4a9df64681f552a19c
-  data.tar.gz: 0b83282bc5280d5d7e79d0bf8424d12b0ee9270c683da89937385c94f85261a9d301cbf10e156c6ecd7f702f03a2488a456b44bb6d28fbb9f4b235ec8f11fb85
+  metadata.gz: 29be7394fb628f6ff10f98e63b3d4a01ec3ab7bcdc8d23c35140dc754481051be09bd9668ce2f73ee169d9f380197c8114bf611e90e9e6fcb142ff0cbfaf2a94
+  data.tar.gz: 48870906b9cc159ff4c95faac60f3a4a1e8657b9b1f82003e0441534eb1b2fda359fba59869b0502b6e67cbf3631e1674f51e3fa3be635dd25bd1a70a7a454ef

data/lib/chef/knife/cloud/vra_service.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,19 +18,19 @@
 # limitations under the License.
 #
 
-require 'chef/knife/cloud/exceptions'
-require 'chef/knife/cloud/service'
-require 'chef/knife/cloud/helpers'
-require 'chef/knife/cloud/vra_service_helpers'
-require 'vra'
+require "chef/knife/cloud/exceptions"
+require "chef/knife/cloud/service"
+require "chef/knife/cloud/helpers"
+require_relative "vra_service_helpers"
+require "vra"
 
 class Chef
   class Knife
     class Cloud
       class VraService < Service
         include VraServiceHelpers
-        def initialize(options={})
-          super(options)
+        def initialize(options = {})
+          super(config: options)
 
           @username   = options[:username]
           @password   = options[:password]
@@ -51,7 +51,7 @@ class Chef
           )
         end
 
-        def create_server(options={})
+        def create_server(options = {})
           submitted_request = catalog_request(options).submit
           ui.msg("Catalog request #{submitted_request.id} submitted.")
           wait_for_request(submitted_request, options[:wait_time].to_i, options[:refresh_rate])
@@ -61,8 +61,8 @@ class Chef
           raise CloudExceptions::ServerCreateError, submitted_request.completion_details if submitted_request.failed?
 
           servers = submitted_request.resources.select(&:vm?)
-          raise CloudExceptions::ServerCreateError, 'The vRA request created more than one server, but we were only expecting 1' if servers.length > 1
-          raise CloudExceptions::ServerCreateError, 'The vRA request did not create any servers' if servers.length.zero?
+          raise CloudExceptions::ServerCreateError, "The vRA request created more than one server, but we were only expecting 1" if servers.length > 1
+          raise CloudExceptions::ServerCreateError, "The vRA request did not create any servers" if servers.length == 0
 
           servers.first
         end
@@ -70,19 +70,19 @@ class Chef
         def delete_server(instance_id)
           server = get_server(instance_id)
           server_summary(server)
-          ui.msg('')
+          ui.msg("")
 
-          if server.status == 'DELETED'
+          if server.status == "DELETED"
             ui.warn("Server is already deleted.\n")
             return
           end
 
-          ui.confirm('Do you really want to delete this server')
+          ui.confirm("Do you really want to delete this server")
 
           destroy_request = server.destroy
           ui.msg("Destroy request #{destroy_request.id} submitted.")
           wait_for_request(destroy_request)
-          ui.msg('Destroy request complete.')
+          ui.msg("Destroy request complete.")
           request_summary(destroy_request)
         end
 
@@ -102,22 +102,22 @@ class Chef
           connection.resources.by_id(instance_id)
         end
 
-        def server_summary(server, _columns_with_info=nil)
-          msg_pair('Server ID', server.id)
-          msg_pair('Server Name', server.name)
-          msg_pair('IP Addresses', server.ip_addresses.nil? ? 'none' : server.ip_addresses.join(', '))
-          msg_pair('Status', server.status)
-          msg_pair('Catalog Name', server.catalog_name)
-          msg_pair('Owner IDs', server.owner_ids.empty? ? 'none' : server.owner_ids.join(', '))
-          msg_pair('Owner Names', server.owner_names.empty? ? 'none' : server.owner_names.join(', '))
+        def server_summary(server, _columns_with_info = nil)
+          msg_pair("Server ID", server.id)
+          msg_pair("Server Name", server.name)
+          msg_pair("IP Addresses", server.ip_addresses.nil? ? "none" : server.ip_addresses.join(", "))
+          msg_pair("Status", server.status)
+          msg_pair("Catalog Name", server.catalog_name)
+          msg_pair("Owner IDs", server.owner_ids.empty? ? "none" : server.owner_ids.join(", "))
+          msg_pair("Owner Names", server.owner_names.empty? ? "none" : server.owner_names.join(", "))
         end
 
         def request_summary(request)
-          ui.msg('')
-          msg_pair('Request Status', request.status)
-          msg_pair('Completion State', request.completion_state)
-          msg_pair('Completion Details', request.completion_details)
-          ui.msg('')
+          ui.msg("")
+          msg_pair("Request Status", request.status)
+          msg_pair("Completion State", request.completion_state)
+          msg_pair("Completion Details", request.completion_details)
+          ui.msg("")
         end
 
         def catalog_request(options)

data/lib/chef/knife/cloud/vra_service_helpers.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +18,7 @@
 # limitations under the License.
 #
 
-require 'chef/knife/cloud/helpers'
+require "chef/knife/cloud/helpers"
 
 class Chef
   class Knife
@@ -27,22 +27,22 @@ class Chef
         include Chef::Knife::Cloud::Helpers
 
         def create_service_instance
-          Chef::Knife::Cloud::VraService.new(username:  locate_config_value(:vra_username),
-                                             password:  locate_config_value(:vra_password),
-                                             base_url:  locate_config_value(:vra_base_url),
-                                             tenant:    locate_config_value(:vra_tenant),
-                                             page_size: locate_config_value(:vra_page_size),
+          Chef::Knife::Cloud::VraService.new(username:  config[:vra_username],
+                                             password:  config[:vra_password],
+                                             base_url:  config[:vra_base_url],
+                                             tenant:    config[:vra_tenant],
+                                             page_size: config[:vra_page_size],
                                              verify_ssl: verify_ssl?)
         end
 
         def verify_ssl?
-          !locate_config_value(:vra_disable_ssl_verify)
+          !config[:vra_disable_ssl_verify]
         end
 
-        def wait_for_request(request, wait_time=600, refresh_rate=2)
-          print 'Waiting for request to complete.'
+        def wait_for_request(request, wait_time = 600, refresh_rate = 2)
+          print "Waiting for request to complete."
 
-          last_status = ''
+          last_status = ""
 
           begin
             Timeout.timeout(wait_time) do
@@ -55,7 +55,7 @@ class Chef
                 end
 
                 if last_status == request.status
-                  print '.'
+                  print "."
                 else
                   last_status = request.status
                   print "\n"
@@ -66,7 +66,7 @@ class Chef
               end
             end
           rescue Timeout::Error
-            ui.msg('')
+            ui.msg("")
             ui.error("Request did not complete in #{wait_time} seconds. Check the Requests tab in the vRA UI for more information.")
             exit 1
           end
@@ -78,10 +78,10 @@ class Chef
 
         # rubocop:disable Style/GuardClause
         def check_for_missing_config_values!(*keys)
-          missing = keys.select { |x| locate_config_value(x).nil? }
+          missing = keys.select { |x| config[x].nil? }
 
           unless missing.empty?
-            ui.error("The following required parameters are missing: #{missing.join(', ')}")
+            ui.error("The following required parameters are missing: #{missing.join(", ")}")
             exit(1)
           end
         end

data/lib/chef/knife/cloud/vra_service_options.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,37 +27,37 @@ class Chef
         def self.included(includer)
           includer.class_eval do
             option :vra_base_url,
-              long:        '--vra-base-url API_URL',
-              description: 'URL for the vRA server',
-              proc:        proc { |url| url.sub(%r{/(\/)+$/}, '') }
+              long:        "--vra-base-url API_URL",
+              description: "URL for the vRA server",
+              proc:        proc { |url| url.sub(%r{/(\/)+$/}, "") }
 
             option :vra_username,
-              long:        '--vra-username USERNAME',
-              description: 'Username to use with the vRA API'
+              long:        "--vra-username USERNAME",
+              description: "Username to use with the vRA API"
 
             option :vra_password,
-              long:        '--vra-password PASSWORD',
-              description: 'Password to use with the vRA API'
+              long:        "--vra-password PASSWORD",
+              description: "Password to use with the vRA API"
 
             option :vra_tenant,
-              long:        '--vra-tenant TENANT',
-              description: 'Tenant name (organization) to use with the vRA API'
+              long:        "--vra-tenant TENANT",
+              description: "Tenant name (organization) to use with the vRA API"
 
             option :vra_disable_ssl_verify,
-              long:        '--vra-disable-ssl-verify',
-              description: 'Skip any SSL verification for the vRA API',
+              long:        "--vra-disable-ssl-verify",
+              description: "Skip any SSL verification for the vRA API",
               boolean:     true,
               default:     false
 
             option :vra_page_size,
-              long:        '--page-size NUM_OF_ITEMS',
-              description: 'Maximum number of items to fetch from the vRA API when pagination is forced',
+              long:        "--page-size NUM_OF_ITEMS",
+              description: "Maximum number of items to fetch from the vRA API when pagination is forced",
               default:     200,
               proc:        proc { |page_size| page_size.to_i }
 
             option :request_refresh_rate,
-              long:        '--request-refresh-rate SECS',
-              description: 'Number of seconds to sleep between each check of the request status, defaults to 2',
+              long:        "--request-refresh-rate SECS",
+              description: "Number of seconds to sleep between each check of the request status, defaults to 2",
               default:     2,
               proc:        proc { |secs| secs.to_i }
           end

data/lib/chef/knife/vra_catalog_list.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,46 +18,51 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'chef/knife/cloud/list_resource_command'
-require 'chef/knife/cloud/vra_service'
-require 'chef/knife/cloud/vra_service_helpers'
-require 'chef/knife/cloud/vra_service_options'
+require "chef/knife"
+require "chef/knife/cloud/list_resource_command"
+require_relative "cloud/vra_service_options"
 
 class Chef
   class Knife
     class Cloud
       class VraCatalogList < ResourceListCommand
-        include VraServiceHelpers
         include VraServiceOptions
 
-        banner 'knife vra catalog list'
+        banner "knife vra catalog list"
+
+        deps do
+          require_relative "cloud/vra_service"
+          require_relative "cloud/vra_service_helpers"
+          include VraServiceHelpers
+        end
 
         option :entitled,
-               long:        '--entitled-only',
-               description: 'only list entitled vRA catalog entries',
-               boolean:     true,
-               default:     false
+          long:        "--entitled-only",
+          description: "only list entitled vRA catalog entries",
+          boolean:     true,
+          default:     false
 
         def before_exec_command
           @columns_with_info = [
-            { label: 'Catalog ID',  key: 'id' },
-            { label: 'Name',        key: 'name' },
-            { label: 'Description', key: 'description' },
-            { label: 'Status',      key: 'status', value_callback: method(:format_status_value) },
-            { label: 'Subtenant',   key: 'subtenant_name' }
+            { label: "Catalog ID",  key: "id" },
+            { label: "Name",        key: "name" },
+            { label: "Description", key: "description" },
+            { label: "Status",      key: "status", value_callback: method(:format_status_value) },
+            { label: "Subtenant",   key: "subtenant_name" },
           ]
 
-          @sort_by_field = 'name'
+          @sort_by_field = "name"
         end
 
         def query_resource
-          @service.list_catalog_items(locate_config_value(:entitled))
+          @service.list_catalog_items(config[:entitled])
         end
 
         def format_status_value(status)
+          return "-" if status.nil?
+
           status = status.downcase
-          color  = if status == 'published'
+          color  = if status == "published"
                      :green
                    else
                      :red

data/lib/chef/knife/vra_server_create.rb

@@ -2,7 +2,7 @@
 
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,12 +18,10 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'chef/knife/cloud/server/create_command'
-require 'chef/knife/cloud/server/create_options'
-require 'chef/knife/cloud/vra_service'
-require 'chef/knife/cloud/vra_service_helpers'
-require 'chef/knife/cloud/vra_service_options'
+require "chef/knife"
+require "chef/knife/cloud/server/create_command"
+require "chef/knife/cloud/server/create_options"
+require_relative "cloud/vra_service_options"
 
 class Chef
   class Knife
@@ -33,57 +31,62 @@ class Chef
         include VraServiceOptions
         include ServerCreateOptions
 
-        banner 'knife vra server create CATALOG_ID (options)'
+        banner "knife vra server create CATALOG_ID (options)"
+
+        deps do
+          require_relative "cloud/vra_service"
+          require_relative "cloud/vra_service_helpers"
+        end
 
         option :cpus,
-               long:        '--cpus NUM_CPUS',
-               description: 'Number of CPUs the server should have'
+          long:        "--cpus NUM_CPUS",
+          description: "Number of CPUs the server should have"
 
         option :node_ssl_verify_mode,
-               long: '--node-ssl-verify-mode [peer|none]',
-               description: 'Whether or not to verify the SSL cert for all HTTPS requests when bootstrapping'
+          long: "--node-ssl-verify-mode [peer|none]",
+          description: "Whether or not to verify the SSL cert for all HTTPS requests when bootstrapping"
         option :memory,
-               long:        '--memory RAM_IN_MB',
-               description: 'Amount of RAM, in MB, the server should have'
+          long:        "--memory RAM_IN_MB",
+          description: "Amount of RAM, in MB, the server should have"
 
         option :requested_for,
-               long:        '--requested-for LOGIN',
-               description: 'The login to list as the owner of this resource. Will default to the vra_username parameter'
+          long:        "--requested-for LOGIN",
+          description: "The login to list as the owner of this resource. Will default to the vra_username parameter"
 
         option :server_create_timeout,
-               long:        '--server-create-timeout SECONDS',
-               description: 'number of seconds to wait for the server to complete',
-               default:     600
+          long:        "--server-create-timeout SECONDS",
+          description: "number of seconds to wait for the server to complete",
+          default:     600
 
         option :subtenant_id,
-               long:        '--subtenant-id ID',
-               description: 'The subtenant ID (a.k.a "business group") to list as the owner of this resource. ' \
-                 'Will default to the blueprint subtenant if it exists.'
+          long:        "--subtenant-id ID",
+          description: 'The subtenant ID (a.k.a "business group") to list as the owner of this resource. ' \
+            "Will default to the blueprint subtenant if it exists."
 
         option :lease_days,
-               long:        '--lease-days NUM_DAYS',
-               description: 'Number of days requested for the server lease, provided the blueprint allows this to be specified'
+          long:        "--lease-days NUM_DAYS",
+          description: "Number of days requested for the server lease, provided the blueprint allows this to be specified"
 
         option :notes,
-               long:        '--notes NOTES',
-               description: 'String of text to be included in the request notes.'
+          long:        "--notes NOTES",
+          description: "String of text to be included in the request notes."
 
         option :extra_params,
-               long:        '--extra-param KEY=TYPE:VALUE',
-               description: 'Additional parameters to pass to vRA for this catalog request. TYPE must be "string" or "integer". ' \
-                 'Can be used multiple times.',
-               default:     {},
-               proc:        proc { |param|
-                              Chef::Config[:knife][:vra_extra_params] ||= {}
-                              key, value_str = param.split('=')
-                              Chef::Config[:knife][:vra_extra_params].merge!(key => value_str)
-                            }
+          long:        "--extra-param KEY=TYPE:VALUE",
+          description: 'Additional parameters to pass to vRA for this catalog request. TYPE must be "string" or "integer". ' \
+            "Can be used multiple times.",
+          default:     {},
+          proc:        proc { |param|
+            Chef::Config[:knife][:vra_extra_params] ||= {}
+            key, value_str = param.split("=")
+            Chef::Config[:knife][:vra_extra_params].merge!(key => value_str)
+          }
 
         def validate_params!
           super
 
           if @name_args.empty?
-            ui.error('You must supply a Catalog ID to use for your new server.')
+            ui.error("You must supply a Catalog ID to use for your new server.")
             exit 1
           end
 
@@ -96,23 +99,23 @@ class Chef
           super
 
           @create_options = {
-            catalog_id:       @name_args.first,
-            cpus:             locate_config_value(:cpus),
-            memory:           locate_config_value(:memory),
-            requested_for:    locate_config_value(:requested_for),
-            subtenant_id:     locate_config_value(:subtenant_id),
-            lease_days:       locate_config_value(:lease_days),
-            notes:            locate_config_value(:notes),
-            extra_params:     extra_params,
-            wait_time:        locate_config_value(:server_create_timeout),
-            refresh_rate:     locate_config_value(:request_refresh_rate)
+            catalog_id: @name_args.first,
+            cpus: config[:cpus],
+            memory: config[:memory],
+            requested_for: config[:requested_for],
+            subtenant_id: config[:subtenant_id],
+            lease_days: config[:lease_days],
+            notes: config[:notes],
+            extra_params: extra_params,
+            wait_time: config[:server_create_timeout],
+            refresh_rate: config[:request_refresh_rate],
           }
         end
 
         def before_bootstrap
           super
 
-          config[:chef_node_name] = locate_config_value(:chef_node_name) ? locate_config_value(:chef_node_name) : server.name
+          config[:chef_node_name] = config[:chef_node_name] ? config[:chef_node_name] : server.name
           config[:bootstrap_ip_address] = hostname_for_server
         end
 
@@ -120,7 +123,7 @@ class Chef
           return if Chef::Config[:knife][:vra_extra_params].nil? || Chef::Config[:knife][:vra_extra_params].empty?
 
           Chef::Config[:knife][:vra_extra_params].each_with_object([]) do |(key, value_str), memo|
-            type, value = value_str.split(':')
+            type, value = value_str.split(":")
             memo << { key: key, type: type, value: value }
           end
         end
@@ -131,7 +134,7 @@ class Chef
           extra_params.each do |param|
             raise ArgumentError, "No type and value set for extra parameter #{param[:key]}" if param[:type].nil? || param[:value].nil?
             raise ArgumentError, "Invalid parameter type for #{param[:key]} - must be string or integer" unless
-              param[:type] == 'string' || param[:type] == 'integer'
+              param[:type] == "string" || param[:type] == "integer"
           end
         end