kitchen-azurerm 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d34cb889a331fa1622ad6e3729fe3ee619c06b5ab830ccc067ca6e17441be01
-  data.tar.gz: a507483fd57dd9ac42ca96e2379d926bd6ad7aa924960374e6bd86298c196f3d
+  metadata.gz: 65f0cc54a62e738484f2f5469a37e476e0323bdd0ac59ef180e99a05de3fa0c8
+  data.tar.gz: dce34ba2cec4675d575aa4607f9b00874d4e504f8d5c7ee1ce1b18d1311b4434
 SHA512:
-  metadata.gz: 995c517ffd324584166c51a7463b2bc9588754828c231351224474713b34bc19d0d9ca0714c93fb5c3cdb7d9409911034a7af5a2200ab90fdb89ec3d4f019c74
-  data.tar.gz: 4d79344aba476cc4caf04ca35f785a47eeba4de4758d883f26bf0e7bc912c846cc91def32cbdd1fb5325d3bbfe6b9fe6a4adb1bd0c717054283dd6e580f5ed36
+  metadata.gz: cdf17e7f3013d461390749209072afbf0a7f8ef7969853467a66cd7b90471226b9848a36d89212c7148681cfcb27aa96bb5ac7d3e2e9e9ca38ac3d8839d7d987
+  data.tar.gz: 25d1728326d14b31470120ee867263fbf814ffe6758946705b64391c7948031fbefbbafc123baa23ea4f404089d16d30cecf3117c2bc9867a1e0dfab2fac33d3

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

@@ -67,10 +67,18 @@ module Kitchen
         # Requests deletion of a resource group, returning as soon as ARM
         # accepts the request rather than waiting for it to finish.
         #
+        # A group that is already gone counts as deleted: that is the outcome
+        # the caller asked for, and ARM answers 404. Treating that as an error
+        # wedged +kitchen destroy+ permanently for any instance whose resource
+        # group had been removed out of band - deleted in the portal to save
+        # money, or never created because +kitchen create+ failed early. Every
+        # subsequent destroy failed the same way, so the instance could only be
+        # cleared by hand-deleting its state file.
+        #
         # @param name [String] resource group name.
         # @return [void]
         def delete_resource_group(name)
-          call(:delete, resource_group_path(name), api_version: RESOURCES_API_VERSION)
+          call(:delete, resource_group_path(name), api_version: RESOURCES_API_VERSION, allow: [404])
           nil
         end
 

data/lib/kitchen/driver/azurerm.rb

@@ -302,7 +302,7 @@ module Kitchen
           dnsNameForPublicIP: "kitchen-#{state[:uuid]}",
           vmName: state[:vm_name],
           systemAssignedIdentity: config[:system_assigned_identity],
-          userAssignedIdentities: config[:user_assigned_identities].to_h { |identity| [identity, {}] },
+          userAssignedIdentities: Array(config[:user_assigned_identities]).to_h { |identity| [identity, {}] },
           secretUrl: config[:secret_url],
           vaultName: config[:vault_name],
           vaultResourceGroup: config[:vault_resource_group],
@@ -315,7 +315,7 @@ module Kitchen
 
         parameters["nicName"] = nic_name(state)
         parameters["customData"] = prepared_custom_data unless config[:custom_data].to_s.empty?
-        parameters["osDiskSizeGb"] = config[:os_disk_size_gb] unless config[:os_disk_size_gb].to_s.empty?
+        parameters["osDiskSizeGb"] = os_disk_size_gb unless config[:os_disk_size_gb].to_s.empty?
         parameters["nsgId"] = config[:nsg_id] unless config[:nsg_id].to_s.empty?
 
         parameters.merge(image_parameters)
@@ -333,6 +333,28 @@ module Kitchen
         { "imagePublisher" => publisher, "imageOffer" => offer, "imageSku" => sku, "imageVersion" => version }
       end
 
