knife-windows 0.5.15 → 0.6.0

data/lib/chef/knife/winrm_base.rb

@@ -1,99 +1,99 @@
-#
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, 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.
-#
-
-require 'chef/knife'
-require 'chef/encrypted_data_bag_item'
-require 'kconv'
-
-class Chef
-  class Knife
-    module WinrmBase
-
-      # :nodoc:
-      # Would prefer to do this in a rational way, but can't be done b/c of
-      # Mixlib::CLI's design :(
-      def self.included(includer)
-        includer.class_eval do
-
-          deps do
-            require 'readline'
-            require 'chef/json_compat'
-          end
-
-          option :winrm_user,
-            :short => "-x USERNAME",
-            :long => "--winrm-user USERNAME",
-            :description => "The WinRM username",
-            :default => "Administrator",
-            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_user] = key }
-
-          option :winrm_password,
-            :short => "-P PASSWORD",
-            :long => "--winrm-password PASSWORD",
-            :description => "The WinRM password",
-            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_password] = key }
-
-          option :winrm_port,
-            :short => "-p PORT",
-            :long => "--winrm-port PORT",
-            :description => "The WinRM port, by default this is 5985",
-            :default => "5985",
-            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_port] = key }
-
-          option :identity_file,
-            :short => "-i IDENTITY_FILE",
-            :long => "--identity-file IDENTITY_FILE",
-            :description => "The SSH identity file used for authentication"
-
-          option :winrm_transport,
-            :short => "-t TRANSPORT",
-            :long => "--winrm-transport TRANSPORT",
-            :description => "The WinRM transport type.  valid choices are [ssl, plaintext]",
-            :default => 'plaintext',
-            :proc => Proc.new { |transport| Chef::Config[:knife][:winrm_transport] = transport }
-
-          option :kerberos_keytab_file,
-            :short => "-i KEYTAB_FILE",
-            :long => "--keytab-file KEYTAB_FILE",
-            :description => "The Kerberos keytab file used for authentication",
-            :proc => Proc.new { |keytab| Chef::Config[:knife][:kerberos_keytab_file] = keytab }
-
-          option :kerberos_realm,
-            :short => "-R KERBEROS_REALM",
-            :long => "--kerberos-realm KERBEROS_REALM",
-            :description => "The Kerberos realm used for authentication",
-            :proc => Proc.new { |realm| Chef::Config[:knife][:kerberos_realm] = realm }
-
-          option :kerberos_service,
-            :short => "-S KERBEROS_SERVICE",
-            :long => "--kerberos-service KERBEROS_SERVICE",
-            :description => "The Kerberos service used for authentication",
-            :proc => Proc.new { |service| Chef::Config[:knife][:kerberos_service] = service }
-
-          option :ca_trust_file,
-            :short => "-f CA_TRUST_FILE",
-            :long => "--ca-trust-file CA_TRUST_FILE",
-            :description => "The Certificate Authority (CA) trust file used for SSL transport",
-            :proc => Proc.new { |trust| Chef::Config[:knife][:ca_trust_file] = trust }
-
-        end
-      end
-
-    end
-  end
-end
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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.
+#
+
+require 'chef/knife'
+require 'chef/encrypted_data_bag_item'
+require 'kconv'
+
+class Chef
+  class Knife
+    module WinrmBase
+
+      # :nodoc:
+      # Would prefer to do this in a rational way, but can't be done b/c of
+      # Mixlib::CLI's design :(
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'readline'
+            require 'chef/json_compat'
+          end
+
+          option :winrm_user,
+            :short => "-x USERNAME",
+            :long => "--winrm-user USERNAME",
+            :description => "The WinRM username",
+            :default => "Administrator",
+            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_user] = key }
+
+          option :winrm_password,
+            :short => "-P PASSWORD",
+            :long => "--winrm-password PASSWORD",
+            :description => "The WinRM password",
+            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_password] = key }
+
+          option :winrm_port,
+            :short => "-p PORT",
+            :long => "--winrm-port PORT",
+            :description => "The WinRM port, by default this is 5985",
+            :default => "5985",
+            :proc => Proc.new { |key| Chef::Config[:knife][:winrm_port] = key }
+
+          option :identity_file,
+            :short => "-i IDENTITY_FILE",
+            :long => "--identity-file IDENTITY_FILE",
+            :description => "The SSH identity file used for authentication"
+
+          option :winrm_transport,
+            :short => "-t TRANSPORT",
+            :long => "--winrm-transport TRANSPORT",
+            :description => "The WinRM transport type.  valid choices are [ssl, plaintext]",
+            :default => 'plaintext',
+            :proc => Proc.new { |transport| Chef::Config[:knife][:winrm_transport] = transport }
+
+          option :kerberos_keytab_file,
+            :short => "-i KEYTAB_FILE",
+            :long => "--keytab-file KEYTAB_FILE",
+            :description => "The Kerberos keytab file used for authentication",
+            :proc => Proc.new { |keytab| Chef::Config[:knife][:kerberos_keytab_file] = keytab }
+
+          option :kerberos_realm,
+            :short => "-R KERBEROS_REALM",
+            :long => "--kerberos-realm KERBEROS_REALM",
+            :description => "The Kerberos realm used for authentication",
+            :proc => Proc.new { |realm| Chef::Config[:knife][:kerberos_realm] = realm }
+
+          option :kerberos_service,
+            :short => "-S KERBEROS_SERVICE",
+            :long => "--kerberos-service KERBEROS_SERVICE",
+            :description => "The Kerberos service used for authentication",
+            :proc => Proc.new { |service| Chef::Config[:knife][:kerberos_service] = service }
+
+          option :ca_trust_file,
+            :short => "-f CA_TRUST_FILE",
+            :long => "--ca-trust-file CA_TRUST_FILE",
+            :description => "The Certificate Authority (CA) trust file used for SSL transport",
+            :proc => Proc.new { |trust| Chef::Config[:knife][:ca_trust_file] = trust }
+
+        end
+      end
+
+    end
+  end
+end

