knife-azure 1.8.7 → 1.9.0

data/lib/chef/knife/azure_server_list.rb

@@ -1,8 +1,8 @@
 #
 # Author:: Barry Davis (barryd@jetstreamsoftware.com)
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Adam Jacob (<adam@chef.io>)
+# Copyright:: Copyright 2010-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +18,7 @@
 # limitations under the License.
 #
 
-require File.expand_path('../azure_base', __FILE__)
+require File.expand_path("../azure_base", __FILE__)
 
 class Chef
   class Knife

data/lib/chef/knife/azure_server_show.rb

@@ -1,8 +1,8 @@
 #
 # Author:: Barry Davis (barryd@jetstreamsoftware.com)
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Author:: Adam Jacob (<adam@chef.io>)
+# Copyright:: Copyright 2010-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +18,7 @@
 # limitations under the License.
 #
 
-require File.expand_path('../azure_base', __FILE__)
+require File.expand_path("../azure_base", __FILE__)
 
 class Chef
   class Knife
@@ -26,7 +26,7 @@ class Chef
 
       include Knife::AzureBase
 
-      banner "knife azure server show SERVER [SERVER]"  
+      banner "knife azure server show SERVER [SERVER]"
 
       def run
         $stdout.sync = true

data/lib/chef/knife/azure_vnet_create.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Jeff Mendoza (jeffmendoza@live.com)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,41 +16,41 @@
 # limitations under the License.
 #
 
-require File.expand_path('../azure_base', __FILE__)
+require File.expand_path("../azure_base", __FILE__)
 
 class Chef
   class Knife
     class AzureVnetCreate < Knife
       include Knife::AzureBase
 
-      banner 'knife azure vnet create (options)'
+      banner "knife azure vnet create (options)"
 
       option :azure_network_name,
-        :short => '-n NETWORK_NAME',
-        :long => '--azure-network-name NETWORK_NAME',
+        :short => "-n NETWORK_NAME",
+        :long => "--azure-network-name NETWORK_NAME",
         :description =>
-          'Specifies the name of the virtual network to create.'
+          "Specifies the name of the virtual network to create."
 
       option :azure_affinity_group,
-        :short => '-a GROUP',
-        :long => '--azure-affinity-group GROUP',
+        :short => "-a GROUP",
+        :long => "--azure-affinity-group GROUP",
         :description =>
-          'Specifies the affinity group to associate with the vnet.'
+          "Specifies the affinity group to associate with the vnet."
 
       option :azure_address_space,
-        :long => '--azure-address-space CIDR',
+        :long => "--azure-address-space CIDR",
         :description =>
-          'Specifies the address space of the vnet using CIDR notation.'
+          "Specifies the address space of the vnet using CIDR notation."
 
       option :azure_subnet_name,
-        :long => '--azure-subnet-name CIDR',
+        :long => "--azure-subnet-name CIDR",
         :description =>
-          'Specifies the Subnet Name.'
+          "Specifies the Subnet Name."
 
       def run
         $stdout.sync = true
 
