knife-azure 1.9.0 → 2.0.1

data/lib/chef/knife/bootstrap_azure.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Aliasgar Batterywala (aliasgar.batterywala@clogeny.com)
-# Copyright:: Copyright 2016-2018 Chef Software, Inc.
+# Copyright:: Copyright 2010-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,13 +17,13 @@
 #
 
 require "chef/knife/azure_base"
+require "chef/knife/bootstrap"
 require "chef/knife/bootstrap/common_bootstrap_options"
 require "chef/knife/bootstrap/bootstrapper"
 
 class Chef
   class Knife
-    class BootstrapAzure < Knife
-
+    class BootstrapAzure < Knife::Bootstrap
       include Knife::AzureBase
       include Knife::Bootstrap::CommonBootstrapOptions
       include Knife::Bootstrap::Bootstrapper
@@ -31,45 +31,70 @@ class Chef
       banner "knife bootstrap azure SERVER (options)"
 
       option :azure_dns_name,
-        :short => "-d DNS_NAME",
-        :long => "--azure-dns-name DNS_NAME",
-        :description => "Optional. The DNS prefix name that is used to access the cloud service."
+        short: "-d DNS_NAME",
+        long: "--azure-dns-name DNS_NAME",
+        description: "Optional. The DNS prefix name that is used to access the cloud service."
+
+      # run() would be executing from parent class
+      # Chef::Knife::Bootstrap, defined in core.
+      # Required methods have been overridden here
+      #### run() execution begins ####
+
+      def plugin_setup!; end
 
-      def run
+      def validate_name_args!; end
+
+      def plugin_validate_options!
         ui.info "Validating..."
         validate_asm_keys!
+      end
 
-        begin
-          if @name_args.length == 1
-            service.add_extension(@name_args[0], set_ext_params)
-            if locate_config_value(:extended_logs)
-              print "\n\nWaiting for the Chef Extension to become available/ready"
-              wait_until_extension_available(Time.now, 10)
-              print "\n\nWaiting for the first chef-client run"
-              fetch_chef_client_logs(Time.now, 35)
-            end
-          else
-            raise ArgumentError, "Please specify the SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length == 0
-            raise ArgumentError, "Please specify only one SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length > 1
+      def plugin_create_instance!
+        if @name_args.length == 1
+          service.add_extension(@name_args[0], set_ext_params)
+          if locate_config_value(:extended_logs)
+            print "\n\nWaiting for the Chef Extension to become available/ready"
+            wait_until_extension_available(Time.now, 10)
+            print "\n\nWaiting for the first chef-client run"
+            fetch_chef_client_logs(Time.now, 35)
           end
-        rescue => error
-          ui.error("#{error.message}")
-          Chef::Log.debug("#{error.backtrace.join("\n")}")
-          exit
+        else
+          raise ArgumentError, "Please specify the SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.empty?
+          raise ArgumentError, "Please specify only one SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length > 1
         end
+      rescue StandardError => error
+        ui.error(error.message.to_s)
+        Chef::Log.debug(error.backtrace.join("\n").to_s)
+        exit
       end
 
+      def plugin_finalize; end
+
+      # Following methods are not required
+      #
+      def connect!; end
+
+      def register_client; end
+
+      def render_template; end
+
+      def upload_bootstrap(content); end
+
+      def perform_bootstrap(bootstrap_path); end
+
+      #### run() execution ends ####
+
       def set_ext_params
         begin
           ui.info "Looking for the server #{@name_args[0]}..."
-          server = service.find_server({
-              name: @name_args[0],
-              azure_dns_name: locate_config_value(:azure_dns_name)
-            })
+          server = service.find_server(
+            name: @name_args[0],
+            azure_dns_name: locate_config_value(:azure_dns_name)
+          )
 
           ## if azure_dns_name value not passed by user then set it using the hostedservicename attribute from the retrieved server's object ##
           config[:azure_dns_name] = server.hostedservicename if locate_config_value(:azure_dns_name).nil? && (server.instance_of? Azure::Role)
-          if !server.instance_of? Azure::Role
+          unless server.instance_of? Azure::Role
             if server.nil?
               if !locate_config_value(:azure_dns_name).nil?
                 raise "Hosted service #{locate_config_value(:azure_dns_name)} does not exist."
@@ -83,7 +108,7 @@ class Chef
 
           ui.info "\nServer #{@name_args[0]} found."
           ui.info "Setting the Chef Extension parameters."
-          ext_params = Hash.new
+          ext_params = {}
           case server.os_type.downcase
           when "windows"
             ext_params[:chef_extension] = "ChefClient"
@@ -137,9 +162,7 @@ class Chef
               extension = fetch_extension(my_role)
               ## check if Chef Extension not found (which means it is not available/ready yet) then sleep_and_wait OR
               ## if found (which means it is available/ready now) then proceed further with chef-client run logs fetch process ##
