kitchen-azurerm 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53c5b50e83af16c56722ecbc2baa30b5a28621cc17f4edde82a59b22420812f
-  data.tar.gz: cd39338fdf0d29d39780e93b6a9fc8c27cd955daf59b6fc79f3be56801c7d891
+  metadata.gz: 8615b3c50c7c88dc0167c2b0daebd1c66c1fec9bd05d1c169223c30fc00a7cc2
+  data.tar.gz: 769a0df10ad7af7a1215066955eba46717e16358f83ad176df6954d4f2e43d49
 SHA512:
-  metadata.gz: d62cae11a2fa2a679657fc9c81e6b03547802cd7773f6b801b644388beb09b6fe44de2f0d5f2e9a1601cf3eee92b7a2d86e1f29e7dd86b09e3e6445fdceaebd5
-  data.tar.gz: 8bbccc8d27fef365420257f9a11d89cd8b326cf6e60c97e737c1fe304b14f28ee543793c314e9e638096b606c6ccc64986e7d4db94345d53463981b84eadc931
+  metadata.gz: 48a2d37a873c8d2b842dc20e0c2e40cc9b349faed29d0c1f9bbc12ccb53097e0df0a06884f29c840b2e2f72a3deef6a0ab2244ef037a9c1aa24397524f756747
+  data.tar.gz: b3538aa314c217566e22a359655aee67eedb88cff3d2ea2f35e17445db4fe5821b57d5beb183f8ec77ac077ed58f88f275fd011fbdaa162a3b17def168c2c99e

data/README.md

@@ -674,6 +674,8 @@ info:    vm image list command OK
 
 * The ```destroy_resource_group_contents``` (default: "false") parameter can be used when you want to destroy the resources within a resource group without destroying the resource group itself. For example, the following configuration options used in combination would use an existing resource group (or create one if it doesn't exist) and will destroy the contents of the resource group in the ```kitchen destroy``` phase.
 
+* The ```destroy_explicit_resource_group_tags``` (default: "true") parameter can be used when you want to remove tags associated with an explicit resource group. The default setting is set to `true` to remain consistent with previous behavior. This should be used in combination with an explicitly named resource group and will be honored during the ```kitchen destroy``` phase.
+
 ```yaml
 ---
 driver:

data/lib/kitchen/driver/azurerm.rb

@@ -1,15 +1,15 @@
 require "kitchen"
 require_relative "azure_credentials"
-require "securerandom"
+require "securerandom" unless defined?(SecureRandom)
 require "azure_mgmt_resources"
 require "azure_mgmt_network"
-require "base64"
+require "base64" unless defined?(Base64)
 require "sshkey"
-require "fileutils"
-require "erb"
-require "ostruct"
-require "json"
-require "faraday"
+require "fileutils" unless defined?(FileUtils)
+require "erb" unless defined?(Erb)
+require "ostruct" unless defined?(OpenStruct)
+require "json" unless defined?(JSON)
+require "faraday" unless defined?(Faraday)
 
 module Kitchen
   module Driver
@@ -174,6 +174,10 @@ module Kitchen
         true
       end
 
+      default_config(:destroy_explicit_resource_group_tags) do |_config|
+        true
+      end
+
       default_config(:destroy_resource_group_contents) do |_config|
         false
       end
@@ -277,12 +281,9 @@ module Kitchen
         @resource_management_client = ::Azure::Resources::Profiles::Latest::Mgmt::Client.new(options)
 
         # Create Resource Group
-        resource_group = ::Azure::Resources::Profiles::Latest::Mgmt::Models::ResourceGroup.new
-        resource_group.location = config[:location]
-        resource_group.tags = config[:resource_group_tags]
         begin
           info "Creating Resource Group: #{state[:azure_resource_group_name]}"
-          create_resource_group(state[:azure_resource_group_name], resource_group)
+          create_resource_group(state[:azure_resource_group_name], get_resource_group)
         rescue ::MsRestAzure::AzureOperationError => operation_error
           error operation_error.body
           raise operation_error
@@ -534,6 +535,35 @@ module Kitchen
             info "Creating deployment: #{empty_deployment_name}"
             create_deployment_async(state[:azure_resource_group_name], empty_deployment_name, empty_deployment).value!
             follow_deployment_until_end_state(state[:azure_resource_group_name], empty_deployment_name)
+
+            # Maintain tags on the resource group
+            if config[:destroy_explicit_resource_group_tags] == false
+              warn 'The "destroy_explicit_resource_group_tags" setting value is set to "false". The tags on the resource group will NOT be removed.'
+              # NOTE: We are using the internal wrapper function create_resource_group() which wraps the API
+              # method of create_or_update().
+              begin
+                create_resource_group(state[:azure_resource_group_name], get_resource_group)
+              rescue ::MsRestAzure::AzureOperationError => operation_error
+                error operation_error.body
+                raise operation_error
+              end
+            end
+
+            # Corner case where we want to use kitchen to remove the tags
+            if config[:destroy_explicit_resource_group_tags] == true
+              warn 'The "destroy_explicit_resource_group_tags" setting value is set to "true". The tags on the resource group will be removed.'
+              # NOTE: We are using the internal wrapper function create_resource_group() which wraps the API
+              # method of create_or_update().
+              resource_group = get_resource_group
+              resource_group.tags = {}
+              begin
+                create_resource_group(state[:azure_resource_group_name], resource_group)
+              rescue ::MsRestAzure::AzureOperationError => operation_error
+                error operation_error.body
+                raise operation_error
+              end
+            end
+
           rescue ::MsRestAzure::AzureOperationError => operation_error
             error operation_error.body
             raise operation_error
@@ -706,6 +736,16 @@ module Kitchen
       # Wrapper methods for the Azure API calls to retry the calls when getting timeouts.
       #
 
+      # Create a new resource group object and set the location and tags attributes then return it.
+      #
+      # @return [::Azure::Resources::Profiles::Latest::Mgmt::Models::ResourceGroup] A new resource group object.
+      def get_resource_group
+        resource_group = ::Azure::Resources::Profiles::Latest::Mgmt::Models::ResourceGroup.new
+        resource_group.location = config[:location]
+        resource_group.tags = config[:resource_group_tags]
+        resource_group
+      end
+
       def create_resource_group(resource_group_name, resource_group)
         retries = config[:azure_api_retries]
         begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-azurerm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Stuart Preston
@@ -128,16 +128,16 @@ dependencies:
   name: chefstyle
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement