kitchen-google 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6f8ac82e7287b315c4983229aad826ffc6dc2616d7b94c0f1887c3f3fbfdd4
-  data.tar.gz: 15e6f00245977ef5f27fa4c9fb09ee81e320534e2b2757ab6f812cb43f2d5e03
+  metadata.gz: 7bb68767fd70358c97f209575379ad984b9aab4fd4b3f0377cf1e77b5167796a
+  data.tar.gz: 83f5317efdf99856679a51a88a95c5d5601dc220989285c54e5771b290b90393
 SHA512:
-  metadata.gz: 813a82a35180d748b4d629b71e9ff9204a31a4482443e70e49830a1457ff545d7b7542ecfea6644991a864a5052f3cf3ef905276cfd171e0248b62327072d6f0
-  data.tar.gz: ddbdb11f5bf6420395f772189ce8145f65120c01aee09a065702c735fae641f75a809875713dd6a525eaf0d1ecb53724d5fe5fe48fc246ca21d9268393f0235f
+  metadata.gz: 59c12a1a8494f2c99df3a5ddb5b68bcb34fde00815e3ed25df084b4e1cb7b96057f030486350870b694ac2cd827fdffc47f94a421c7586118d9338dc7c5870e7
+  data.tar.gz: 5e1f05a0b84feab76831418aeff5b5900d84a8285fbe3bf0b7b9c046ec958e9e6d46027bb47e493842c3e84f91d2398f094f23058b6f97b82be23a06b86e36bd

data/lib/kitchen/driver/gce.rb

@@ -89,7 +89,10 @@ module Kitchen
       default_config :tags, []
       default_config :preemptible, false
       default_config :auto_restart, false
-      default_config :auto_migrate, false
+      # Matches GCE's own default for onHostMaintenance. Several machine
+      # families, E2 among them, reject TERMINATE unless the instance is
+      # preemptible, so defaulting this off makes them unusable.
+      default_config :auto_migrate, true
       default_config :image_family, nil
       default_config :image_name, nil
       default_config :image_project, nil
@@ -125,13 +128,35 @@ module Kitchen
 
       # Configuration applied to every disk before the user's own settings.
       #
+      # Deliberately sets no `disk_type`. GCE derives an omitted disk type from
+      # the instance's machine series -- pd-standard on first- and
+      # second-generation series such as N1 and N2, pd-balanced on C3, C3D and
+      # M3, and hyperdisk-balanced on C4, N4 and newer -- so leaving it unset is
+      # the only default that is compatible with every machine type. Naming one
+      # here would fail outright on the families that no longer accept it.
+      #
       # @return [Hash] the per-disk defaults
       DISK_DEFAULT_CONFIG = {
         autodelete_disk: true,
         disk_size: 10,
-        disk_type: "pd-standard",
       }.freeze
 
+      # Local Windows account Test Kitchen's WinRM transport defaults to, and
+      # which Google's Windows images ship disabled.
+      #
+      # @return [String] the built-in administrator account name
+      BUILTIN_ADMINISTRATOR = "administrator".freeze
+
+      # Told to the user when they are about to wait out a WinRM timeout for a
+      # reason the driver can see coming.
+      #
+      # @return [String] the warning text
+      BUILTIN_ADMINISTRATOR_WARNING =
+        "The WinRM transport is connecting as the built-in Administrator account, which is " \
+        "disabled on Google's Windows images. The guest agent resets its password without " \
+        "enabling it, so the login will be refused. Set transport.username to any other name " \
+        "and the agent will create that account instead.".freeze
+
       # Human-readable driver name shown in Test Kitchen output.
       #
       # @return [String] the driver's display name
@@ -164,13 +189,17 @@ module Kitchen
         info("Creating GCE instance <#{server_name}> in project #{project}, zone #{zone}...")
         operation = connection.insert_instance(project, zone, create_instance_object(server_name))
 
-        wait_for_operation(operation)
-
-        server              = server_instance(server_name)
+        # GCE starts billing for the instance as soon as the insert is
+        # accepted, so record it before waiting on the operation. Anything that
+        # goes wrong from here on can then be torn down by the rescue below,
+        # and by `kitchen destroy` if the process does not survive to run it.
         state[:server_name] = server_name
-        state[:hostname]    = ip_address_for(server)
         state[:zone]        = zone
 
