vagrant-windows-hyperv 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf9197f8b3d059f4d8117de0e615f1ea3dbc025a
+  data.tar.gz: f81e610a7fb874b0948b7b4b15b59654b8500f7a
+SHA512:
+  metadata.gz: 01eae9a2ec5400761d2d0ed60924a60ca67a0de51ba24eeb653b53a39cdb276d4ea6bc6ae671b62f1f585ec45f7460357e4522bd745630814aa675225c8de9c8
+  data.tar.gz: 4114c5e863fc4af4726e3331f6324cb59385035263294591951ed53aa0b0868d67415a6096bce8729cf900eb92f59cc5de387558ab6ae2a81d229cf112fe2562

data/.gitignore

@@ -0,0 +1,19 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+
+# Ignore RDP files
+*.rdp

data/Gemfile

@@ -0,0 +1,15 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-windows-hyperv.gemspec
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files 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.

data/README.md

@@ -0,0 +1,89 @@
+# Vagrant Windows Hyper-V Provider
+
+Vagrant is a tool for building complete development environments, sandboxed in a virtual machine. It helps enforce good practices by encouraging the use of automation so that development environments are as close to production as possible.
+
+Hyper-V provider is available by default in Vagrant with version 1.5 and up. This plugin is created to provide windows guest support for the Vagrant Hyper-V provider.
+
+
+## Installation
+Install Vagrant 1.5 (or higher)
+http://www.vagrantup.com/downloads.html
+
+
+Install plugin like so: 
+vagrant plugin install vagrant-windows-hyperv
+
+
+## Configuration settings 
+For more information on general configuration settings please visit the Vagrant Documentation.
+http://docs.vagrantup.com/v2/
+
+
+##Setting specific to this plugin
+
+### Sync Folder configuration
+
+With Vagrant 1.5 SMB share is available by default and vagrant picks the most suitable
+implementation for the providers.
+
+You can even specify the following options
+
+ :smb_id   Specify a unique share name, with which the network share will be available. By default vagrant will generate a smb_id if not specified.
+ 
+
+
+
+```ruby
+   # Mounts the host/path to guest/path and will have realtime sync
+    config.vm.synced_folder 'C:/test_sync_2', "C:/Users/vagrant/test_sync_2" 
+
+```
+### VM Type
+* Set the VM guest type 
+
+```ruby
+config.vm.guest = :windows
+```
+
+### Override user name
+* If you're building a custom box and want to customize the user name, you can use the hyper-v custom block to add it in
+
+```ruby
+config.vm.provider "hyperv" do |hv, override|
+  override.ssh.username = "myuser"
+end
+```
+### New RDP Command
+* A new command vagrant rdp is introduced to connect to the Windows VM
+` vagrant rdp `
+
+
+### Provision Command
+* Provision command works for Vagrant hyper-v with this plugin installed
+` vagrant provision `
+
+
+## Troubleshooting
+
+### Remote PowerShell
+Vagrant-Windows-HyperV uses remote PowerShell to communicate with the guest VMs, so the guest VMs should have WinRM service running and remote PowerShell running.
+
+To Enable remote PowerShell in the guest.
+Go to the guest VM, open a cmd terminal and type the following command
+```
+powershell Enable-PSRemoting –force
+```
+### Trustedhosts
+With PowerShell being enabled in the remote VM, the host has to trust this guest to establish the connection.
+One can add the guest IP under trustedhost. Here "*" can be used as a wildcard to trust all hosts, or replace the * with the IP address of the guest..
+
+Type this command from an Administrator cmdshell prompt
+
+`
+powershell set-item wsman:\localhost\client\trustedhosts *
+`
+
+### SMB Share
+There is a bug in the current vagrant release (1.5.1) you may run into collisions when you create shares. To avoid this, user smb_id option and make sure the share name does not collide with existing shares.
+
+` config.vm.synced_folder 'C:/test_sync_2', "C:/Users/vagrant/test_sync_2", :smb_id => "test_my_share" `

data/Rakefile

@@ -0,0 +1,29 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+# Default task is to run the unit tests
+task :default => "spec"
+
+

data/example_box/metadata.json

@@ -0,0 +1 @@
+{ "provider" : "hyperv"}

data/lib/vagrant-windows-hyperv.rb

@@ -0,0 +1,38 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require "pathname"
+require "vagrant-windows-hyperv/plugin"
+
+module VagrantPlugins
+  module VagrantHyperV
+    lib_path = Pathname.new(File.expand_path("../vagrant-windows-hyperv", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+    autoload :Driver, lib_path.join("driver")
+
+    # Load a communicator for Windows guest
+    require lib_path.join("communication/powershell")
+
+    # Include the provision scripts for Windows
+    require lib_path.join("provisioner/shell")
+    require lib_path.join("provisioner/puppet")
+    require lib_path.join("provisioner/chef_solo")
+
+    monkey_patch = Pathname.new(File.expand_path("../vagrant-windows-hyperv/monkey_patch", __FILE__))
+    # Monkey Patch the core Hyper-V vagrant with the following
+    require monkey_patch.join("plugins/synced_folders/smb/synced_folders")
+    require monkey_patch.join("action/provision")
+    require monkey_patch.join("machine")
+    require monkey_patch.join("util/powershell")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/action.rb

@@ -0,0 +1,81 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require "pathname"
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module VagrantHyperV
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Message, I18n.t("vagrant_hyperv.message_not_created")
+              next
+            end
+            b2.use SetupPackageFiles
+            b2.use Call, GracefulHalt, :off, :running do |env2, b3|
+              if !env2[:result]
+                b3.use StopInstance
+              end
+            end
+            b2.use Export
+            b2.use Package
+          end
+        end
+      end
+
+      def self.action_rdp
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t("vagrant_hyperv.message_not_created")
+              next
+            end
+
+            b2.use Call, IsState, :running do |env1, b3|
+              if !env1[:result]
+                b3.use Message, I18n.t("vagrant_win_hyperv.message_rdp_not_ready")
+                next
+              end
+
+              b3.use Rdp
+            end
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsState, :not_created do |env1, b1|
+            if env1[:result]
+              b1.use Message, I18n.t("vagrant_hyperv.message_not_created")
+              next
+            end
+            b1.use Call, IsState, :running do |env2, b2|
+              if !env2[:result]
+                b2.use Message, I18n.t("vagrant_hyperv.message_not_running")
+              else
+                b2.use Provision
+              end
+            end
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :Export, action_root.join("export")
+      autoload :Package, action_root.join("package")
+      autoload :Rdp, action_root.join("rdp")
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/action/export.rb

@@ -0,0 +1,54 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require "fileutils"
+
+module VagrantPlugins
+  module VagrantHyperV
+    module Action
+      class Export
+         attr_reader :temp_dir
+         def initialize(app, env)
+           @app = app
+         end
+
+         def call(env)
+           @env = env
+
+           raise "Please off the machine before package" if \
+             @env[:machine].provider.state.id != :off
+
+           @temp_dir = env[:tmp_path].join(Time.now.to_i.to_s)
+           export
+           add_metadata_json
+
+           @app.call(env)
+
+           recover(env) # called to cleanup temp directory
+         end
+
+         def recover(env)
+           if temp_dir && File.exist?(temp_dir)
+             FileUtils.rm_rf(temp_dir)
+           end
+         end
+
+         def export
+           @env[:ui].info('Exporting the VM, this process may take a while.')
+           result = @env[:machine].provider.driver.export_vm_to(temp_dir.to_s)
+           # Hyper-V Exports the VM under the VM's name in to the temp directory.
+           # Set the package directory to this folder, all files should go into this folder
+           @env["package.directory"] = temp_dir.join(result["name"])
+         end
+
+         def add_metadata_json
+           File.open(File.join(@env["package.directory"], "metadata.json"), "w") do |f|
+             f.write(' { "provider" : "hyperv" }')
+           end
+         end
+      end
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/action/package.rb

@@ -0,0 +1,21 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require 'vagrant/action/general/package'
+
+module VagrantPlugins
+  module VagrantHyperV
+    module Action
+      class Package < Vagrant::Action::General::Package
+        # Doing this so that we can test that the parent is properly
+        # called in the unit tests.
+        alias_method :general_call, :call
+        def call(env)
+          general_call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/action/rdp.rb

@@ -0,0 +1,49 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require "log4r"
+require "pathname"
+require "vagrant/util/powershell"
+
+module VagrantPlugins
+  module VagrantHyperV
+    module Action
+      # This action generates a .rdp file into the root path of the project.
+      # and establishes a RDP session with necessary resource sharing
+      class Rdp
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::hyperv::rdp")
+        end
+
+        def call(env)
+          if env[:machine].config.vm.guest != :windows
+            raise Errors::RDPNotAvailable,
+              guest: env[:machine].config.vm.guest
+          end
+          @env = env
+          @env[:ui].detail I18n.t("vagrant_win_hyperv.generating_rdp")
+          generate_rdp_file
+          command = ["mstsc", "machine.rdp"]
+          Vagrant::Util::PowerShell.execute(*command)
+        end
+
+        def generate_rdp_file
+          ssh_info = @env[:machine].ssh_info
+          rdp_options = {
+            "username:s" => ssh_info[:username],
+            "prompt for credentials:i" => "1",
+            "full address:s" => ssh_info[:host]
+          }
+          file = File.open("machine.rdp", "w")
+            rdp_options.each do |key, value|
+              file.puts "#{key}:#{value}"
+          end
+          file.close
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/action/setup_package_files.rb

@@ -0,0 +1,55 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+module VagrantPlugins
+  module VagrantHyperV
+    module Action
+      class SetupPackageFiles
+        def initialize(app, env)
+          @app = app
+
+          env["package.include"] ||= []
+          env["package.vagrantfile"] ||= nil
+        end
+
+        def call(env)
+          files = {}
+          env["package.include"].each do |file|
+            source = Pathname.new(file)
+            dest   = nil
+
+            # If the source is relative then we add the file as-is to the include
+            # directory. Otherwise, we copy only the file into the root of the
+            # include directory. Kind of strange, but seems to match what people
+            # expect based on history.
+            if source.relative?
+              dest = source
+            else
+              dest = source.basename
+            end
+
+            # Assign the mapping
+            files[file] = dest
+          end
+
+          if env["package.vagrantfile"]
+            # Vagrantfiles are treated special and mapped to a specific file
+            files[env["package.vagrantfile"]] = "_Vagrantfile"
+          end
+
+          # Verify the mapping
+          files.each do |from, _|
+            raise "File do not exist #{file}" if !File.exist?(from)
+          end
+
+          # Save the mapping
+          env["package.files"] = files
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end