knife-ec2 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c08a54649fd441e8a497e268d512da71aa52c1b868196cd672297cb3535685
-  data.tar.gz: 92b071136caf3bd82c6c47ed4970a815a6e3590de358d737234c3d7067cadbf2
+  metadata.gz: 10d2009ca1b8decd1be69f2c0ba04eb3316010c6d99c0a6ed88a2018c0c5bd1b
+  data.tar.gz: 610d660db9b532dd282d135e1885324ed6ec44a6c458d6d403af11479195c19a
 SHA512:
-  metadata.gz: 493bae78b6be752198bff0d1b6f9a6001f1f9be4fbfecf67d04e05a54351f9fdeadae50fa17db0e941cce63a0737d52897b912c793b9a2cacedeba0386238fbc
-  data.tar.gz: 6dbdbfc483c9a7b870d0c472de48ad460913f3e90eedbedb30a04f4f14998d9eb8a308ab102cc666f2849ff7ff2f209fe4c7f86469a7a4fd0d8bf8322ba04c4a
+  metadata.gz: e8adadfcba613c816fdf61badf3877f0e618f8db713400ff569b5bb9328af695d2821cdd42fcf18b2aaf395b271361d739983777353bb375211536e06a32e032
+  data.tar.gz: 5ad31dc527d678d6cb71cc23326bb1003aeef22645a56b33751905e29c725e12d21d3750a2060ef287a237d62299ef1543f8e5aea71aee75505984f4823c9024

data/lib/chef/knife/ec2_ami_list.rb

@@ -43,12 +43,14 @@ class Chef
       option :platform,
         short: "-p PLATFORM",
         long: "--platform PLATFORM",
-        description: "Platform of the server. Allowed values are windows, ubuntu, debian, centos, fedora, rhel, nginx, turnkey, jumpbox, coreos, cisco, amazon, nessus"
-
+        description: "Platform of the server",
+        in: Chef::Knife::Ec2Base::VALID_PLATFORMS
       option :owner,
         short: "-o OWNER",
         long: "--owner OWNER",
-        description: "The AMI owner (self, aws-marketplace, microsoft). Default is aws-marketplace"
+        description: "The AMI owner. Default is aws-marketplace",
+        default: "aws-marketplace",
+        in: %w{self aws-marketplace microsoft}
 
       option :search,
         short: "-s SEARCH",
@@ -67,7 +69,7 @@ class Chef
           ui.color("Architecture", :bold),
           ui.color("Size", :bold),
           ui.color("Name", :bold),
-          ui.color("Description", :bold)
+          ui.color("Description", :bold),
         ].flatten.compact
 
         output_column_count = servers_list.length
@@ -110,8 +112,7 @@ class Chef
 
       def image_params
         params = {}
-        owner = locate_config_value(:owner) || "aws-marketplace" # aws-marketplace, microsoft
-        params["owners"] = [owner.to_s]
+        params["owners"] = [locate_config_value(:owner).to_s]
 
         filters = []
         filters << { platform: locate_config_value(:platform) } if locate_config_value(:platform)

data/lib/chef/knife/ec2_base.rb

@@ -21,6 +21,8 @@ require "chef/knife"
 class Chef
   class Knife
     module Ec2Base
+      # All valid platforms
+      VALID_PLATFORMS ||= %w{windows ubuntu debian centos fedora rhel nginx turnkey jumpbox coreos cisco amazon nessus}.freeze
 
       # @todo Would prefer to do this in a rational way, but can't be done b/c of Mixlib::CLI's design :(
       def self.included(includer)
@@ -98,7 +100,8 @@ class Chef
       end
 
       def fetch_ami(image_id)
-        return {} unless image_id
+        return nil unless image_id
+
         ec2_connection.describe_images({
           image_ids: [image_id],
         }).images.first
@@ -144,15 +147,15 @@ class Chef
         end
 
         server_data["availability_zone"] = server_obj.instances[0].placement.availability_zone
