knife-openstack 1.3.2 → 2.0.0

data/lib/chef/knife/openstack_floating_ip_list.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # Author:: Vasundhara Jagdale (<vasundhara.jagdale@clogeny.com>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.
 
-require 'chef/knife/cloud/list_resource_command'
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_service_options'
+require "chef/knife/cloud/list_resource_command"
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_service_options"
 
 class Chef
   class Knife
@@ -12,16 +13,16 @@ class Chef
         include OpenstackHelpers
         include OpenstackServiceOptions
 
-        banner 'knife openstack floating_ip list (options)'
+        banner "knife openstack floating_ip list (options)"
 
         def before_exec_command
           # set columns_with_info map
           @columns_with_info = [
-            { label: 'ID', key: 'id' },
-            { label: 'Instance ID', key: 'instance_id' },
-            { label: 'IP Address', key: 'ip' },
-            { label: 'Fixed IP', key: 'fixed_ip' },
-            { label: 'Floating IP Pool', key: 'pool' }
+            { label: "ID", key: "id" },
+            { label: "Instance ID", key: "instance_id" },
+            { label: "IP Address", key: "ip" },
+            { label: "Fixed IP", key: "fixed_ip" },
+            { label: "Floating IP Pool", key: "pool" },
           ]
         end
 

data/lib/chef/knife/openstack_floating_ip_release.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 #
 # Author:: Vasundhara Jagdale (<vasundhara.jagdale@clogeny.com>)
 # Copyright:: Copyright (c) 2015 Chef Software, Inc.
 #
 
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_service_options'
-require 'chef/knife/cloud/command'
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_service_options"
+require "chef/knife/cloud/command"
 
 class Chef
   class Knife
@@ -14,16 +15,16 @@ class Chef
         include OpenstackServiceOptions
         include OpenstackHelpers
 
-        banner 'knife openstack floating_ip release ID [ID] (options)'
+        banner "knife openstack floating_ip release ID [ID] (options)"
 
         def execute_command
           if @name_args[0]
             response = service.release_address(@name_args[0])
             if response && response.status == 202
-              ui.info 'Floating IP released successfully.'
+              ui.info "Floating IP released successfully."
             end
           else
-            ui.error 'Please provide Floating IP to release.'
+            ui.error "Please provide Floating IP to release."
             exit 1
           end
         end

data/lib/chef/knife/openstack_group_list.rb

@@ -1,6 +1,7 @@
-require 'chef/knife/cloud/list_resource_command'
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_service_options'
+# frozen_string_literal: true
+require "chef/knife/cloud/list_resource_command"
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_service_options"
 
 class Chef
   class Knife
@@ -9,7 +10,7 @@ class Chef
         include OpenstackHelpers
         include OpenstackServiceOptions
 
-        banner 'knife openstack group list (options)'
+        banner "knife openstack group list (options)"
 
         def query_resource
           @service.connection.security_groups
@@ -20,14 +21,14 @@ class Chef
         end
 
         def list(security_groups)
-          if (config[:format] == 'summary')
+          if config[:format] == "summary"
             group_list = [
-              ui.color('Name', :bold),
-              ui.color('Protocol', :bold),
-              ui.color('From', :bold),
-              ui.color('To', :bold),
-              ui.color('CIDR', :bold),
-              ui.color('Description', :bold)
+              ui.color("Name", :bold),
+              ui.color("Protocol", :bold),
+              ui.color("From", :bold),
+              ui.color("To", :bold),
+              ui.color("CIDR", :bold),
+              ui.color("Description", :bold),
             ]
             security_groups.sort_by(&:name).each do |group|
               group.security_group_rules.each do |rule|
@@ -36,7 +37,7 @@ class Chef
                   group_list << rule.ip_protocol
                   group_list << rule.from_port.to_s
                   group_list << rule.to_port.to_s
-                  group_list << rule.ip_range['cidr']
+                  group_list << rule.ip_range["cidr"]
                   group_list << group.description
                 end
               end

data/lib/chef/knife/openstack_helpers.rb

@@ -1,19 +1,20 @@
-require 'chef/knife/cloud/openstack_service_options'
+# frozen_string_literal: true
+require "chef/knife/cloud/openstack_service_options"
 
 class Chef
   class Knife
     class Cloud
       module OpenstackHelpers
         def primary_private_ip_address(addresses)
