chef-provisioning-vsphere 2.0.2 → 2.0.3

data/lib/kitchen/driver/vsphere.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
-require 'json'
-require 'kitchen'
-require 'chef/provisioning/vsphere_driver'
-require 'chef/provisioning/machine_spec'
+require "json"
+require "kitchen"
+require "chef/provisioning/vsphere_driver"
+require "chef/provisioning/machine_spec"
 
+# Main Kitchen Module
 module Kitchen
+  # Main Kitchen::Driver Module
   module Driver
+    # vSphere kitchen class extends the Kitchen::Driver::Base
     class Vsphere < Kitchen::Driver::Base
       @@chef_zero_server = false
 
@@ -17,20 +20,23 @@ module Kitchen
                      bootstrap_options: {
                        use_linked_clone: true,
                        ssh: {
-                         user: 'root',
+                         user: "root",
                          paranoid: false,
-                         port: 22
+                         port: 22,
                        },
                        convergence_options: {},
                        customization_spec: {
-                         domain: 'local'
-                       }
+                         domain: "local",
+                       },
                      }
 
       default_config(:vsphere_name) do |driver|
         "#{driver.instance.name}-#{SecureRandom.hex(4)}"
       end
 
+      # Creates VM on the vSphere cluster
+      #
+      # @param [Object] state Uses state of the machine from Chef provisioning.
       def create(state)
         state[:vsphere_name] = config[:vsphere_name]
         state[:username] = config[:machine_options][:bootstrap_options][:ssh][:user]
@@ -40,18 +46,21 @@ module Kitchen
         machine = with_provisioning_driver(state) do |action_handler, driver, machine_spec|
           driver.allocate_machine(action_handler, machine_spec, config[:machine_options])
           driver.ready_machine(action_handler, machine_spec, config[:machine_options])
-          state[:server_id] = machine_spec.location['server_id']
-          state[:hostname] = machine_spec.location['ipaddress']
+          state[:server_id] = machine_spec.location["server_id"]
+          state[:hostname] = machine_spec.location["ipaddress"]
           machine_spec.save(action_handler)
         end
       end
 
+      # Destroys VM on the vSphere cluster
+      #
+      # @param [Object] state Uses state of the machine from Chef provisioning.
       def destroy(state)
         return if state[:server_id].nil?
 
         with_provisioning_driver(state) do |action_handler, driver, machine_spec|
-          machine_spec.location = { 'driver_url' => driver.driver_url,
-                                    'server_id' => state[:server_id] }
+          machine_spec.location = { "driver_url" => driver.driver_url,
+                                    "server_id" => state[:server_id] }
           driver.destroy_machine(action_handler, machine_spec, config[:machine_options])
         end
 
@@ -60,6 +69,9 @@ module Kitchen
         state.delete(:vsphere_name)
       end
 
+      # Leverages the chef provisioning driver options
+      #
+      # @param [Object] state Uses state of the machine from Chef provisioning.
       def with_provisioning_driver(state)
         config[:machine_options][:convergence_options] = { chef_server: chef_server }
         machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server).get(:machine, state[:vsphere_name])
@@ -73,13 +85,15 @@ module Kitchen
         yield(action_handler, driver, machine_spec)
       end
 
+      # Uses either a remote Chef server or Chef Zero
+      #
       def chef_server
         unless @@chef_zero_server
           vsphere_mutex.synchronize do
             unless @@chef_zero_server
               Chef::Config.local_mode = true
               Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
-              require 'chef/local_mode'
+              require "chef/local_mode"
               Chef::LocalMode.setup_server_connectivity
               @@chef_zero_server = true
             end
@@ -89,6 +103,8 @@ module Kitchen
         Cheffish.default_chef_server
       end
 
+      # Creates a new mutex object for Kitchen
+      #
       def vsphere_mutex
         @@vsphere_mutex ||= begin
           Kitchen.mutex.synchronize do

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+
+SimpleCov.start do
+  # add_filter do |source_file|
+  #   # source_file.lines.count < 5
+  #   source.filename =~ /^#{SimpleCov.root}\/chef-provisioning-fake/)
+  # end
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-vsphere
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - CenturyLink Cloud
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-13 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi
@@ -191,6 +191,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provisioner for creating vSphere VM instances in Chef Provisioning.
 email: jj@chef.io
 executables: []
@@ -198,6 +226,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -221,6 +251,7 @@ files:
 - lib/kitchen/driver/vsphere.rb
 - spec/integration_tests/.gitignore
 - spec/integration_tests/vsphere_driver_spec.rb
+- spec/spec_helper.rb
 - spec/unit_tests/VsphereDriver_spec.rb
 - spec/unit_tests/VsphereUrl_spec.rb
 - spec/unit_tests/clone_spec_builder_spec.rb
@@ -253,6 +284,7 @@ summary: Provisioner for creating vSphere VM instances in Chef Provisioning.
 test_files:
 - spec/integration_tests/.gitignore
 - spec/integration_tests/vsphere_driver_spec.rb
+- spec/spec_helper.rb
 - spec/unit_tests/VsphereDriver_spec.rb
 - spec/unit_tests/VsphereUrl_spec.rb
 - spec/unit_tests/clone_spec_builder_spec.rb