kitchen-ec2 3.17.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4993e5b97ddbe3fb98f8e58b9877bf90b3e0a165b521dc295d53dc9bcbbe192
-  data.tar.gz: 621bf0ddd53d9f8488ca6b7c351cf12c733cbcc534f23c30a3390b932fdc2e4e
+  metadata.gz: 5a5e24ca8e2d208d63f7079597ea3d8c3773eab8d82891ec1052f226dfb0d3b2
+  data.tar.gz: 6bd3c4846bc622f399ee748e2e5e15d5aaf1dc2b70d8db875ac3d20897fdb58e
 SHA512:
-  metadata.gz: f62f3a41a041935cd4371e0cef514ec1a919f40ea8e21dc25bb84cec67dce7d97810469a3e220cc567daff040ba37da5cb026ddcb94aba0bdf86eec5adcffe6c
-  data.tar.gz: 7011bf26dc6e011af1af506b7ce9c42d5c26e1a19ff610896ed407200490d473b467dbf80a1260868e160e8d48da6792a1e0343dc5792eff2dbc09c7cee663fc
+  metadata.gz: 9016a081a3b1cd4cfc2bcf57e02df07a6f3225b610a2087ef45dd5d5da3fb8dc9db823675283cb7e6eba5c0cb90174b705244bed5222eedf3211a06cf06a7659
+  data.tar.gz: 3ec395554c6ff841f46be8610b2b6c7ae9b19d58af87c3b786589df73950cbbb3864b533691fd2015ec075d29697ec850b381e99fadd3f17762799d953523dc4

data/lib/kitchen/driver/aws/client.rb

@@ -22,16 +22,12 @@ require "aws-sdk-core/shared_credentials"
 require "aws-sdk-core/instance_profile_credentials"
 
 module Kitchen
-
   module Driver
-
     class Aws
-
       # A class for creating and managing the EC2 client connection
       #
       # @author Tyler Ball <tball@chef.io>
       class Client
-
         def initialize(
           region,
           profile_name = "default",
@@ -40,12 +36,12 @@ module Kitchen
           ssl_verify_peer = true
         )
           ::Aws.config.update(
-            region: region,
+            region:,
             profile: profile_name,
-            http_proxy: http_proxy,
-            ssl_verify_peer: ssl_verify_peer
+            http_proxy:,
+            ssl_verify_peer:
           )
-          ::Aws.config.update(retry_limit: retry_limit) unless retry_limit.nil?
+          ::Aws.config.update(retry_limit:) unless retry_limit.nil?
         end
 
         # create a new AWS EC2 instance
@@ -89,11 +85,7 @@ module Kitchen
         def resource
           @resource ||= ::Aws::EC2::Resource.new
         end
-
       end
-
     end
-
   end
-
 end

data/lib/kitchen/driver/aws/dedicated_hosts.rb

@@ -98,10 +98,10 @@ module Kitchen
           info("Deallocating dedicated host #{host_id}")
 
           response = ec2.client.release_hosts({ host_ids: [host_id] })
-          unless response.unsuccessful.empty?
-            warn "ERROR: Could not release dedicated host #{host_id}. Host may remain allocated and incur cost"
-            exit!
-          end
+          return if response.unsuccessful.empty?
+
+          warn "ERROR: Could not release dedicated host #{host_id}. Host may remain allocated and incur cost"
+          exit!
         end
 
         # return instance family from type

data/lib/kitchen/driver/aws/instance_generator.rb

@@ -20,16 +20,12 @@ require "base64" unless defined?(Base64)
 require "aws-sdk-ec2"
 
 module Kitchen
-
   module Driver
-
     class Aws
-
       # A class for encapsulating the instance payload logic
       #
       # @author Tyler Ball <tball@chef.io>
       class InstanceGenerator
-
         attr_reader :config, :ec2, :logger
 
         def initialize(config, ec2, logger)
@@ -42,7 +38,7 @@ module Kitchen
         # can be passed in null, others need to be ommitted if they are null
         # Some fields can be passed in null, others need to be ommitted if they are null
         # @return [Hash]
-        def ec2_instance_data # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def ec2_instance_data
           # Support for looking up security group id and subnet id using tags.
           vpc_id = nil
           client = ::Aws::EC2::Client.new(region: config[:region])
@@ -129,8 +125,8 @@ module Kitchen
               # and Integers need to be represented as Strings
               { key: k, value: v.to_s }
             end
-            instance_tag_spec = { resource_type: "instance", tags: tags }
-            volume_tag_spec = { resource_type: "volume", tags: tags }
+            instance_tag_spec = { resource_type: "instance", tags: }
+            volume_tag_spec = { resource_type: "volume", tags: }
             i[:tag_specifications] = [instance_tag_spec, volume_tag_spec]
           end
 
@@ -146,7 +142,7 @@ module Kitchen
             if i.key?(:placement)
               i[:placement][:tenancy] = tenancy
             else
-              i[:placement] = { tenancy: tenancy }
+              i[:placement] = { tenancy: }
             end
           end
           unless config[:block_device_mappings].nil? || config[:block_device_mappings].empty?
@@ -190,7 +186,44 @@ module Kitchen
             if i.key?(:placement)
               i[:placement][:tenancy] = tenancy
             else
-              i[:placement] = { tenancy: tenancy }
+              i[:placement] = { tenancy: }
+            end
+          end
+          placement = config[:placement]
+          if placement
+            unless i.key?(:placement)
+              i[:placement] = {}
+            end
+            if placement[:affinity]
+              i[:placement][:affinity] = placement[:affinity]
+            end
+            if placement[:availability_zone]
+              i[:placement][:availability_zone] = placement[:availability_zone]
+            end
+            if placement[:group_id] && !placement[:group_name]
+              i[:placement][:group_id] = placement[:group_id]
+            end
+            if placement[:group_name] && !placement[:group_id]
+              i[:placement][:group_name] = placement[:group_name]
+            end
+            if placement[:host_id]
+              i[:placement][:host_id] = placement[:host_id]
+            end
+            if placement[:host_resource_group_arn]
+              i[:placement][:host_resource_group_arn] = placement[:host_resource_group_arn]
+            end
+            if placement[:partition_number]
+              i[:placement][:partition_number] = placement[:partition_number]
+            end
+            if placement[:tenancy]
+              i[:placement][:tenancy] = placement[:tenancy]
+            end
+          end
+          license_specifications = config[:licenses]
+          if license_specifications
+            i[:licenses] = []
+            license_specifications.each do |license_configuration_arn|
+              i[:licenses].append({ license_configuration_arn: license_configuration_arn[:license_configuration_arn] })
             end
           end
           unless config[:instance_initiated_shutdown_behavior].nil? ||
@@ -212,11 +245,7 @@ module Kitchen
 
           @user_data = Base64.encode64(raw_user_data)
         end
-
       end
-
     end
-
   end
-
 end

data/lib/kitchen/driver/aws/standard_platform/alma.rb

