kitchen-azurerm 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc95dc73706d3eb94349e23d021b1747f838b1dde2ea375d3be1fe2d27b920d
-  data.tar.gz: 6719ba4591a556c5eeb6a1187d21fddd5ad2b72e4faf74b8fc5d483158c09ad1
+  metadata.gz: f2e163e7f873cd30975117e7959c9f860980e67c6a57a57cceea3b5784a15c88
+  data.tar.gz: 842ce181806cd18fd1ce064222311cb24f7702b5c569f9e57c1971ef0e8a2843
 SHA512:
-  metadata.gz: fbda874b618647705e59cd47b1ae9ef4f128b7bdfacebef707824eabc158f875b011ae666c33b5e6bff478553af14fc9206f7c23bcc41b0955c58f3b6b57fc70
-  data.tar.gz: 654610bdad5017605ece2dbede6907952b605e7607f5024a8e15a6f3e786af8b69ef8b19dfab78f79898afe945cf4415f5600806c1bbedf4edc8b2125b845828
+  metadata.gz: 57922ce563572966e695342e34e01eb89c04bb30528c0931baa41b28bcf043ed2d6ccbd45141df8febbbc1739b038d9307ed666b0bd349b33b626df685f2ca70
+  data.tar.gz: 44e874be227fa2625d1b73091c80b1402e548b5bf7851da030737d80f58f479409585c7b5248d95c67e42d536bbada211127612cd037a38bf4b2257b214c66bc

data/lib/kitchen/driver/azure/environments.rb

@@ -63,6 +63,10 @@ module Kitchen
         # Every supported cloud, keyed by its downcased name so that lookups are
         # case-insensitive.
         #
+        # +AzureGermanCloud+ is kept only so that an existing kitchen.yml naming
+        # it still loads: Microsoft closed that cloud in 2021, and its endpoints
+        # no longer answer.
+        #
         # @return [Hash{String => Environment}]
         ALL = [
           Environment.new("Azure",

data/lib/kitchen/driver/azure/errors.rb

@@ -22,11 +22,12 @@ module Kitchen
 
         # The HTTP status code of the failing response.
         #
-        # @return [Integer]
+        # @return [Integer, nil] nil when the error was raised before a
+        #   response arrived, as the token providers do.
         attr_reader :status
 
         # @param message [String] human-readable summary.
-        # @param status [Integer] HTTP status code.
+        # @param status [Integer, nil] HTTP status code, when there was one.
         # @param body [Hash] parsed ARM error body.
         def initialize(message, status: nil, body: {})
           super(message)

data/lib/kitchen/driver/azurerm.rb

@@ -2,6 +2,7 @@ require "kitchen"
 
 require_relative "azure_credentials"
 require_relative "azure/errors"
+require_relative "azurerm_version"
 require "securerandom" unless defined?(SecureRandom)
 require "base64" unless defined?(Base64)
 autoload :SSHKey, "sshkey"
@@ -29,8 +30,21 @@ module Kitchen
       # @return [Azure::ArmClient, nil]
       attr_accessor :arm_client
 
+      # The writer needs a docstring of its own: one comment above an
+      # attr_accessor is copied to both methods, so the argument the writer
+      # takes can only be described here. The directive has to come after the
+      # accessor - placed before it, the accessor overwrites it.
+
+      # @!method arm_client=(client)
+      #   Replaces the ARM client.
+      #
+      #   @param client [Azure::ArmClient, nil] the client to use.
+      #   @return [Azure::ArmClient, nil] the client that was set.
+
       kitchen_driver_api_version 2
 
+      plugin_version Kitchen::Driver::AZURERM_VERSION
+
       # Settings that Azure retirements have made inoperable. They are still
       # accepted so that an existing kitchen.yml keeps loading, but they no
       # longer do anything and {#warn_about_deprecated_config} says so.
@@ -253,6 +267,8 @@ module Kitchen
       # @param state [Hash] the instance state, mutated in place.
       # @return [void]
       # @raise [RuntimeError] if no +subscription_id+ can be resolved.
+      # @raise [Kitchen::UserError] if +os_disk_size_gb+ is not a whole number,
+      #   or the public half of the transport's SSH key cannot be found.
       # @raise [Azure::OperationError] if an Azure API call fails
       #   for any reason other than an already-running deployment.
       def create(state)
@@ -307,8 +323,9 @@ module Kitchen
       # surface as an Azure error partway through a create, once the resource
       # group already exists, so this looks for them up front.
       #
-      # @param state [Hash] the instance state, unused - the checks are about
-      #   configuration and credentials, which exist before any instance does.
+      # @param _state [Hash] the instance state. Test Kitchen passes it, but
+      #   the checks are about configuration and credentials, which exist
+      #   before any instance does, so it is ignored.
       # @return [Boolean] true when a problem was found, as +kitchen doctor+
       #   expects.
       def doctor(_state)
@@ -556,7 +573,13 @@ module Kitchen
         state.key?(property) && !state[property].to_s.empty?
       end
 
-      # Fills in any state values that are not already present.
+      # Fills in any state values that are not already present, and drops the
+      # generated password when the transport authenticates with an SSH key.
+      #
+      # +use_managed_disks+ is copied across with the settings that are still
+      # read, even though Azure's retirement of unmanaged disks left nothing
+      # reading it - see {DEPRECATED_CONFIG}. It is written as nil, since the
+      # setting has no default.
       #
       # @param state [Hash] existing Hash of state values.
       # @return [Hash] the same Hash, with defaults applied.
@@ -930,7 +953,9 @@ module Kitchen
       # worse than saying so promptly.
       #
       # @param state [Hash] the instance state.
-      # @return [Hash] +:live+, +:state+, +:resource_id+ and +:message+.
+      # @return [Hash] always +:live+, +:state+ and +:message+; +:resource_id+
+      #   only when the virtual machine was found, since nothing else knows
+      #   which resource to name.
       def status(state)
         resource_group = state[:azure_resource_group_name]
         vm_name = state[:vm_name]
@@ -1391,7 +1416,11 @@ module Kitchen
 
       # Base64-encoded custom data for the VM.
       #
-      # @return [String, nil] nil when no +custom_data+ is configured.
+      # An unset +custom_data+ is "" rather than nil, which encodes to "" - so
+      # callers guard on the setting being empty rather than on this returning
+      # nil.
+      #
+      # @return [String, nil] nil only when +custom_data+ is explicitly nil.
       def prepared_custom_data
         return nil if config[:custom_data].nil?
 
@@ -1540,7 +1569,7 @@ module Kitchen
       # Requests deletion of a resource group without waiting for it to finish.
       #
       # @param resource_group_name [String] the resource group name.
-      # @return [Object] the operation response.
+      # @return [void] ARM answers a delete with no body worth returning.
       def delete_resource_group_async(resource_group_name)
         with_azure_retries("while sending resource group deletion request for '#{resource_group_name}'.") do
           arm_client.delete_resource_group(resource_group_name)

data/lib/kitchen/driver/azurerm_version.rb

@@ -6,6 +6,6 @@ module Kitchen
     # driver and, with it, the whole Azure SDK.
     #
     # @return [String]
-    AZURERM_VERSION = "2.3.0".freeze
+    AZURERM_VERSION = "2.4.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-azurerm
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Stuart Preston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-24 00:00:00.000000000 Z
+date: 2026-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile