vagrant-windows 0.1.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6373e5fcaeafb284ed319640b162f38d2c1fbb42
+  data.tar.gz: f292ab1b6c18eb837fd7b5d8f9b2bc34dfda6aad
+SHA512:
+  metadata.gz: e86f29b4b5661bd43041cda843cf062735b3f66ca80a20a0c097724572a3124a4131bb809201bc8e77767e845c2a998350be3af2028108eb40c6e781dd6d0c96
+  data.tar.gz: 770f88ccf1d8bc53f22921a56dc1a27c5176b93c6bc8e4eab9336ab21d19706558a1c1f02ac3136302110313518d8275c207074db8ad5b2b76ade076edeca977

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    vagrant-windows (0.1.1)
+    vagrant-windows (0.2.0)
       highline
-      vagrant (~> 1.0.3)
       winrm (~> 1.1.1)
 
 GEM
@@ -12,32 +11,22 @@ GEM
     akami (1.2.0)
       gyoku (>= 0.4.0)
       nokogiri (>= 1.4.0)
-    archive-tar-minitar (0.5.2)
-    builder (3.1.3)
-    childprocess (0.3.5)
-      ffi (~> 1.0, >= 1.0.6)
-    erubis (2.7.0)
-    ffi (1.1.5)
+    builder (3.0.4)
+    ffi (1.4.0)
     gssapi (1.0.3)
       ffi (>= 1.0.1)
     gyoku (0.4.6)
       builder (>= 2.1.2)
-    highline (1.6.14)
+    highline (1.6.15)
     httpclient (2.2.0.2)
     httpi (0.9.7)
       rack
-    i18n (0.6.1)
-    json (1.5.4)
     little-plugger (1.1.3)
-    log4r (1.1.10)
     logging (1.6.2)
       little-plugger (>= 1.1.3)
-    net-scp (1.0.4)
-      net-ssh (>= 1.99.1)
-    net-ssh (2.2.2)
-    nokogiri (1.5.5)
+    nokogiri (1.5.6)
     nori (1.1.3)
-    rack (1.4.1)
+    rack (1.5.2)
     rubyntlm (0.1.1)
     savon (0.9.5)
       akami (~> 1.0)
@@ -48,15 +37,6 @@ GEM
       nori (~> 1.0)
       wasabi (~> 1.0)
     uuidtools (2.1.3)
-    vagrant (1.0.3)
-      archive-tar-minitar (= 0.5.2)
-      childprocess (~> 0.3.1)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6.0)
-      json (~> 1.5.1)
-      log4r (~> 1.1.9)
-      net-scp (~> 1.0.4)
-      net-ssh (~> 2.2.2)
     wasabi (1.0.0)
       nokogiri (>= 1.4.0)
     winrm (1.1.2)

data/README.md

@@ -1,35 +1,33 @@
- 
-Installing
-==========
 
- ```
- gem install vagrant-windows
- ```
+Installing Vagrant-Windows
+==========================
+
+- Vagrant 1.0 should use <code>gem "vagrant-windows", "~> 0.1.2"</code>
+- Vagrant 1.1 should use <code>gem "vagrant-windows", "~> 1.0.0"</code>
+- Vagrant 1.2 is not yet supported. There needs to be a refactor to support capabilities. We are looking for a backwards compatiable way to implement this.
+
 
 Building a Base Box
 ===================
 
 All Windows Machines
 -------------------- 
- -Enable WinRM
-
-  ```
+  -Enable WinRM
+```
    winrm quickconfig -q
    winrm set winrm/config/winrs @{MaxMemoryPerShellMB="512"}
    winrm set winrm/config @{MaxTimeoutms="1800000"}
    winrm set winrm/config/service @{AllowUnencrypted="true"}
    winrm set winrm/config/service/auth @{Basic="true"}
-   ```
-  - Create a vagrant user
-    - For things to work out of the box, username and password should both be vagrant
-
+```
+  - Create a vagrant user, for things to work out of the box username and password should both be "vagrant".
   - Turn off UAC (Msconfig)
   - Disable complex passwords
   
 Servers
 --------