-        server_data["groups"] = server_obj.groups.map { |grp| grp.name }
-        server_data["iam_instance_profile"] = ( server_obj.instances[0].iam_instance_profile.nil? ? nil : server_obj.instances[0].iam_instance_profile.arn[/instance-profile\/(.*)/] )
+        server_data["groups"] = server_obj.groups.map(&:name)
+        server_data["iam_instance_profile"] = ( server_obj.instances[0].iam_instance_profile.nil? ? nil : server_obj.instances[0].iam_instance_profile.arn[%r{instance-profile/(.*)}] )
         server_data["id"] = server_data["instance_id"]
 
-        tags = server_obj.instances[0].tags.map { |x| x.value }
+        tags = server_obj.instances[0].tags.map(&:value)
         server_data["name"] = tags[0]
         server_data["placement_group"] = server_obj.instances[0].placement.group_name
-        server_data["security_groups"] = server_obj.instances[0].security_groups.map { |x| x.group_name }
-        server_data["security_group_ids"] = server_obj.instances[0].security_groups.map { |x| x.group_id }
+        server_data["security_groups"] = server_obj.instances[0].security_groups.map(&:group_name)
+        server_data["security_group_ids"] = server_obj.instances[0].security_groups.map(&:group_id)
         server_data["state"] = server_obj.instances[0].state.name
         server_data["subnet_id"] = server_obj.instances[0].network_interfaces[0].subnet_id
         server_data["tags"] = tags
@@ -164,7 +167,7 @@ class Chef
 
       # @return [Struct]
       def normalize_server_data(server_hashes)
-        require "ostruct"
+        require "ostruct" unless defined?(OpenStruct)
         OpenStruct.new(server_hashes)
       end
 
@@ -191,12 +194,12 @@ class Chef
       # Platform value return for Windows AMIs; otherwise, it is blank.
       # @return [Boolean]
       def is_image_windows?
-        ami.platform == "windows"
+        ami && ami.platform == "windows"
       end
 
       # validate the config options that were passed since some of them cannot be used together
       # also validate the aws configuration file contents if present
-      def validate_aws_config!(keys = [:aws_access_key_id, :aws_secret_access_key])
+      def validate_aws_config!(keys = %i{aws_access_key_id aws_secret_access_key})
         errors = [] # track all errors so we report on all of them
 
         validate_aws_config_file! if locate_config_value(:aws_config_file)
@@ -206,10 +209,10 @@ class Chef
           #   aws keys have not been passed in config / CLI and the default cred file location does exist
           #   OR
           #   the user passed aws_credential_file
-          if (Chef::Config[:knife].keys & [:aws_access_key_id, :aws_secret_access_key]).empty? && aws_cred_file_location ||
+          if (Chef::Config[:knife].keys & %i{aws_access_key_id aws_secret_access_key}).empty? && aws_cred_file_location ||
               locate_config_value(:aws_credential_file)
 
-            unless (Chef::Config[:knife].keys & [:aws_access_key_id, :aws_secret_access_key]).empty?
+            unless (Chef::Config[:knife].keys & %i{aws_access_key_id aws_secret_access_key}).empty?
               errors << "Either provide a credentials file or the access key and secret keys but not both."
             end
 
@@ -227,20 +230,7 @@ class Chef
             exit 1
           end
         end
-
-        if locate_config_value(:platform)
-          unless valid_platforms.include? (locate_config_value(:platform))
-            raise ArgumentError, "Invalid platform: #{locate_config_value(:platform)}. Allowed platforms are: #{valid_platforms.join(", ")}."
-          end
-        end
-
-        if locate_config_value(:owner)
-          unless ["self", "aws-marketplace", "microsoft"].include? (locate_config_value(:owner)) # rubocop:disable Style/WordArray
-            raise ArgumentError, "Invalid owner: #{locate_config_value(:owner)}. Allowed owners are self, aws-marketplace or microsoft."
-          end
-        end
       end
-
     end
 
     # the path to the aws credentials file.
