chef-provisioning-vsphere 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94f12572899fa323e4850f9dba56919e530f1286
-  data.tar.gz: 49bd4bee75b043471c114250d93684333ab42651
+  metadata.gz: e921ec7be5d161723bdd1e333b4d1a93ec4a9e09
+  data.tar.gz: 2f3c474699229fdfa75df67513b7570e1ce86c15
 SHA512:
-  metadata.gz: 45810258d60b403cddfd5bed2eda7ca8eec5332e0ad459d8e96bd6325b6200a55382f8bf686da79247c954978a282d375df47a17528533320d926ba3ebc46f7a
-  data.tar.gz: 37d60704a8f35eab4354877ee8ebc43d9191ee56af75b1f05146563309ad1faa9f2b7bf7e4492d2b4ff7fccd347969237b28a1418e073d46c3d5285e8c1b01d1
+  metadata.gz: 2e773ae65c3cefceb7f46a0d3c2dbc1a7242d80c3b1c998b35485027fb1dac2a15d97bae89d57b1194a7a3d87c6ac327229370ed18514b8fb2bd7cea3ce727c7
+  data.tar.gz: c3dccf9cb837eb675865706276cb5a0d1239488dbd4c23e21d8b57fb4cd3b26a92a641c844eb82a885b535417d5791e89b11bbb5b91de65d231a30346a1caba8

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,22 @@
+### Versions:
+<!--- Version of the software where you are encountering the issue --->
+<!-- You should probably update in this is not newest release.--->
+* Version of Chef-Provisioning:
+* Version of Chef-Provisioning-vSphere:
+
+### Platform Details
+<!--- What version of vSphere/vCenter are you running? What version of ESXi are you using too?--->
+* Version of vSphere/vCenter:
+* Version of ESXi:
+
+### Scenario:
+<!--- What you are trying to achieve and you can't?--->
+
+### Steps to Reproduce:
+<!--- If you are filing an issue what are the things we need to do in order to repro your problem? How are you using this cookbook or any resources it includes?--->
+
+### Expected Result:
+<!--- What are you expecting to happen as the consequence of above reproduction steps?--->
+
+### Actual Result:
+<!--- What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.--->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description
+
+<!--- Describe what this change achieves--->
+
+### Issues Resolved
+
+<!--- List any existing issues this PR resolves--->
+
+### Check List
+
+- [ ] All tests pass.
+- [ ] All style checks pass.
+- [ ] Functionality includes testing.
+- [ ] Functionality has been documented in the README if applicable

data/.gitignore

@@ -5,4 +5,6 @@ Gemfile.lock
 .envrc
 .ruby-version
 my_cookbook
-.DS_Store
+.DS_Store
+doc/
+.yardoc/

data/.travis.yml

@@ -5,6 +5,13 @@ branches:
     - master
 rvm:
   - 2.3.3
+  - 2.4.1
+
 script:
   - bundle exec rake style
   - bundle exec rake unit
+  - bundle exec rake yard
+
+matrix:
+  allow_failures:
+  - rvm: 2.3.3

data/CHANGELOG.md

@@ -1,7 +1,22 @@
 # Change Log
 
