knife-windows 0.5.10 → 0.5.12

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-fs
+

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in knife-windows.gemspec
 gemspec
+
+group :test do
+  gem "rspec"
+  gem "ruby-wmi"
+  gem "chef"
+end

data/Rakefile

@@ -1,2 +1,16 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+
+  task :default => :spec
+
+  desc "Run all specs in spec directory"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end

data/lib/chef/knife/bootstrap/windows-chef-client-msi.erb

@@ -16,33 +16,112 @@
 @rem limitations under the License.
 @rem
 
+@setlocal
+
 <%= "SETX HTTP_PROXY \"#{knife_config[:bootstrap_proxy]}\"" if knife_config[:bootstrap_proxy] %>
-mkdir C:\chef
+mkdir <%= bootstrap_directory %>
 
-> C:\chef\wget.vbs (
+> <%= bootstrap_directory %>\wget.vbs (
  <%= win_wget %>
 )
 
+> <%= bootstrap_directory %>\wget.ps1 (
+ <%= win_wget_ps %>
+)
+
+@rem Determine the version and the architecture
+
+FOR /F "tokens=1-8 delims=.[] " %%A IN ('ver') DO (
+@set WinMajor=%%D
+@set WinMinor=%%E
+@set WinBuild=%%F
+)
+
+goto Version%WinMajor%.%WinMinor%
+
+@rem If this is an unknown version of windows set the default
+@set MACHINE_OS=2008r2
+goto architecture
+
+:Version6.0
+@set MACHINE_OS=2008
+goto architecture
+
+:Version5.2
+@set MACHINE_OS=2003r2
+goto architecture
+
+:Version6.1
+@set MACHINE_OS=2008r2
+goto architecture
+
+:Version6.2
+@set MACHINE_OS=2012
+goto architecture
+
+:architecture
+
+goto Architecture%PROCESSOR_ARCHITECTURE%
+
+@rem If this is an unknown architecture set the default
+@set MACHINE_ARCH=i686
+goto install
+
+:Architecturex86
+@set MACHINE_ARCH=i686
+goto install
+
+:Architectureamd64
+@set MACHINE_ARCH=x86_64
+goto install
+
+:install
 @rem Install Chef using chef-client MSI installer
-cscript /nologo C:\chef\wget.vbs /url:http://www.opscode.com/chef/install.msi /path:%TEMP%\chef-client-latest.msi
-msiexec /qb /i %TEMP%\chef-client-latest.msi
 
-> C:\chef\validation.pem (
+@set "REMOTE_SOURCE_MSI_URL=https://www.opscode.com/chef/download?p=windows&pv=%MACHINE_OS%&m=%MACHINE_ARCH%"
+@set "LOCAL_DESTINATION_MSI_PATH=<%= local_download_path %>"
+@set "FALLBACK_QUERY_STRING=&DownloadContext=PowerShell"
+
+cscript /nologo <%= bootstrap_directory %>\wget.vbs /url:"%REMOTE_SOURCE_MSI_URL%" /path:"%LOCAL_DESTINATION_MSI_PATH%"
+
+@rem Work around issues found in Windows Server 2012 around job objects not respecting WSMAN memory quotas
+@rem that cause the MSI download process to exceed the quota even when it is increased by administrators.
+@rem Retry the download using a more memory-efficient mechanism that only works if PowerShell is available.
+@if ERRORLEVEL 1 (      
+    echo Warning: Failed to download "%REMOTE_SOURCE_MSI_URL%" to "%LOCAL_DESTINATION_MSI_PATH%"
+    echo Warning: Retrying download with PowerShell if available
+    if EXIST "%LOCAL_DESTINATION_MSI_PATH%" del /f /q "%LOCAL_DESTINATION_MSI_PATH%"
+    @powershell -ExecutionPolicy Unrestricted -NoProfile -NonInteractive "& '<%= bootstrap_directory %>\wget.ps1' '%REMOTE_SOURCE_MSI_URL%%FALLBACK_QUERY_STRING%' '%LOCAL_DESTINATION_MSI_PATH%'"
+
+    if NOT ERRORLEVEL 1 (
+        echo Download succeeded
+    ) else (
+        echo Failed to download "%REMOTE_SOURCE_MSI_URL%"
+        echo Subsequent attempt to install the downloaded MSI is likely to fail
+    )
+)
+
+<%= install_chef %>
+
+@endlocal
+
+> <%= bootstrap_directory %>\validation.pem (
  <%= validation_key %>
 )
 
 <% if @config[:encrypted_data_bag_secret] -%>
-> C:\chef\encrypted_data_bag_secret (
+> <%= bootstrap_directory %>\encrypted_data_bag_secret (
  <%= encrypted_data_bag_secret %>
 )
 <% end -%>
 
-> C:\chef\client.rb (
+> <%= bootstrap_directory %>\client.rb (
  <%= config_content %>
 )
 
-> C:\chef\first-boot.json (
+> <%= bootstrap_directory %>\first-boot.json (
  <%= run_list %>
 )
 
 <%= start_chef %>
+

data/lib/chef/knife/bootstrap_windows_base.rb

@@ -136,14 +136,14 @@ class Chef
         # we have to run the remote commands in 2047 char chunks
         create_bootstrap_bat_command do |command_chunk, chunk_num|
           begin
-            run_command("cmd.exe /C echo \"Rendering '#{bootstrap_bat_file}' chunk #{chunk_num}\" && #{command_chunk}").run
+            run_command("cmd.exe /C echo \"Rendering '#{bootstrap_bat_file}' chunk #{chunk_num}\" && #{command_chunk}")
           rescue SystemExit => e
             raise unless e.success?
           end
         end
 
         # execute the bootstrap.bat file
-        run_command(bootstrap_command).run
+        run_command(bootstrap_command)
       end
 
       def bootstrap_command

data/lib/chef/knife/bootstrap_windows_ssh.rb

@@ -78,7 +78,7 @@ class Chef
         ssh.config[:identity_file] = config[:identity_file]
         ssh.config[:manual] = true
         ssh.config[:host_key_verify] = config[:host_key_verify]
-        ssh
+        ssh.run
       end
 
     end

data/lib/chef/knife/bootstrap_windows_winrm.rb

@@ -17,7 +17,9 @@
 #
 
 require 'chef/knife/bootstrap_windows_base'
+require 'chef/knife/winrm'
 require 'chef/knife/winrm_base'
+require 'chef/knife/bootstrap'
 
 class Chef
   class Knife
@@ -51,7 +53,7 @@ class Chef
         winrm.config[:ca_trust_file] = Chef::Config[:knife][:ca_trust_file] if Chef::Config[:knife][:ca_trust_file]
         winrm.config[:manual] = true
         winrm.config[:winrm_port] = locate_config_value(:winrm_port)
-        winrm
+        winrm.run
       end
 
     end

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -136,6 +136,33 @@ WGET
           escape_and_echo(win_wget)
         end
 
+        def win_wget_ps
+          win_wget_ps = <<-WGET_PS
+param(
+   [String] $remoteUrl,
+   [String] $localPath
+)
+
+$webClient = new-object System.Net.WebClient; 
+
+$webClient.DownloadFile($remoteUrl, $localPath);
+WGET_PS
+
+          escape_and_echo(win_wget_ps)
+        end
+
+        def install_chef
+          install_chef = 'msiexec /qb /i "%LOCAL_DESTINATION_MSI_PATH%"'
+        end
+
+        def bootstrap_directory
+          bootstrap_directory = "C:\\chef"
+        end
+
+        def local_download_path
+          local_download_path = "%TEMP%\\chef-client-latest.msi"
+        end
+
         # escape WIN BATCH special chars
         # and prefixes each line with an
         # echo

data/lib/chef/knife/winrm.rb

@@ -89,7 +89,16 @@ class Chef
                  end
                  r
                end
-        (ui.fatal("No nodes returned from search!"); exit 10) if list.length == 0
+        if list.length == 0
+          if @action_nodes.length == 0
+            ui.fatal("No nodes returned from search!")
+          else
+            ui.fatal("#{@action_nodes.length} #{@action_nodes.length > 1 ? "nodes":"node"} found, " +
+                     "but does not have the required attribute (#{config[:attribute]}) to establish the connection. " +
+                     "Try setting another attribute to open the connection using --attribute.")
+          end
+          exit 10
+        end
         session_from_list(list)
       end
 
@@ -238,7 +247,7 @@ class Chef
             end
 
             session.close
-            exit @exit_code || 0
+            @exit_code || 0
           end
         rescue WinRM::WinRMHTTPTransportError => e
           case e.message

data/lib/knife-windows/version.rb

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

data/spec/functional/bootstrap_download_spec.rb

@@ -0,0 +1,115 @@
+#
+# 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"
+  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
+      # to be populated, chef installation and first chef run
+      @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 directorires 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
+
+      bootstrap_context = Chef::Knife::BootstrapWindowsWinrm.new([ "127.0.0.1" ])
+
+      # Execute the commands locally that would normally be executed via WinRM
+      bootstrap_context.stub(:run_command) do |command|
+        system(command)
+      end
+
+      bootstrap_context.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 artifiacts 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 

data/spec/spec_helper.rb

@@ -0,0 +1,63 @@
+
+# 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.
+#
+
+def windows?
+  !!(RUBY_PLATFORM =~ /mswin|mingw|windows/)
+end
+
+require_relative '../lib/chef/knife/core/windows_bootstrap_context'
+require_relative '../lib/chef/knife/bootstrap_windows_winrm'
+
+if windows?
+  require 'ruby-wmi'
+end
+
+def windows2012?
+  is_win2k12 = false
+  
+  if  windows?
+    this_operating_system = WMI::Win32_OperatingSystem.find(:first)
+    os_version = this_operating_system.send('Version')
+
+    # The operating system version is a string in the following form
+    # that can be split into components based on the '.' delimiter:
+    # MajorVersionNumber.MinorVersionNumber.BuildNumber
+    os_version_components = os_version.split('.')
+
+    if os_version_components.length < 2
+      raise 'WMI returned a Windows version from Win32_OperatingSystem.Version ' +
+        'with an unexpected format. The Windows version could not be determined.'
+    end
+
+    # Windows 6.2 is Windows Server 2012, so test the major and
+    # minor version components
+    is_win2k12 = os_version_components[0] == '6' && os_version_components[1] == '2'
+  end
+
+  is_win2k12
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  
+  config.filter_run_excluding :windows_only => true unless windows?
+  config.filter_run_excluding :windows_2012_only => true unless windows2012?
+end
+

data/spec/unit/knife/winrm_spec.rb

@@ -0,0 +1,65 @@
+#
+# Author:: Bryan McLellan <btm@opscode.com>
+# Copyright:: Copyright (c) 2013 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'
+
+Chef::Knife::Winrm.load_deps
+
+describe Chef::Knife::Winrm do
+  before(:all) do
+    @original_config = Chef::Config.hash_dup
+    @original_knife_config = Chef::Config[:knife].dup
+  end
+
+  after(:all) do
+    Chef::Config.configuration = @original_config
+    Chef::Config[:knife] = @original_knife_config
+  end
+
+  before do
+    @knife = Chef::Knife::Winrm.new
+    @knife.config[:attribute] = "fqdn"
+    @node_foo = Chef::Node.new
+    @node_foo.automatic_attrs[:fqdn] = "foo.example.org"
+    @node_foo.automatic_attrs[:ipaddress] = "10.0.0.1"
+    @node_bar = Chef::Node.new
+    @node_bar.automatic_attrs[:fqdn] = "bar.example.org"
+    @node_bar.automatic_attrs[:ipaddress] = "10.0.0.2"
+  end
+
+  describe "#configure_session" do
+    before do
+      @query = mock("Chef::Search::Query")
+    end
+
+    context "when there are some hosts found but they do not have an attribute to connect with" do
+      before do
+        @query.stub!(:search).and_return([[@node_foo, @node_bar]])
+        @node_foo.automatic_attrs[:fqdn] = nil
+        @node_bar.automatic_attrs[:fqdn] = nil
+        Chef::Search::Query.stub!(:new).and_return(@query)
+      end
+    
+      it "should raise a specific error (KNIFE-222)" do
+        @knife.ui.should_receive(:fatal).with(/does not have the required attribute/)
+        @knife.should_receive(:exit).with(10)
+        @knife.configure_session
+      end
+    end
+  end
+end  

metadata

@@ -1,50 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: knife-windows
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 0.5.12
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 10
-  version: 0.5.10
 platform: ruby
-authors: 
+authors:
 - Seth Chisamore
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-13 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: em-winrm
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 5
-        - 4
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.5.4
   type: :runtime
-  version_requirements: *id001
-description: Plugin that adds functionality to Chef's Knife CLI for configuring/interacting with nodes running Microsoft Windows
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+description: Plugin that adds functionality to Chef's Knife CLI for configuring/interacting
+  with nodes running Microsoft Windows
+email:
 - schisamo@opscode.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - LICENSE
-files: 
+files:
 - .gitignore
+- .rspec
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -60,40 +54,32 @@ files:
 - lib/chef/knife/winrm.rb
 - lib/chef/knife/winrm_base.rb
 - lib/knife-windows/version.rb
+- spec/functional/bootstrap_download_spec.rb
+- spec/spec_helper.rb
+- spec/unit/knife/winrm_spec.rb
 homepage: https://github.com/opscode/knife-windows
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 49
-      segments: 
-      - 1
-      - 9
-      - 1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Plugin that adds functionality to Chef's Knife CLI for configuring/interacting with nodes running Microsoft Windows
+summary: Plugin that adds functionality to Chef's Knife CLI for configuring/interacting
+  with nodes running Microsoft Windows
 test_files: []
-