@@ -285,16 +275,10 @@ class Chef
       map
     end
 
-    # All valid platforms
-    # @return [Array]
-    def valid_platforms
-      %w{windows ubuntu debian centos fedora rhel nginx turnkey jumpbox coreos cisco amazon nessus}
-    end
-
     # Get the platform from server name
     # @return [String]
     def find_server_platform(server_name)
-      get_platform = valid_platforms.select { |name| server_name.downcase.include?(name) }
+      get_platform = VALID_PLATFORMS.select { |name| server_name.downcase.include?(name) }
       get_platform.first
     end
 

data/lib/chef/knife/ec2_eip_list.rb

@@ -38,7 +38,7 @@ class Chef
           ui.color("Private IPs", :bold),
           ui.color("IPv6 IPs", :bold),
           ui.color("Subnet ID", :bold),
-          ui.color("VPC ID", :bold)
+          ui.color("VPC ID", :bold),
         ].flatten.compact
 
         output_column_count = eni_list.length

data/lib/chef/knife/ec2_securitygroup_list.rb

@@ -33,7 +33,7 @@ class Chef
         sg_list = [
           ui.color("ID", :bold),
           ui.color("Name", :bold),
-          ui.color("VPC ID", :bold)
+          ui.color("VPC ID", :bold),
         ].flatten.compact
 
         output_column_count = sg_list.length

data/lib/chef/knife/ec2_server_create.rb

@@ -61,20 +61,6 @@ class Chef
         description: "The security groups for this server; not allowed when using VPC",
         proc: Proc.new { |groups| groups.split(",") }
 
-      option :security_group_ids,
-        long: "--security-group-ids 'X,Y,Z'",
-        description: "The security group ids for this server; required when using VPC. Provide values in format --security-group-ids 'X,Y,Z'. [DEPRECATED] This option will be removed in future release. Use the new --security-group-id option. ",
-        proc: Proc.new { |security_group_ids|
-          ui.warn("[DEPRECATED] This option will be removed in future release. Use the new --security-group-id option multiple times when specifying multiple groups for e.g. -g sg-e985168d -g sg-e7f06383 -g sg-ec1b7e88.")
-          if security_group_ids.delete(" ").split(",").size > 1
-            Chef::Config[:knife][:security_group_ids] = security_group_ids.delete(" ").split(",")
-          else
-            Chef::Config[:knife][:security_group_ids] ||= []
-            Chef::Config[:knife][:security_group_ids].push(security_group_ids)
-            Chef::Config[:knife][:security_group_ids]
-          end
-        }
-
       option :security_group_id,
         short: "-g SECURITY_GROUP_ID",
         long: "--security-group-id ID",
@@ -102,15 +88,6 @@ class Chef
         long: "--primary-eni ENI_ID",
         description: "Specify a pre-existing eni to use when building the instance."
 
-      option :tags,
-        short: "-T T=V[,T=V,...]",
-        long: "--tags Tag=Value[,Tag=Value...]",
-        description: "The tags for this server. [DEPRECATED] Use --aws-tag instead.",
-        proc: Proc.new { |tags|
-          Chef::Log.warn("[DEPRECATED] --tags option is deprecated. Use --aws-tag option instead.")
-          tags.split(",")
-        }
-
       option :availability_zone,
         short: "-Z ZONE",
         long: "--availability-zone ZONE",
@@ -270,16 +247,6 @@ class Chef
         description: "Tag the Root volume",
         proc: Proc.new { |volume_tags| volume_tags.split(",") }
 
-      option :tag_node_in_chef,
-        long: "--tag-node-in-chef",
-        description: "Flag for tagging node in ec2 and chef both. [DEPRECATED] Use --chef-tag instead.",
-        proc: Proc.new { |v|
-          Chef::Log.warn("[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead.")
-          v
-        },
-        boolean: true,
-        default: false
-
       option :instance_initiated_shutdown_behavior,
         long: "--instance-initiated-shutdown-behavior SHUTDOWN_BEHAVIOR",
         description: "Indicates whether an instance stops or terminates when you initiate shutdown from the instance. Possible values are 'stop' and 'terminate', default is 'stop'."