+      # The OS disk size, as a number ARM will accept.
+      #
+      # YAML makes +os_disk_size_gb: 64+ an Integer and +os_disk_size_gb: "64"+
+      # a String, and the ARM parameter is typed +int+ - Azure rejects the
+      # String outright rather than coercing it:
+      #
+      #   The provided value for the template parameter 'osDiskSizeGb' is not
+      #   valid. Expected a value of type 'Integer', but received a value of
+      #   type 'String'.
+      #
+      # Quoting a number in kitchen.yml is an easy thing to do, and the driver
+      # already tolerates the same ambiguity for +boot_diagnostics_enabled+.
+      #
+      # @return [Integer]
+      # @raise [Kitchen::UserError] if the value is not a whole number.
+      def os_disk_size_gb
+        Integer(config[:os_disk_size_gb])
+      rescue ArgumentError, TypeError
+        raise Kitchen::UserError,
+          "os_disk_size_gb must be a whole number of gigabytes, but was #{config[:os_disk_size_gb].inspect}."
+      end
+
       # Whether managed boot diagnostics should be switched on.
       #
       # Historically this setting defaulted to the *string* +"true"+, and plenty
@@ -561,26 +583,47 @@ module Kitchen
         template["resources"].select { |resource| resource["type"] == "Microsoft.Compute/virtualMachines" }
       end
 
+      # Serializes the generate-and-write below.
+      #
+      # Test Kitchen runs instances as threads inside one process, so
+      # +kitchen create -c+ had every thread reach the "does the key exist?"
+      # check before any of them had written one. Each generated its own pair
+      # and wrote it over the last, so only the instance whose key happened to
+      # land on disk last was reachable - the rest were deployed with a public
+      # key nobody held the private half of, and failed at converge with
+      # +Permission denied (publickey)+.
+      #
+      # @return [Mutex]
+      KEY_GENERATION_MUTEX = Mutex.new
+
       # Returns the public key to inject into the deployment, generating a new
       # key pair on disk when the configured private key does not yet exist.
       #
       # @param private_key_filename [String] path to the transport's private key.
       # @return [String] the OpenSSH-format public key, stripped of whitespace.
       def public_key_for_deployment(private_key_filename)
-        unless File.file?(private_key_filename)
-          key = SSHKey.generate
+        KEY_GENERATION_MUTEX.synchronize do
+          generate_key_pair(private_key_filename) unless File.file?(private_key_filename)
 
-          ::FileUtils.mkdir_p(File.dirname(private_key_filename))
-          File.write(private_key_filename, key.private_key)
-          File.chmod(0600, private_key_filename)
-          File.write("#{private_key_filename}.pub", key.ssh_public_key)
-          File.chmod(0600, "#{private_key_filename}.pub")
-
-          return key.ssh_public_key.strip
+          public_key_filename = instance.transport[:ssh_public_key] || "#{private_key_filename}.pub"
+          File.read(public_key_filename).strip
         end
+      end
+
+      # Writes a fresh SSH key pair to disk.
+      #
+      # Always called with {KEY_GENERATION_MUTEX} held.
+      #
+      # @param private_key_filename [String] path to write the private key to.
+      # @return [void]
+      def generate_key_pair(private_key_filename)
+        key = SSHKey.generate
 
-        public_key_filename = instance.transport[:ssh_public_key] || "#{private_key_filename}.pub"
-        File.read(public_key_filename).strip
+        ::FileUtils.mkdir_p(File.dirname(private_key_filename))
+        File.write(private_key_filename, key.private_key)
+        File.chmod(0600, private_key_filename)
+        File.write("#{private_key_filename}.pub", key.ssh_public_key)
+        File.chmod(0600, "#{private_key_filename}.pub")
       end
 
       # Builds the pre-deployment from a caller-supplied ARM template file.
@@ -940,8 +983,11 @@ module Kitchen
         data = {
           vm_tags: vm_tag_string(config[:vm_tags]),
           storage_account_type: config[:storage_account_type],
-          image_id: config[:image_id],
-          custom_data: config[:custom_data],
+          # A setting written with no value is nil, not "". The templates ask
+          # these two whether they are empty, so give them something that can
+          # answer.
+          image_id: config[:image_id].to_s,
+          custom_data: config[:custom_data].to_s,
           os_disk_size_gb: config[:os_disk_size_gb],
           data_disks_for_vm_json:,
           use_ephemeral_osdisk: config[:use_ephemeral_osdisk],

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.1.2".freeze
+    AZURERM_VERSION = "2.1.4".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-azurerm
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Stuart Preston
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'