-## [2.0.2](https://github.com/chef-partners/chef-provisioning-vsphere/tree/2.0.2) (2017-05-13)
-[Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.0.0...2.0.2)
+## [2.0.3](https://github.com/chef-partners/chef-provisioning-vsphere/tree/2.0.3) (2017-05-22)
+[Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.0.2...2.0.3)
+
+**Closed issues:**
+
+- Patch on transport\_respond? [\#31](https://github.com/chef-partners/chef-provisioning-vsphere/issues/31)
+- Github Templates [\#28](https://github.com/chef-partners/chef-provisioning-vsphere/issues/28)
+
+**Merged pull requests:**
+
+- Patch on transport\_respond? [\#32](https://github.com/chef-partners/chef-provisioning-vsphere/pull/32) ([jcalonsoh](https://github.com/jcalonsoh))
+- Added github templates [\#30](https://github.com/chef-partners/chef-provisioning-vsphere/pull/30) ([jjasghar](https://github.com/jjasghar))
+- waffle.io Badge [\#29](https://github.com/chef-partners/chef-provisioning-vsphere/pull/29) ([waffle-iron](https://github.com/waffle-iron))
+- Time to do doc all the things! [\#27](https://github.com/chef-partners/chef-provisioning-vsphere/pull/27) ([jjasghar](https://github.com/jjasghar))
+
+## [v2.0.2](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.0.2) (2017-05-13)
+[Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.0.0...v2.0.2)
 
 **Closed issues:**
 

data/Gemfile

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem Version](https://img.shields.io/gem/v/chef-provisioning-vsphere.svg)][gem]
 [![Build Status](https://travis-ci.org/chef-partners/chef-provisioning-vsphere.svg?branch=master)][travis]
+[![Inline docs](http://inch-ci.org/github/chef-partners/chef-provisioning-vsphere.svg?branch=master)](http://inch-ci.org/github/chef-partners/chef-provisioning-vsphere)
+[![Stories in Ready](https://badge.waffle.io/chef-partners/chef-provisioning-vsphere.png?label=ready&title=Ready)](https://waffle.io/chef-partners/chef-provisioning-vsphere?utm_source=badge)
 
 This is a [chef-provisioning](https://github.com/chef/chef-provisioning) provisioner for [VMware vSphere](http://www.vmware.com/products/vsphere).
 
@@ -321,7 +323,7 @@ platforms:
             - 10
             - 10
             - 10
-            
+
 suites:
   - name: default
     runlist:
@@ -346,5 +348,7 @@ You can run then `kitchen diagnose` to verify the nodes and settings that will b
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+We have attempted to `TODO` markings. If you find one, whether it's documentation or a feature, it's a great place to start helping out. `$ grep -r "TODO" lib/`
+
 [gem]: https://rubygems.org/gems/chef-provisioning-vsphere
 [travis]: https://travis-ci.org/chef-partners/chef-provisioning-vsphere

data/Rakefile

@@ -1,34 +1,41 @@
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'chef/provisioning/vsphere_driver/version'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "chef/provisioning/vsphere_driver/version"
+require "rspec/core/rake_task"
+require "chefstyle"
+require "rubocop/rake_task"
+require "yard"
 
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/lib")
 
 RuboCop::RakeTask.new(:style) do |task|
-  task.options << '--display-cop-names'
+  task.options << "--display-cop-names"
 end
 
 RSpec::Core::RakeTask.new(:unit) do |task|
-  task.pattern = 'spec/unit_tests/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation']
+  task.pattern = "spec/unit_tests/*_spec.rb"
+  task.rspec_opts = ["--color", "-f documentation"]
 end
 
 RSpec::Core::RakeTask.new(:integration) do |task|
-  task.pattern = 'spec/integration_tests/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation', '--out rspec.txt']
+  task.pattern = "spec/integration_tests/*_spec.rb"
+  task.rspec_opts = ["--color", "-f documentation", "--out rspec.txt"]
 end
 
 begin
-  require 'github_changelog_generator/task'
+  require "github_changelog_generator/task"
 
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     config.future_release = ChefProvisioningVsphere::VERSION
     config.issues = true
   end
 rescue LoadError
-  puts 'github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs'
+  puts "github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs"
 end
 
-task default: [:unit]
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"] # optional
+  t.stats_options = ["--list-undoc"] # optional
+end
+
+task default: [:style, :unit]

data/chef-provisioning-vsphere.gemspec

@@ -1,37 +1,37 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/lib')
-require 'chef/provisioning/vsphere_driver/version'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/lib")
+require "chef/provisioning/vsphere_driver/version"
 
 Gem::Specification.new do |s|
-  s.name = 'chef-provisioning-vsphere'
+  s.name = "chef-provisioning-vsphere"
   s.version = ChefProvisioningVsphere::VERSION
   s.platform = Gem::Platform::RUBY
-  s.extra_rdoc_files = ['README.md']
-  s.summary = 'Provisioner for creating vSphere VM instances in Chef Provisioning.'
+  s.extra_rdoc_files = ["README.md"]
+  s.summary = "Provisioner for creating vSphere VM instances in Chef Provisioning."
   s.description = s.summary
-  s.authors = ['CenturyLink Cloud', 'JJ Asghar']
-  s.email = 'jj@chef.io'
-  s.homepage = 'https://github.com/chef-partners/chef-provisioning-vsphere'
-  s.license = 'MIT'
-
-  s.bindir       = 'bin'
-  s.executables  = %w()
-
-  s.require_path = 'lib'
+  s.authors = ["CenturyLink Cloud", "JJ Asghar"]
+  s.email = "jj@chef.io"
+  s.homepage = "https://github.com/chef-partners/chef-provisioning-vsphere"
+  s.license = "MIT"
+  s.bindir       = "bin"
+  s.executables  = %w{}
+  s.require_path = "lib"
   s.files        = `git ls-files -z`.split("\x0")
   s.test_files   = s.files.grep(%r{^(test|spec|features)/})
 
-  s.add_dependency 'rbvmomi', '~> 1.10'
-  s.add_dependency 'chef-provisioning', '~> 2.0'
-  s.add_dependency 'github_changelog_generator'
-  s.add_dependency 'cheffish', '>= 4.0', '< 14.0'
-  s.add_dependency 'chef', '>= 12.0', '< 14.0'
+  s.add_dependency "rbvmomi", "~> 1.10"
+  s.add_dependency "chef-provisioning", "~> 2.0"
+  s.add_dependency "github_changelog_generator"
+  s.add_dependency "cheffish", ">= 4.0", "< 14.0"
+  s.add_dependency "chef", ">= 12.0", "< 14.0"
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'chefstyle'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'pry-byebug'
-  s.add_development_dependency 'pry-stack_explorer'
-  s.add_development_dependency 'rb-readline'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "chefstyle"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "pry-stack_explorer"
+  s.add_development_dependency "rb-readline"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "yard"
 end

data/lib/chef/provisioning/driver_init/vsphere.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
-require 'chef/provisioning/vsphere_driver'
+require "chef/provisioning/vsphere_driver"
 
-Chef::Provisioning.register_driver_class('vsphere', ChefProvisioningVsphere::VsphereDriver)
+Chef::Provisioning.register_driver_class("vsphere", ChefProvisioningVsphere::VsphereDriver)

data/lib/chef/provisioning/vsphere_driver.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
-require 'chef/provisioning'
-require 'chef/provisioning/vsphere_driver/driver'
+require "chef/provisioning"
+require "chef/provisioning/vsphere_driver/driver"
 
+# The main Chef class for all the Chef code!
 class Chef
+  # The main Chef module for the Domain Specialized Language
   module DSL
+    # The main Chef module for the the Recipe in side of Chef's DSL
     module Recipe
+      # Creates the url object for Chef-Provisioning to leverage.
+      #
+      # @param [Object] driver_options Used from the Chef Provisioning to connect
+      # @param [Object] block TODO
       def with_vsphere_driver(driver_options, &block)
         url = ChefProvisioningVsphere::VsphereDriver.canonicalize_url(
           nil, driver_options

data/lib/chef/provisioning/vsphere_driver/clone_spec_builder.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
+
+# Provisions machines in vSphere.
 module ChefProvisioningVsphere
+  # Creates a cspec for VMware
   class CloneSpecBuilder
     def initialize(vsphere_helper, action_handler)
       @vsphere_helper = vsphere_helper
@@ -9,6 +12,11 @@ module ChefProvisioningVsphere
     attr_reader :vsphere_helper
     attr_reader :action_handler
 
+    # The main build method.
+    #
+    # @param [String] options Options set from Chef-Provisioning.
+    # @param [String] vm_template The VM template to clone from.
+    # @param [String] vm_name The VM name to create.
     def build(vm_template, vm_name, options)
       clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(
         location: relocate_spec_for(vm_template, options),
@@ -52,6 +60,10 @@ module ChefProvisioningVsphere
       clone_spec
     end
 
+    # Figure out or declare where you need to bootstrap the vm
+    #
+    # @param [String] options Options set from Chef-Provisioning.
+    # @param [String] vm_template The VM template to clone from.
     def relocate_spec_for(vm_template, options)
       rspec = RbVmomi::VIM.VirtualMachineRelocateSpec
       host = nil
@@ -66,12 +78,12 @@ module ChefProvisioningVsphere
       elsif vm_template.config.template && !host.nil?
         rspec.pool = host.parent.resourcePool # assign to the "invisible" pool root
       elsif vm_template.config.template
-        raise 'either :host or :resource_pool must be specified when cloning from a VM Template'
+        raise "either :host or :resource_pool must be specified when cloning from a VM Template"
       end
 
       if options[:use_linked_clone]
         if vm_template.config.template
-          Chef::Log.warn('Using a VM Template, ignoring use_linked_clone.')
+          Chef::Log.warn("Using a VM Template, ignoring use_linked_clone.")
         else
           vsphere_helper.create_delta_disk(vm_template)
           rspec.diskMoveType = :moveChildMostDiskBacking
@@ -85,19 +97,24 @@ module ChefProvisioningVsphere
       rspec
     end
 
+    # Verify and create all the options needed for Customization Specs
+    #
+    # @param [String] options Options set from Chef-Provisioning.
+    # @param [String] vm_name The VM name that is set.
+    # @param [String] vm_template The VM template to clone from.
     def customization_options_from(vm_template, vm_name, options)
       if options.key?(:customization_spec)
         if options[:customization_spec].is_a?(Hash) ||
-           options[:customization_spec].is_a?(Cheffish::MergedConfig)
+            options[:customization_spec].is_a?(Cheffish::MergedConfig)
           cust_options = options[:customization_spec]
           ip_settings = cust_options[:ipsettings]
           cust_domain = cust_options[:domain]
 
-          raise ArgumentError, 'domain is required' unless cust_domain
+          raise ArgumentError, "domain is required" unless cust_domain
           cust_ip_settings = nil
           if ip_settings && ip_settings.key?(:ip)
             unless cust_options[:ipsettings].key?(:subnetMask)
-              raise ArgumentError, 'subnetMask is required for static ip'
+              raise ArgumentError, "subnetMask is required for static ip"
             end
             cust_ip_settings = RbVmomi::VIM::CustomizationIPSettings.new(
               ip_settings
@@ -128,7 +145,7 @@ module ChefProvisioningVsphere
           cust_hwclockutc = cust_options[:hw_clock_utc]
           cust_timezone = cust_options[:time_zone]
 
-          cust_prep = if vm_template.config.guestId.start_with?('win')
+          cust_prep = if vm_template.config.guestId.start_with?("win")
                         windows_prep_for(options, vm_name)
                       else
                         RbVmomi::VIM::CustomizationLinuxPrep.new(
@@ -141,7 +158,7 @@ module ChefProvisioningVsphere
           cust_adapter_mapping = [
             RbVmomi::VIM::CustomizationAdapterMapping.new(
               adapter: cust_ip_settings
-            )
+            ),
           ]
           RbVmomi::VIM::CustomizationSpec.new(
             identity: cust_prep,
@@ -154,15 +171,23 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Creates a hostname, and verifies that it fulfills the requirements
+    #
+    # @param [String] options Options set from Chef-Provisioning.
+    # @param [String] vm_name The VM name that is set.
     def hostname_from(options, vm_name)
       hostname = options[:hostname] || vm_name
       test = /^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])$/
-      unless hostname.match(test) # rubocop:disable Performance/RegexpMatch
-        raise 'Only letters, numbers or hyphens in hostnames allowed'
+      unless hostname =~ test
+        raise "Only letters, numbers or hyphens in hostnames allowed"
       end
       RbVmomi::VIM::CustomizationFixedName.new(name: hostname)
     end
 
+    # Preparation work for windows, sysprep and the like.
+    #
+    # @param [String] options Options set from Chef-Provisioning.
+    # @param [String] vm_name The VM name that is set.
     def windows_prep_for(options, vm_name)
       cust_options = options[:customization_spec]
       unless cust_options[:run_once].nil?
@@ -175,22 +200,21 @@ module ChefProvisioningVsphere
         plainText: true,
         value: options[:ssh][:password]
       )
-      if cust_options.key?(:domain) && (cust_options[:domain] != 'local')
+      if cust_options.key?(:domain) && (cust_options[:domain] != "local")
         cust_domain_password = RbVmomi::VIM::CustomizationPassword(
           plainText: true,
-          value: ENV['domainAdminPassword'] || cust_options[:domainAdminPassword]
+          value: ENV["domainAdminPassword"] || cust_options[:domainAdminPassword]
         )
         cust_id = RbVmomi::VIM::CustomizationIdentification.new(
           joinDomain: cust_options[:domain],
           domainAdmin: cust_options[:domainAdmin],
           domainAdminPassword: cust_domain_password
         )
-        # puts "my env passwd is: #{ENV['domainAdminPassword']}"
         action_handler.report_progress "joining domain #{cust_options[:domain]} /
           with user: #{cust_options[:domainAdmin]}"
       else
         cust_id = RbVmomi::VIM::CustomizationIdentification.new(
-          joinWorkgroup: 'WORKGROUP'
+          joinWorkgroup: "WORKGROUP"
         )
       end
       cust_gui_unattended = RbVmomi::VIM::CustomizationGuiUnattended.new(

data/lib/chef/provisioning/vsphere_driver/driver.rb

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
-require 'chef'
-require 'cheffish/merged_config'
-require 'chef/provisioning/driver'
-require 'chef/provisioning/machine/windows_machine'
-require 'chef/provisioning/machine/unix_machine'
-require 'chef/provisioning/vsphere_driver/clone_spec_builder'
-require 'chef/provisioning/vsphere_driver/version'
-require 'chef/provisioning/vsphere_driver/vsphere_helpers'
-require 'chef/provisioning/vsphere_driver/vsphere_url'
-require 'chef/provisioning/vsphere_driver/vm_helper'
-
+require "chef"
+require "cheffish/merged_config"
+require "chef/provisioning/driver"
+require "chef/provisioning/machine/windows_machine"
+require "chef/provisioning/machine/unix_machine"
+require "chef/provisioning/vsphere_driver/clone_spec_builder"
+require "chef/provisioning/vsphere_driver/version"
+require "chef/provisioning/vsphere_driver/vsphere_helpers"
+require "chef/provisioning/vsphere_driver/vsphere_url"
+require "chef/provisioning/vsphere_driver/vm_helper"
+
+# Provisions machines in vSphere.
 module ChefProvisioningVsphere
-  # Provisions machines in vSphere.
+  # Inherits the Chef::Provisioning::Driver attirbutes
   class VsphereDriver < Chef::Provisioning::Driver
     include Chef::Mixin::ShellOut
 
+    # Creates the new object via the URL
+    #
+    # @param [String] driver_url The driver url to connect via.
+    # @param [Object] config The config to get to the machine you are creating.
     def self.from_url(driver_url, config)
       VsphereDriver.new(driver_url, config)
     end
@@ -34,6 +39,9 @@ module ChefProvisioningVsphere
       [driver_url || URI::VsphereUrl.from_config(config).to_s, config]
     end
 
+    # Converts the keys from strings to symbols
+    #
+    # @param [Object] h converts to key:value
     def self.symbolize_keys(h)
       Hash === h ?
         Hash[
@@ -43,6 +51,9 @@ module ChefProvisioningVsphere
         ] : h
     end
 
+    # Converts the keys from strings to symbols
+    #
+    # @param [Object] hash_like converts to key:value
     def deep_symbolize(hash_like)
       return {} if hash_like.nil? || hash_like.empty?
       r = {}
@@ -53,17 +64,21 @@ module ChefProvisioningVsphere
       r
     end
 
+    # Initialize method for this class
+    #
+    # @param [String] driver_url Location of where the driver needs to connect to.
+    # @param [Object] config The complete config of the machine options.
     def initialize(driver_url, config)
       super(driver_url, config)
 
       uri = URI(driver_url)
       @connect_options = {
-        provider: 'vsphere',
+        provider: "vsphere",
         host: uri.host,
         port: uri.port,
         use_ssl: uri.use_ssl,
         insecure: uri.insecure,
-        path: uri.path
+        path: uri.path,
       }
 
       if driver_options
@@ -74,6 +89,8 @@ module ChefProvisioningVsphere
 
     attr_reader :connect_options, :vm_helper
 
+    # Creates a new vm_helper if not already there
+    #
     def vm_helper
       @vm_helper ||= ChefProvisioningVsphere::VmHelper.new
     end
@@ -132,13 +149,13 @@ module ChefProvisioningVsphere
         )
         vm = vm_for(machine_spec)
         if vm
-          Chef::Log.warn 'returning existing machine'
+          Chef::Log.warn "returning existing machine"
           return vm
         else
           Chef::Log.warn machine_msg(
             machine_spec.name,
-            machine_spec.location['server_id'],
-            'no longer exists.  Recreating ...'
+            machine_spec.location["server_id"],
+            "no longer exists.  Recreating ..."
           )
         end
       end
@@ -155,11 +172,14 @@ module ChefProvisioningVsphere
       action_handler.performed_action(machine_msg(
                                         machine_spec.name,
                                         vm.config.instanceUuid,
-                                        'created'
+                                        "created"
       ))
       vm
     end
 
+    # Squishes the options to one large hash
+    #
+    # @param [Object] machine_options taken from Chef provisioning for all the `machine_options`
     def merge_options!(machine_options)
       @config = Cheffish::MergedConfig.new(
         { machine_options: machine_options },
@@ -168,17 +188,26 @@ module ChefProvisioningVsphere
       @config = deep_symbolize(@config.to_h)
     end
 
+    # Adds machine spec location from other options.
+    #
+    # @param [Object] machine_spec taken from Chef provisioning for all the `machine_spec`.
+    # @param [Object] vm taken from Chef provisioning for all the vm state.
     def add_machine_spec_location(vm, machine_spec)
       machine_spec.location = {
-        'driver_url' => driver_url,
-        'driver_version' => VERSION,
-        'server_id' => vm.config.instanceUuid,
-        'is_windows' => is_windows?(vm),
-        'allocated_at' => Time.now.utc.to_s,
-        'ipaddress' => vm.guest.ipAddress
+        "driver_url" => driver_url,
+        "driver_version" => VERSION,
+        "server_id" => vm.config.instanceUuid,
+        "is_windows" => is_windows?(vm),
+        "allocated_at" => Time.now.utc.to_s,
+        "ipaddress" => vm.guest.ipAddress,
       }
     end
 
+    # Verify if machine is there or create it.
+    #
+    # @param [Object] bootstrap_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] machine_spec taken from Chef provisioning for all the `machine_spec`.
+    # @param [Object] action_handler taken from Chef provisioning for TODO.
     def find_or_create_vm(bootstrap_options, machine_spec, action_handler)
       vm = vsphere_helper.find_vm(
         bootstrap_options[:vm_folder],
@@ -188,7 +217,7 @@ module ChefProvisioningVsphere
         Chef::Log.info machine_msg(
           machine_spec.name,
           vm.config.instanceUuid,
-          'already created'
+          "already created"
         )
       else
         vm = clone_vm(
@@ -200,12 +229,16 @@ module ChefProvisioningVsphere
       vm
     end
 
+    # Creates a full description of the machine.
+    #
+    # @param [Object] bootstrap_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] machine_spec taken from Chef provisioning for all the `machine_spec`.
     def full_description(machine_spec, bootstrap_options)
       description = ["creating machine #{machine_spec.name} on #{driver_url}"]
       bootstrap_options.to_hash.each_pair do |key, value|
         if value.is_a?(Hash)
           temp_value = value.clone
-          temp_value[:password] = '*********' if value.key?(:password)
+          temp_value[:password] = "*********" if value.key?(:password)
         else
           temp_value = value
         end
@@ -214,10 +247,21 @@ module ChefProvisioningVsphere
       description
      end
 
+    # Creates a string of specific Machine information
+    #
+    # @param [String] name The name of the machine
+    # @param [String] id The ID of the machine
+    # @param [Object] action TODO
+    # @return [String] "Machine - ACTION - NAME (UUID on URL)"
     def machine_msg(name, id, action)
       "Machine - #{action} - #{name} (#{id} on #{driver_url})"
     end
 
+    # Sets the machine to ready state. (Creates the machine but does not bootstrap Chef into it.)
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] machine_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] machine_spec taken from Chef provisioning for all the `machine_spec`.
     def ready_machine(action_handler, machine_spec, machine_options)
       machine_options = deep_symbolize(machine_options)
       merge_options! machine_options
@@ -225,7 +269,7 @@ module ChefProvisioningVsphere
       vm = start_machine(action_handler, machine_spec, machine_options)
       if vm.nil?
         raise "Machine #{machine_spec.name} does not have a server "\
-        'associated with it, or server does not exist.'
+        "associated with it, or server does not exist."
       end
 
       bootstrap_options = machine_options[:bootstrap_options]
@@ -250,6 +294,12 @@ module ChefProvisioningVsphere
       machine
     end
 
+    # Creates new NICs for the machine
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] bootstrap_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] vm The VM object.
+    # @param [Object] machine The machine object.
     def setup_extra_nics(action_handler, bootstrap_options, vm, machine)
       networks = bootstrap_options[:network_name]
       networks = [networks] if networks.is_a?(String)
@@ -271,6 +321,12 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Is the transport layer ready?
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] machine_spec taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] vm The VM object.
+    # @param [Object] machine_options The options required to talk to the VM.
     def transport_respond?(
       machine_options,
       vm,
@@ -284,7 +340,7 @@ module ChefProvisioningVsphere
       # Customization below may change this to a valid ip
       wait_until_ready(action_handler, machine_spec, machine_options, vm)
 
-      if !machine_spec.location['ipaddress'] || !has_ip?(machine_spec.location['ipaddress'], vm)
+      if !machine_spec.location["ipaddress"] || !has_ip?(machine_spec.location["ipaddress"], vm)
         # find the ip we actually want
         # this will be the static ip to assign
         # or the ip reported back by the vm if using dhcp
@@ -298,7 +354,7 @@ module ChefProvisioningVsphere
         unless !transport.nil? && transport.available? && has_ip?(vm_ip, vm)
           attempt_ip(machine_options, action_handler, vm, machine_spec)
         end
-        machine_spec.location['ipaddress'] = vm.guest.ipAddress
+        machine_spec.location["ipaddress"] = vm_ip # vm.guest.ipAddress vmWare ip_address here can be 0.0.0.0
         action_handler.report_progress(
           "IP address obtained: #{machine_spec.location['ipaddress']}"
         )
@@ -310,14 +366,14 @@ module ChefProvisioningVsphere
         wait_for_transport(action_handler, machine_spec, machine_options, vm)
       rescue Timeout::Error
         # Only ever reboot once, and only if it's been less than 10 minutes since we stopped waiting
-        if machine_spec.location['started_at'] ||
-           remaining_wait_time(machine_spec, machine_options) < -(10 * 60)
+        if machine_spec.location["started_at"] ||
+            remaining_wait_time(machine_spec, machine_options) < -(10 * 60)
           raise
         else
           Chef::Log.warn(machine_msg(
                            machine_spec.name,
                            vm.config.instanceUuid,
-                           'started but SSH did not come up.  Rebooting...'
+                           "started but SSH did not come up.  Rebooting..."
           ))
           restart_server(action_handler, machine_spec, machine_options)
           wait_until_ready(action_handler, machine_spec, machine_options, vm)
@@ -326,19 +382,25 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Test out the IP to connect to.
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] machine_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] vm The VM object.
+    # @param [Object] machine_spec The spec required to talk to the VM.
     def attempt_ip(machine_options, action_handler, vm, machine_spec)
       vm_ip = ip_to_bootstrap(machine_options[:bootstrap_options], vm)
 
       wait_for_ip(vm, machine_options, machine_spec, action_handler)
 
       unless has_ip?(vm_ip, vm)
-        action_handler.report_progress 'rebooting...'
-        if vm.guest.toolsRunningStatus != 'guestToolsRunning'
-          msg = 'tools have stopped. current power state is '
+        action_handler.report_progress "rebooting..."
+        if vm.guest.toolsRunningStatus != "guestToolsRunning"
+          msg = "tools have stopped. current power state is "
           msg << vm.runtime.powerState
-          msg << ' and tools state is '
+          msg << " and tools state is "
           msg << vm.guest.toolsRunningStatus
-          msg << '. powering up server...'
+          msg << ". powering up server..."
           action_handler.report_progress(msg)
           vsphere_helper.start_vm(vm)
         else
@@ -348,6 +410,12 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Wait for the Windows Domain.
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] bootstrap_options taken from Chef provisioning for all the bootstrap options.
+    # @param [Object] vm The VM object.
+    # @param [Object] machine_spec The specs to connect to bootstrap machine
     def wait_for_domain(bootstrap_options, vm, machine_spec, action_handler)
       return unless bootstrap_options[:customization_spec]
 
@@ -363,7 +431,7 @@ module ChefProvisioningVsphere
 
       return unless domain
 
-      if is_windows?(vm) && domain != 'local'
+      if is_windows?(vm) && domain != "local"
         start = Time.now.utc
         trimmed_name = machine_spec.name.byteslice(0, 15)
         expected_name = "#{trimmed_name}.#{domain}"
@@ -371,13 +439,19 @@ module ChefProvisioningVsphere
           "waiting to domain join and be named #{expected_name}"
         )
         until (Time.now.utc - start) > 30 ||
-              (vm.guest.hostName == expected_name)
-          print '.'
+            (vm.guest.hostName == expected_name)
+          print "."
           sleep 5
         end
       end
     end
 
+    # Wait for another IP allocation.
+    #
+    # @param [Object] action_handler TODO
+    # @param [Object] vm The VM object.
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
     def wait_for_ip(vm, machine_options, machine_spec, action_handler)
       bootstrap_options = machine_options[:bootstrap_options]
       ip_to_bootstrap(bootstrap_options, vm)
@@ -387,7 +461,7 @@ module ChefProvisioningVsphere
       msg = [msg1, msg2].join
       action_handler.report_progress msg
 
-      vm_ip ||= ip_to_bootstrap(bootstrap_options, vm)
+      vm_ip = @vm_helper.ip || ip_to_bootstrap(bootstrap_options, vm)
       until transport_for(
         machine_spec,
         machine_options[:bootstrap_options][:ssh],
@@ -396,7 +470,7 @@ module ChefProvisioningVsphere
         action_handler.report_progress(
           "IP addresses found: #{all_ips_for(vm)}"
         )
-        vm_ip ||= ip_to_bootstrap(bootstrap_options, vm)
+        vm_ip = @vm_helper.ip || ip_to_bootstrap(bootstrap_options, vm)
         if has_ip?(vm_ip, vm)
           transport_for(
             machine_spec,
@@ -408,21 +482,36 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Flatten all IPs for a VM
+    #
+    # @param [Object] vm The VM object.
     def all_ips_for(vm)
       vm.guest.net.map(&:ipAddress).flatten
     end
 
+    # Does the VM have this IP?
+    #
+    # @param [Object] vm The VM object.
+    # @param [String] ip IP to see if it's in the map.
     def has_ip?(ip, vm)
       all_ips_for(vm).include?(ip)
     end
 
     # Connect to machine without acquiring it
+    #
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
     def connect_to_machine(machine_spec, machine_options)
       machine_options = deep_symbolize(machine_options)
       merge_options! machine_options
       machine_for(machine_spec, machine_options)
     end
 
+    # Destroy the Machine
+    #
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
+    # @param [Object] action_handler TODO
     def destroy_machine(action_handler, machine_spec, machine_options)
       machine_options = deep_symbolize(machine_options)
       merge_options! machine_options
@@ -433,7 +522,7 @@ module ChefProvisioningVsphere
             vsphere_helper.stop_vm(vm, machine_options[:stop_timeout])
             vm.Destroy_Task.wait_for_completion
           rescue RbVmomi::Fault => fault
-            raise fault unless fault.fault.class.wsdl_name == 'ManagedObjectNotFound'
+            raise fault unless fault.fault.class.wsdl_name == "ManagedObjectNotFound"
           ensure
             machine_spec.location = nil
           end
@@ -443,6 +532,11 @@ module ChefProvisioningVsphere
       strategy.cleanup_convergence(action_handler, machine_spec)
     end
 
+    # Stop the Machine
+    #
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
+    # @param [Object] action_handler TODO
     def stop_machine(action_handler, machine_spec, machine_options)
       machine_options = deep_symbolize(machine_options)
       merge_options! machine_options
@@ -454,6 +548,11 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Start the Machine
+    #
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
+    # @param [Object] action_handler TODO
     def start_machine(action_handler, machine_spec, machine_options)
       machine_options = deep_symbolize(machine_options)
       merge_options! machine_options
@@ -466,40 +565,53 @@ module ChefProvisioningVsphere
       vm
     end
 
+    # Restart the Machine
+    #
+    # @param [Object] machine_options The machine options required to start the VM.
+    # @param [Object] machine_spec The machine spec required to start the VM.
+    # @param [Object] action_handler TODO
     def restart_server(action_handler, machine_spec, machine_options)
       action_handler.perform_action "restart machine #{machine_spec.name} (#{driver_url})" do
         stop_machine(action_handler, machine_spec, machine_options)
         start_machine(action_handler, machine_spec, machine_options)
-        machine_spec.location['started_at'] = Time.now.utc.to_s
+        machine_spec.location["started_at"] = Time.now.utc.to_s
       end
     end
 
     protected
 
+    # Ubuntu requires some...hacking to get DNS to work.
+    #
+    # @param [Object] bootstrap_options The bootstarp options required to start the VM.
+    # @param [Object] _machine_spec The machine spec required to start the VM.
+    # @param [Object] machine Machine object to connect to.
     def setup_ubuntu_dns(machine, bootstrap_options, _machine_spec)
-      host_lookup = machine.execute_always('host google.com')
+      host_lookup = machine.execute_always("host google.com")
       if host_lookup.exitstatus != 0
-        if host_lookup.stdout.include?('setlocale: LC_ALL')
-          machine.execute_always('locale-gen en_US && update-locale LANG=en_US')
+        if host_lookup.stdout.include?("setlocale: LC_ALL")
+          machine.execute_always("locale-gen en_US && update-locale LANG=en_US")
         end
         distro = machine.execute_always("lsb_release -i | sed -e 's/Distributor ID://g'").stdout.strip
         Chef::Log.info "Found distro:#{distro}"
-        if distro == 'Ubuntu'
-          distro_version = machine.execute_always('lsb_release -r | sed -e s/[^0-9.]//g').stdout.strip.to_f
+        if distro == "Ubuntu"
+          distro_version = machine.execute_always("lsb_release -r | sed -e s/[^0-9.]//g").stdout.strip.to_f
           Chef::Log.info "Found distro version:#{distro_version}"
           if distro_version >= 12.04
-            Chef::Log.info 'Ubuntu version 12.04 or greater. Need to patch DNS.'
-            interfaces_file = '/etc/network/interfaces'
-            nameservers = bootstrap_options[:customization_spec][:ipsettings][:dnsServerList].join(' ')
+            Chef::Log.info "Ubuntu version 12.04 or greater. Need to patch DNS."
+            interfaces_file = "/etc/network/interfaces"
+            nameservers = bootstrap_options[:customization_spec][:ipsettings][:dnsServerList].join(" ")
             machine.execute_always("if ! cat #{interfaces_file} | grep -q dns-search ; then echo 'dns-search #{bootstrap_options[:customization_spec][:domain]}' >> #{interfaces_file} ; fi")
             machine.execute_always("if ! cat #{interfaces_file} | grep -q dns-nameservers ; then echo 'dns-nameservers #{nameservers}' >> #{interfaces_file} ; fi")
-            machine.execute_always('/etc/init.d/networking restart')
-            machine.execute_always('apt-get -qq update')
+            machine.execute_always("/etc/init.d/networking restart")
+            machine.execute_always("apt-get -qq update")
           end
         end
       end
     end
 
+    # Verify static IP.
+    #
+    # @param [Object] bootstrap_options The bootstarp options required to start the VM.
     def has_static_ip(bootstrap_options)
       if bootstrap_options.key?(:customization_spec)
         bootstrap_options = bootstrap_options[:customization_spec]
@@ -516,22 +628,22 @@ module ChefProvisioningVsphere
     end
 
     def remaining_wait_time(machine_spec, machine_options)
-      if machine_spec.location['started_at']
+      if machine_spec.location["started_at"]
         (machine_options[:start_timeout] || 600) -
-          (Time.now.utc - Time.parse(machine_spec.location['started_at']))
+          (Time.now.utc - Time.parse(machine_spec.location["started_at"]))
       else
         (machine_options[:create_timeout] || 600) -
-          (Time.now.utc - Time.parse(machine_spec.location['allocated_at']))
+          (Time.now.utc - Time.parse(machine_spec.location["allocated_at"]))
       end
     end
 
     def wait_until_ready(action_handler, machine_spec, machine_options, vm)
-      if vm.guest.toolsRunningStatus != 'guestToolsRunning'
+      if vm.guest.toolsRunningStatus != "guestToolsRunning"
         if action_handler.should_perform_actions
           action_handler.report_progress "waiting for #{machine_spec.name} (#{vm.config.instanceUuid} on #{driver_url}) to be ready ..."
           until remaining_wait_time(machine_spec, machine_options) < 0 ||
-                (vm.guest.toolsRunningStatus == 'guestToolsRunning' && vm.guest.ipAddress && !vm.guest.ipAddress.empty?)
-            print '.'
+              (vm.guest.toolsRunningStatus == "guestToolsRunning" && vm.guest.ipAddress && !vm.guest.ipAddress.empty?)
+            print "."
             sleep 5
           end
           action_handler.report_progress "#{machine_spec.name} is now ready"
@@ -541,7 +653,7 @@ module ChefProvisioningVsphere
 
     def vm_for(machine_spec)
       if machine_spec.location
-        vsphere_helper.find_vm_by_id(machine_spec.location['server_id'])
+        vsphere_helper.find_vm_by_id(machine_spec.location["server_id"])
       end
     end
 
@@ -570,7 +682,7 @@ module ChefProvisioningVsphere
         size = size.to_i
         next if size == 0
         if bootstrap_options[:datastore].to_s.empty?
-          raise ':datastore must be specified when adding a disk to a cloned vm'
+          raise ":datastore must be specified when adding a disk to a cloned vm"
         end
         task = vm.ReconfigVM_Task(
           spec: RbVmomi::VIM.VirtualMachineConfigSpec(
@@ -579,7 +691,7 @@ module ChefProvisioningVsphere
                 vm,
                 bootstrap_options[:datastore],
                 size
-              )
+              ),
             ]
           )
         )
@@ -614,7 +726,7 @@ module ChefProvisioningVsphere
       )
       strategy = convergence_strategy_for(machine_spec, machine_options)
 
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         Chef::Provisioning::Machine::WindowsMachine.new(
           machine_spec, transport, strategy
         )
@@ -627,13 +739,13 @@ module ChefProvisioningVsphere
 
     def is_windows?(vm)
       return false if vm.nil?
-      vm.config.guestId.start_with?('win')
+      vm.config.guestId.start_with?("win")
     end
 
     def convergence_strategy_for(machine_spec, machine_options)
-      require 'chef/provisioning/convergence_strategy/install_msi'
-      require 'chef/provisioning/convergence_strategy/install_cached'
-      require 'chef/provisioning/convergence_strategy/no_converge'
+      require "chef/provisioning/convergence_strategy/install_msi"
+      require "chef/provisioning/convergence_strategy/install_cached"
+      require "chef/provisioning/convergence_strategy/no_converge"
 
       mopts = machine_options[:convergence_options].to_hash.dup
       if mopts[:chef_server]
@@ -647,7 +759,7 @@ module ChefProvisioningVsphere
         )
       end
 
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         Chef::Provisioning::ConvergenceStrategy::InstallMsi.new(
           mopts, config
         )
@@ -658,6 +770,12 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Wait for the transport connection to happen
+    #
+    # @param [Object] machine_spec The machine_spec from Chef-Provisioning
+    # @param [Object] machine_options Options for remote connections
+    # @param [Object] vm The VM object from Chef-Provisioning
+    # @param [Object] action_handler taken from Chef provisioning for TODO.
     def wait_for_transport(action_handler, machine_spec, machine_options, vm)
       @vm_helper.find_port?(vm, machine_options[:bootstrap_options]) if vm_helper.port.nil?
       transport = transport_for(
@@ -669,7 +787,7 @@ module ChefProvisioningVsphere
           action_handler.report_progress "waiting for #{machine_spec.name} (#{vm.config.instanceUuid} on #{driver_url}) to be connectable (transport up and running) ..."
 
           until remaining_wait_time(machine_spec, machine_options) < 0 || transport.available?
-            print '.'
+            print "."
             sleep 5
           end
 
@@ -678,29 +796,38 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Figure out the transport system to send to the VM
+    #
+    # @param [Object] machine_spec The machine_spec from Chef-Provisioning
+    # @param [Object] remoting_options Options for remote connections
+    # @param [String] ip The IP to connect to.
     def transport_for(
       machine_spec,
       remoting_options,
-      ip = machine_spec.location['ipaddress']
+      ip = machine_spec.location["ipaddress"]
     )
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         create_winrm_transport(ip, remoting_options)
       else
         create_ssh_transport(ip, remoting_options)
       end
     end
 
+    # Create a robust WinRM transport connect, so so many options to make a simple connection
+    #
+    # @param [String] host The host the VM is connecting to
+    # @param [Object] options Options that are required to connect to the host from Chef-Provisioning
     def create_winrm_transport(host, options)
-      require 'chef/provisioning/transport/winrm'
+      require "chef/provisioning/transport/winrm"
       winrm_transport = if options[:port] == 5986
                           :ssl
                         else
                           options[:winrm_transport].nil? ? :negotiate : options[:winrm_transport].to_sym
                         end
-      port = options[:port] || @vm_helper.port # winrm_transport == :ssl ? '5986' : '5985'
+      port = options[:port] || @vm_helper.port
       winrm_options = {
         user: (options[:user]).to_s,
-        pass: options[:password]
+        pass: options[:password],
       }
       if options[:winrm_opts].nil?
         opt = options[:user].include?('\\') ? :disable_sspi : :basic_auth_only
@@ -719,30 +846,37 @@ module ChefProvisioningVsphere
       )
     end
 
+    # Find the IP to bootstrap against
+    #
+    # @param [String] host The host the VM is connecting to
+    # @param [Object] options Options that are required to connect to the host from Chef-Provisioning
     def create_ssh_transport(host, options)
-      require 'chef/provisioning/transport/ssh'
+      require "chef/provisioning/transport/ssh"
       ssh_user = options[:user]
       options = options.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
       Chef::Provisioning::Transport::SSH.new(
         host,
         ssh_user,
         options.to_hash,
-        @config[:machine_options][:sudo] ? { prefix: 'sudo ' } : {},
+        @config[:machine_options][:sudo] ? { prefix: "sudo " } : {},
         config
       )
     end
 
+    # Find the IP to bootstrap against
+    #
+    # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
+    # @param [Object] vm The VM object from Chef-Provisioning
     def ip_to_bootstrap(bootstrap_options, vm)
       @vm_helper.find_port?(vm, bootstrap_options) unless vm_helper.port?
       if has_static_ip(bootstrap_options)
         if bootstrap_options[:customization_spec].is_a?(String)
           spec = vsphere_helper.find_customization_spec(bootstrap_options[:customization_spec])
-          spec.nicSettingMap[0].adapter.ip.ipAddress
+          @vm_helper.ip = spec.nicSettingMap[0].adapter.ip.ipAddress
         else
           ## Check if true available
           @vm_helper.ip = bootstrap_options[:customization_spec][:ipsettings][:ip] unless vm_helper.ip?
-          print '.' until @vm_helper.open_port?(@vm_helper.ip, @vm_helper.port, 1)
-          @vm_helper.ip.to_s
+          print "." until @vm_helper.open_port?(@vm_helper.ip, @vm_helper.port, 1)
         end
       else
         if use_ipv4_during_bootstrap?(bootstrap_options)
@@ -751,10 +885,13 @@ module ChefProvisioningVsphere
           end
         end
         @vm_helper.ip = vm.guest.ipAddress until vm_guest_ip?(vm) && @vm_helper.open_port?(@vm_helper.ip, @vm_helper.port, 1) # Don't set empty ip
-        @vm_helper.ip
       end
+      @vm_helper.ip.to_s
     end
 
+    # Force IPv4 a bootstrap, default: false
+    #
+    # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
     def use_ipv4_during_bootstrap?(bootstrap_options)
       if bootstrap_options.key?(:bootstrap_ipv4)
         return bootstrap_options[:bootstrap_ipv4] == true
@@ -762,6 +899,9 @@ module ChefProvisioningVsphere
       false
     end
 
+    # Setting a bootstrap ip timeout, default: 30
+    #
+    # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
     def bootstrap_ip_timeout(bootstrap_options)
       if bootstrap_options.key?(:ipv4_timeout)
         return bootstrap_options[:ipv4_timeout].to_i
@@ -769,25 +909,32 @@ module ChefProvisioningVsphere
       30
     end
 
+    # What for IPv4 address
+    #
+    # @param [String] timeout Declared a timeout
+    # @param [Object] vm The VM object from Chef-Provisioning
     def wait_for_ipv4(timeout, vm)
       sleep_time = 5
-      print 'Waiting for ipv4 address.'
+      print "Waiting for ipv4 address."
       tries = 0
       start_search_ip = true
       max_tries = timeout > sleep_time ? timeout / sleep_time : 1
       while start_search_ip && (tries += 1) <= max_tries
-        print '.'
+        print "."
         sleep sleep_time
         @vm_helper.ip = vm.guest.ipAddress if vm_guest_ip?(vm)
         start_search_ip = false if @vm_helper.open_port?(@vm_helper.ip, @vm_helper.port, 1)
       end
-      raise 'Timed out waiting for ipv4 address!' if tries > max_tries && !IPAddr.new(vm.guest.ipAddress).ipv4?
-      puts 'Found ipv4 address!'
+      raise "Timed out waiting for ipv4 address!" if tries > max_tries && !IPAddr.new(vm.guest.ipAddress).ipv4?
+      puts "Found ipv4 address!"
       true
     end
 
+    # What is the VM guest IP
+    #
+    # @param [Object] vm The VM object from Chef-Provisioning
     def vm_guest_ip?(vm)
-      vm.guest.guestState == 'running' && vm.guest.toolsRunningStatus == 'guestToolsRunning' && !vm.guest.ipAddress.nil? && IPAddr.new(vm.guest.ipAddress).ipv4?
+      vm.guest.guestState == "running" && vm.guest.toolsRunningStatus == "guestToolsRunning" && !vm.guest.ipAddress.nil? && IPAddr.new(vm.guest.ipAddress).ipv4?
     end
   end
 end