@@ -379,6 +346,7 @@ class Chef
           enable_classic_link(config[:classic_link_vpc_id], config[:classic_link_vpc_security_group_ids]) if config[:classic_link_vpc_id]
         rescue Aws::EC2::Errors::ServiceError, Aws::EC2::Errors::Error
           raise if (tries -= 1) <= 0
+
           ui.warn("server not ready, retrying tag application (retries left: #{tries})")
           sleep 5
           retry
@@ -462,7 +430,7 @@ class Chef
         msg_pair("IAM Profile", config_value(:iam_instance_profile)) if config_value(:iam_instance_profile)
         msg_pair("Primary ENI", config_value(:primary_eni)) if config_value(:primary_eni)
         msg_pair("AWS Tags", printed_aws_tags)
-        msg_pair("Chef Tags", config_value(:chef_tag)) if config_value(:chef_tag)
+        msg_pair("Chef Tags", config_value(:tags)) if config_value(:tags).any?
         msg_pair("SSH Key", server.key_name)
         msg_pair("Root Device Type", server.root_device_type)
         msg_pair("Root Volume Tags", printed_volume_tags)
@@ -560,6 +528,7 @@ class Chef
       def s3_secret
         @s3_secret ||= begin
           return false unless config_value(:s3_secret)
+
           Chef::Knife::S3Source.fetch(config_value(:s3_secret))
         end
       end
@@ -573,12 +542,6 @@ class Chef
         Chef::Knife::DataBagSecretOptions.set_cl_secret(s3_secret) if config_value(:s3_secret)
         config[:secret] = s3_secret || config_value(:secret)
 
-        # If --chef-tag is provided then it will be set in chef as single value e.g. --chef-tag "myTag"
-        # Otherwise if --tag-node-in-chef is provided then it will tag the chef in key=value pair of --tags option
-        # e.g. --tags "key=value"
-        if config_value(:chef_tag)
-          config[:tags] = config_value(:chef_tag)
-        end
         # Modify global configuration state to ensure hint gets set by
         # knife-bootstrap
         Chef::Config[:knife][:hints] ||= {}
@@ -602,12 +565,12 @@ class Chef
 
       def plugin_validate_options!
         if Chef::Config[:knife].keys.include? :aws_ssh_key_id
-          Chef::Config[:knife][:ssh_key_name] = Chef::Config[:knife][:aws_ssh_key_id] if !Chef::Config[:knife][:ssh_key_name]
+          Chef::Config[:knife][:ssh_key_name] = Chef::Config[:knife][:aws_ssh_key_id] unless Chef::Config[:knife][:ssh_key_name]
           Chef::Config[:knife].delete(:aws_ssh_key_id)
           ui.warn("Use of aws_ssh_key_id option in knife.rb/config.rb config is deprecated, use ssh_key_name option instead.")
         end
 
-        validate_aws_config!([:image, :ssh_key_name, :aws_access_key_id, :aws_secret_access_key])
+        validate_aws_config!(%i{image ssh_key_name aws_access_key_id aws_secret_access_key})
 
         validate_nics! if config_value(:network_interfaces)
 
@@ -725,7 +688,7 @@ class Chef
         end
 
         if config_value(:spot_price).nil? && config_value(:spot_wait_mode)
-          if !(config_value(:spot_wait_mode).casecmp("prompt") == 0)
+          unless config_value(:spot_wait_mode).casecmp("prompt") == 0
             ui.error("spot-wait-mode option requires that a spot-price option is set.")
             exit 1
           end
@@ -749,17 +712,16 @@ class Chef
           end
         end
 