+        wait_for_operation(operation)
+
+        state[:hostname] = ip_address_for(server_instance(server_name))
+
         info("Server <#{server_name}> created.")
 
         update_windows_password(server_name)
@@ -269,9 +298,12 @@ module Kitchen
           boot: true,
           autodelete_disk: config.fetch(:autodelete_disk, DISK_DEFAULT_CONFIG[:autodelete_disk]),
           disk_size: config.fetch(:disk_size, DISK_DEFAULT_CONFIG[:disk_size]),
-          disk_type: config.fetch(:disk_type, DISK_DEFAULT_CONFIG[:disk_type]),
         }
 
+        # Carry the key only when the user set it, so that an unset type stays
+        # absent rather than becoming an explicit nil. See DISK_DEFAULT_CONFIG.
+        disk_config[:disk_type] = config[:disk_type] if config[:disk_type]
+
         raise "Disk type #{disk_config[:disk_type]} is not valid" unless valid_disk_type?(disk_config[:disk_type])
 
         disk_config
@@ -388,11 +420,13 @@ module Kitchen
         raise "You cannot use autodelete_disk, disk_size or disk_type with the new disks configuration" if old_disk_configuration_present? && new_disk_configuration_present?
         raise "Disk image #{config[:image_name]} is not valid - check your image name and image project" if boot_disk_source_image.nil?
 
+        warn(BUILTIN_ADMINISTRATOR_WARNING) if winrm_transport? && builtin_administrator?
         warn("Both zone and region specified - region will be ignored.") if config[:zone] && config[:region]
         warn("Both image family and name specified - image family will be ignored") if config[:image_family] && config[:image_name]
         warn("Image project not specified - searching current project only") unless config[:image_project]
         warn("Subnet project not specified - searching current project only") if config[:subnet] && !config[:subnet_project]
         warn("Auto-migrate disabled for preemptible instance") if preemptible? && config[:auto_migrate]
+        warn("Auto-migrate disabled for instance with guest accelerators") if guest_accelerators? && config[:auto_migrate]
         warn("Auto-restart disabled for preemptible instance") if preemptible? && config[:auto_restart]
         warn("These configs are deprecated - consider using new disks configuration") if old_disk_configuration_present?
       end
@@ -425,6 +459,14 @@ module Kitchen
         )
       end
 
+      # Whether the WinRM transport is configured to log in as the built-in
+      # Administrator account.
+      #
+      # @return [Boolean] true if the transport username is `administrator`
+      def builtin_administrator?
+        instance.transport[:username].to_s.casecmp?(BUILTIN_ADMINISTRATOR)
+      end
+
       # Whether the suite's transport is WinRM, implying a Windows guest.
       #
       # @return [Boolean] true when the transport is WinRM
@@ -525,10 +567,13 @@ module Kitchen
 
       # Whether a disk type exists in the target zone.
       #
+      # An unset type is valid: the driver sends no `diskType` at all and GCE
+      # substitutes the default for the instance's machine series.
+      #
       # @param disk_type [String, nil] the disk type to check
-      # @return [Boolean] true if the disk type is valid
+      # @return [Boolean] true if the disk type is valid or unset
       def valid_disk_type?(disk_type)
-        return false if disk_type.nil?
+        return true if disk_type.nil?
 
         check_api_call { connection.get_disk_type(project, zone, disk_type) }
       end
@@ -753,17 +798,19 @@ module Kitchen
         disk.boot           = true if disk_config[:boot]
         disk.auto_delete    = disk_config[:autodelete_disk]
         params.disk_size_gb = disk_config[:disk_size]
-        params.disk_type    = disk_type_url_for(disk_config[:disk_type])
+        params.disk_type    = disk_type_url_for(disk_config[:disk_type]) if disk_config[:disk_type]
 
         if local_ssd?(disk_config)
           info("Creating a #{LOCAL_SSD_SIZE_GB} GB local ssd as scratch disk (https://cloud.google.com/compute/docs/disks/#localssds).")
           disk.type = "SCRATCH"
         elsif disk.boot
-          info("Creating a #{disk_config[:disk_size]} GB boot disk named #{unique_disk_name} from image #{image_name}...")
+          params.disk_size_gb = disk_size_for_image(disk_config[:disk_size], image_name)
+          info("Creating a #{params.disk_size_gb} GB boot disk named #{unique_disk_name} from image #{image_name}...")
           params.source_image = boot_disk_source_image
           params.disk_name    = unique_disk_name
         else
