kitchen-ec2 3.7.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6429e51c08d43c0e1084b9acc55b76feacae05bbe42b7cf3a1e35e0de70f87
-  data.tar.gz: 9f2a0adbe2866ad6a267ab8adc14d24a890b22b71b0abe272808a2a52def3933
+  metadata.gz: b5acaa7d4d497244e97e35e4d8c44f1b0a8771100dfb0ef01cae937a7904a853
+  data.tar.gz: 92a4bb2ffeb6c84295fc6432e0c0852e63e11f1a4cbea7ae4fad54888ad9869e
 SHA512:
-  metadata.gz: aa308480b37d109ec173851aefe0098523d2a59c06481e88004bf76ccb8d87dfbd865300d2383157af13b38af47588ec2d1adf0541734f7279669a8dbcb0b673
-  data.tar.gz: 48f6f1a3dc22caf5d04079ef1579c19850e7e72558708e633537adb752969c3aac1b79702804864fac3fad9140e8d9053347c3ecde47e578e0545366d0b0b619
+  metadata.gz: fb7fc3f4d93a893455e274f0744c510526a79c2bd997bf6ef712f9e7774ab13a077b2c038402d7c41eaf8610f7b0bff9abeddddc5633b36c2e1142bfe72c4779
+  data.tar.gz: 44f07e5fb729c8fd106e3df0030a7d267322ebd80220f19f115e2f8addc6148a1ebd5c2da05bb4e5f84867c74b1889a4131881183f8f89ed5f67bde776e7ac7d

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Tyler Ball (<tball@chef.io>)
 #

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Tyler Ball (<tball@chef.io>)
 #
@@ -17,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "base64"
+require "base64" unless defined?(Base64)
 require "aws-sdk-ec2"
 
 module Kitchen
@@ -59,7 +58,7 @@ module Kitchen
             raise "The subnet tagged '#{config[:subnet_filter][:tag]}:#{config[:subnet_filter][:value]}' does not exist!" unless subnets.any?
 
             # => Select the least-populated subnet if we have multiple matches
-            subnet = subnets.sort_by { |s| s[:available_ip_address_count] }.last
+            subnet = subnets.max_by { |s| s[:available_ip_address_count] }
             vpc_id = subnet.vpc_id
             config[:subnet_id] = subnet.subnet_id
           end
@@ -133,7 +132,7 @@ module Kitchen
 
           availability_zone = config[:availability_zone]
           if availability_zone
-            if availability_zone =~ /^[a-z]$/i
+            if /^[a-z]$/i.match?(availability_zone)
               availability_zone = "#{config[:region]}#{availability_zone}"
             end
             i[:placement] = { availability_zone: availability_zone.downcase }
@@ -176,7 +175,7 @@ module Kitchen
           end
           availability_zone = config[:availability_zone]
           if availability_zone
-            if availability_zone =~ /^[a-z]$/i
+            if /^[a-z]$/i.match?(availability_zone)
               availability_zone = "#{config[:region]}#{availability_zone}"
             end
             i[:placement] = { availability_zone: availability_zone.downcase }

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

@@ -210,10 +210,10 @@ module Kitchen
           images = images.sort_by(&:creation_date).reverse
           # P5: We prefer x86_64 over i386 (if available)
           images = prefer(images) { |image| image.architecture == "x86_64" }
-          # P4: We prefer gp2 (SSD) (if available)
+          # 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 && b.ebs.volume_type == "gp2"
+              b.device_name == image.root_device_name && b.ebs && %w{gp3 gp2}.any? { |t| b.ebs.volume_type == t }
             end
           end
           # P3: We prefer ebs over instance_store (if available)

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

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

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

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

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

@@ -23,6 +23,14 @@ module Kitchen
         class Centos < StandardPlatform
           StandardPlatform.platforms["centos"] = self
 
+          CENTOS_OWNER_ID = "125523088429".freeze
+          PRODUCT_CODES = {
+            "6" => "6x5jmcajty9edm3f211pqjfn2",
+            "7" => "aw0evgkw8e5c1q413zgy5pjce",
+            # It appears that v8 is not published to the
+            # AWS marketplace and hence does not have a product code
+          }.freeze
+
           # default username for this platform's ami
           # @return [String]
           def username
@@ -34,10 +42,25 @@ module Kitchen
           end
 
           def image_search
+            # Version 8+ are published directly, not to the AWS marketplace. Use OWNER ID.
             search = {
-              "owner-alias" => "aws-marketplace",
-              "name" => ["CentOS Linux #{version}*", "CentOS-#{version}*-GA-*"],
+              "owner-id" => CENTOS_OWNER_ID,
+              "name" => ["CentOS #{version}*", "CentOS-#{version}*-GA-*"],
             }
