fog-azure-rm 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7723f74bbee0611351af2564fa5d3435354be5a5ed212a12fdae7ab5050a88c
-  data.tar.gz: 142a0f7e06a32ff2e83fe9b87c62ff115edc7e6b0601e37e5c967c45f91b1ed6
+  metadata.gz: df46e3710a22d1cbeca770d5132cb57545062441ad3991a140dea9f33845b8bb
+  data.tar.gz: b95d9140a0510bc61b0a8cc61dcbb609278edb53d39fab4c182b1926841be38f
 SHA512:
-  metadata.gz: 9cd47cf5c5ad0b765a791dd1faaef235139671c2fa8bac0c01d5b404ca66390ae91e1f490f4a3e6308074399f4c4d8192f52d5433cc6408eed457641bf90f2f2
-  data.tar.gz: 31215199cce2b823e2e0d80ccd6ee593f425deadaf65a389f6fc656c6372f0fee07442186faad44a9105860fbf3e1833b1d072a987ee2540c93308b58f993524
+  metadata.gz: 62a38b825f9a5228096a0edb21a584a1318378dc7a215849dc92f99fbc806c8da793decabfd90977a14081e0147db6cba4c91db8297c95635146088c52a3aad2
+  data.tar.gz: 7392b2fad3a5e12de70924c50c55aa1305ff03cf7e5e7ddd25614813831e98a6f9549433a97b0c396a92e589b06b0694ad59175f008423b21568fc8c247e0b92

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 0.6.0
+
+**Changed:**
+- Updated dependency of mime-types to (~> 3.0)
+- Updated dependency of rake to (>= 12.3.3)
+
+## 0.5.3
+
+**Fixed**
+- Added Null Check for `path_params` hash for `AzureOperationError` Request Headers
+
+## 0.5.2
+
+**Added**
+- Printing Information from `AzureOperationError` Response Headers
+
+## 0.5.1
+
+**Added**
+- Added Managed Disk Caching Option
+
 ## 0.5.0
 
 **Added**

data/fog-azure-rm.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w[README.md]
   spec.required_ruby_version = '>= 2.0.0'
   spec.post_install_message = 'Thanks for installing!'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.8.4'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'codeclimate-test-reporter' , '~> 1.0.0'
@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'azure_mgmt_key_vault', '~> 0.9.0'
   spec.add_dependency 'azure-storage', '= 0.11.5.preview'
   spec.add_dependency 'vhd', '0.0.4'
-  spec.add_dependency 'mime-types', '~> 1.25'
+  spec.add_dependency 'mime-types', '~> 3.0'
 end

data/lib/fog/azurerm/custom_fog_errors.rb

@@ -6,6 +6,40 @@ module Fog
       def initialize(message, azure_exception)
         super(azure_exception.request, azure_exception.response, azure_exception.body, "Exception in #{message}")
       end
+
+      def print_subscription_limits_information
+        request_method = @request.method
+        subscription_id = @request.path_params['subscriptionId'] unless @request.path_params.nil?
+
+        limit_value = remaining_subscription_request_limits(@response)
+
+        puts "Subscription: '#{subscription_id}'. Request Method: '#{request_method}'. \nLimit Value: #{limit_value['header']}: #{limit_value['value']}\n" unless limit_value.empty?
+      end
+
+      def remaining_subscription_request_limits(response)
+        limit = {}
+        # handles both read and write limits
+        if response.headers.key? 'x-ms-ratelimit-remaining-subscription-resource-requests'
+          limit['header'] = 'x-ms-ratelimit-remaining-subscription-resource-requests'
+          limit['value'] = response.headers['x-ms-ratelimit-remaining-subscription-resource-requests']
+
+        # limit for collection API calls
+        elsif response.headers.key? 'x-ms-ratelimit-remaining-subscription-resource-entities-read'
+          limit['header'] = 'x-ms-ratelimit-remaining-subscription-resource-entities-read'
+          limit['value'] = response.headers['x-ms-ratelimit-remaining-subscription-resource-entities-read']
+
+        # read requests limit
+        elsif response.headers.key? 'x-ms-ratelimit-remaining-subscription-reads'
+          limit['header'] = 'x-ms-ratelimit-remaining-subscription-reads'
+          limit['value'] = response.headers['x-ms-ratelimit-remaining-subscription-reads']
+
+        # write requests limit
+        elsif response.headers.key? 'x-ms-ratelimit-remaining-subscription-writes'
+          limit['header'] = 'x-ms-ratelimit-remaining-subscription-writes'
+          limit['value'] = response.headers['x-ms-ratelimit-remaining-subscription-writes']
+        end
+        limit
+      end
     end
 
     # This is a custom Fog exception inherited from Azure::Core::Http::HTTPError