-              if extension.nil?
-                sleep_and_wait = true
-              end
+              sleep_and_wait = true if extension.nil?
             else
               ## given role not found or GuestAgent not ready yet ##
               sleep_and_wait = true
@@ -151,7 +174,7 @@ class Chef
 
           ## wait for some time and then re-fetch the status ##
           if sleep_and_wait == true
-            print "#{ui.color('.', :bold)}"
+            print "#{ui.color(".", :bold)}"
             sleep 30
             wait_until_extension_available(
               extension_deploy_start_time,

data/lib/chef/knife/bootstrap_azurerm.rb

@@ -1,7 +1,6 @@
 #
 # Author:: Nimisha Sharad (nimisha.sharad@clogeny.com)
-#
-# Copyright:: Copyright 2016-2018 Chef Software, Inc.
+# Copyright:: Copyright 2010-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,6 +17,7 @@
 #
 
 require "chef/knife/azurerm_base"
+require "chef/knife/bootstrap"
 require "chef/knife/bootstrap/common_bootstrap_options"
 require "chef/knife/bootstrap/bootstrapper"
 require "azure/resource_management/ARM_interface"
@@ -25,46 +25,64 @@ require "time"
 
 class Chef
   class Knife
-    class BootstrapAzurerm < Knife
+    class BootstrapAzurerm < Knife::Bootstrap
       include Knife::AzurermBase
       include Knife::Bootstrap::CommonBootstrapOptions
       include Knife::Bootstrap::Bootstrapper
 
       banner "knife bootstrap azurerm SERVER (options)"
 
-      option :azure_service_location,
-        :short => "-m LOCATION",
-        :long => "--azure-service-location LOCATION",
-        :description => "Required if not using an Affinity Group. Specifies the geographic location - the name of the data center location that is valid for your subscription.
-                                      Eg: westus, eastus, eastasia, southeastasia, northeurope, westeurope",
-        :proc        => Proc.new { |lo| Chef::Config[:knife][:azure_service_location] = lo }
+      # run() would be executing from parent class
+      # Chef::Knife::Bootstrap, defined in core.
+      # Required methods have been overridden here
+      #### run() execution begins ####
+
+      def plugin_setup!; end
 
-      def run
+      def validate_name_args!; end
+
+      def plugin_validate_options!
         ui.log("Validating...")
         validate_arm_keys!(:azure_resource_group_name, :azure_service_location)
+      end
 
-        begin
-          if @name_args.length == 1
-            ui.log("Creating VirtualMachineExtension....")
-            ext_params = set_ext_params
-            vm_extension = service.create_vm_extension(ext_params)
-            if vm_extension
-              if ext_params[:chef_extension_public_param][:extendedLogs] == "true"
-                service.fetch_chef_client_logs(ext_params[:azure_resource_group_name], ext_params[:azure_vm_name], ext_params[:chef_extension], Time.now)
-              end
-              ui.log("VirtualMachineExtension creation successfull.")
-              ui.log("Virtual Machine Extension name is: #{vm_extension.name}")
-              ui.log("Virtual Machine Extension ID is: #{vm_extension.id}")
+      def plugin_create_instance!
+        if @name_args.length == 1
+          ui.log("Creating VirtualMachineExtension....")
+          ext_params = set_ext_params
+          vm_extension = service.create_vm_extension(ext_params)
+          if vm_extension
+            if ext_params[:chef_extension_public_param][:extendedLogs] == "true"
+              service.fetch_chef_client_logs(ext_params[:azure_resource_group_name], ext_params[:azure_vm_name], ext_params[:chef_extension], Time.now)
             end
-          else
-            raise ArgumentError, "Please specify the SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length == 0
-            raise ArgumentError, "Please specify only one SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length > 1
+            ui.log("VirtualMachineExtension creation successfull.")
+            ui.log("Virtual Machine Extension name is: #{vm_extension.name}")
+            ui.log("Virtual Machine Extension ID is: #{vm_extension.id}")
           end
-        rescue => error
-          service.common_arm_rescue_block(error)
+        else
+          raise ArgumentError, "Please specify the SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.empty?
+          raise ArgumentError, "Please specify only one SERVER name which needs to be bootstrapped via the Chef Extension." if @name_args.length > 1
         end
+      rescue StandardError => error
+        service.common_arm_rescue_block(error)
       end
 
+      def plugin_finalize; end
+
+      # Following methods are not required
+      #
+      def connect!; end
+
+      def register_client; end
+
+      def render_template; end
+
+      def upload_bootstrap(content); end
+
+      def perform_bootstrap(bootstrap_path); end
+
+      #### run() execution ends ####
+
       def set_ext_params
         server = service.find_server(locate_config_value(:azure_resource_group_name), name_args[0])
 
@@ -72,7 +90,7 @@ class Chef
           if service.extension_already_installed?(server)
             raise "Virtual machine #{server.name} already has Chef extension installed on it."
           else
-            ext_params = Hash.new
+            ext_params = {}
             case server.storage_profile.os_disk.os_type.downcase
             when "windows"
               ext_params[:chef_extension] = "ChefClient"
@@ -100,7 +118,6 @@ class Chef
 
         ext_params
       end
-
     end
   end
 end

data/lib/knife-azure/version.rb

@@ -1,6 +1,23 @@
+#
+# Copyright:: Copyright 2010-2019, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 module Knife
   module Azure
-    VERSION = "1.9.0"
+    VERSION = "2.0.1".freeze
     MAJOR, MINOR, TINY = VERSION.split(".")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-azure
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Barry Davis
@@ -9,36 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '15.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '15.1'
 - !ruby/object:Gem::Dependency
-  name: knife-windows
+  name: chef-bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '15.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '15.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_resources
   requirement: !ruby/object:Gem::Requirement
@@ -125,14 +139,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ipaddress
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +222,6 @@ files:
 - lib/chef/knife/azurerm_server_delete.rb
 - lib/chef/knife/azurerm_server_list.rb
 - lib/chef/knife/azurerm_server_show.rb
-- lib/chef/knife/bootstrap/bootstrap_options.rb
 - lib/chef/knife/bootstrap/bootstrapper.rb
 - lib/chef/knife/bootstrap/common_bootstrap_options.rb
 - lib/chef/knife/bootstrap_azure.rb
@@ -226,15 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A plugin to the Chef knife tool for creating instances on the Microsoft Azure

data/lib/chef/knife/bootstrap/bootstrap_options.rb

@@ -1,105 +0,0 @@
-#
-# Author:: Aliasgar Batterywala (aliasgar.batterywala@clogeny.com)
-#
-# Copyright:: Copyright 2016-2018 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-#
-# Bootstrap options listed here are in accordance with the options supported by
-# Chef's bootstrap which bootstraps the target system through protocols like ssh
-# or winrm. In addition it contains additional options which gives the users a
-# choice to bootstrap the target system through cloud-api protocol.
-#
-
-require "chef/knife/winrm_base"
-require "chef/knife/bootstrap_windows_base"
-class Chef
-  class Knife
-    class Bootstrap
-      module BootstrapOptions
-
-        def self.included(includer)
-          includer.class_eval do
-
-            include Knife::WinrmBase
-            include Knife::BootstrapWindowsBase
-            deps do
-              require "chef/knife/bootstrap"
-              Chef::Knife::Bootstrap.load_deps
-            end
-
-            option :forward_agent,
-              :short => "-A",
-              :long => "--forward-agent",
-              :description =>  "Enable SSH agent forwarding",
-              :boolean => true
-
-            option :json_attributes,
-              :short => "-j JSON",
-              :long => "--json-attributes JSON",
-              :description => "A JSON string to be added to the first run of chef-client",
-              :proc => lambda { |o| JSON.parse(o) }
-
-            option :host_key_verify,
-              :long => "--[no-]host-key-verify",
-              :description => "Verify host key, enabled by default.",
-              :boolean => true,
-              :default => true
-
-            option :bootstrap_url,
-              :long        => "--bootstrap-url URL",
-              :description => "URL to a custom installation script",
-              :proc        => Proc.new { |u| Chef::Config[:knife][:bootstrap_url] = u }
-
-            option :bootstrap_wget_options,
-              :long        => "--bootstrap-wget-options OPTIONS",
-              :description => "Add options to wget when installing chef-client",
-              :proc        => Proc.new { |wo| Chef::Config[:knife][:bootstrap_wget_options] = wo }
-
-            option :bootstrap_curl_options,
-              :long        => "--bootstrap-curl-options OPTIONS",
-              :description => "Add options to curl when install chef-client",
-              :proc        => Proc.new { |co| Chef::Config[:knife][:bootstrap_curl_options] = co }
-
-            option :use_sudo_password,
-              :long => "--use-sudo-password",
-              :description => "Execute the bootstrap via sudo with password",
-              :boolean => false
-
-            option :extended_logs,
-              :long => "--extended-logs",
-              :boolean => true,
-              :default => false,
-              :description => "Optional. Provide this option when --bootstrap-protocol is set to 'cloud-api'. It shows chef converge logs in detail."
-
-            option :chef_daemon_interval,
-              :long => "--chef-daemon-interval INTERVAL",
-              :description => "Optional. Provide this option when --bootstrap-protocol is set to 'cloud-api'.
-                                  It specifies the frequency (in minutes) at which the chef-service runs.
-                                  Pass 0 if you don't want the chef-service to be installed on the target machine."
-
-            option :daemon,
-              :long => "--daemon DAEMON",
-              :description => "Optional. Configures the chef-client service for unattended execution. Requires --bootstrap-protocol to be 'cloud-api' and the node platform to be Windows.
-                                Options: 'none' or 'service' or 'task'.
-                                none - Currently prevents the chef-client service from being configured as a service.
-                                service - Configures the chef-client to run automatically in the background as a service.
-                                task - Configures the chef-client to run automatically in the background as a scheduled task."
-          end
-        end
-      end
-    end
-  end
-end