vagrant-windows-domain 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32c0962897914ab1f2665b2ee83e436403d1c7d6
+  data.tar.gz: 6b9f71576ad54801a1325ed828d8a04b614e186b
+SHA512:
+  metadata.gz: a2a5bba2574096eb6dd50802d44f87b1a20e94caee7f9191dfa686cef067c16b86ca4953c97d40e3203373eed09d5eaec89d28b77a4df6ca6a5f2af473dec6b7
+  data.tar.gz: a15ef170cca8c7b9d8424d1e35d71d8447c3e49567fe9b74c36b6e69e31a99e7146f72dbcd9ac99679efc327a5dc19a824d4ec700e72f3c5ed6f24ef8d66f668

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.vagrant
+.idea

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+before_install:
+- rvm @global do gem uninstall bundler --all --executables
+- gem uninstall bundler --all --executables
+- gem install bundler --version '< 1.7.0'
+rvm:
+- 2.0.0
+- 2.1.0
+- ruby-head
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  fast_finish: true
+env:
+  matrix:
+  - VAGRANT_VERSION=v1.6.5
+  global:
+    secure: bs4ezY+1Wksy8hH3nymPJ3AL99mpXULVc/AIh16JetEYw1850QkX7r4gQukMlcyByKUhxucjDLid0Y+KDH5kGMM16QjrVQGhAnUQzMoLD2qPbAaxDCUqpCJtFEEQKYxJvFvEK8a5SQzAsTVG4sgABQ/MllsIIH0FjkWgFtH6050=
+script: bundle exec rake test:unit

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-windows-domain.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-windows-domain", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Fellows
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Vagrant Windows Domain Plugin
+
+[![Build Status](https://travis-ci.org/SEEK-Jobs/vagrant-windows-domain.svg)](https://travis-ci.org/SEEK-Jobs/vagrant-windows-domain)
+[![Coverage Status](https://coveralls.io/repos/SEEK-Jobs/vagrant-windows-domain/badge.svg?branch=master)](https://coveralls.io/r/SEEK-Jobs/vagrant-windows-domain?branch=master)
+[![Gem Version](https://badge.fury.io/rb/vagrant-windows-domain.svg)](http://badge.fury.io/rb/vagrant-windows-domain)
+
+A Vagrant Plugin that makes connecting and disconnecting your Windows Vagrant box to a Windows Domain a cinch.
+
+On a `vagrant up` - unless credentials are supplied - it will prompt the user for their domain credentials and add the guest to the domain, including restarting the guest without interfering with other provisioners. 
+
+On a `vagrant destroy`, it will do the same and remove itself from the Domain, keeping things neat-n-tidy.
+
+## Installation
+
+```vagrant plugin install vagrant-windows-domain```
+
+## Usage
+
+In your Vagrantfile, add the following plugin and configure to your needs:
+
+```ruby
+config.vm.provision :windows_domain do |domain|
+
+    # The Windows Domain to join.
+    #
+    # Setting this will result in an additional restart.
+    domain.domain = "domain.int"
+
+    # The new Computer Name to use when joining the domain.
+    #
+    # Uses the Rename-Computer PowerShell command. ORRRR -NewName flag??
+    # Specifies a new name for the computer in the new domain.
+    domain.computer_name "myfandangledname"
+
+    # The Username to use when authenticating against the Domain.
+    #
+    # Specifies a user account that has permission to join the computers to a new domain. 
+    #
+    # If not supplied the plugin will prompt the user during provisioning to provide one.
+    domain.username = "me"
+
+    # The Password to use when authenticating against the Domain.
+    #
+    # Specifies the password of a user account that has permission to 
+    # join the computers to a new domain. 
+    #
+    # If not supplied the plugin will prompt the user during provisioning to provide one.
+    domain.password = "iprobablyshouldntusethisfield"
+
+    # The set of Advanced options to pass when joining the Domain.
+    #
+    # See (https://technet.microsoft.com/en-us/library/hh849798.aspx) for detail, these are generally not required.
+    domain.join_options = { "--JoinReadOnly" => "" }
+
+    # Organisational Unit path in AD.
+    #
+    # Specifies an organizational unit (OU) for the domain account. 
+    # Enter the full distinguished name of the OU in quotation marks. 
+    # The default value is the default OU for machine objects in the domain.
+    domain.ou_path = "OU=testOU,DC=domain,DC=Domain,DC=com"
+
+    # Performs an unsecure join to the specified domain.
+    #
+    # When this option is enabled username/password are not required and cannot be used.
+    domain.unsecure = false
+end
+```
+## Example
+
+There is a [sample](https://github.com/SEEK-Jobs/vagrant-windows-domain/tree/master/development) Vagrant setup used for development of this plugin. 
+This is a great real-life example to get you on your way.
+
+### Supported Environments
+
+Currently the plugin supports any Windows environment with Powershell 3+ installed (2008r2, 2012r2 should work nicely).
+
+## Uninistallation
+
+```vagrant plugin uninstall vagrant-windows-domain```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/vagrant-windows-domain/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Squash commits & push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => [:test, :quality]
+# Remove 'install' task as the gem is installed to Vagrant, not to system
+Rake::Task[:install].clear
+namespace :test do
+  RSpec::Core::RakeTask.new('unit') do |task|
+    task.pattern = 'spec/**/*_spec.rb'
+  end
+end
+desc "Run all tests"
+task :test => ['test:unit']
+task :spec => :test

data/development/Vagrantfile

@@ -0,0 +1,64 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+$shell_script = <<SCRIPT
+  Write-Host "Hey, this happened after the restart!"
+SCRIPT
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  
+  config.vm.box = "mfellows/windows2012r2"
+  config.vm.guest = :windows
+  config.vm.communicator = "winrm"
+  config.vm.network :forwarded_port, guest: 5985, host: 5985, id: "winrm", auto_correct: true
+
+  # Run Windows Domain Provisioner
+  config.vm.provision :windows_domain do |domain|
+
+    # The Windows Domain to join.
+    #
+    # Setting this will result in an additional restart.
+    domain.domain = "domain.int"
+
+    # The new Computer Name to use when joining the domain.
+    #
+    # Uses the Rename-Computer PowerShell command. ORRRR -NewName flag??
+    # Specifies a new name for the computer in the new domain.
+    domain.computer_name "myfandangledname"
+
+    # The Username to use when authenticating against the Domain.
+    #
+    # Specifies a user account that has permission to join the computers to a new domain. 
+    domain.username = "me"
+
+    # The Password to use when authenticating against the Domain.
+    #
+    # Specifies the password of a user account that has permission to 
+    # join the computers to a new domain. 
+    domain.password = "iprobablyshouldntusethisfield"
+
+    # The set of Advanced options to pass when joining the Domain.
+    #
+    # See (https://technet.microsoft.com/en-us/library/hh849798.aspx) for detail.
+    # NOTE: If we user :computer_name from above this needs to be merged!!
+    domain.join_options
+
+    # Organisational Unit path in AD.
+    #
+    # Specifies an organizational unit (OU) for the domain account. 
+    # Enter the full distinguished name of the OU in quotation marks. 
+    # The default value is the default OU for machine objects in the domain.
+    domain.ou_path
+
+    # Performs an unsecure join to the specified domain.
+    #
+    # When this option is used username/password are not required
+    domain.unsecure
+  end
+
+  # Confirm that this will run after the reload from the domain provisioner!
+  config.vm.provision "shell", inline: $shell_script  
+end

data/lib/vagrant-windows-domain.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-windows-domain/plugin"
+
+module VagrantPlugins
+  module WindowsDomain
+    lib_path = Pathname.new(File.expand_path("../vagrant-windows-domain", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../lib", __FILE__))
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+require "vagrant/util/counter"
+require "log4r"
+
+module VagrantPlugins
+  module WindowsDomain    
+    # The "Configuration" represents a configuration of how the WindowsDomain
+    # provisioner should behave: authentication mechanism etc.
+    class Config < Vagrant.plugin("2", :config)
+
+      # The Windows Domain to join.
+      #
+      # Setting this will result in an additional restart.
+      attr_accessor :domain
+
+      # The new Computer Name to use when joining the domain.
+      #
+      # Uses the Rename-Computer PowerShell command. ORRRR -NewName flag??
+      # Specifies a new name for the computer in the new domain.
+      attr_accessor :computer_name
+
+      # The Username to use when authenticating against the Domain.
+      #
+      # Specifies a user account that has permission to join the computers to a new domain. 
+      attr_accessor :username
+
+      # The Password to use when authenticating against the Domain.
+      #
+      # Specifies the password of a user account that has permission to 
+      # join the computers to a new domain. 
+      attr_accessor :password
+
+      # The set of Advanced options to pass when joining the Domain.
+      #
+      # See (https://technet.microsoft.com/en-us/library/hh849798.aspx) for detail.
+      # NOTE: If we user :computer_name from above this needs to be merged!!
+      attr_accessor :join_options
+
+      # Organisational Unit path in AD.
+      #
+      # Specifies an organizational unit (OU) for the domain account. 
+      # Enter the full distinguished name of the OU in quotation marks. 
+      # The default value is the default OU for machine objects in the domain.
+      attr_accessor :ou_path
+
+      # Performs an unsecure join to the specified domain.
+      #
+      # When this option is used username/password are not required
+      attr_accessor :unsecure
+
+      # The current Computer Name.
+      #
+      # Used to determine whether or not we need to rename the computer 
+      # on join. This parameter should not be manually set.
+      attr_accessor :old_computer_name      
+
+      def initialize
+        super
+        @domain            = UNSET_VALUE
+        @computer_name     = UNSET_VALUE
+        @username          = UNSET_VALUE
+        @password          = UNSET_VALUE
+        @join_options      = {}
+        @ou_path           = UNSET_VALUE
+        @unsecure          = UNSET_VALUE
+        @logger            = Log4r::Logger.new("vagrant::vagrant_windows_domain")
+      end
+
+      # Final step of the Configuration lifecyle prior to
+      # validation.
+      #
+      # Ensures all attributes are set to defaults if not provided.
+      def finalize!
+        super
+
+        # Null checks
+        @domain            = nil if @domain == UNSET_VALUE || @domain == ""
+        @computer_name     = nil if @computer_name == UNSET_VALUE || @computer_name == ""
+        @username          = nil if @username == UNSET_VALUE || @username == ""
+        @password          = nil if @password == UNSET_VALUE || @password == ""
+        @join_options      = {} if @join_options == UNSET_VALUE
+        @ou_path           = nil if @ou_path == UNSET_VALUE
+        @unsecure          = false if @unsecure == UNSET_VALUE
+      end
+
+      # Validate configuration and return a hash of errors.
+      #
+      # Validation happens after finalize!.
+      #
+      # @param [Machine] The current {Machine}
+      # @return [Hash] Any errors or {} if no errors found
+      def validate(machine)
+        @old_computer_name = get_guest_computer_name(machine)
+        
+        errors = _detected_errors
+
+        # Need to supply one of them!
+        if ( (@username != nil && @password != nil) && @unsecure == true)
+          errors << I18n.t("vagrant_windows_domain.errors.both_credentials_provided")
+        end
+        
+        { "windows domain provisioner" => errors }
+      end
+
+      # Gets the Computer Name from the guest machine
+      def get_guest_computer_name(machine)
+        computerName = ""
+        machine.communicate.shell.powershell("$env:COMPUTERNAME") do |type, data|
+          if !data.chomp.empty?
+            if [:stderr, :stdout].include?(type)
+              color = type == :stdout ? :green : :red
+              computerName = data.chomp
+              @logger.info("Detected guest computer name: #{computerName}")
+            end
+          end
+        end
+
+        computerName
+      end      
+    end
+  end
+end

data/lib/vagrant-windows-domain/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  vagrant_windows_domain:
+    already_status: |-
+      The machine is already %{status}.
+
+    running: |-
+      "Running Windows Domain Provisioner"
+
+    errors:
+      unsupported_platform: |-
+        Unsupported platform detected. Vagrant Windows Domain only works on Windows guest environments.
+      both_credentials_provided: |-
+        You must not supply a "username" and "password" if "unsecure" is set to true.
+      binary_not_detected: |-
+        "The command '%{binary} required to join/remove the guest machine from the domain '%{domain}' was not found on the guest machine"
+      absolute_module_path: |-
+        "Absolute 'module_path' not allowed. Please provide a path relative to your Vagrantfile."

data/lib/vagrant-windows-domain/plugin.rb

@@ -0,0 +1,23 @@
+require "vagrant"
+
+module VagrantPlugins
+  module WindowsDomain
+    class Plugin < Vagrant.plugin("2")
+      name "DSC"
+      description <<-DESC
+        Provides support for adding and removing guest Windows machines
+        from a Domain.
+      DESC
+
+      config(:windows_domain, :provisioner) do
+        require_relative 'config'
+        Config
+      end
+
+      provisioner(:windows_domain) do
+        require_relative 'provisioner'
+        Provisioner
+      end
+    end
+  end
+end

data/lib/vagrant-windows-domain/provisioner.rb

@@ -0,0 +1,193 @@
+require "log4r"
+require 'erb'
+
+module VagrantPlugins
+  module WindowsDomain
+    # DSC Errors namespace, including setup of locale-based error messages.
+    class WindowsDomainError < Vagrant::Errors::VagrantError
+      error_namespace("vagrant_windows_domain.errors")
+      I18n.load_path << File.expand_path("locales/en.yml", File.dirname(__FILE__))
+    end
+    class DSCUnsupportedOperation < WindowsDomainError
+      error_key(:unsupported_operation)
+    end    
+
+    # Windows Domain Provisioner Plugin.
+    #
+    # Connects and Removes a guest Machine from a Windows Domain.
+    class Provisioner < Vagrant.plugin("2", :provisioner)
+
+      # Default path for storing the transient script runner
+      WINDOWS_DOMAIN_GUEST_RUNNER_PATH = "c:/tmp/vagrant-windows-domain-runner.ps1"
+
+      # Constructs the Provisioner Plugin.
+      #
+      # @param [Machine] machine The guest machine that is to be provisioned.
+      # @param [Config] config The Configuration object used by the Provisioner.
+      # @returns Provisioner
+      def initialize(machine, config)
+        super
+
+        @logger = Log4r::Logger.new("vagrant::provisioners::vagrant_windows_domain")
+      end
+
+      # Configures the Provisioner.
+      #
+      # @param [Config] root_config The default configuration from the Vagrant hierarchy.
+      def configure(root_config)
+        raise WindowsDomainError, :unsupported_platform if !windows?
+
+        verify_guest_capability
+      end
+
+      # Run the Provisioner!
+      def provision
+        @machine.env.ui.say(:info, "Connecting guest machine to domain '#{config.domain}' with computer name '#{config.computer_name}'")
+
+        set_credentials
+
+        join_domain
+
+        restart_guest
+      end
+
+      # Join the guest machine to a Windows Domain.
+      #
+      # Generates, writes and runs a script to join a domain.
+      def join_domain        
+        run_remote_command_runner(write_command_runner_script(generate_command_runner_script(true)))
+      end
+
+      # Removes the guest machine from a Windows Domain.
+      #
+      # Generates, writes and runs a script to leave a domain.
+      def leave_domain
+        run_remote_command_runner(write_command_runner_script(generate_command_runner_script(false)))
+      end
+      alias_method :unjoin_domain, :leave_domain
+
+      # Ensure credentials are provided.
+      #
+      # Get username/password from user if not provided
+      # as part of the config.
+      def set_credentials
+        if (config.username == nil)
+          @logger.info("==> Requesting username as none provided")
+          config.username = @machine.env.ui.ask("Please enter your domain username: ")
+        end
+
+        if (config.password == nil)
+          @logger.info("==> Requesting password as none provided")
+          config.password = @machine.env.ui.ask("Please enter your domain password (output will be hidden): ", {:echo => false})
+        end
+      end
+
+      # Cleanup after a destroy action.
+      #
+      # This is the method called when destroying a machine that allows
+      # for any state related to the machine created by the provisioner
+      # to be cleaned up.
+      def cleanup        
+        set_credentials
+        leave_domain
+
+      end
+
+      # Restarts the Computer and waits
+      def restart_guest
+        @machine.env.ui.say(:info, "Restarting computer for updates to take effect.")
+        options = {}
+        options[:provision_ignore_sentinel] = false
+        @machine.action(:reload, options)
+        begin
+          sleep 10
+        end until @machine.communicate.ready?
+      end
+
+      # Verify that we can call the remote operations.
+      # Required to add the computer to a Domain.
+      def verify_guest_capability
+        verify_binary("Add-Computer")
+        verify_binary("Remove-Computer")
+      end
+
+      # Verify a binary\command is executable on the guest machine.
+      def verify_binary(binary)
+        @machine.communicate.sudo(
+          "which #{binary}",
+          error_class: WindowsDomainError,
+          error_key: :binary_not_detected,
+          domain: config.domain,
+          binary: binary)
+      end
+
+      # Generates a PowerShell runner script from an ERB template
+      #
+      # @param [boolean] add_to_domain Whether or not to add or remove the computer to the domain (default: true).
+      # @return [String] The interpolated PowerShell script.
+      def generate_command_runner_script(add_to_domain=true)
+        path = File.expand_path("../templates/runner.ps1", __FILE__)
+
+        script = Vagrant::Util::TemplateRenderer.render(path, options: {
+            config: @config,
+            username: @config.username,
+            password: @config.password,
+            domain: @config.domain,
+            add_to_domain: add_to_domain
+            # parameters: @config.join_options.map { |k,v| "#{k}" + (!v.nil? ? " \"#{v}\"": '') }.join(" ")
+        })
+      end
+
+      # Writes the PowerShell runner script to a location on the guest.
+      #
+      # @param [String] script The PowerShell runner script.
+      # @return [String] the Path to the uploaded location on the guest machine.
+      def write_command_runner_script(script)
+        guest_script_path = WINDOWS_DOMAIN_GUEST_RUNNER_PATH
+        file = Tempfile.new(["vagrant-windows-domain-runner", "ps1"])
+        begin
+          file.write(script)
+          file.fsync
+          file.close
+          @machine.communicate.upload(file.path, guest_script_path)
+        ensure
+          file.close
+          file.unlink
+        end
+        guest_script_path
+      end
+
+      # Runs the PowerShell script on the guest machine.
+      def run_remote_command_runner(script_path)
+        command = ". '#{script_path}'"
+
+        @machine.ui.info(I18n.t(
+          "vagrant_windows_domain.running"))
+
+        opts = {
+          elevated: true,
+          error_key: :ssh_bad_exit_status_muted,
+          good_exit: 0,
+          shell: :powershell
+        }
+
+        @machine.communicate.sudo(command, opts) do |type, data|
+          if !data.chomp.empty?
+            if [:stderr, :stdout].include?(type)
+              color = type == :stdout ? :green : :red
+              @machine.ui.info(
+                data.chomp,
+                color: color, new_line: false, prefix: false)
+            end
+          end
+        end
+      end
+
+      # If on using WinRM, we can assume we are on Windows
+      def windows?
+        @machine.config.vm.communicator == :winrm
+      end
+
+    end
+  end
+end

data/lib/vagrant-windows-domain/templates/runner.ps1.erb

@@ -0,0 +1,9 @@
+$secpasswd = ConvertTo-SecureString "<%= options[:password] %>" -AsPlainText -Force
+$credentials = New-Object System.Management.Automation.PSCredential ("<%= options[:username] %>", $secpasswd)
+
+<% if options[:add_to_domain] === true %>
+echo "Add-Computer"
+Add-Computer -DomainName <%= options[:domain] %> -Credential $credentials -Verbose -Force #-WhatIf
+<% else %>
+Remove-Computer -UnjoinDomainCredential $credentials -Verbose -Force
+<% end %>

data/lib/vagrant-windows-domain/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module WindowsDomain
+    VERSION = "1.0.0"
+  end
+end

data/spec/base.rb

@@ -0,0 +1,54 @@
+shared_context "unit" do
+  before(:each) do
+    # State to store the list of registered plugins that we have to
+    # unregister later.
+    @_plugins = []
+
+    # Create a thing to store our temporary files so that they aren't
+    # unlinked right away.
+    @_temp_files = []
+  end
+
+  # This helper creates a temporary file and returns a Pathname
+  # object pointed to it.
+  #
+  # @return [Pathname]
+  def temporary_file(contents=nil)
+    f = Tempfile.new("vagrant-unit")
+
+    if contents
+      f.write(contents)
+      f.flush
+    end
+
+    # Store the tempfile in an instance variable so that it is not
+    # garbage collected, so that the tempfile is not unlinked.
+    @_temp_files << f
+
+    return Pathname.new(f.path)
+  end
+
+  # Asserts that the current (config) validation run should fail.
+  # Any error message is sufficient.
+  def assert_invalid
+    errors = subject.validate(machine)
+    if !errors.values.any? { |v| !v.empty? }
+      raise "No errors: #{errors.inspect}"
+    end
+  end
+
+  # Asserts that the current (config) validation should fail with a specific message.
+  def assert_error(error)
+    errors = subject.validate(machine)
+    raise "Error #{error} was not raised" if !errors["windows domain provisioner"].include? error
+  end
+
+  # Asserts that no failures should occur in the current (config) validation run.
+  def assert_valid
+    errors = subject.validate(machine)
+    if !errors.values.all? { |v| v.empty? }
+      raise "Errors: #{errors.inspect}"
+    end
+  end
+
+end

data/spec/provisioner/config_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'vagrant-windows-domain/provisioner'
+require 'vagrant-windows-domain/config'
+require 'base'
+
+describe VagrantPlugins::WindowsDomain::Config do
+  include_context "unit"
+  let(:instance) { described_class.new }
+  let(:machine) { double("machine") }
+
+ let(:root_path)           { (Pathname.new(Dir.mktmpdir)).to_s }
+  let(:ui)                  { Vagrant::UI::Silent.new }
+  let(:machine)             { double("machine", ui: ui) }
+  let(:env)                 { double("environment", root_path: root_path, ui: ui) }
+  let(:vm)                  { double ("vm") }
+  let(:communicator)        { double ("communicator") }
+  let(:shell)               { double ("shell") }
+  let(:powershell)          { double ("powershell") }
+  let(:guest)               { double ("guest") }
+  let(:configuration_file)  { "manifests/MyWebsite.ps1" }
+  let(:module_path)         { ["foo/modules", "foo/modules2"] }
+  let(:root_config)         { VagrantPlugins::DSC::Config.new }
+  # subject                   { described_class.new machine, root_config }
+
+  describe "defaults (finalize!)" do
+
+    before do
+      env = double("environment", root_path: "/tmp/vagrant-windows-domain-path")
+      config = double("config")
+      machine.stub(config: config, env: env)
+    end
+
+    before { subject.finalize! }
+
+    its("domain")            { should be_nil }
+    its("computer_name")     { should eq(nil) }
+    its("username")          { should be_nil }
+    its("password")          { should be_nil }
+    its("join_options")      { should eq({})   }
+    its("ou_path")           { should be_nil }
+    its("unsecure")          { should eq(false) }
+
+    it "should ignore empty strings" do
+      subject.domain = ""
+      subject.username = ""
+      subject.password = ""
+      subject.computer_name = ""
+      
+      subject.finalize!
+
+      expect(subject.domain).to be_nil
+      expect(subject.computer_name).to be_nil
+      expect(subject.username).to be_nil
+      expect(subject.password).to be_nil
+    end
+  end
+
+  describe "validate settings" do
+    before do
+      env = double("environment", root_path: "/tmp/vagrant-windows-domain-path")
+      config = double("config")
+      machine.stub(config: config, env: env)
+      allow(machine).to receive(:communicate).and_return(communicator)
+      allow(communicator).to receive(:shell).and_return(shell)
+      allow(shell).to receive(:powershell).and_yield(:stdout, "myoldcomputername")
+    end
+
+    before { subject.finalize! }
+
+    it "should be invalid if either 'username' and 'password' or 'unsecure' are both provided" do
+      subject.username = "myusername"
+      subject.password = "mypassword"
+      subject.unsecure = true
+      subject.validate(machine)
+
+      assert_invalid
+      assert_error("You must not supply a \"username\" and \"password\" if \"unsecure\" is set to true.")
+    end
+
+    it "should detect the current computers' name" do
+      subject.validate(machine)
+      expect(subject.old_computer_name).to eq("myoldcomputername")
+    end
+
+  end
+
+end

data/spec/provisioner/provisioner_spec.rb

@@ -0,0 +1,197 @@
+require 'spec_helper'
+require 'vagrant-windows-domain/provisioner'
+require 'vagrant-windows-domain/config'
+require 'rspec/its'
+
+describe VagrantPlugins::WindowsDomain::Provisioner do
+  include_context "unit"
+
+  let(:root_path)           { (Pathname.new(Dir.mktmpdir)).to_s }
+  let(:ui)                  { Vagrant::UI::Silent.new }
+  let(:machine)             { double("machine", ui: ui) }
+  let(:env)                 { double("environment", root_path: root_path, ui: ui) }
+  let(:vm)                  { double ("vm") }
+  let(:communicator)        { double ("communicator") }
+  let(:shell)               { double ("shell") }
+  let(:powershell)          { double ("powershell") }
+  let(:guest)               { double ("guest") }
+  let(:configuration_file)  { "manifests/MyWebsite.ps1" }
+  let(:module_path)         { ["foo/modules", "foo/modules2"] }
+  let(:root_config)         { VagrantPlugins::WindowsDomain::Config.new }
+  subject                   { described_class.new machine, root_config }
+
+  describe "configure" do
+    before do
+      allow(machine).to receive(:root_config).and_return(root_config)
+      machine.stub(config: root_config, env: env)
+
+      allow(machine).to receive(:communicate).and_return(communicator)
+      allow(communicator).to receive(:shell).and_return(shell)
+      allow(shell).to receive(:powershell).with("$env:COMPUTERNAME").and_yield(:stdout, "myoldcomputername")      
+      allow(root_config).to receive(:vm).and_return(vm)
+      allow(vm).to receive(:communicator).and_return(:winrm)
+      root_config.finalize!
+      root_config.validate(machine)
+    end
+
+    it "should confirm if the OS is Windows" do
+      allow(communicator).to receive(:sudo).twice
+      expect(subject.windows?).to eq(true)
+      subject.configure(root_config)
+    end
+
+    it "should error if the detected OS is not Windows" do
+      allow(vm).to receive(:communicator).and_return(:ssh)
+      expect { subject.configure(root_config) }.to raise_error("Unsupported platform detected. Vagrant Windows Domain only works on Windows guest environments.")
+    end
+
+    it "should verify the guest has the required powershell cmdlets/capabilities" do
+      expect(communicator).to receive(:sudo).with("which Add-Computer", {:error_class=>VagrantPlugins::WindowsDomain::WindowsDomainError, :error_key=>:binary_not_detected, :domain=>nil, :binary=>"Add-Computer"})
+      expect(communicator).to receive(:sudo).with("which Remove-Computer", {:error_class=>VagrantPlugins::WindowsDomain::WindowsDomainError, :error_key=>:binary_not_detected, :domain=>nil, :binary=>"Remove-Computer"})
+      subject.configure(root_config)
+    end
+  end
+
+  describe "provision" do
+
+    # before do
+    #   # allow(root_config).to receive(:vm).and_return(vm)
+    #   allow(machine).to receive(:root_config).and_return(root_config)
+    #   allow(machine).to receive(:env).and_return(env)
+    #   root_config.finalize!
+    #   root_config.validate(machine)
+    #   subject.configure(root_config)
+    #   machine.stub(config: root_config, env: env, communicate: communicator, guest: guest)
+    # end
+
+    it "should join the domain" do
+
+    end
+
+    it "should restart the machine on a successful domain join" do
+
+    end
+
+    it "should not attempt to join the domain if already on it" do
+
+    end
+
+    it "should authenticate with credentials if provided" do
+
+    end
+
+    it "should prompt for credentials if not provided" do
+    
+    end
+
+    it "should remove any traces of credentials once provisioning has occurred" do
+
+    end
+
+  end
+
+  describe "cleanup" do
+
+    it "should leave domain when a `vagrant destroy` is issued" do
+
+    end
+
+  end
+
+  # describe "Powershell runner script" do
+#     before do
+#       # Prevent counters messing with output in tests
+#       Vagrant::Util::Counter.class_eval do
+#         def get_and_update_counter(name=nil) 1 end
+#       end
+
+#       allow(machine).to receive(:root_config).and_return(root_config)
+#       root_config.configuration_file = configuration_file
+#       machine.stub(config: root_config, env: env)
+#       root_config.module_path = module_path
+#       root_config.configuration_file = configuration_file
+#       root_config.finalize!
+#       root_config.validate(machine)
+#       subject.configure(root_config)
+
+#     end
+
+#     context "with default parameters" do
+#       it "should generate a valid powershell command" do
+#         script = subject.generate_dsc_runner_script
+#         expect_script = "#
+# # DSC Runner.
+# #
+# # Bootstraps the DSC environment, sets up configuration data
+# # and runs the DSC Configuration.
+# #
+# #
+
+# # Set the local PowerShell Module environment path
+# $absoluteModulePaths = [string]::Join(\";\", (\"/tmp/vagrant-windows-domain-1/modules-0;/tmp/vagrant-windows-domain-1/modules-1\".Split(\";\") | ForEach-Object { $_ | Resolve-Path }))
+
+# echo \"Adding to path: $absoluteModulePaths\"
+# $env:PSModulePath=\"$absoluteModulePaths;${env:PSModulePath}\"
+# (\"/tmp/vagrant-windows-domain-1/modules-0;/tmp/vagrant-windows-domain-1/modules-1\".Split(\";\") | ForEach-Object { gci -Recurse  $_ | ForEach-Object { Unblock-File  $_.FullName} })
+
+# $script = $(Join-Path \"/tmp/vagrant-windows-domain-1\" \"manifests/MyWebsite.ps1\" -Resolve)
+# echo \"PSModulePath Configured: ${env:PSModulePath}\"
+# echo \"Running Configuration file: ${script}\"
+
+# # Generate the MOF file, only if a MOF path not already provided.
+# # Import the Manifest
+# . $script
+
+# cd \"/tmp/vagrant-windows-domain-1\"
+# $StagingPath = $(Join-Path \"/tmp/vagrant-windows-domain-1\" \"staging\")
+# $response = MyWebsite -OutputPath $StagingPath  4>&1 5>&1 | Out-String
+
+# # Start a DSC Configuration run
+# $response += Start-DscConfiguration -Force -Wait -Verbose -Path $StagingPath 4>&1 5>&1 | Out-String
+# $response"
+
+#         expect(script).to eq(expect_script)
+#       end
+#     end
+
+#   end
+
+#   describe "write DSC Runner script" do
+#     it "should upload the customised DSC runner to the guest" do
+#       script = "myscript"
+#       path = "/local/runner/path"
+#       guest_path = "c:/tmp/vagrant-windows-domain-runner.ps1"
+#       machine.stub(config: root_config, env: env, communicate: communicator)
+#       file = double("file")
+#       allow(file).to receive(:path).and_return(path)
+#       allow(Tempfile).to receive(:new) { file }
+#       expect(file).to receive(:write).with(script)
+#       expect(file).to receive(:fsync)
+#       expect(file).to receive(:close).exactly(2).times
+#       expect(file).to receive(:unlink)
+#       expect(communicator).to receive(:upload).with(path, guest_path)
+#       res = subject.write_dsc_runner_script(script)
+#       expect(res.to_s).to eq(guest_path)
+#     end
+#   end
+
+#   describe "Apply DSC" do
+#     it "should invoke the DSC Runner and notify the User of provisioning status" do
+#       expect(ui).to receive(:info).with(any_args).once
+#       expect(ui).to receive(:info).with("provisioned!", {color: :green, new_line: false, prefix: false}).once
+#       allow(machine).to receive(:communicate).and_return(communicator)
+#       expect(communicator).to receive(:sudo).with('. ' + "'c:/tmp/vagrant-windows-domain-runner.ps1'",{:elevated=>true, :error_key=>:ssh_bad_exit_status_muted, :good_exit=>0, :shell=>:powershell}).and_yield(:stdout, "provisioned!")
+
+#       subject.run_dsc_apply
+#     end
+
+#     it "should show error output in red" do
+#       expect(ui).to receive(:info).with(any_args).once
+#       expect(ui).to receive(:info).with("provisioned!", {color: :red, new_line: false, prefix: false}).once
+#       allow(machine).to receive(:communicate).and_return(communicator)
+#       expect(communicator).to receive(:sudo).with('. ' + "'c:/tmp/vagrant-windows-domain-runner.ps1'",{:elevated=>true, :error_key=>:ssh_bad_exit_status_muted, :good_exit=>0, :shell=>:powershell}).and_yield(:stderr, "provisioned!")
+
+#       subject.run_dsc_apply
+    # end
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+require 'coveralls'
+
+require 'vagrant-windows-domain/version'
+require 'vagrant-windows-domain/plugin'
+require 'rspec/its'
+require 'base'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  coverage_dir('tmp/coverage')
+  add_filter '/spec/'
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.color = true
+  config.tty = true
+end

data/vagrant-windows-domain.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-windows-domain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-windows-domain"
+  spec.version       = Vagrant::WindowsDomain::VERSION
+  spec.authors       = ["Matt Fellows"]
+  spec.email         = ["matt.fellows@onegeek.com.au"]
+  spec.summary       = "Windows Domain Provisioner for Vagrant"
+  spec.description   = "Adds and Removes Windows Guests from a Windows Domain, as part of the standard machine lifecycle."
+  spec.homepage      = "https://github.com/SEEK-Jobs/vagrant-windows-domain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", '~> 10.3', '>= 10.3.0'
+  spec.add_development_dependency "bundler", "~> 1.6", '>= 1.6.0'
+  spec.add_development_dependency "coveralls", "~> 0.7.1", '>= 0.7.1'
+  spec.add_development_dependency "rspec-core", '~> 3.1', '>= 3.1.0'
+  spec.add_development_dependency "rspec-expectations", '~> 3.1', '>= 3.1.0'
+  spec.add_development_dependency "rspec-mocks", '~> 3.1', '>= 3.1.0'
+  spec.add_development_dependency "rspec-its", "~> 1.0.1", '>= 1.0.0'
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-windows-domain
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Fellows
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Adds and Removes Windows Guests from a Windows Domain, as part of the
+  standard machine lifecycle.
+email:
+- matt.fellows@onegeek.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- development/Vagrantfile
+- lib/vagrant-windows-domain.rb
+- lib/vagrant-windows-domain/config.rb
+- lib/vagrant-windows-domain/locales/en.yml
+- lib/vagrant-windows-domain/plugin.rb
+- lib/vagrant-windows-domain/provisioner.rb
+- lib/vagrant-windows-domain/templates/runner.ps1.erb
+- lib/vagrant-windows-domain/version.rb
+- spec/base.rb
+- spec/provisioner/config_spec.rb
+- spec/provisioner/provisioner_spec.rb
+- spec/spec_helper.rb
+- vagrant-windows-domain.gemspec
+homepage: https://github.com/SEEK-Jobs/vagrant-windows-domain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Windows Domain Provisioner for Vagrant
+test_files:
+- spec/base.rb
+- spec/provisioner/config_spec.rb
+- spec/provisioner/provisioner_spec.rb
+- spec/spec_helper.rb