data/lib/fog/azurerm/docs/compute.md

@@ -160,7 +160,7 @@ async_response = fog_compute_service.servers.create_async(
         os_disk_name: '<Disk Name>'                          # [Optional], name of the os disk
 )
 ```
-Following methods are available to handle async respoonse:
+Following methods are available to handle async response:
 - state
 - pending?
 - rejected?
@@ -310,10 +310,10 @@ fog_compute_service.managed_disks.create(
 
 ## Attach a Managed Data Disk to Server
 
-Get the server object and attach a Data Disk to it.
+Get the server object and attach a Data Disk with Disk Caching Option to it. Possible <Disk Caching Option> values include: "None", "ReadOnly", "ReadWrite". By Default "None" set.
 
 ```ruby
-server.attach_managed_disk('<Disk Name>', '<Disk Resource Group Name>')
+server.attach_managed_disk('<Disk Name>', '<Disk Resource Group Name>', '<Async Option>', '<Disk Caching Option>')
 ```
 
 ## Detach a Managed Data Disk from Server

data/lib/fog/azurerm/models/compute/server.rb

@@ -173,8 +173,8 @@ module Fog
           async ? create_fog_async_response(response) : merge_attributes(Fog::Compute::AzureRM::Server.parse(response))
         end
 
-        def attach_managed_disk(disk_name, disk_resource_group, async = false)
-          response = service.attach_data_disk_to_vm(data_disk_params(disk_name, nil, nil, disk_resource_group), async)
+        def attach_managed_disk(disk_name, disk_resource_group, async = false, caching = 'None')
+          response = service.attach_data_disk_to_vm(data_disk_params(disk_name, nil, nil, disk_resource_group, caching), async)
           async ? create_fog_async_response(response) : merge_attributes(Fog::Compute::AzureRM::Server.parse(response))
         end
 
@@ -239,14 +239,15 @@ module Fog
           }
         end
 
-        def data_disk_params(disk_name, disk_size = nil, storage_account = nil, disk_resource_group = nil)
+        def data_disk_params(disk_name, disk_size = nil, storage_account = nil, disk_resource_group = nil, caching = nil)
           {
             vm_name: name,
             vm_resource_group: resource_group,
             disk_name: disk_name,
             disk_size_gb: disk_size,
             storage_account_name: storage_account,
-            disk_resource_group: disk_resource_group
+            disk_resource_group: disk_resource_group,
+            caching: caching
           }
         end
 

data/lib/fog/azurerm/requests/compute/attach_data_disk_to_vm.rb

@@ -11,6 +11,7 @@ module Fog
           disk_resource_group = disk_params[:disk_resource_group]
           disk_size = disk_params[:disk_size_gb]
           storage_account_name = disk_params[:storage_account_name]
+          caching = disk_params[:caching] || nil
 
           msg = "Attaching Data Disk #{disk_name} to Virtual Machine #{vm_name} in Resource Group #{vm_resource_group}"
           Fog::Logger.debug msg
@@ -24,7 +25,7 @@ module Fog
             data_disk = get_unmanaged_disk_object(disk_name, disk_size, lun, storage_account_name, access_key)
           elsif disk_resource_group
             # Managed data disk
-            data_disk = get_data_disk_object(disk_resource_group, disk_name, lun)
+            data_disk = get_data_disk_object(disk_resource_group, disk_name, lun, caching)
           end
           vm.storage_profile.data_disks.push(data_disk)
           begin
@@ -75,7 +76,7 @@ module Fog
           lun_range_list[0]
         end
 
-        def get_data_disk_object(disk_resource_group, disk_name, lun)
+        def get_data_disk_object(disk_resource_group, disk_name, lun, caching)
           msg = "Getting Managed Disk #{disk_name} from Resource Group #{disk_resource_group}"
           begin
             disk = @compute_mgmt_client.disks.get(disk_resource_group, disk_name)
@@ -88,6 +89,18 @@ module Fog
           managed_disk.lun = lun
           managed_disk.create_option = Azure::ARM::Compute::Models::DiskCreateOptionTypes::Attach
 
+          # Managed Disk Caching Type
+          managed_disk.caching = case caching
+                                 when 'ReadOnly'
+                                   Azure::ARM::Compute::Models::CachingTypes::ReadOnly
+                                 when 'ReadWrite'
+                                   Azure::ARM::Compute::Models::CachingTypes::ReadWrite
+                                 when 'None', nil
+                                   Azure::ARM::Compute::Models::CachingTypes::None
+                                 else
+                                   raise "Invalid Disk Caching Option: #{caching}"
+                                 end
+
           # Managed disk parameter
           managed_disk_params = Azure::ARM::Compute::Models::ManagedDiskParameters.new
           managed_disk_params.id = disk.id

data/lib/fog/azurerm/utilities/general.rb

@@ -50,8 +50,11 @@ end
 
 def raise_azure_exception(exception, msg)
   raise Fog::AzureRM::CustomAzureCoreHttpError.new(exception) if exception.is_a?(Azure::Core::Http::HTTPError)
-  raise Fog::AzureRM::CustomAzureOperationError.new(msg, exception) if exception.is_a?(MsRestAzure::AzureOperationError)
-  raise exception
+  raise exception unless exception.is_a?(MsRestAzure::AzureOperationError)
+
+  azure_operation_error = Fog::AzureRM::CustomAzureOperationError.new(msg, exception)
+  azure_operation_error.print_subscription_limits_information if !azure_operation_error.request.nil? && !azure_operation_error.response.nil?
+  raise azure_operation_error
 end
 
 # Make sure if input_params(Hash) contains all keys present in required_params(Array)

data/lib/fog/azurerm/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module AzureRM
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/rakefile

@@ -1,4 +1,6 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+
 task default: :cc_coverage
 task :test do
   ENV['COVERAGE'] = nil

data/test/integration/server.rb

@@ -134,7 +134,7 @@ begin
     name: 'TestVM-Managed',
     location: LOCATION,
     resource_group: 'TestRG-VM',
-    vm_size: 'Basic_A0',
+    vm_size: 'Standard_B2s',
     storage_account_name: nil,
     username: 'testuser',
     password: 'Confiz=123',
@@ -238,6 +238,30 @@ begin
   )
   puts "Created Managed Disk: #{managed_disk.name}"
 
+  managed_disk_ro = compute.managed_disks.create(
+    name: 'ManagedDataDiskRO',
+    location: LOCATION,
+    resource_group_name: 'TestRG-VM',
+    account_type: 'Standard_LRS',
+    disk_size_gb: 100,
+    creation_data: {
+      create_option: 'Empty'
+    }
+  )
+  puts "Created Managed Disk: #{managed_disk_ro.name}"
+
+  managed_disk_rw = compute.managed_disks.create(
+    name: 'ManagedDataDiskRW',
+    location: LOCATION,
+    resource_group_name: 'TestRG-VM',
+    account_type: 'Standard_LRS',
+    disk_size_gb: 100,
+    creation_data: {
+      create_option: 'Empty'
+    }
+  )
+  puts "Created Managed Disk: #{managed_disk_rw.name}"
+
   ########################################################################################################################
   ######################                          Attach Managed Data Disk to VM                    ######################
   ########################################################################################################################
@@ -245,6 +269,12 @@ begin
   managed_vm.attach_managed_disk('ManagedDataDisk', 'TestRG-VM')
   puts 'Attached Managed Data Disk to VM!'
 
+  managed_vm.attach_managed_disk('ManagedDataDiskRO', 'TestRG-VM', false, 'ReadOnly')
+  puts 'Attached Managed Data Disk with Disk Caching ReadOnly to VM!'
+
+  managed_vm.attach_managed_disk('ManagedDataDiskRW', 'TestRG-VM', false, 'ReadWrite')
+  puts 'Attached Managed Data Disk with Disk Caching ReadWrite to VM!'
+
   ########################################################################################################################
   ######################                          Detach Data Disk from VM                          ######################
   ########################################################################################################################
@@ -252,6 +282,12 @@ begin
   managed_vm.detach_managed_disk('ManagedDataDisk')
   puts 'Detached Managed Data Disk from VM!'
 
+  managed_vm.detach_managed_disk('ManagedDataDiskRO')
+  puts 'Detached Managed Data Disk with Disk Caching ReadOnly from VM!'
+
+  managed_vm.detach_managed_disk('ManagedDataDiskRW')
+  puts 'Detached Managed Data Disk with Disk Caching ReadWrite from VM!'
+
   ########################################################################################################################
   ######################                         Delete Managed Data Disk                           ######################
   ########################################################################################################################
@@ -259,6 +295,12 @@ begin
   managed_disk.destroy
   puts 'Deleted managed data disk!'
 
+  managed_disk_ro.destroy
+  puts 'Deleted managed data disk with Disk Caching ReadOnly!'
+
+  managed_disk_rw.destroy
+  puts 'Deleted managed data disk with Disk Caching ReadWrite!'
+
   ########################################################################################################################
   ######################                      List VM in a resource group                           ######################
   ########################################################################################################################

data/test/models/compute/test_server.rb

@@ -216,6 +216,12 @@ class TestServer < Minitest::Test
     @service.stub :attach_data_disk_to_vm, response do
       assert_instance_of Fog::Compute::AzureRM::Server, @server.attach_managed_disk('disk_name', 'resoure_group')
     end
+    @service.stub :attach_data_disk_to_vm, response do
+      assert_instance_of Fog::Compute::AzureRM::Server, @server.attach_managed_disk('disk_name', 'resoure_group', false, 'ReadOnly')
+    end
+    @service.stub :attach_data_disk_to_vm, response do
+      assert_instance_of Fog::Compute::AzureRM::Server, @server.attach_managed_disk('disk_name', 'resoure_group', false, 'ReadWrite')
+    end
 
     async_response = Concurrent::Promise.execute { 10 }
     @service.stub :attach_data_disk_to_vm, async_response do

data/test/requests/compute/test_attach_data_disk_to_vm.rb

@@ -42,6 +42,22 @@ class TestAttachDataDiskToVM < Minitest::Test
         end
       end
     end
+    @virtual_machines.stub :get, @get_vm_response do
+      @disks.stub :get, @get_managed_disk_response do
+        @virtual_machines.stub :create_or_update, @get_vm_managed_disk_response do
+          input_params = { vm_name: 'ManagedVM', vm_resource_group: 'ManagedRG', disk_name: 'ManagedDataDisk1', disk_size_gb: 100, disk_resource_group: 'ManagedRG', caching: 'ReadOnly' }
+          assert_equal @service.attach_data_disk_to_vm(input_params, false), @get_vm_managed_disk_response
+        end
+      end
+    end
+    @virtual_machines.stub :get, @get_vm_response do
+      @disks.stub :get, @get_managed_disk_response do
+        @virtual_machines.stub :create_or_update, @get_vm_managed_disk_response do
+          input_params = { vm_name: 'ManagedVM', vm_resource_group: 'ManagedRG', disk_name: 'ManagedDataDisk1', disk_size_gb: 100, disk_resource_group: 'ManagedRG', caching: 'ReadWrite' }
+          assert_equal @service.attach_data_disk_to_vm(input_params, false), @get_vm_managed_disk_response
+        end
+      end
+    end
   end
 
   def test_attach_data_disk_to_vm_failure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-azure-rm
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Shaffan Chaudhry
@@ -15,25 +15,25 @@ authors:
 - Azeem Sajid
 - Maham Nazir
 - Abbas Sheikh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -250,18 +250,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.0'
 description: |-
   This library can be used as a module for 'fog' or as standalone provider
                           to use the Azure Resource Manager cloud services in applications..
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -1059,8 +1059,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.3.5
+signing_key:
 specification_version: 4
 summary: Module for the 'fog' gem to support Azure Resource Manager cloud services.
 test_files: []