-          info("Creating a #{disk_config[:disk_size]} GB extra disk named #{unique_disk_name} from image #{disk_config[:custom_image]}...")
+          params.disk_size_gb = disk_size_for_image(disk_config[:disk_size], disk_config[:custom_image])
+          info("Creating a #{params.disk_size_gb} GB extra disk named #{unique_disk_name} from image #{disk_config[:custom_image]}...")
           params.source_image = image_url(disk_config[:custom_image])
           params.disk_name    = unique_disk_name
         end
@@ -771,6 +818,50 @@ module Kitchen
         disk
       end
 
+      # The size to request for a disk cloned from an image.
+      #
+      # GCE refuses to create a disk smaller than the image it is cloned from,
+      # and the driver's own 10 GB default is smaller than many stock images -
+      # every Windows image is 50 GB, and Rocky and CentOS are 20 GB. Rather
+      # than fail the run over a size the user never chose, raise the request
+      # to what the image needs and say so.
+      #
+      # @param requested [Integer, nil] the configured size in gigabytes
+      # @param image [String, nil] the image the disk is cloned from
+      # @return [Integer, nil] the size to request
+      # @api private
+      def disk_size_for_image(requested, image)
+        image_size = image_disk_size_gb(image)
+        return requested if image_size.nil? || (!requested.nil? && requested >= image_size)
+
+        warn("Requested disk size of #{requested} GB is smaller than image #{image} " \
+             "(#{image_size} GB) - creating a #{image_size} GB disk instead.")
+        image_size
+      end
+
+      # The size, in gigabytes, of an image in the image project.
+      #
+      # Memoised per image name, since the boot image is looked up more than
+      # once during a single action.
+      #
+      # @param image [String, nil] the image name
+      # @return [Integer, nil] the image's size, or nil if it cannot be read
+      # @api private
+      def image_disk_size_gb(image)
+        return if image.nil?
+
+        @image_disk_sizes ||= {}
+        return @image_disk_sizes[image] if @image_disk_sizes.key?(image)
+
+        @image_disk_sizes[image] =
+          begin
+            connection.get_image(image_project, image).disk_size_gb
+          rescue Google::Apis::ClientError => e
+            debug("Unable to read the size of image #{image}: #{e.message}")
+            nil
+          end
+      end
+
       # Creates a standalone persistent disk, waits for it to become ready, and
       # returns a reference attaching it to the instance.
       #
@@ -781,7 +872,7 @@ module Kitchen
         disk = Google::Apis::ComputeV1::Disk.new
         disk.name    = unique_disk_name
         disk.size_gb = disk_config[:disk_size]
-        disk.type    = disk_type_url_for(disk_config[:disk_type])
+        disk.type    = disk_type_url_for(disk_config[:disk_type]) if disk_config[:disk_type]
 
         info("Creating a #{disk_config[:disk_size]} GB disk named #{unique_disk_name}...")
         wait_for_operation(connection.insert_disk(project, zone, disk))
@@ -1019,16 +1110,24 @@ module Kitchen
         config[:preemptible] ? true : false
       end
 
-      # Whether the instance may live-migrate. Always false when preemptible,
-      # which GCE does not allow to migrate.
+      # Whether the instance may live-migrate. Always false for preemptible
+      # instances and for instances with guest accelerators attached, neither
+      # of which GCE will migrate.
       #
       # @return [Boolean] true if live migration is enabled
       def auto_migrate?
-        return false if preemptible?
+        return false if preemptible? || guest_accelerators?
 
         config[:auto_migrate] ? true : false
       end
 
+      # Whether any guest accelerators are attached.
+      #
+      # @return [Boolean] true if the instance has at least one accelerator
+      def guest_accelerators?
+        !Array(config[:guest_accelerators]).empty?
+      end
+
       # Whether the instance should restart automatically. Always false when
       # preemptible, which GCE does not allow to auto-restart.
       #

data/lib/kitchen/driver/gce_version.rb

@@ -28,6 +28,6 @@ module Kitchen
     # release. Keep it on one line.
     #
     # @return [String] the gem version
-    GCE_VERSION = "3.0.0"
+    GCE_VERSION = "3.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-google
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Test Kitchen Team