-          primary_network_ip_address(addresses, 'private')
+          primary_network_ip_address(addresses, "private")
         end
 
         def primary_public_ip_address(addresses)
-          primary_network_ip_address(addresses, 'public')
+          primary_network_ip_address(addresses, "public")
         end
 
         def primary_network_ip_address(addresses, network_name)
-          addresses[network_name].last['addr'] if addresses[network_name] && !addresses[network_name].empty?
+          addresses[network_name].last["addr"] if addresses[network_name] && !addresses[network_name].empty?
         end
 
         def create_service_instance
@@ -29,12 +30,12 @@ class Chef
           if addresses[addresses.keys[0]] && addresses[addresses.keys[0]].size > 0
             ips = addresses[addresses.keys[0]]
             ips.each do |ip|
-              version = 'IPv6' if ip['version'] == 6
-              version = 'IPv4' if ip['version'] == 4
+              version = "IPv6" if ip["version"] == 6
+              version = "IPv4" if ip["version"] == 4
               info << "#{addresses.keys[0]}:#{version}: #{ip['addr']}"
             end
           end
-          info.join(' ')
+          info.join(" ")
         end
       end
     end

data/lib/chef/knife/openstack_image_list.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # Author:: Prabhu Das (<prabhu.das@clogeny.com>)
 # Copyright:: Copyright (c) 2014 Chef Software, Inc.
 
-require 'chef/knife/cloud/list_resource_command'
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_service_options'
+require "chef/knife/cloud/list_resource_command"
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_service_options"
 
 class Chef
   class Knife
@@ -12,10 +13,10 @@ class Chef
         include OpenstackHelpers
         include OpenstackServiceOptions
 
-        banner 'knife openstack image list (options)'
+        banner "knife openstack image list (options)"
 
         option :disable_filter,
-               long: '--disable-filter',
+               long: "--disable-filter",
                description: "Disable filtering of the image list. Currently filters names ending with 'initrd' or 'kernel'",
                boolean: true,
                default: false
@@ -23,15 +24,15 @@ class Chef
         def before_exec_command
           # set resource_filters
           unless config[:disable_filter]
-            @resource_filters = [{ attribute: 'name', regex: /initrd$|kernel$|loader$|virtual$|vmlinuz$/ }]
+            @resource_filters = [{ attribute: "name", regex: /initrd$|kernel$|loader$|virtual$|vmlinuz$/ }]
           end
           # set columns_with_info map
           @columns_with_info = [
-            { label: 'Name', key: 'name' },
-            { label: 'ID', key: 'id' },
-            { label: 'Snapshot', key: 'metadata', value_callback: method(:is_image_snapshot) }
+            { label: "Name", key: "name" },
+            { label: "ID", key: "id" },
+            { label: "Snapshot", key: "metadata", value_callback: method(:is_image_snapshot) },
           ]
-          @sort_by_field = 'name'
+          @sort_by_field = "name"
         end
 
         def query_resource
@@ -39,10 +40,10 @@ class Chef
         end
 
         def is_image_snapshot(metadata)
-          snapshot = 'no'
+          snapshot = "no"
           metadata.each do |datum|
-            if (datum.key == 'image_type') && (datum.value == 'snapshot')
-              snapshot = 'yes'
+            if (datum.key == "image_type") && (datum.value == "snapshot")
+              snapshot = "yes"
             end
           end
           snapshot

data/lib/chef/knife/openstack_network_list.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # Author:: Prabhu Das (<prabhu.das@clogeny.com>)
 # Copyright:: Copyright (c) 2014 Chef Software, Inc.
 
-require 'chef/knife/cloud/list_resource_command'
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_service_options'
+require "chef/knife/cloud/list_resource_command"
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_service_options"
 
 class Chef
   class Knife
@@ -12,17 +13,17 @@ class Chef
         include OpenstackHelpers
         include OpenstackServiceOptions
 
-        banner 'knife openstack network list (options)'
+        banner "knife openstack network list (options)"
 
         def before_exec_command
           # set columns_with_info map
           @columns_with_info = [
-            { label: 'Name', key: 'name' },
-            { label: 'ID', key: 'id' },
-            { label: 'Tenant', key: 'tenant_id' },
-            { label: 'Shared', key: 'shared' }
+            { label: "Name", key: "name" },
+            { label: "ID", key: "id" },
+            { label: "Tenant", key: "tenant_id" },
+            { label: "Shared", key: "shared" },
           ]