@@ -40,10 +40,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /AlmaLinux OS/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)\b/i
-              new(driver, "alma", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /AlmaLinux OS/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)\b/i
+            new(driver, "alma", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/amazon.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /amzn-ami/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
-              new(driver, "amazon", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /amzn-ami/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
+            new(driver, "amazon", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/amazon2.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /amzn2-ami/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
-              new(driver, "amazon2", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /amzn2-ami/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
+            new(driver, "amazon2", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/amazon2023.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /al2023-ami/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
-              new(driver, "amazon2023", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /al2023-ami/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
+            new(driver, "amazon2023", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/centos.rb

@@ -52,10 +52,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /centos/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)\b/i
-              new(driver, "centos", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /centos/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)\b/i
+            new(driver, "centos", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/debian.rb

@@ -73,16 +73,16 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /debian/i.match?(image.name)
-              image.name =~ /\b(\d+|#{DEBIAN_CODENAMES.values.join("|")})\b/i
-              version = (Regexp.last_match || [])[1]
-              if version && version.to_i == 0
-                version = DEBIAN_CODENAMES.find do |_v, codename|
-                  codename == version.downcase
-                end.first
-              end
-              new(driver, "debian", version, image.architecture)
+            return unless /debian/i.match?(image.name)
+
+            image.name =~ /\b(\d+|#{DEBIAN_CODENAMES.values.join("|")})\b/i
+            version = (Regexp.last_match || [])[1]
+            if version&.to_i&.zero?
+              version = DEBIAN_CODENAMES.find do |_v, codename|
+                codename == version.downcase
+              end.first
             end
+            new(driver, "debian", version, image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/fedora.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /fedora/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)\b/i
-              new(driver, "fedora", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /fedora/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)\b/i
+            new(driver, "fedora", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/freebsd.rb

@@ -41,10 +41,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /freebsd/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)\b/i
-              new(driver, "freebsd", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /freebsd/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)\b/i
+            new(driver, "freebsd", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/macos.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /amzn-ec2-macos/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
-              new(driver, "macos", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /amzn-ec2-macos/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
+            new(driver, "macos", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/rhel.rb

@@ -32,7 +32,7 @@ module Kitchen
           # default username for this platform's ami
           # @return [String]
           def username
-            (version && version.to_f < 6.4) ? "root" : "ec2-user"
+            version && version.to_f < 6.4 ? "root" : "ec2-user"
           end
 
           def image_search
@@ -45,10 +45,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /rhel/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)/i
-              new(driver, "rhel", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /rhel/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)/i
+            new(driver, "rhel", (Regexp.last_match || [])[1], image.architecture)
           end
 
           def sort_by_version(images)

data/lib/kitchen/driver/aws/standard_platform/rocky.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /Rocky-/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
-              new(driver, "rocky", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /Rocky-/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+[\.\d])?)/i
+            new(driver, "rocky", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/ubuntu.rb

@@ -39,10 +39,10 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /ubuntu/i.match?(image.name)
-              image.name =~ /\b(\d+(\.\d+)?)\b/i
-              new(driver, "ubuntu", (Regexp.last_match || [])[1], image.architecture)
-            end
+            return unless /ubuntu/i.match?(image.name)
+
+            image.name =~ /\b(\d+(\.\d+)?)\b/i
+            new(driver, "ubuntu", (Regexp.last_match || [])[1], image.architecture)
           end
         end
       end

data/lib/kitchen/driver/aws/standard_platform/windows.rb

@@ -70,21 +70,20 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if /Windows/i.match?(image.name)
-              # 2008 R2 SP2
-              if image.name =~ /(\b\d+)\W*(r\d+)?/i
-                major, revision = (Regexp.last_match || [])[1], (Regexp.last_match || [])[2]
-                if image.name =~ /(sp\d+|rtm)/i
-                  service_pack = (Regexp.last_match || [])[1]
-                end
-                revision = revision.downcase if revision
-                service_pack ||= "rtm"
-                service_pack = service_pack.downcase
-                version = "#{major}#{revision}#{service_pack}"
-              end
-
-              new(driver, "windows", version, image.architecture)
+            return unless /Windows/i.match?(image.name)
+
+            # 2008 R2 SP2
+            if image.name =~ /(\b\d+)\W*(r\d+)?/i
+              major = (Regexp.last_match || [])[1]
+              revision = (Regexp.last_match || [])[2]
+              service_pack = (Regexp.last_match || [])[1] if image.name =~ /(sp\d+|rtm)/i
+              revision = revision.downcase if revision
+              service_pack ||= "rtm"
+              service_pack = service_pack.downcase
+              version = "#{major}#{revision}#{service_pack}"
             end
+
+            new(driver, "windows", version, image.architecture)
           end
 
           protected
@@ -132,30 +131,30 @@ module Kitchen
 
           private
 
-          def windows_name_filter # rubocop:disable Metrics/MethodLength
+          def windows_name_filter
             major, revision, service_pack = windows_version_parts
-            if major == 2022 || major == 2019 || major == 2016
+            if [2022, 2019, 2016].include?(major)
               "Windows_Server-#{major}-English-Full-Base-*"
-            elsif major == 1709 || major == 1803
+            elsif [1709, 1803].include?(major)
               "Windows_Server-#{major}-English-Core-ContainersLatest-*"
             else
-              case revision
-              when nil
-                revision_strings = ["", "R*_"]
-              when 0
-                revision_strings = [""]
-              else
-                revision_strings = ["R#{revision}_"]
-              end
-
-              case service_pack
-              when nil
-                revision_strings = revision_strings.flat_map { |r| ["#{r}RTM", "#{r}SP*"] }
-              when 0
-                revision_strings = revision_strings.map { |r| "#{r}RTM" }
-              else
-                revision_strings = revision_strings.map { |r| "#{r}SP#{service_pack}" }
-              end
+              revision_strings = case revision
+                                 when nil
+                                   ["", "R*_"]
+                                 when 0
+                                   [""]
+                                 else
+                                   ["R#{revision}_"]
+                                 end
+
+              revision_strings = case service_pack
+                                 when nil
+                                   revision_strings.flat_map { |r| ["#{r}RTM", "#{r}SP*"] }
+                                 when 0
+                                   revision_strings.map { |r| "#{r}RTM" }
+                                 else
+                                   revision_strings.map { |r| "#{r}SP#{service_pack}" }
+                                 end
 
               name_filter = revision_strings.map do |r|
                 "Windows_Server-#{major || "*"}-#{r}-English-*-Base-*"

data/lib/kitchen/driver/aws/standard_platform.rb

@@ -91,6 +91,11 @@ module Kitchen
         #
         SUPPORTED_ARCHITECTURES = %w{x86_64 i386 arm64}.freeze
 
+        #
+        # The list of supported ebs volume types
+        #
+        EBS_VOLUME_TYPES = %w{gp3 gp2}.freeze
+
         #
         # Find the best matching image for the given image search.
         #
@@ -103,12 +108,12 @@ module Kitchen
           end
 
           # We prefer most recent first
-          images = driver.ec2.resource.images(filters: filters)
+          images = driver.ec2.resource.images(filters:)
           images = sort_images(images)
           show_returned_images(images)
 
           # Grab the best match
-          images.first && images.first.id
+          images.first&.id
         end
 
         #
@@ -136,9 +141,9 @@ module Kitchen
         #
         def self.from_platform_string(driver, platform_string)
           platform, version, architecture = parse_platform_string(platform_string)
-          if platform && platforms[platform]
-            platforms[platform].new(driver, platform, version, architecture)
-          end
+          return unless platform && platforms[platform]
+
+          platforms[platform].new(driver, platform, version, architecture)
         end
 
         #
@@ -157,6 +162,20 @@ module Kitchen
           nil
         end
 
+        def self.parse_platform_string(platform_string)
+          platform, version = platform_string.split("-", 2)
+
+          # If the right side is a valid architecture, use it as such
+          # i.e. debian-i386 or windows-server-2012r2-i386
+          if version && SUPPORTED_ARCHITECTURES.include?(version.split("-")[-1])
+            # server-2012r2-i386 -> server-2012r2, -, i386
+            version, _dash, architecture = version.rpartition("-")
+            version = nil if version == ""
+          end
+
+          [platform, version, architecture]
+        end
+
         protected
 
         #
@@ -192,20 +211,6 @@ module Kitchen
 
         private
 
-        def self.parse_platform_string(platform_string)
-          platform, version = platform_string.split("-", 2)
-
-          # If the right side is a valid architecture, use it as such
-          # i.e. debian-i386 or windows-server-2012r2-i386
-          if version && SUPPORTED_ARCHITECTURES.include?(version.split("-")[-1])
-            # server-2012r2-i386 -> server-2012r2, -, i386
-            version, _dash, architecture = version.rpartition("-")
-            version = nil if version == ""
-          end
-
-          [platform, version, architecture]
-        end
-
         def sort_images(images)
           # P6: We prefer more recent images over older ones
           images = images.sort_by(&:creation_date).reverse
@@ -214,7 +219,7 @@ module Kitchen
           # P4: We prefer (SSD) (if available)
           images = prefer(images) do |image|
             image.block_device_mappings.any? do |b|
-              b.device_name == image.root_device_name && b.ebs && %w{gp3 gp2}.any? { |t| b.ebs.volume_type == t }
+              b.device_name == image.root_device_name && b.ebs && EBS_VOLUME_TYPES.any?(b.ebs.volume_type)
             end
           end
           # P3: We prefer ebs over instance_store (if available)

data/lib/kitchen/driver/ec2.rb

@@ -45,20 +45,17 @@ require "etc" unless defined?(Etc)
 require "socket" unless defined?(Socket)
 
 module Kitchen
-
   module Driver
-
     # Amazon EC2 driver for Test Kitchen.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Ec2 < Kitchen::Driver::Base
-
       kitchen_driver_api_version 2
 
       plugin_version Kitchen::Driver::EC2_VERSION
 
       default_config :region, ENV["AWS_REGION"] || "us-east-1"
-      default_config :shared_credentials_profile, ENV["AWS_PROFILE"]
+      default_config :shared_credentials_profile, ENV.fetch("AWS_PROFILE", nil)
       default_config :availability_zone, nil
       default_config :instance_type, &:default_instance_type
       default_config :ebs_optimized, false
@@ -82,14 +79,14 @@ module Kitchen
       default_config :aws_access_key_id,  nil
       default_config :aws_secret_access_key, nil
       default_config :aws_session_token,  nil
-      default_config :aws_ssh_key_id,     ENV["AWS_SSH_KEY_ID"]
+      default_config :aws_ssh_key_id,     ENV.fetch("AWS_SSH_KEY_ID", nil)
       default_config :aws_ssh_key_type,   "rsa"
       default_config :image_id, &:default_ami
       default_config :image_search,       nil
       default_config :username,           nil
       default_config :associate_public_ip, nil
       default_config :interface,           nil
-      default_config :http_proxy,          ENV["HTTPS_PROXY"] || ENV["HTTP_PROXY"]
+      default_config :http_proxy,          ENV["HTTPS_PROXY"] || ENV.fetch("HTTP_PROXY", nil)
       default_config :retry_limit,         3
       default_config :tenancy,             "default"
       default_config :instance_initiated_shutdown_behavior, nil
@@ -194,10 +191,10 @@ module Kitchen
       end
 
       # empty keys cause failures when tagging and they make no sense
-      validations[:tags] = lambda do |attr, val, _driver|
+      validations[:tags] = lambda do |_attr, val, _driver|
         # if someone puts the tags each on their own line it's an array not a hash
         # @todo we should probably just do the right thing and support this format
-        if val.class == Array
+        if val.instance_of?(Array)
           warn "AWS instance tags must be specified as a single hash, not a tag " \
             "on each line. Example: {:foo => 'bar', :bar => 'foo'}"
           exit!
@@ -247,13 +244,13 @@ module Kitchen
           info("Auto placement on one dedicated host out of: #{hosts_with_capacity.map(&:host_id).join(", ")}")
         end
 
-        if config[:spot_price]
-          # Spot instance when a price is set
-          server = with_request_limit_backoff(state) { submit_spots }
-        else
-          # On-demand instance
-          server = with_request_limit_backoff(state) { submit_server }
-        end
+        server = if config[:spot_price]
+                   # Spot instance when a price is set
+                   with_request_limit_backoff(state) { submit_spots }
+                 else
+                   # On-demand instance
+                   with_request_limit_backoff(state) { submit_server }
+                 end
         info("Instance <#{server.id}> requested.")
         with_request_limit_backoff(state) do
           logging_proc = ->(attempts) { info("Polling AWS for existence, attempt #{attempts}...") }
@@ -269,7 +266,7 @@ module Kitchen
           tries: 10,
           sleep: lambda { |n| [2**n, 30].min },
           on: ::Aws::EC2::Errors::InvalidInstanceIDNotFound
-        ) do |r, _|
+        ) do |_r, _|
           wait_until_ready(server, state)
         end
 
@@ -320,10 +317,10 @@ module Kitchen
         delete_key(state)
 
         # Clean up dedicated hosts matching instance_type and unused (if allowed)
-        if config[:tenancy] == "host" && allow_deallocate_host?
-          empty_hosts = hosts_with_capacity.select { |host| host_unused?(host) }
-          empty_hosts.each { |host| deallocate_host(host.host_id) }
-        end
+        return unless config[:tenancy] == "host" && allow_deallocate_host?
+
+        empty_hosts = hosts_with_capacity.select { |host| host_unused?(host) }
+        empty_hosts.each { |host| deallocate_host(host.host_id) }
       end
 
       def image
@@ -427,7 +424,7 @@ module Kitchen
       def expand_config(conf, key)
         configs = []
 
-        if conf[key] && conf[key].is_a?(Array)
+        if conf[key].is_a?(Array)
           values = conf[key]
           values.each do |value|
             new_config = conf.clone
@@ -499,11 +496,11 @@ module Kitchen
         instance_data = instance_generator.ec2_instance_data
 
         config_spot_price = config[:spot_price].to_s
-        if %w{ondemand on-demand}.include?(config_spot_price)
-          spot_price = ""
-        else
-          spot_price = config_spot_price
-        end
+        spot_price = if %w{ondemand on-demand}.include?(config_spot_price)
+                       ""
+                     else
+                       config_spot_price
+                     end
         spot_options = {
           # Must use one-time in order to use instance_interruption_behavior=terminate
           # spot_instance_type: "one-time", # default
@@ -519,7 +516,7 @@ module Kitchen
 
         instance_data[:instance_market_options] = {
           market_type: "spot",
-          spot_options: spot_options,
+          spot_options:,
         }
 
         # The preferred way to create a spot instance is via request_spot_instances()
@@ -551,7 +548,7 @@ module Kitchen
             aws_instance.state.name == "running" &&
             hostname != "0.0.0.0"
 
-          if ready && ( hostname.nil? || hostname == "" )
+          if ready && (hostname.nil? || hostname == "")
             debug("Unable to detect hostname using interface_type #{config[:interface]}. Fallback to ordered mapping")
             state[:hostname] = hostname(aws_instance, nil)
           end
@@ -567,7 +564,7 @@ module Kitchen
                 output = Base64.decode64(output)
                 debug "Console output: --- \n#{output}"
               end
-              ready = !!(output =~ /Windows is Ready to use/)
+              ready = !!(output.include?("Windows is Ready to use"))
             end
           end
           ready
@@ -600,7 +597,7 @@ module Kitchen
       end
 
       def fetch_windows_admin_password(server, state)
-        wait_with_destroy(server, state, "to fetch windows admin password") do |aws_instance|
+        wait_with_destroy(server, state, "to fetch windows admin password") do |_aws_instance|
           enc = server.client.get_password_data(
             instance_id: state[:server_id]
           ).password_data
@@ -655,7 +652,7 @@ module Kitchen
           server.send(interface_type)
         else
           potential_hostname = nil
-          INTERFACE_TYPES.values.each do |type|
+          INTERFACE_TYPES.each_value do |type|
             potential_hostname ||= server.send(type)
             # AWS returns an empty string if the dns name isn't populated yet
             potential_hostname = nil if potential_hostname == ""
@@ -717,7 +714,7 @@ module Kitchen
 
         # Preparing custom static admin user if we defined something other than Administrator
         custom_admin_script = ""
-        if !(instance.transport[:username] =~ /administrator/i) && instance.transport[:password]
+        if instance.transport[:username] !~ /administrator/i && instance.transport[:password]
           custom_admin_script = Kitchen::Util.outdent!(<<-EOH)
           "Disabling Complex Passwords" >> $logfile
           $seccfg = [IO.Path]::GetTempFileName()
@@ -759,7 +756,7 @@ module Kitchen
       def image_info(image)
         root_device = image.block_device_mappings
           .find { |b| b.device_name == image.root_device_name }
-        volume_type = " #{root_device.ebs.volume_type}" if root_device && root_device.ebs
+        volume_type = " #{root_device.ebs.volume_type}" if root_device&.ebs
 
         " Architecture: #{image.architecture}," \
         " Virtualization: #{image.virtualization_type}," \
@@ -813,6 +810,17 @@ module Kitchen
         params = {
           group_name: "kitchen-#{Array.new(8) { rand(36).to_s(36) }.join}",
           description: "Test Kitchen for #{instance.name} by #{Etc.getlogin || "nologin"} on #{Socket.gethostname}",
+          tag_specifications: [
+            {
+              resource_type: "security-group",
+              tags: [
+                {
+                  key: "created-by",
+                  value: "test-kitchen",
+                },
+              ],
+            },
+          ],
         }
         params[:vpc_id] = vpc_id if vpc_id
         resp = ec2.client.create_security_group(params)
@@ -829,7 +837,7 @@ module Kitchen
               from_port: port,
               to_port: port,
               ip_ranges: Array(config[:security_group_cidr_ip]).map do |cidr_ip|
-                { cidr_ip: cidr_ip }
+                { cidr_ip: }
               end,
             }
           end
@@ -851,14 +859,28 @@ module Kitchen
           (Etc.getlogin || "nologin").gsub(/\W/, ""),
           Socket.gethostname.gsub(/\W/, "")[0..20],
           Time.now.utc.iso8601,
-          Array.new(8) { rand(36).to_s(36) }.join(""),
+          Array.new(8) { rand(36).to_s(36) }.join,
         ]
         # In a perfect world this would generate the key locally and use ImportKey
         # instead for better security, but given the use case that is very likely
         # to rapidly exhaust local entropy by creating a lot of keys. So this is
         # probably fine. If you want very high security, probably don't use this
         # feature anyway.
-        resp = ec2.client.create_key_pair(key_name: "kitchen-#{name_parts.join("-")}", key_type: config[:aws_ssh_key_type])
+        resp = ec2.client.create_key_pair(
+          key_name: "kitchen-#{name_parts.join("-")}",
+          key_type: config[:aws_ssh_key_type],
+          tag_specifications: [
+            {
+              resource_type: "key-pair",
+              tags: [
+                {
+                  key: "created-by",
+                  value: "test-kitchen",
+                },
+              ],
+            },
+          ]
+        )
         state[:auto_key_id] = resp.key_name
         info("Created automatic key pair #{state[:auto_key_id]}")
         # Write the key out with safe permissions
@@ -892,7 +914,7 @@ module Kitchen
             puts "ENI #{config[:elastic_network_interface_id]} already attached."
           end
         rescue ::Aws::EC2::Errors::InvalidNetworkInterfaceIDNotFound => e
-          warn("#{e}")
+          warn(e.to_s)
         end
       end
 
@@ -922,7 +944,6 @@ module Kitchen
         state.delete(:auto_key_id)
         File.unlink("#{config[:kitchen_root]}/.kitchen/#{instance.name}.pem")
       end
-
     end
   end
 end

data/lib/kitchen/driver/ec2_version.rb

@@ -17,10 +17,8 @@
 # limitations under the License.
 
 module Kitchen
-
   module Driver
-
     # Version string for EC2 Test Kitchen driver
-    EC2_VERSION = "3.17.0".freeze
+    EC2_VERSION = "3.18.0".freeze
   end
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ec2
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.18.0
 platform: ruby
 authors:
-- Fletcher Nichol
+- Test Kitchen Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: test-kitchen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
   requirement: !ruby/object:Gem::Requirement
@@ -64,9 +44,29 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: A Test Kitchen Driver for Amazon EC2
 email:
-- fnichol@nichol.ca
+- help@sous-chefs.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Amazon EC2