data/lib/knife-windows/version.rb

@@ -1,6 +1,6 @@
-module Knife
-  module Windows
-    VERSION = "0.5.15"
-    MAJOR, MINOR, TINY = VERSION.split('.')
-  end
-end
+module Knife
+  module Windows
+    VERSION = "0.6.0"
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

data/spec/functional/bootstrap_download_spec.rb

@@ -1,120 +1,122 @@
-#
-# Author:: Adam Edwards (<adamed@opscode.com>)
-# Copyright:: Copyright (c) 2012 Opscode, 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.
-#
-
-require 'spec_helper'
-require 'tmpdir'
-
-# These test cases exercise the Knife::Windows knife plugin's ability
-# to download a bootstrap msi as part of the bootstrap process on
-# Windows nodes. The test modifies the Windows batch file generated
-# from an erb template in the plugin source in order to enable execution
-# of only the download functionality contained in the bootstrap template.
-# The test relies on knowledge of the fields of the template itself and 
-# also on knowledge of the contents and structure of the Windows batch
-# file generated by the template.
-#
-# Note that if the bootstrap template changes substantially, the tests
-# should fail and will require re-implementation. If such changes
-# occur, the bootstrap code should be refactored to explicitly expose
-# the download funcitonality separately from other tasks to make the
-# test more robust.
-describe 'Knife::Windows::Core msi download functionality for knife Windows winrm bootstrap template' do 
-
-  before(:all) do
-    # Since we're always running 32-bit Ruby, fix the
-    # PROCESSOR_ARCHITECTURE environment variable.
-
-    if ENV["PROCESSOR_ARCHITEW6432"]
-      ENV["PROCESSOR_ARCHITECTURE"] = ENV["PROCESSOR_ARCHITEW6432"]
-    end
-    
-    # All file artifacts from this test will be written into this directory
-    @temp_directory = Dir.mktmpdir("bootstrap_test")
-
-    # Location to which the download script will be modified to write
-    # the downloaded msi
-    @local_file_download_destination = "#{@temp_directory}/chef-client-latest.msi"
-
-    source_code_directory = File.dirname(__FILE__)    
-    @template_file_path ="#{source_code_directory}/../../lib/chef/knife/bootstrap/windows-chef-client-msi.erb"    
-  end
-
-  after(:all) do
-    # Clear the temp directory upon exit
-    if Dir.exists?(@temp_directory)
-      FileUtils::remove_dir(@temp_directory)
-    end
-  end
-
-  describe "running on any version of the Windows OS", :windows_only do
-    before do
-      @mock_bootstrap_context = Chef::Knife::Core::WindowsBootstrapContext.new({ }, nil, { })
-
-      # Stub the bootstrap context and prevent config related sections
-      # from being populated, i.e. chef installation and first chef
-      # run sections
-      @mock_bootstrap_context.stub(:validation_key).and_return("echo.validation_key")
-      @mock_bootstrap_context.stub(:encrypted_data_bag_secret).and_return("echo.encrypted_data_bag_secret")
-      @mock_bootstrap_context.stub(:config_content).and_return("echo.config_content")
-      @mock_bootstrap_context.stub(:start_chef).and_return("echo.echo start_chef_command")
-      @mock_bootstrap_context.stub(:run_list).and_return("echo.run_list")
-      @mock_bootstrap_context.stub(:install_chef).and_return("echo.echo install_chef_command")
-
-      # Change the directories where bootstrap files will be created
-      @mock_bootstrap_context.stub(:bootstrap_directory).and_return(@temp_directory.gsub(::File::SEPARATOR, ::File::ALT_SEPARATOR))
-      @mock_bootstrap_context.stub(:local_download_path).and_return(@local_file_download_destination.gsub(::File::SEPARATOR, ::File::ALT_SEPARATOR))
-
-      # Prevent password prompt during bootstrap process
-      @mock_winrm = Chef::Knife::Winrm.new
-      @mock_winrm.stub(:get_password).and_return(nil)
-      Chef::Knife::Winrm.stub(:new).and_return(@mock_winrm)
-
-      Chef::Knife::Core::WindowsBootstrapContext.stub(:new).and_return(@mock_bootstrap_context)
-    end
-
-    it "downloads the chef-client MSI during winrm bootstrap" do
-      clean_test_case
-
-      winrm_bootstrapper = Chef::Knife::BootstrapWindowsWinrm.new([ "127.0.0.1" ])
-      winrm_bootstrapper.config[:template_file] = @template_file_path      
-
-      # Execute the commands locally that would normally be executed via WinRM
-      winrm_bootstrapper.stub(:run_command) do |command|
-        system(command)
-      end
-
-      winrm_bootstrapper.run
-
-      # Download should succeed
-      download_succeeded?.should == true
-    end
-  end
-
-  def download_succeeded?
-    File.exists?(@local_file_download_destination) && ! File.zero?(@local_file_download_destination)
-  end
-
-  # Remove file artifacts generated by individual test cases
-  def clean_test_case
-    if File.exists?(@local_file_download_destination)
-      File.delete(@local_file_download_destination)
-    end
-  end
-  
-end 
+#
+# Author:: Adam Edwards (<adamed@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, 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.
+#
+
+require 'spec_helper'
+require 'tmpdir'
+
+# These test cases exercise the Knife::Windows knife plugin's ability
+# to download a bootstrap msi as part of the bootstrap process on
+# Windows nodes. The test modifies the Windows batch file generated
+# from an erb template in the plugin source in order to enable execution
+# of only the download functionality contained in the bootstrap template.
+# The test relies on knowledge of the fields of the template itself and 
+# also on knowledge of the contents and structure of the Windows batch
+# file generated by the template.
+#
+# Note that if the bootstrap template changes substantially, the tests
+# should fail and will require re-implementation. If such changes
+# occur, the bootstrap code should be refactored to explicitly expose
+# the download funcitonality separately from other tasks to make the
+# test more robust.
+describe 'Knife::Windows::Core msi download functionality for knife Windows winrm bootstrap template' do 
+
+  before(:all) do
+    # Since we're always running 32-bit Ruby, fix the
+    # PROCESSOR_ARCHITECTURE environment variable.
+
+    if ENV["PROCESSOR_ARCHITEW6432"]
+      ENV["PROCESSOR_ARCHITECTURE"] = ENV["PROCESSOR_ARCHITEW6432"]
+    end
+    
+    # All file artifacts from this test will be written into this directory
+    @temp_directory = Dir.mktmpdir("bootstrap_test")
+
+    # Location to which the download script will be modified to write
+    # the downloaded msi
+    @local_file_download_destination = "#{@temp_directory}/chef-client-latest.msi"
+
+    source_code_directory = File.dirname(__FILE__)    
+    @template_file_path ="#{source_code_directory}/../../lib/chef/knife/bootstrap/windows-chef-client-msi.erb"    
+  end
+
+  after(:all) do
+    # Clear the temp directory upon exit
+    if Dir.exists?(@temp_directory)
+      FileUtils::remove_dir(@temp_directory)
+    end
+  end
+
+  describe "running on any version of the Windows OS", :windows_only do
+    before do
+      @mock_bootstrap_context = Chef::Knife::Core::WindowsBootstrapContext.new({ }, nil, { :knife => {} })
+
+      # Stub the bootstrap context and prevent config related sections
+      # from being populated, i.e. chef installation and first chef
+      # run sections
+      @mock_bootstrap_context.stub(:validation_key).and_return("echo.validation_key")
+      @mock_bootstrap_context.stub(:encrypted_data_bag_secret).and_return("echo.encrypted_data_bag_secret")
+      @mock_bootstrap_context.stub(:config_content).and_return("echo.config_content")
+      @mock_bootstrap_context.stub(:start_chef).and_return("echo.echo start_chef_command")
+      @mock_bootstrap_context.stub(:run_list).and_return("echo.run_list")
+      @mock_bootstrap_context.stub(:install_chef).and_return("echo.echo install_chef_command")
+
+      # Change the directories where bootstrap files will be created
+      @mock_bootstrap_context.stub(:bootstrap_directory).and_return(@temp_directory.gsub(::File::SEPARATOR, ::File::ALT_SEPARATOR))
+      @mock_bootstrap_context.stub(:local_download_path).and_return(@local_file_download_destination.gsub(::File::SEPARATOR, ::File::ALT_SEPARATOR))
+
+      # Prevent password prompt during bootstrap process
+      @mock_winrm = Chef::Knife::Winrm.new
+      @mock_winrm.stub(:get_password).and_return(nil)
+      Chef::Knife::Winrm.stub(:new).and_return(@mock_winrm)
+
+      Chef::Knife::Core::WindowsBootstrapContext.stub(:new).and_return(@mock_bootstrap_context)
+    end
+
+    it "downloads the chef-client MSI during winrm bootstrap" do
+
+      clean_test_case
+
+      winrm_bootstrapper = Chef::Knife::BootstrapWindowsWinrm.new([ "127.0.0.1" ])
+      winrm_bootstrapper.stub(:wait_for_remote_response)
+      winrm_bootstrapper.config[:template_file] = @template_file_path      
+
+      # Execute the commands locally that would normally be executed via WinRM
+      winrm_bootstrapper.stub(:run_command) do |command|
+        system(command)
+      end
+
+      winrm_bootstrapper.run
+
+      # Download should succeed
+      download_succeeded?.should == true
+    end
+  end
+
+  def download_succeeded?
+    File.exists?(@local_file_download_destination) && ! File.zero?(@local_file_download_destination)
+  end
+
+  # Remove file artifacts generated by individual test cases
+  def clean_test_case
+    if File.exists?(@local_file_download_destination)
+      File.delete(@local_file_download_destination)
+    end
+  end
+  
+end