-        Chef::Log.info('validating...')
+        Chef::Log.info("validating...")
         validate_asm_keys!(:azure_network_name, :azure_affinity_group, :azure_address_space)
 
         params = {
@@ -62,9 +62,9 @@ class Chef
 
         rsp = service.create_vnet(params)
         print "\n"
-        if rsp.at_css('Status').nil?
-          if rsp.at_css('Code').nil? || rsp.at_css('Message').nil?
-            puts 'Unknown Error. try -VV'
+        if rsp.at_css("Status").nil?
+          if rsp.at_css("Code").nil? || rsp.at_css("Message").nil?
+            puts "Unknown Error. try -VV"
           else
             puts "#{rsp.at_css('Code').content}: "\
                  "#{rsp.at_css('Message').content}"

data/lib/chef/knife/azure_vnet_list.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Jeff Mendoza (jeffmendoza@live.com)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright 2013-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,14 +16,14 @@
 # limitations under the License.
 #
 
-require File.expand_path('../azure_base', __FILE__)
+require File.expand_path("../azure_base", __FILE__)
 
 class Chef
   class Knife
     class AzureVnetList < Knife
       include Knife::AzureBase
 
-      banner 'knife azure vnet list (options)'
+      banner "knife azure vnet list (options)"
 
       def run
         $stdout.sync = true

data/lib/chef/knife/azurerm_base.rb

@@ -1,4 +1,4 @@
-
+#
 # Author:: Aliasgar Batterywala (aliasgar.batterywala@clogeny.com)
 #
 # Copyright:: Copyright 2009-2018, Chef Software Inc.
@@ -17,12 +17,12 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'azure/resource_management/ARM_interface'
-require 'mixlib/shellout'
-require 'chef/mixin/shell_out'
-require 'time'
-require 'json'
+require "chef/knife"
+require "azure/resource_management/ARM_interface"
+require "mixlib/shellout"
+require "chef/mixin/shell_out"
+require "time"
+require "json"
 
 class Chef
   class Knife
@@ -34,15 +34,15 @@ class Chef
       XPLAT_VERSION_WITH_WCM_DEPRECATED ||= "0.10.5"
 
       if Chef::Platform.windows?
-        require 'azure/resource_management/windows_credentials'
+        require "azure/resource_management/windows_credentials"
         include Azure::ARM::WindowsCredentials
       end
 
       def self.included(includer)
         includer.class_eval do
           deps do
-            require 'readline'
-            require 'chef/json_compat'
+            require "readline"
+            require "chef/json_compat"
           end
 
           option :azure_resource_group_name,
@@ -64,7 +64,7 @@ class Chef
 
       def locate_config_value(key)
         key = key.to_sym
-        config[key] || Chef::Config[:knife][key]  || default_config[key]
+        config[key] || Chef::Config[:knife][key] || default_config[key]
       end
 
       # validates ARM mandatory keys
@@ -84,14 +84,14 @@ class Chef
             errors << "You did not provide a valid '#{pretty_key(k)}' value. Please set knife[:#{k}] in your knife.rb."
           end
         end
-        if errors.each{|e| ui.error(e)}.any?
+        if errors.each { |e| ui.error(e) }.any?
           exit 1
         end
       end
 
       def authentication_details
         if is_azure_cred?
-          return {:azure_tenant_id => locate_config_value(:azure_tenant_id), :azure_client_id => locate_config_value(:azure_client_id), :azure_client_secret => locate_config_value(:azure_client_secret)}
+          return { :azure_tenant_id => locate_config_value(:azure_tenant_id), :azure_client_id => locate_config_value(:azure_client_id), :azure_client_secret => locate_config_value(:azure_client_secret) }
         elsif Chef::Platform.windows?
           token_details = token_details_for_windows()
         else
@@ -102,9 +102,9 @@ class Chef
       end
 
       def get_azure_cli_version
-        if @azure_version  != ""
+        if @azure_version != ""
           get_version = shell_out!("azure -v || az -v | grep azure-cli", { returns: [0] }).stdout
-          @azure_version = get_version.gsub(/[^0-9.]/, '')
+          @azure_version = get_version.gsub(/[^0-9.]/, "")
         end
         @azure_prefix = @azure_version.to_i < 2 ? "azure" : "az"
         @azure_version
@@ -123,10 +123,10 @@ class Chef
       end
 
       def token_details_from_accessToken_file
-        home_dir = File.expand_path('~')
-        file = File.read(home_dir + '/.azure/accessTokens.json')
+        home_dir = File.expand_path("~")
+        file = File.read(home_dir + "/.azure/accessTokens.json")
         file = JSON.parse(file)
-        token_details = {:tokentype => file[-1]["tokenType"], :user => file[-1]["userId"], :token => file[-1]["accessToken"], :clientid => file[-1]["_clientId"], :expiry_time => file[-1]["expiresOn"], :refreshtoken => file[-1]["refreshToken"]}
+        token_details = { :tokentype => file[-1]["tokenType"], :user => file[-1]["userId"], :token => file[-1]["accessToken"], :clientid => file[-1]["_clientId"], :expiry_time => file[-1]["expiresOn"], :refreshtoken => file[-1]["refreshToken"] }
         token_details
       end
 
@@ -148,13 +148,11 @@ class Chef
       end
 
       def azure_authentication
-        begin
-          ui.log("Authenticating...")
-          Mixlib::ShellOut.new("#{@azure_prefix} vm show 'knifetest@resourcegroup' testvm", :timeout => 30).run_command
-        rescue Mixlib::ShellOut::CommandTimeout
-        rescue Exception
-          raise_azure_status
-        end
+        ui.log("Authenticating...")
+        Mixlib::ShellOut.new("#{@azure_prefix} vm show 'knifetest@resourcegroup' testvm", :timeout => 30).run_command
+      rescue Mixlib::ShellOut::CommandTimeout
+      rescue Exception
+        raise_azure_status
       end
 
       def check_token_validity(token_details)
@@ -176,18 +174,18 @@ class Chef
             raise login_message
           end
         else
-          home_dir = File.expand_path('~')
-          if !File.exists?(home_dir + "/.azure/accessTokens.json") || File.size?(home_dir + '/.azure/accessTokens.json') <= 2
+          home_dir = File.expand_path("~")
+          if !File.exist?(home_dir + "/.azure/accessTokens.json") || File.size?(home_dir + "/.azure/accessTokens.json") <= 2
             raise login_message
           end
         end
       end
 
       def parse_publish_settings_file(filename)
-        require 'nokogiri'
-        require 'base64'
-        require 'openssl'
-        require 'uri'
+        require "nokogiri"
+        require "base64"
+        require "openssl"
+        require "uri"
         begin
           doc = Nokogiri::XML(File.open(find_file(filename)))
           profile = doc.at_css("PublishProfile")
@@ -204,7 +202,7 @@ class Chef
           end
           Chef::Config[:knife][:azure_mgmt_cert] = management_cert.certificate.to_pem + management_cert.key.to_pem
           Chef::Config[:knife][:azure_subscription_id] = doc.at_css("Subscription").attribute("Id").value
-        rescue=> error
+        rescue => error
           puts "#{error.class} and #{error.message}"
           exit 1
         end
@@ -217,10 +215,10 @@ class Chef
           file = name
         elsif config_dir && File.exist?(File.join(config_dir, name))
           file = File.join(config_dir, name)
-        elsif File.exist?(File.join(ENV['HOME'], '.chef', name))
-          file = File.join(ENV['HOME'], '.chef', name)
+        elsif File.exist?(File.join(ENV["HOME"], ".chef", name))
+          file = File.join(ENV["HOME"], ".chef", name)
         else
-          ui.error('Unable to find file - ' + name)
+          ui.error("Unable to find file - " + name)
           exit 1
         end
         file
@@ -228,37 +226,37 @@ class Chef
 
       def msg_server_summary(server)
         puts "\n\n"
-        if server.provisioningstate == 'Succeeded'
+        if server.provisioningstate == "Succeeded"
           Chef::Log.info("Server creation went successfull.")
           puts "\nServer Details are:\n"
 
-          msg_pair('Server ID', server.id)
-          msg_pair('Server Name', server.name)
-          msg_pair('Server Public IP Address', server.publicipaddress)
+          msg_pair("Server ID", server.id)
+          msg_pair("Server Name", server.name)
+          msg_pair("Server Public IP Address", server.publicipaddress)
           if is_image_windows?
-            msg_pair('Server RDP Port', server.rdpport)
+            msg_pair("Server RDP Port", server.rdpport)
           else
-            msg_pair('Server SSH Port', server.sshport)
+            msg_pair("Server SSH Port", server.sshport)
           end
-          msg_pair('Server Location', server.locationname)
-          msg_pair('Server OS Type', server.ostype)
-          msg_pair('Server Provisioning State', server.provisioningstate)
+          msg_pair("Server Location", server.locationname)
+          msg_pair("Server OS Type", server.ostype)
+          msg_pair("Server Provisioning State", server.provisioningstate)
         else
           Chef::Log.info("Server Creation Failed.")
         end
 
         puts "\n\n"
 
-        if server.resources.provisioning_state == 'Succeeded'
+        if server.resources.provisioning_state == "Succeeded"
           Chef::Log.info("Server Extension creation went successfull.")
           puts "\nServer Extension Details are:\n"
 
-          msg_pair('Server Extension ID', server.resources.id)
-          msg_pair('Server Extension Name', server.resources.name)
-          msg_pair('Server Extension Publisher', server.resources.publisher)
-          msg_pair('Server Extension Type', server.resources.type)
-          msg_pair('Server Extension Type Handler Version', server.resources.type_handler_version)
-          msg_pair('Server Extension Provisioning State', server.resources.provisioning_state)
+          msg_pair("Server Extension ID", server.resources.id)
+          msg_pair("Server Extension Name", server.resources.name)
+          msg_pair("Server Extension Publisher", server.resources.publisher)
+          msg_pair("Server Extension Type", server.resources.type)
+          msg_pair("Server Extension Type Handler Version", server.resources.type_handler_version)
+          msg_pair("Server Extension Provisioning State", server.resources.provisioning_state)
         else
           Chef::Log.info("Server Extension Creation Failed.")
         end
@@ -270,16 +268,16 @@ class Chef
           raise ArgumentError, "When --azure-vnet-subnet-name is specified, the --azure-vnet-name must also be specified."
         end
 
-        if locate_config_value(:azure_vnet_subnet_name) == 'GatewaySubnet'
-          raise ArgumentError, 'GatewaySubnet cannot be used as the name for --azure-vnet-subnet-name option. GatewaySubnet can only be used for virtual network gateways.'
+        if locate_config_value(:azure_vnet_subnet_name) == "GatewaySubnet"
+          raise ArgumentError, "GatewaySubnet cannot be used as the name for --azure-vnet-subnet-name option. GatewaySubnet can only be used for virtual network gateways."
         end
 
-        if locate_config_value(:node_ssl_verify_mode) && !["none", "peer"].include?(locate_config_value(:node_ssl_verify_mode))
+        if locate_config_value(:node_ssl_verify_mode) && !%w{none peer}.include?(locate_config_value(:node_ssl_verify_mode))
           raise ArgumentError, "Invalid value '#{locate_config_value(:node_ssl_verify_mode)}' for --node-ssl-verify-mode. Use Valid values i.e 'none', 'peer'."
         end
 
         if is_image_windows?
-          if locate_config_value(:winrm_user).nil? ||  locate_config_value(:winrm_password).nil?
+          if locate_config_value(:winrm_user).nil? || locate_config_value(:winrm_password).nil?
             raise ArgumentError, "Please provide --winrm-user and --winrm-password options for Windows option."
           end
         end
@@ -307,19 +305,19 @@ class Chef
         end
 
         config[:ohai_hints] = format_ohai_hints(locate_config_value(:ohai_hints))
-        validate_ohai_hints if ! locate_config_value(:ohai_hints).casecmp('default').zero?
+        validate_ohai_hints if ! locate_config_value(:ohai_hints).casecmp("default").zero?
       end
 
-  private
+      private
 
-      def msg_pair(label, value, color=:cyan)
+      def msg_pair(label, value, color = :cyan)
         if value && !value.to_s.empty?
           puts "#{ui.color(label, color)}: #{value}"
         end
       end
 
       def pretty_key(key)
-        key.to_s.gsub(/_/, ' ').gsub(/\w+/){ |w| (w =~ /(ssh)|(aws)/i) ? w.upcase  : w.capitalize }
+        key.to_s.tr("_", " ").gsub(/\w+/) { |w| (w =~ /(ssh)|(aws)/i) ? w.upcase : w.capitalize }
       end
 
       def is_image_windows?
@@ -340,7 +338,7 @@ class Chef
       end
 
       def is_WCM_env_var_set?
-        ENV['AZURE_USE_SECURE_TOKEN_STORAGE'].nil? ? false : true
+        ENV["AZURE_USE_SECURE_TOKEN_STORAGE"].nil? ? false : true
       end
 
       def raise_azure_status

data/lib/chef/knife/azurerm_server_create.rb

@@ -17,10 +17,10 @@
 # limitations under the License.
 #
 
-require 'chef/knife/azurerm_base'
-require 'securerandom'
-require 'chef/knife/bootstrap/common_bootstrap_options'
-require 'chef/knife/bootstrap/bootstrapper'
+require "chef/knife/azurerm_base"
+require "securerandom"
+require "chef/knife/bootstrap/common_bootstrap_options"
+require "chef/knife/bootstrap/bootstrapper"
 
 class Chef
   class Knife
@@ -83,7 +83,7 @@ class Chef
                                       Standard_GRS (Standard Geo-redundant storage)
                                       Standard_RAGRS (Standard Read access geo-redundant storage)
                                       Premium_LRS (Premium Locally-redundant storage)",
-        :default => 'Standard_GRS'
+        :default => "Standard_GRS"
 
       option :azure_vm_name,
         :long => "--azure-vm-name NAME",
@@ -121,7 +121,7 @@ class Chef
         :long => "--azure-image-reference-version VERSION",
         :description => "Optional. Specifies the version of the image used to create the virtual machine.
                           Default value is 'latest'",
-        :default => 'latest'
+        :default => "latest"
 
       option :azure_image_os_type,
         :long => "--azure-image-os-type OSTYPE",
@@ -130,8 +130,9 @@ class Chef
       option :azure_vm_size,
         :short => "-z SIZE",
         :long => "--azure-vm-size SIZE",
-        :description => "Optional. Size of virtual machine (ExtraSmall, Small, Medium, Large, ExtraLarge)",
-        :default => 'Small',
+        :description => "Optional. Size of virtual machine. Default is Standard_A1_v2.
+                        Eg: Standard_A2, Standard_F2, Standard_G1 etc.",
+        :default => "Standard_A1_v2",
         :proc => Proc.new { |si| Chef::Config[:knife][:azure_vm_size] = si }
 
       option :azure_availability_set,
@@ -188,7 +189,7 @@ class Chef
                                      Supported values are: vm_name, public_fqdn and platform.
                                      User can pass any comma separated combination of these values like 'vm_name,public_fqdn'.
                                      Default value is 'default' which corresponds to the supported values list mentioned here.",
-        :default => 'default'
+        :default => "default"
 
       def run
         $stdout.sync = true
@@ -241,12 +242,12 @@ class Chef
 
         # We assign azure_vm_name to chef_node_name If node name is nill because storage account name is combination of hash value and node name.
         config[:chef_node_name] ||= locate_config_value(:azure_vm_name)
-        
+
         server_def[:azure_storage_account] = locate_config_value(:azure_vm_name) if server_def[:azure_storage_account].nil?
-        server_def[:azure_storage_account] = server_def[:azure_storage_account].gsub(/[!@#$%^&*()_-]/,'')
+        server_def[:azure_storage_account] = server_def[:azure_storage_account].gsub(/[!@#$%^&*()_-]/, "")
 
         server_def[:azure_os_disk_name] = locate_config_value(:azure_vm_name) if server_def[:azure_os_disk_name].nil?
-        server_def[:azure_os_disk_name] = server_def[:azure_os_disk_name].gsub(/[!@#$%^&*()_-]/,'')
+        server_def[:azure_os_disk_name] = server_def[:azure_os_disk_name].gsub(/[!@#$%^&*()_-]/, "")
 
         server_def[:azure_vnet_name] = locate_config_value(:azure_vm_name) if server_def[:azure_vnet_name].nil?
         server_def[:azure_vnet_subnet_name] = locate_config_value(:azure_vm_name) if locate_config_value(:azure_vnet_subnet_name).nil?
@@ -274,16 +275,16 @@ class Chef
       end
 
       def supported_ohai_hints
-        [
-          'vm_name',
-          'public_fqdn',
-          'platform'
-        ]
+        %w{
+          vm_name
+          public_fqdn
+          platform
+        }
       end
 
       def format_ohai_hints(ohai_hints)
-        ohai_hints = ohai_hints.split(',').each { |hint| hint.strip! }
-        ohai_hints.join(',')
+        ohai_hints = ohai_hints.split(",").each { |hint| hint.strip! }
+        ohai_hints.join(",")
       end
 
       def is_supported_ohai_hint?(hint)
@@ -291,7 +292,7 @@ class Chef
       end
 
       def validate_ohai_hints
-        hint_values = locate_config_value(:ohai_hints).split(',')
+        hint_values = locate_config_value(:ohai_hints).split(",")
         hint_values.each do |hint|
           if ! is_supported_ohai_hint?(hint)
             raise ArgumentError, "Ohai Hint name #{hint} passed is not supported. Please run the command help to see the list of supported values."
@@ -332,7 +333,7 @@ class Chef
             when "windows"
               set_os_image("MicrosoftWindowsServer", "WindowsServer", "2012-R2-Datacenter")
             else
-              raise ArgumentError, 'Invalid value of --azure-image-os-type. Accepted values ubuntu|centos|windows'
+              raise ArgumentError, "Invalid value of --azure-image-os-type. Accepted values ubuntu|centos|windows"
             end
           else
             validate_arm_keys!(:azure_image_os_type) unless is_image_os_type?
@@ -360,7 +361,7 @@ class Chef
       end
 
       def validate_publisher_and_offer
-        if (locate_config_value(:azure_image_reference_publisher) || locate_config_value(:azure_image_reference_offer))
+        if locate_config_value(:azure_image_reference_publisher) || locate_config_value(:azure_image_reference_offer)
           # if azure_image_os_type is given and any of the other image reference parameters like publisher or offer are also given,
           # raise error
           raise ArgumentError, 'Please specify either --azure-image-os-type OR --azure-image-os-type with --azure-image-reference-sku or 4 image reference parameters i.e.