-          @sort_by_field = 'name'
+          @sort_by_field = "name"
         end
 
         def query_resource

data/lib/chef/knife/openstack_server_create.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Seth Chisamore (<schisamo@getchef.com>)
 # Author:: Matt Ray (<matt@getchef.com>)
@@ -18,12 +19,12 @@
 # limitations under the License.
 #
 
-require 'chef/knife/cloud/server/create_command'
-require 'chef/knife/openstack_helpers'
-require 'chef/knife/cloud/openstack_server_create_options'
-require 'chef/knife/cloud/openstack_service'
-require 'chef/knife/cloud/openstack_service_options'
-require 'chef/knife/cloud/exceptions'
+require "chef/knife/cloud/server/create_command"
+require "chef/knife/openstack_helpers"
+require "chef/knife/cloud/openstack_server_create_options"
+require "chef/knife/cloud/openstack_service"
+require "chef/knife/cloud/openstack_service_options"
+require "chef/knife/cloud/exceptions"
 
 class Chef
   class Knife
@@ -33,7 +34,7 @@ class Chef
         include OpenstackServerCreateOptions
         include OpenstackServiceOptions
 
-        banner 'knife openstack server create (options)'
+        banner "knife openstack server create (options)"
 
         def before_exec_command
           super
@@ -46,11 +47,11 @@ class Chef
               :flavor_ref => service.get_flavor(locate_config_value(:flavor)).id,
               :security_groups => locate_config_value(:openstack_security_groups),
               :availability_zone => locate_config_value(:availability_zone),
-              'os:scheduler_hints' => locate_config_value(:openstack_scheduler_hints),
+              "os:scheduler_hints" => locate_config_value(:openstack_scheduler_hints),
               :metadata => locate_config_value(:metadata),
-              :key_name => locate_config_value(:openstack_ssh_key_id)
+              :key_name => locate_config_value(:openstack_ssh_key_id),
             },
-            server_create_timeout: locate_config_value(:server_create_timeout)
+            server_create_timeout: locate_config_value(:server_create_timeout),
           }
           unless locate_config_value(:openstack_volumes).nil?
             counter = 99
@@ -59,53 +60,53 @@ class Chef
               {
                 volume_id: vol,
                 delete_on_termination: false,
-                device_name: '/dev/vd' + counter.chr,
-                volume_size: nil
+                device_name: "/dev/vd" + counter.chr,
+                volume_size: nil,
               }
             end
           end
 
-          @create_options[:server_def].merge!(user_data: locate_config_value(:user_data)) if locate_config_value(:user_data)
-          @create_options[:server_def].merge!(nics: locate_config_value(:network_ids).map { |nic| nic_id = { 'net_id' => nic } }) if locate_config_value(:network_ids)
+          @create_options[:server_def][:user_data] = locate_config_value(:user_data) if locate_config_value(:user_data)
+          @create_options[:server_def][:nics] = locate_config_value(:network_ids).map { |nic| nic_id = { "net_id" => nic } } if locate_config_value(:network_ids)
 
           Chef::Log.debug("Create server params - server_def = #{@create_options[:server_def]}")
           # set columns_with_info map
           @columns_with_info = [
-            { label: 'Instance ID', key: 'id' },
-            { label: 'Name', key: 'name' },
-            { label: 'Public IP', key: 'addresses', value_callback: method(:primary_public_ip_address) },
-            { label: 'Private IP', key: 'addresses', value_callback: method(:primary_private_ip_address) },
-            { label: 'Flavor', key: 'flavor', value_callback: method(:get_id) },
-            { label: 'Image', key: 'image', value_callback: method(:get_id) },
-            { label: 'Keypair', key: 'key_name' },
-            { label: 'State', key: 'state' },
-            { label: 'Availability Zone', key: 'availability_zone' }
+            { label: "Instance ID", key: "id" },
+            { label: "Name", key: "name" },
+            { label: "Public IP", key: "addresses", value_callback: method(:primary_public_ip_address) },
+            { label: "Private IP", key: "addresses", value_callback: method(:primary_private_ip_address) },
+            { label: "Flavor", key: "flavor", value_callback: method(:get_id) },
+            { label: "Image", key: "image", value_callback: method(:get_id) },
+            { label: "Keypair", key: "key_name" },
+            { label: "State", key: "state" },
+            { label: "Availability Zone", key: "availability_zone" },
           ]
         end
 
         def get_id(value)
-          value['id']
+          value["id"]
         end
 
         # Setup the floating ip after server creation.
         def after_exec_command
           Chef::Log.debug("Addresses #{server.addresses}")
-          msg_pair('Public IP Address', primary_public_ip_address(server.addresses)) if primary_public_ip_address(server.addresses)
-          msg_pair('Private IP Address', primary_private_ip_address(server.addresses)) if primary_private_ip_address(server.addresses)
+          msg_pair("Public IP Address", primary_public_ip_address(server.addresses)) if primary_public_ip_address(server.addresses)
+          msg_pair("Private IP Address", primary_private_ip_address(server.addresses)) if primary_private_ip_address(server.addresses)
 
           floating_address = locate_config_value(:openstack_floating_ip)
           bind_ip = primary_network_ip_address(server.addresses, server.addresses.keys[0])
           Chef::Log.debug("Floating IP Address requested #{floating_address}")
-          unless (floating_address == '-1') # no floating IP requested
+          unless floating_address == "-1" # no floating IP requested
             addresses = service.connection.addresses
             # floating requested without value
             if floating_address.nil?
               free_floating = addresses.find_index { |a| a.fixed_ip.nil? }
               begin
                 if free_floating.nil? # no free floating IP found
-                  error_message = 'Unable to assign a Floating IP from allocated IPs.'
+                  error_message = "Unable to assign a Floating IP from allocated IPs."
                   ui.fatal(error_message)
-                  fail CloudExceptions::ServerSetupError, error_message
+                  raise CloudExceptions::ServerSetupError, error_message
                 else
                   floating_address = addresses[free_floating].ip
                 end
@@ -116,22 +117,22 @@ class Chef
             end
 
             # Pull the port_id for the associate_floating_ip
-            port_id = @service.network.list_ports[:body]['ports'].find { |x| x['fixed_ips'][0]['ip_address'] == bind_ip }['id']
-            fixed_ip_address = service.network.list_ports[:body]['ports'].find { |x| x['id'] == port_id }['fixed_ips'][0]['ip_address']
+            port_id = @service.network.list_ports[:body]["ports"].find { |x| x["fixed_ips"][0]["ip_address"] == bind_ip }["id"]
+            fixed_ip_address = service.network.list_ports[:body]["ports"].find { |x| x["id"] == port_id }["fixed_ips"][0]["ip_address"]
 
             floating_ip_id = get_floating_ip_id(floating_address)
             # Associate the floating ip via the neutron/network api
             @service.network.associate_floating_ip(floating_ip_id, port_id, fixed_ip_address: fixed_ip_address)
 
             # a bit of a hack, but server.reload takes a long time
-            (server.addresses['public'] ||= []) << { 'version' => 4, 'addr' => floating_address }
-            msg_pair('Floating IP Address', floating_address)
+            (server.addresses["public"] ||= []) << { "version" => 4, "addr" => floating_address }
+            msg_pair("Floating IP Address", floating_address)
           end
 
           Chef::Log.debug("Addresses #{server.addresses}")
           Chef::Log.debug("Public IP Address actual: #{primary_public_ip_address(server.addresses)}") if primary_public_ip_address(server.addresses)
 
-          msg_pair('Private IP Address', primary_private_ip_address(server.addresses)) if primary_private_ip_address(server.addresses)
+          msg_pair("Private IP Address", primary_private_ip_address(server.addresses)) if primary_private_ip_address(server.addresses)
           super
         end
 
@@ -144,13 +145,13 @@ class Chef
           # The bootstrap network is always initialised to 'public' when a network name isn't specified.  Therefore,
           # only set the bootstrap network to 'private' if still initialised to public and nothing was specified for
           # the private network name.
-          config[:bootstrap_network] = 'private' if config[:private_network] && config[:bootstrap_network] == 'public'
+          config[:bootstrap_network] = "private" if config[:private_network] && config[:bootstrap_network] == "public"
 
           # Which IP address to bootstrap
           unless config[:network] # --no-network
             bootstrap_ip_address = primary_public_ip_address(server.addresses) ||