-        if config_value(:tag_node_in_chef)
-          ui.warn("[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead.")
-        end
-
-        if config_value(:tags)
-          ui.warn("[DEPRECATED] --tags option is deprecated. Use --aws-tag option instead.")
+        if config_value(:chef_tag)
+          # If --chef-tag is provided then it will be set in chef as single value e.g. --chef-tag "myTag"
+          # --tags has been removed from knife-ec2, now it's available in core
+          config[:tags] += config_value(:chef_tag)
+          ui.warn("[DEPRECATED] --chef-tag option is deprecated and will be removed in future release. Use --tags TAGS option instead.")
         end
       end
 
-      def tags
-        tags = config_value(:tags) || config_value(:aws_tag)
+      def parse_aws_tags
+        tags = config_value(:aws_tag)
         if !tags.nil? && (tags.length != tags.to_s.count("="))
           ui.error("AWS Tags should be entered in a key = value pair")
           exit 1
@@ -837,7 +799,7 @@ class Chef
       end
 
       def process_user_data(script_lines)
-        if !ssl_config_data_already_exist?
+        unless ssl_config_data_already_exist?
           ps_start_tag = "<powershell>\n"
           ps_end_tag = "</powershell>\n"
           ps_start_tag_index = script_lines.index(ps_start_tag) || script_lines.index(ps_start_tag.strip)
@@ -996,7 +958,7 @@ class Chef
         attributes[:disable_api_termination] = config_value(:disable_api_termination) if config_value(:spot_price).nil?
 
         attributes[:instance_initiated_shutdown_behavior] = config_value(:instance_initiated_shutdown_behavior)
-        attributes[:chef_tag] = config_value(:chef_tag)
+        attributes[:chef_tag] = config_value(:tags)
         attributes
       end
 
@@ -1137,6 +1099,7 @@ class Chef
       # @return [Boolean]
       def subnet_public_ip_on_launch?
         return false unless server.subnet_id
+
         subnet = fetch_subnet(server.subnet_id)
         subnet.map_public_ip_on_launch
       end
@@ -1204,7 +1167,7 @@ class Chef
         return true if invalid_nic_ids.empty?
 
         ui.error "The following network interfaces are invalid: " \
-          "#{invalid_nic_ids.join(', ')}"
+          "#{invalid_nic_ids.join(", ")}"
         exit 1
       end
 
@@ -1313,6 +1276,7 @@ class Chef
         sleep 10
         response = fetch_password_data(server_id)
         return false unless response.password_data
+
         true
       end
 
@@ -1345,8 +1309,7 @@ class Chef
 
       # TODO: connection_protocol and connection_port used to choose winrm/ssh or 5985/22 based on the image chosen
       def connection_port
-        port = config_value(:connection_port,
-                            knife_key_for_protocol(connection_protocol, :port))
+        port = config_value(:connection_port, knife_key_for_protocol(connection_protocol, :port))
         return port if port
 
         assign_default_port
@@ -1370,7 +1333,7 @@ class Chef
 
         default_protocol = is_image_windows? ? "winrm" : "ssh"
 