+
+            if version && version.split(".").first.to_i < 8
+              # Versions <8 are published to the AWS marketplace and use a different naming convention
+              search = {
+                "owner-alias" => "aws-marketplace",
+                "name" => ["CentOS Linux #{version}*", "CentOS-#{version}*-GA-*"],
+              }
+              # For versions published to aws-marketplace, additionally filter on product code to
+              # avoid non-official AMIs. Can't use CentOS owner ID here, as the owner ID is that of aws marketplace.
+              # https://github.com/test-kitchen/kitchen-ec2/issues/456
+              PRODUCT_CODES.keys.each do |major_version|
+                search["product-code"] = PRODUCT_CODES[major_version] if version.start_with?(major_version)
+              end
+            end
             search["architecture"] = architecture if architecture
             search
           end
@@ -52,7 +75,7 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if image.name =~ /centos/i
+            if /centos/i.match?(image.name)
               image.name =~ /\b(\d+(\.\d+)?)\b/i
               new(driver, "centos", (Regexp.last_match || [])[1], image.architecture)
             end

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

@@ -23,8 +23,8 @@ module Kitchen
         class Debian < StandardPlatform
           StandardPlatform.platforms["debian"] = self
 
-          # 10/11 are listed last since we default to the first item in the hash
-          # and 10/11 are not released yet. When they're released move them up
+          # 11/12 are listed last since we default to the first item in the hash
+          # and 11/12 are not released yet. When they're released move them up
           DEBIAN_CODENAMES = {
             10 => "buster",
             9 => "stretch",
@@ -60,7 +60,7 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if image.name =~ /debian/i
+            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

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

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

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

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

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

@@ -45,11 +45,18 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if image.name =~ /rhel/i
+            if /rhel/i.match?(image.name)
               image.name =~ /\b(\d+(\.\d+)?)/i
               new(driver, "rhel", (Regexp.last_match || [])[1], image.architecture)
             end
           end
+
+          def sort_by_version(images)
+            # First do a normal version sort
+            super(images)
+            # Now sort again, shunning Beta releases.
+            prefer(images) { |image| !image.name.match(/_Beta-/i) }
+          end
         end
       end
     end

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

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

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

@@ -70,7 +70,7 @@ module Kitchen
           end
 
           def self.from_image(driver, image)
-            if image.name =~ /Windows/i
+            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]

data/lib/kitchen/driver/ec2.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -17,8 +16,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "benchmark"
-require "json"
+require "benchmark" unless defined?(Benchmark)
+require "json" unless defined?(JSON)
 require "kitchen"
 require_relative "ec2_version"
 require_relative "aws/client"
@@ -35,10 +34,10 @@ require_relative "aws/standard_platform/ubuntu"
 require_relative "aws/standard_platform/windows"
 require "aws-sdk-ec2"
 require "aws-sdk-core/waiters/errors"
-require "retryable"
-require "time"
-require "etc"
-require "socket"
+require "retryable" unless defined?(Retryable)
+require "time" unless defined?(Time)
+require "etc" unless defined?(Etc)
+require "socket" unless defined?(Socket)
 
 module Kitchen
 
@@ -57,7 +56,8 @@ module Kitchen
       default_config :shared_credentials_profile, ENV["AWS_PROFILE"]
       default_config :availability_zone, nil
       default_config :instance_type, &:default_instance_type
-      default_config :ebs_optimized,      false
+      default_config :ebs_optimized, false
+      default_config :delete_on_termination, true
       default_config :security_group_ids, nil
       default_config :security_group_filter, nil
       default_config :security_group_cidr_ip, "0.0.0.0/0"
@@ -261,13 +261,14 @@ module Kitchen
 
         info("EC2 instance <#{state[:server_id]}> ready (hostname: #{state[:hostname]}).")
         instance.transport.connection(state).wait_until_ready
-        create_ec2_json(state) if instance.provisioner.name =~ /chef/i
+        attach_network_interface(state) unless config[:elastic_network_interface_id].nil?
+        create_ec2_json(state) if /chef/i.match?(instance.provisioner.name)
         debug("ec2:create '#{state[:hostname]}'")
-      rescue Exception
+      rescue Exception => e
         # Clean up any auto-created security groups or keys on the way out.
         delete_security_group(state)
         delete_key(state)
-        raise
+        raise "#{e.message} in the specified region #{config[:region]}. Please check this AMI is available in this region."
       end
 
       def destroy(state)
@@ -319,17 +320,14 @@ module Kitchen
       end
 
       def default_instance_type
-        @instance_type ||= begin
-          # We default to the free tier (t2.micro for hvm, t1.micro for paravirtual)
-          if image && image.virtualization_type == "hvm"
-            info("instance_type not specified. Using free tier t2.micro instance ...")
-            "t2.micro"
-          else
-            info("instance_type not specified. Using free tier t1.micro instance since" \
-                 " image is paravirtual (pick an hvm image to use the superior t2.micro!) ...")
-            "t1.micro"
-          end
-        end
+        @instance_type ||= if image && image.virtualization_type == "hvm"
+                             info("instance_type not specified. Using free tier t2.micro instance ...")
+                             "t2.micro"
+                           else
+                             info("instance_type not specified. Using free tier t1.micro instance since" \
+                                  " image is paravirtual (pick an hvm image to use the superior t2.micro!) ...")
+                             "t1.micro"
+                           end
       end
 
       # The actual platform is the platform detected from the image
@@ -424,7 +422,31 @@ module Kitchen
       def submit_spots
         configs = [config]
         expanded = []
-        keys = %i{instance_type subnet_id}
+        keys = %i{instance_type}
+
+        unless config[:subnet_filter]
+          # => Use explicitly specified subnets
+          keys << :subnet_id
+        else
+          # => Enable cascading through matching subnets
+          client = ::Aws::EC2::Client.new(region: config[:region])
+          subnets = client.describe_subnets(
+            filters: [
+              {
+                name: "tag:#{config[:subnet_filter][:tag]}",
+                values: [config[:subnet_filter][:value]],
+              },
+            ]
+          ).subnets
+          raise "A subnet matching '#{config[:subnet_filter][:tag]}:#{config[:subnet_filter][:value]}' does not exist!" unless subnets.any?
+
+          configs = subnets.map do |subnet|
+            new_config = config.clone
+            new_config[:subnet_id] = subnet.subnet_id
+            new_config[:subnet_filter] = nil
+            new_config
+          end
+        end
 
         keys.each do |key|
           configs.each do |conf|
@@ -436,12 +458,10 @@ module Kitchen
 
         errs = []
         configs.each do |conf|
-          begin
-            @config = conf
-            return submit_spot
-          rescue => e
-            errs.append(e)
-          end
+          @config = conf
+          return submit_spot
+        rescue => e
+          errs.append(e)
         end
         raise ["Could not create a spot instance:", errs].flatten.join("\n")
       end
@@ -450,7 +470,6 @@ module Kitchen
         debug("Creating EC2 Spot Instance..")
         instance_data = instance_generator.ec2_instance_data
 
-        request_duration = config[:spot_wait]
         config_spot_price = config[:spot_price].to_s
         if %w{ondemand on-demand}.include?(config_spot_price)
           spot_price = ""
@@ -458,9 +477,10 @@ module Kitchen
           spot_price = config_spot_price
         end
         spot_options = {
-          spot_instance_type: "persistent", # Cannot use one-time with valid_until
-          valid_until: Time.now + request_duration,
-          instance_interruption_behavior: "stop",
+          # Must use one-time in order to use instance_interruption_behavior=terminate
+          # spot_instance_type: "one-time", # default
+          # Must use instance_interruption_behavior=terminate in order to use block_duration_minutes
+          # instance_interruption_behavior: "terminate", # default
         }
         if config[:block_duration_minutes]
           spot_options[:block_duration_minutes] = config[:block_duration_minutes]
@@ -762,7 +782,9 @@ module Kitchen
               ip_protocol: "tcp",
               from_port: port,
               to_port: port,
-              ip_ranges: [{ cidr_ip: config[:security_group_cidr_ip] }],
+              ip_ranges: Array(config[:security_group_cidr_ip]).map do |cidr_ip|
+                { cidr_ip: cidr_ip }
+              end,
             }
           end
         )
@@ -803,6 +825,31 @@ module Kitchen
         state[:ssh_key] = key_path
       end
 
+      def attach_network_interface(state)
+        info("Attaching Network interface <#{config[:elastic_network_interface_id]}> with the instance <#{state[:server_id]}> .")
+        client = ::Aws::EC2::Client.new(region: config[:region])
+        begin
+          check_eni = client.describe_network_interface_attribute({
+            attribute: "attachment",
+            network_interface_id: config[:elastic_network_interface_id],
+          })
+          if check_eni.attachment.nil?
+            unless state[:server_id].nil?
+              client.attach_network_interface({
+              device_index: 1,
+              instance_id: state[:server_id],
+              network_interface_id: config[:elastic_network_interface_id],
+              })
+              info("Attached Network interface <#{config[:elastic_network_interface_id]}> with the instance <#{state[:server_id]}> .")
+            end
+          else
+            puts "ENI #{config[:elastic_network_interface_id]} already attached."
+          end
+        rescue ::Aws::EC2::Errors::InvalidNetworkInterfaceIDNotFound => e
+          warn("#{e}")
+        end
+      end
+
       # Clean up a temporary security group for this instance.
       #
       # @api private

data/lib/kitchen/driver/ec2_version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -22,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for EC2 Test Kitchen driver
-    EC2_VERSION = "3.7.0".freeze
+    EC2_VERSION = "3.10.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ec2
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -19,7 +19,7 @@ dependencies:
         version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,35 +29,7 @@ dependencies:
         version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: excon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
   requirement: !ruby/object:Gem::Requirement
@@ -92,104 +64,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: countloc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-- !ruby/object:Gem::Dependency
-  name: chefstyle
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.2
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A Test Kitchen Driver for Amazon EC2
 email:
 - fnichol@nichol.ca
@@ -224,14 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Amazon EC2