-                                   primary_private_ip_address(server.addresses) ||
-                                   server.addresses.first[1][0]['addr']
+              primary_private_ip_address(server.addresses) ||
+              server.addresses.first[1][0]["addr"]
             Chef::Log.debug("No Bootstrap Network: #{config[:bootstrap_network]}")
           else
             bootstrap_ip_address = primary_network_ip_address(server.addresses, config[:bootstrap_network])
@@ -159,14 +160,14 @@ class Chef
 
           Chef::Log.debug("Bootstrap IP Address: #{bootstrap_ip_address}")
           if bootstrap_ip_address.nil?
-            error_message = 'No IP address available for bootstrapping.'
+            error_message = "No IP address available for bootstrapping."
             ui.error(error_message)
-            fail CloudExceptions::BootstrapError, error_message
+            raise CloudExceptions::BootstrapError, error_message
           end
           config[:bootstrap_ip_address] = bootstrap_ip_address
 
           config[:hints] ||= {}
-          config[:hints]['openstack'] ||= {}
+          config[:hints]["openstack"] ||= {}
         end
 
         def validate_params!
@@ -175,17 +176,17 @@ class Chef
 
           errors = []
 
-          if locate_config_value(:bootstrap_protocol) == 'winrm'
+          if locate_config_value(:bootstrap_protocol) == "winrm"
             if locate_config_value(:winrm_password).nil?
-              errors << 'You must provide Winrm Password.'
+              errors << "You must provide Winrm Password."
             end
-          elsif locate_config_value(:bootstrap_protocol) != 'ssh'
-            errors << 'You must provide a valid bootstrap protocol. options [ssh/winrm]. For linux type images, options [ssh]'
+          elsif locate_config_value(:bootstrap_protocol) != "ssh"
+            errors << "You must provide a valid bootstrap protocol. options [ssh/winrm]. For linux type images, options [ssh]"
           end
 
-          errors << 'You must provide --image-os-type option [windows/linux]' unless %w(windows linux).include?(locate_config_value(:image_os_type))
-          error_message = ''
-          fail CloudExceptions::ValidationError, error_message if errors.each { |e| ui.error(e); error_message = "#{error_message} #{e}." }.any?
+          errors << "You must provide --image-os-type option [windows/linux]" unless %w{windows linux}.include?(locate_config_value(:image_os_type))
+          error_message = ""
+          raise CloudExceptions::ValidationError, error_message if errors.each { |e| ui.error(e); error_message = "#{error_message} #{e}." }.any?
         end
 
         def is_image_valid?
@@ -199,7 +200,7 @@ class Chef
         def is_floating_ip_valid?
           address = locate_config_value(:openstack_floating_ip)
 
-          return true if address == '-1' # no floating IP requested
+          return true if address == "-1" # no floating IP requested
 
           addresses = service.connection.addresses
           return false if addresses.empty? # no floating IPs
@@ -222,20 +223,20 @@ class Chef
 
         def post_connection_validations
           errors = []
-          errors << 'You have not provided a valid image ID. Please note the options for this value are -I or --image.' unless is_image_valid?
-          errors << 'You have not provided a valid flavor ID. Please note the options for this value are -f or --flavor.' unless is_flavor_valid?
-          errors << 'You have either requested an invalid floating IP address or none are available.' unless is_floating_ip_valid?
-          error_message = ''
-          fail CloudExceptions::ValidationError, error_message if errors.each { |e| ui.error(e); error_message = "#{error_message} #{e}." }.any?
+          errors << "You have not provided a valid image ID. Please note the options for this value are -I or --image." unless is_image_valid?
+          errors << "You have not provided a valid flavor ID. Please note the options for this value are -f or --flavor." unless is_flavor_valid?
+          errors << "You have either requested an invalid floating IP address or none are available." unless is_floating_ip_valid?
+          error_message = ""
+          raise CloudExceptions::ValidationError, error_message if errors.each { |e| ui.error(e); error_message = "#{error_message} #{e}." }.any?
         end
 
         def get_floating_ip_id(floating_address)
           # required for this method to work
           floating_ip_id = -1
           # Figure out the id for the port that the floating ip you requested
-          @service.network.list_floating_ips[:body]['floatingips'].each do |x|
-            if x['floating_ip_address'] == floating_address
-              floating_ip_id = x['id']
+          @service.network.list_floating_ips[:body]["floatingips"].each do |x|
+            if x["floating_ip_address"] == floating_address
+              floating_ip_id = x["id"]
             end
           end
           floating_ip_id