-  - Disable Shutdown Tracker (http://www.jppinto.com/2010/01/how-to-disable-the-shutdown-event-tracker-in-server-20032008/)
-  - Disable "Server Manager" Starting at login (http://www.elmajdal.net/win2k8/How_to_Turn_Off_The_Automatic_Display_of_Server_Manager_At_logon.aspx)
+  - [Disable Shutdown Tracker](http://www.jppinto.com/2010/01/how-to-disable-the-shutdown-event-tracker-in-server-20032008/)
+  - [Disable "Server Manager" Starting at login](http://www.elmajdal.net/win2k8/How_to_Turn_Off_The_Automatic_Display_of_Server_Manager_At_logon.aspx)
   
 The Vagrant File
 ================
@@ -37,51 +35,95 @@ The Vagrant File
 Add the following to your Vagrantfile
 
 ```ruby
-  config.vm.guest = :windows
-
-  config.vm.forward_port 3389, 3390, :name => "rdp", :auto => true
-  config.vm.forward_port 5985, 5985, :name => "winrm", :auto => true
+config.vm.guest = :windows
+config.windows.halt_timeout = 15
+config.winrm.username = "vagrant"
+config.winrm.password = "vagrant"
+config.vm.network :forwarded_port, guest: 3389, host: 3389
+config.vm.network :forwarded_port, guest: 5985, host: 5985
 ```
 
 Example:
 ```ruby
-Vagrant::Config.run do |config|
-
-  #The following timeout configuration is option, however if have
-  #any large remote_file resources in your chef recipes, you may
-  #experience timeouts (reported as 500 responses)
-  config.winrm.timeout = 1800     #Set WinRM Timeout in seconds (Default 30)
+Vagrant.configure("2") do |config|
+  
+  # Max time to wait for the guest to shutdown
+  config.windows.halt_timeout = 15
+  
+  # Admin user name and password
+  config.winrm.username = "vagrant"
+  config.winrm.password = "vagrant"
 
   # Configure base box parameters
-  config.vm.box = "windows2008r2"
-  config.vm.box_url = "./windows-2008-r2.box"
+  config.vm.box = "vagrant-windows2008r2"
+  config.vm.box_url = "./vagrant-windows2008r2.box"
   config.vm.guest = :windows
 
-  config.vm.forward_port 3389, 3390, :name => "rdp", :auto => true
-  config.vm.forward_port 5985, 5985, :name => "winrm", :auto => true
-
-  config.vm.provision :chef_solo do |chef|
-    chef.add_recipe("your::recipe")
-  end
-
+  # Port forward WinRM and RDP
+  config.vm.network :forwarded_port, guest: 3389, host: 3389
+  config.vm.network :forwarded_port, guest: 5985, host: 5985
+  
 end
 ````
 
+Available Config Parameters:
+
+* ```config.windows.halt_timeout``` - How long Vagrant should wait for the guest to shutdown before forcing exit, defaults to 30 seconds
+* ```config.windows.halt_check_interval``` - How often Vagrant should check if the system has shutdown, defaults to 1 second
+* ```config.winrm.username``` - The Windows guest admin user name, defaults to vagrant.
+* ```config.winrm.password``` - The above's password, defaults to vagrant.
+* ```config.winrm.host``` - The IP of the guest, but because we use NAT with port forwarding this defaults to localhost.
+* ```config.winrm.guest_port``` - The guest's WinRM port, defaults to 5985.
+* ```config.winrm.port``` - The WinRM port on the host, defaults to 5985. You might need to change this if your hosts is also Windows.
+* ```config.winrm.max_tries``` - The number of retries to connect to WinRM, defaults to 12.
+* ```config.winrm.timeout``` - The max number of seconds to wait for a WinRM response, defaults to 1800 seconds.
+
+Note - You need to ensure you specify a config.windows and a config.winrm in your Vagrantfile. Currently there's a problem where
+Vagrant will not load the plugin config even with defaults if at least one of its values doesn't exist in the Vagrantfile.
+
+
 What Works?
 ===========
-- vagrant up|hault|reload|provision
+- vagrant up|halt|reload|provision
 - Chef Vagrant Provisioner
+- Puppet Vagrant Provisioner
 
 What has not been tested
 ========================
-- Everything Else!!!
-- Shell and Puppet Provisioners 
-  - Shell should work, though I have not vetted it yet.
+- Shell provisioning. Shell should work, though I have not vetted it yet.
 
-What does not work
-==================
-- <s>Complex networking setups</s> - Fixed in 0.0.3
-  - Note that I have not tested the Virtual Box 4.0 Driver, all _should_ work. Can someone please confirm?
+TODOs
+=========
+1. Test it! We need to test on more hosts, guests, and VBox versions. Help wanted.
+2. Vagrant 1.2 support. Unfortunately it appears there are some breaking changes with guests between Vagrant 1.1. and 1.2.
+3. Chef-Client support.
+3. Unit tests. 
+4. Better docs.
+
+Troubleshooting
+===============
+
+I get a 401 auth error from WinRM
+---------------------------------
+- Ensure you've followed the WinRM configuration instructions above.
+- Ensure you can manually login using the specified config.winrm.username you've specified in your Vagrantfile.
+- Ensure your password hasn't expired.
+- Ensure your password doesn't need to be changed because of policy.
+
+I get a non-401 error from WinRM waiting for the VM to boot
+-----------------------------------------------------------
+- Ensure you've properly setup port forwarding of WinRM
+- Make sure your VM can boot manually through VBox.
+
+SQL Server cookbook fails to install through Vagrant
+----------------------------------------------------
+- Ensure UAC is turned off
+- Ensure your vagrant user is an admin on the guest
+- The SQL Server installer uses a lot of resources, ensure WinRM Quota Management is properly configured to give it enough resources.
+- See [COOK-1172](http://tickets.opscode.com/browse/COOK-1172) and http://stackoverflow.com/a/15235996/82906 for more information.
+
+If all else fails try running [vagrant with debug logging](http://docs.vagrantup.com/v2/debugging.html), perhaps that will give
+you enough insight to fix the problem or file an issue.
 
 What Can I do to help?
 ======================
@@ -100,10 +142,16 @@ Contributing
 References and Shout Outs
 =========================
 - Chris McClimans - Vagrant Branch (https://github.com/hh/vagrant/blob/feature/winrm/)
--Dan Wanek - WinRM GEM (https://github.com/zenchild/WinRM)
+- Dan Wanek - WinRM GEM (https://github.com/zenchild/WinRM)
   - +1 For being super responsive to pull requests.
 
 
 Changelog
 =========
-0.1.1 - Remove extra debug information from command output.
+0.1.1 - Remove extra debug information from command output.
+
+0.1.2 - Added virtual box 4.2 support.
+
+0.1.3 - Added puppet provisioner.
+
+1.0.0 - Converted to Vagrant 1.1.x plugin architecture.

data/lib/vagrant-windows/communication/winrmcommunicator.rb

@@ -0,0 +1,213 @@
+require 'timeout'
+require 'winrm'
+require 'log4r'
+require 'vagrant/util/ansi_escape_code_remover'
+require 'vagrant/util/file_mode'
+require 'vagrant/util/platform'
+require 'vagrant/util/retryable'
+
+module VagrantWindows
+  module Communication
+    # Provides communication with the VM via WinRM.
+    class WinRMCommunicator < Vagrant.plugin("2", :communicator)
+
+      include Vagrant::Util::ANSIEscapeCodeRemover
+      include Vagrant::Util::Retryable
+
+      attr_reader :logger
+      attr_reader :machine
+      
+      def self.match?(machine)
+        machine.config.vm.guest.eql? :windows
+      end
+
+      def initialize(machine)
+        @machine = machine
+        @logger = Log4r::Logger.new("vagrant_windows::communication::winrmcommunicator")
+        @logger.debug("initializing WinRMCommunicator")
+      end
+
+      def ready?
+        logger.debug("Checking whether WinRM is ready...")
+        
+        Timeout.timeout(@machine.config.winrm.timeout) do
+          execute("hostname") do |type, data|
+            @logger.debug("hostname: #{data}")
+          end
+        end
+
+        # If we reached this point then we successfully connected
+        logger.debug("WinRM is ready!")
+        true
+      end
+      
+      def execute(command, opts=nil, &block)
+        opts = {
+          :error_check => true,
+          :error_class => Errors::WinRMExecutionError,
+          :error_key   => :winrm_bad_exit_status,
+          :command     => command,
+          :sudo        => false,
+          :shell       => :powershell
+        }.merge(opts || {})
+
+        command = VagrantWindows.load_script("command_alias.ps1") << "\r\n" << command
+        exit_status = 0
+        
+        begin
+          # Connect via WinRM and execute the command in the shell.
+          exceptions = [HTTPClient::KeepAliveDisconnected] 
+          exit_status = retryable(:tries => @machine.config.winrm.max_tries, :on => exceptions, :sleep => 10) do
+            shell_execute(command, opts[:shell], &block)
+          end
+        rescue StandardError => e
+          # return a more specific auth error for 401 errors
+          if e.message.include?("401")
+            raise Errors::WinRMAuthorizationError,
+              :user => @machine.config.winrm.username,
+              :password => @machine.config.winrm.password,
+              :endpoint => endpoint,
+              :message => e.message 
+          end
+          # failed for an unknown reason, didn't even get an exit status
+          raise Errors::WinRMExecutionError,
+            :shell => opts[:shell],
+            :command => command,
+            :message => e.message
+        end
+
+        # Check for any exit status errors
+        if opts[:error_check] && exit_status != 0
+          error_opts = opts.merge(:_key => opts[:error_key], :exit_status => exit_status)
+          raise error_opts[:error_class], error_opts 
+        end
+
+        exit_status
+      end
+      
+      # Wrap Sudo in execute.... One day we could integrate with UAC, but Icky
+      def sudo(command, opts=nil, &block)
+        execute(command, opts, &block)
+      end
+      
+      def download(from, to=nil)
+        @logger.warn("Downloading: #{from} to #{to} not supported on Windows guests")
+      end
+      
+      def test(command, opts=nil)
+        opts = { :error_check => false }.merge(opts || {})
+        execute(command, opts) == 0
+      end
+      
+      def upload(from, to)
+        @logger.debug("Uploading: #{from} to #{to}")
+        
+        file = "winrm-upload-#{rand()}"
+        file_name = (session.cmd("echo %TEMP%\\#{file}"))[:data][0][:stdout].chomp
+        session.powershell <<-EOH
+          if(Test-Path #{to})
+          {
+            rm #{to}
+          }
+        EOH
+        Base64.encode64(IO.binread(from)).gsub("\n",'').chars.to_a.each_slice(8000-file_name.size) do |chunk|
+          out = session.cmd( "echo #{chunk.join} >> \"#{file_name}\"" )
+        end
+        execute "mkdir [System.IO.Path]::GetDirectoryName(\"#{to}\")"
+        execute <<-EOH
+          $base64_string = Get-Content \"#{file_name}\"
+          $bytes  = [System.Convert]::FromBase64String($base64_string) 
+          $new_file = [System.IO.Path]::GetFullPath(\"#{to}\")
+          [System.IO.File]::WriteAllBytes($new_file,$bytes)
+        EOH
+      end
+
+      def new_session
+        opts = endpoint_options()
+        logger.debug("Creating WinRM session to #{endpoint} with options: #{opts}")
+
+        client = ::WinRM::WinRMWebService.new(endpoint, :plaintext, opts)
+        client.set_timeout(opts[:operation_timeout])
+        client.toggle_nori_type_casting(:off) #we don't want coersion of types
+        client
+      end
+
+      def session
+        @session ||= new_session
+      end
+
+      protected
+
+      def endpoint_options
+        {
+          :user => @machine.config.winrm.username,
+          :pass => @machine.config.winrm.password,
+          :host => @machine.config.winrm.host,
+          :port => winrm_port(),
+          :operation_timeout => @machine.config.winrm.timeout,
+          :basic_auth_only => true
+        }.merge ({})
+      end
+      
+      def winrm_port
+        @winrm_port ||= find_winrm_host_port()
+      end
+      
+      def find_winrm_host_port
+        expected_guest_port = @machine.config.winrm.guest_port
+        @logger.debug("Searching for WinRM port: #{expected_guest_port.inspect}")
+      
+        # Look for the forwarded port only by comparing the guest port
+        @machine.provider.driver.read_forwarded_ports.each do |_, _, hostport, guestport|
+          return hostport if guestport == expected_guest_port
+        end
+        
+        @machine.config.winrm.port
+      end
+
+      def endpoint
+        if !@winrm_endpoint
+          opts = endpoint_options()
+          @winrm_endpoint = "http://#{opts[:host]}:#{opts[:port]}/wsman"
+        end
+        @winrm_endpoint
+      end    
+
+      # Executes the command on an SSH connection within a login shell.
+      def shell_execute(command, shell=:powershell, &block)
+        @logger.debug("#{shell} executing:\n#{command}")
+        
+        if shell.eql? :cmd
+          output = session.cmd(command) do |out, err|
+            handle_out(:stdout, out, &block)
+            handle_out(:stderr, err, &block)
+          end
+        elsif shell.eql? :powershell
+          output = session.powershell(command) do |out, err|
+            handle_out(:stdout, out, &block)
+            handle_out(:stderr, err, &block)
+          end
+        else
+          raise Errors::WinRMInvalidShell, :shell => shell
+        end
+
+        exit_status = output[:exitcode]
+        @logger.debug("Exit status: #{exit_status.inspect}")
+
+        # Return the final exit status
+        return exit_status
+      end
+      
+      def handle_out(type, data, &block)
+        if block_given? && data
+          if data =~ /\n/
+            data.split(/\n/).each { |d| block.call(type, d) }
+          else
+            block.call(type, data)
+          end
+        end
+      end
+
+    end #WinRM class
+  end
+end

data/lib/vagrant-windows/config/windows.rb

@@ -1,27 +1,31 @@
-module Vagrant
+require "vagrant"
+
+module VagrantWindows
   module Config
-    class Windows < Vagrant::Config::Base
-      attr_accessor :winrm_user
-      attr_accessor :winrm_password
+    class Windows < Vagrant.plugin("2", :config)
+
       attr_accessor :halt_timeout
       attr_accessor :halt_check_interval
-      attr_accessor :device
       
       def initialize
-        @winrm_user = 'vagrant'
-        @winrm_password = 'vagrant'
-        @halt_timeout = 30
-        @halt_check_interval = 1
-        @device = "e1000g"
+        @halt_timeout        = UNSET_VALUE
+        @halt_check_interval = UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << "windows.halt_timeout cannot be nil."        if machine.config.windows.halt_timeout.nil?
+        errors << "windows.halt_check_interval cannot be nil." if machine.config.windows.halt_check_interval.nil?
+
+        { "Windows Guest" => errors }
       end
 
-      def validate(env, errors)
-        [ :winrm_user, :winrm_password].each do |field|
-          errors.add(I18n.t("vagrant.config.common.error_empty", :field => field)) if !instance_variable_get("@#{field}".to_sym)
-        end
+      def finalize!
+        @halt_timeout = 30       if @halt_timeout == UNSET_VALUE
+        @halt_check_interval = 1 if @halt_check_interval == UNSET_VALUE
       end
+
     end
   end
 end
-
-Vagrant.config_keys.register(:windows) { Vagrant::Config::Windows }

data/lib/vagrant-windows/config/winrm.rb

@@ -1,6 +1,9 @@
-module Vagrant
+require "vagrant"
+
+module VagrantWindows
   module Config
-    class WinRM < Vagrant::Config::Base
+    class WinRM < Vagrant.plugin("2", :config)
+
       attr_accessor :username
       attr_accessor :password
       attr_accessor :host
@@ -8,24 +11,41 @@ module Vagrant
       attr_accessor :guest_port
       attr_accessor :max_tries
       attr_accessor :timeout
-
+      
       def initialize
-        @username = "vagrant"
-        @password = "vagrant"
-        @guest_port = 5985
-        @host = "localhost"
-        @max_tries = 12
-        @timeout = 1800
+        @username   = UNSET_VALUE
+        @password   = UNSET_VALUE
+        @host       = UNSET_VALUE
+        @port       = UNSET_VALUE
+        @guest_port = UNSET_VALUE
+        @max_tries  = UNSET_VALUE
+        @timeout    = UNSET_VALUE
       end
 
-      def validate(env, errors)
-        [:username, :password, :host, :max_tries, :timeout].each do |field|
-          errors.add(I18n.t("vagrant.config.common.error_empty", :field => field)) if !instance_variable_get("@#{field}".to_sym)
-        end
+      def validate(machine)
+        errors = []
+
+        errors << "winrm.username cannot be nil."   if machine.config.winrm.username.nil?
+        errors << "winrm.password cannot be nil."   if machine.config.winrm.password.nil?
+        errors << "winrm.host cannot be nil."       if machine.config.winrm.host.nil?
+        errors << "winrm.port cannot be nil."       if machine.config.winrm.port.nil?
+        errors << "winrm.guest_port cannot be nil." if machine.config.winrm.guest_port.nil?
+        errors << "winrm.max_tries cannot be nil."  if machine.config.winrm.max_tries.nil?
+        errors << "winrm.timeout cannot be nil."    if machine.config.winrm.timeout.nil?
 
+        { "WinRM" => errors }
       end
+
+      def finalize!
+        @username = "vagrant" if @username == UNSET_VALUE
+        @password = "vagrant" if @password == UNSET_VALUE
+        @host = "localhost"   if @host == UNSET_VALUE
+        @port = 5985          if @port == UNSET_VALUE
+        @guest_port = 5985    if @guest_port == UNSET_VALUE
+        @max_tries = 12       if @max_tries == UNSET_VALUE
+        @timeout = 1800       if @timeout == UNSET_VALUE
+      end
+
     end
   end
 end
-
-Vagrant.config_keys.register(:winrm) { Vagrant::Config::WinRM }

data/lib/vagrant-windows/errors.rb

@@ -1,22 +1,27 @@
-module Vagrant
+require 'vagrant/errors'
+
+module VagrantWindows
   module Errors
-    class WinRMPortNotDetected < VagrantError
-      status_code(550)
+    
+    class VagrantWindowsError < ::Vagrant::Errors::VagrantError
+      error_namespace("vagrant_windows.errors")
+    end  
+    
+    class WinRMPortNotDetected < VagrantWindowsError
       error_key(:winrm_port_not_detected)
     end
 
-    class WinRMInvalidShell < VagrantError
-      status_code(551)
+    class WinRMInvalidShell < VagrantWindowsError
       error_key(:winrm_invalid_shell)
     end
-    class WinRMTransferError < VagrantError
-      status_code(552)
-      error_key(:winrm_upload_error)
-    end
-    class WinRMTimeout < VagrantError
-      status_code(553)
-      error_key(:winrm_timeout)
+    
+    class WinRMExecutionError < VagrantWindowsError
+      error_key(:winrm_execution_error)
     end
+    
+    class WinRMAuthorizationError < VagrantWindowsError
+      error_key(:winrm_auth_error)
+    end    
 
   end
 end