-        from_url = host_descriptor =~ /^(.*):\/\// ? $1 : nil
+        from_url = host_descriptor =~ %r{^(.*)://} ? $1 : nil
         from_cli = config[:connection_protocol]
         from_knife = Chef::Config[:knife][:connection_protocol]
         @connection_protocol = from_url || from_cli || from_knife || default_protocol
@@ -1382,6 +1345,7 @@ class Chef
 
       def server_name
         return nil unless server
+
         server.public_dns_name || server.private_dns_name || server.private_ip_address
       end
 
@@ -1421,7 +1385,7 @@ class Chef
 
       def hashed_tags
         ht = {}
-        tags.map { |t| key, val = t.split("="); ht[key] = val } unless tags.nil?
+        parse_aws_tags.map { |t| key, val = t.split("="); ht[key] = val } unless parse_aws_tags.nil?
 
         # Always set the Name tag
         unless ht.keys.include? "Name"

data/lib/chef/knife/ec2_server_delete.rb

@@ -150,8 +150,8 @@ class Chef
 
           server_data["name"] = i.instances[0].tags[0].value
           server_data["az"] = i.instances[0].placement.availability_zone
-          server_data["iam_instance_profile"] = ( i.instances[0].iam_instance_profile.nil? ? nil : i.instances[0].iam_instance_profile.arn[/instance-profile\/(.*)/] )
-          server_data["security_groups"] = i.instances[0].security_groups.map { |x| x.group_name }.join(", ")
+          server_data["iam_instance_profile"] = ( i.instances[0].iam_instance_profile.nil? ? nil : i.instances[0].iam_instance_profile.arn[%r{instance-profile/(.*)}] )
+          server_data["security_groups"] = i.instances[0].security_groups.map(&:group_name).join(", ")
 
           all_data << server_data
         end
@@ -161,6 +161,7 @@ class Chef
       # Delete the server instance
       def delete_instance(instance_id)
         return nil unless instance_id || instance_id.is_a?(String)
+
         ec2_connection.terminate_instances({
           instance_ids: [
             instance_id,

data/lib/chef/knife/ec2_server_list.rb

@@ -117,7 +117,7 @@ class Chef
             ui.color("IAM Profile", :bold)
           end,
 
-          ui.color("State", :bold)
+          ui.color("State", :bold),
         ].flatten.compact
 
         output_column_count = servers_list.length
@@ -173,7 +173,7 @@ class Chef
             server_data["az"] = ui.color(i.instances[0].placement.availability_zone, azcolor(i.instances[0].placement.availability_zone))
           end
 
-          server_data["iam_instance_profile"] = ( i.instances[0].iam_instance_profile.nil? ? nil : i.instances[0].iam_instance_profile.arn[/instance-profile\/(.*)/] )
+          server_data["iam_instance_profile"] = ( i.instances[0].iam_instance_profile.nil? ? nil : i.instances[0].iam_instance_profile.arn[%r{instance-profile/(.*)}] )
 
           server_data["state"] = ui.color(i.instances[0].state.name, state_color(i.instances[0].state.name))
 
@@ -182,7 +182,7 @@ class Chef
           end
 
           # dig into security_groups struct
-          server_data["security_groups"] = i.instances[0].security_groups.map { |x| x.group_name }
+          server_data["security_groups"] = i.instances[0].security_groups.map(&:group_name)
 
           all_data << server_data
         end
@@ -191,7 +191,7 @@ class Chef
 
       # @return [Array<String>]
       def extract_tags(tags_struct)
-        tags_struct.map { |x| x.value }
+        tags_struct.map(&:value)
       end
     end
   end

data/lib/chef/knife/ec2_subnet_list.rb

@@ -38,7 +38,7 @@ class Chef
           ui.color("Available IPs", :bold),
           ui.color("AZ Default?", :bold),
           ui.color("Maps Public IP?", :bold),
-          ui.color("VPC ID", :bold)
+          ui.color("VPC ID", :bold),
         ].flatten.compact
 
         output_column_count = subnet_list.length

data/lib/chef/knife/ec2_vpc_list.rb

@@ -36,7 +36,7 @@ class Chef
           ui.color("CIDR Block", :bold),
           ui.color("Instance Tenancy", :bold),
           ui.color("DHCP Options ID", :bold),
-          ui.color("Default VPC?", :bold)
+          ui.color("Default VPC?", :bold),
         ].flatten.compact
 
         output_column_count = vpcs_list.length

data/lib/chef/knife/s3_source.rb

@@ -52,9 +52,9 @@ class Chef
       def path
         uri = URI(@url)
         if uri.scheme == "s3"
-          URI(@url).path.sub(/^\//, "")
+          URI(@url).path.sub(%r{^/}, "")
         else
-          URI(@url).path.split(bucket).last.sub(/^\//, "")
+          URI(@url).path.split(bucket).last.sub(%r{^/}, "")
         end
       end
 

data/lib/knife-ec2/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Ec2
-    VERSION = "1.0.7".freeze
+    VERSION = "1.0.8".freeze
     MAJOR, MINOR, TINY = VERSION.split(".")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-ec2
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef