kitchen-ec2 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5ed0f1bbc994d156a6374c98a1c48f00d2f789f8540b0cb33ae0755996ffca5
-  data.tar.gz: 0f5f90acb192d7a649ebd9d7861ed2bfbec2ae1665d32c5e66d75685518b1eff
+  metadata.gz: 0ab954ba95ae18b5a8af7013f2c2a62ac9437375ea4c4d9fa82c09448335b6ee
+  data.tar.gz: d721117b22321834df518eb5c0a8c14495141148546b48717a337f8953457c20
 SHA512:
-  metadata.gz: 890a0a34755ab636605a8fcfbc45ce8c0f055adb0fa5404c48d516060da3089628091d37bbc9ad555601d742f40647183f2b34988dc703ca03477722b3dfb1bf
-  data.tar.gz: 617aaee4fdd8b335e17731621abb9ae140b73286e4da2e77adbb46cdc560789f02eeb85f208217e3ffbd03746c52a46f4ae051d93ab1436fb2fb8f3f2b267351
+  metadata.gz: 19cff1d09410833ec15c2407d0e14a454c681f5d3044f50e6bb8713050e3ec7524c56b94d9232b8c09f7e25fe9f05fd7b28bff00bda60ba13de9ac1723520da2
+  data.tar.gz: ece685664f0dfb5e7aacb7af3e97d565f005f653a9be2f9ee7c6fbd7566f57a831aba2e3fc3c38a3b098159f3130a95f821c9021400d14f1d471b16fac7113d4

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

@@ -0,0 +1,135 @@
+module Kitchen
+  module Driver
+    module Mixins
+      module DedicatedHosts
+        # check if a suitable dedicated host is available
+        # @return Boolean
+        def host_available?
+          !hosts_with_capacity.empty?
+        end
+
+        # get dedicated host with capacity for instance type
+        # @return Aws::EC2::Types::Host
+        def hosts_with_capacity
+          hosts_managed.select do |host|
+            # T-instance hosts do not report available capacity and can be overprovisioned
+            if host.available_capacity.nil?
+              true
+            else
+              instance_capacity = host.available_capacity.available_instance_capacity
+              capacity_for_type = instance_capacity.detect { |cap| cap.instance_type == config[:instance_type] }
+              capacity_for_type.available_capacity > 0
+            end
+          end
+        end
+
+        # check if host has no instances running
+        # @param host_id [Aws::EC2::Types::Host] dedicated host
+        # @return Boolean
+        def host_unused?(host)
+          host.instances.empty?
+        end
+
+        # get host data for host id
+        # @param host_id [Aws::EC2::Types::Host] dedicated host
+        # @return Array(Aws::EC2::Types::Host)
+        def host_for_id(host_id)
+          ec2.client.describe_hosts(host_ids: [host_id])&.first
+        end
+
+        # get dedicated hosts managed by Test Kitchen
+        # @return Array(Aws::EC2::Types::Host)
+        def hosts_managed
+          response = ec2.client.describe_hosts(
+            filter: [
+              { name: "tag:ManagedBy", values: ["Test Kitchen"] },
+            ]
+          )
+
+          response.hosts.select { |host| host.state == "available" }
+        end
+
+        # allocate new dedicated host for requested instance type
+        # @return String host id
+        def allocate_host
+          unless allow_allocate_host?
+            warn "ERROR: Attempted to allocate dedicated host but need environment variable TK_ALLOCATE_DEDICATED_HOST to be set"
+            exit!
+          end
+
+          unless config[:availability_zone]
+            warn "Attempted to allocate dedicated host but option 'availability_zone' is not set"
+            exit!
+          end
+
+          info("Allocating dedicated host for #{config[:instance_type]} instances. This will incur additional cost")
+
+          request = {
+            availability_zone: config[:availability_zone],
+            quantity: 1,
+
+            auto_placement: "on",
+
+            tag_specifications: [
+              {
+                resource_type: "dedicated-host",
+                tags: [
+                  { key: "ManagedBy", value: "Test Kitchen" },
+                ],
+              },
+            ],
+          }
+
+          # ".metal" is a 1:1 association, everything else has multi-instance capability
+          if instance_size_from_type(config[:instance_type]) == "metal"
+            request[:instance_type] = config[:instance_type]
+          else
+            request[:instance_family] = instance_family_from_type(config[:instance_type])
+          end
+
+          response = ec2.client.allocate_hosts(request)
+          response.host_ids.first
+        end
+
+        # deallocate a dedicated host
+        # @param host_id [String] dedicated host id
+        # @return Aws::EC2::Types::ReleaseHostsResult
+        def deallocate_host(host_id)
+          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
+        end
+
+        # return instance family from type
+        # @param instance_type [String] type in format family.size
+        # @return String instance family
+        def instance_family_from_type(instance_type)
+          instance_type.split(".").first
+        end
+
+        # return instance size from type
+        # @param instance_type [String] type in format family.size
+        # @return String instance size
+        def instance_size_from_type(instance_type)
+          instance_type.split(".").last
+        end
+
+        # check config, if host allocation is enabled
+        # @return Boolean
+        def allow_allocate_host?
+          config[:allocate_dedicated_host]
+        end
+
+        # check config, if host deallocation is enabled
+        # @return Boolean
+        def allow_deallocate_host?
+          config[:deallocate_dedicated_host]
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/ec2.rb

@@ -21,6 +21,7 @@ require "json" unless defined?(JSON)
 require "kitchen"
 require_relative "ec2_version"
 require_relative "aws/client"
+require_relative "aws/dedicated_hosts"
 require_relative "aws/instance_generator"
 require_relative "aws/standard_platform"
 require_relative "aws/standard_platform/amazon"
@@ -89,6 +90,10 @@ module Kitchen
       default_config :instance_initiated_shutdown_behavior, nil
       default_config :ssl_verify_peer, true
       default_config :skip_cost_warning, false
+      default_config :allocate_dedicated_host, false
+      default_config :deallocate_dedicated_host, false
+
+      include Kitchen::Driver::Mixins::DedicatedHosts
 
       def initialize(*args, &block)
         super
@@ -225,6 +230,18 @@ module Kitchen
           config[:aws_ssh_key_id] = nil
         end
 
+        # Allocate new dedicated hosts if needed and allowed
+        if config[:tenancy] == "host"
+          unless host_available? || allow_allocate_host?
+            warn "ERROR: tenancy `host` requested but no suitable host and allocation not allowed (set `allocate_dedicated_host` setting)"
+            exit!
+          end
+
+          allocate_host unless host_available?
+
+          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 }
@@ -296,6 +313,12 @@ module Kitchen
         # Clean up any auto-created security groups or keys.
         delete_security_group(state)
         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
       end
 
       def image

data/lib/kitchen/driver/ec2_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for EC2 Test Kitchen driver
-    EC2_VERSION = "3.13.0".freeze
+    EC2_VERSION = "3.14.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ec2
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Fletcher Nichol
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -73,6 +73,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - lib/kitchen/driver/aws/client.rb
+- lib/kitchen/driver/aws/dedicated_hosts.rb
 - lib/kitchen/driver/aws/instance_generator.rb
 - lib/kitchen/driver/aws/standard_platform.rb
 - lib/kitchen/driver/aws/standard_platform/amazon.rb
@@ -90,7 +91,7 @@ homepage: https://github.com/test-kitchen/kitchen-ec2
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: A Test Kitchen Driver for Amazon EC2
 test_files: []