beaker-vcloud 1.0.0 → 2.0.0

data/Rakefile

@@ -1,24 +1,13 @@
 require 'rspec/core/rake_task'
 
 namespace :test do
-
   namespace :spec do
-
-    desc "Run spec tests"
+    desc 'Run spec tests'
     RSpec::Core::RakeTask.new(:run) do |t|
       t.rspec_opts = ['--color']
       t.pattern = 'spec/'
     end
-
-    desc "Run spec tests with coverage"
-    RSpec::Core::RakeTask.new(:coverage) do |t|
-      ENV['BEAKER_VCLOUD_COVERAGE'] = 'y'
-      t.rspec_opts = ['--color']
-      t.pattern = 'spec/'
-    end
-
   end
-
 end
 
 # namespace-named default tasks.
@@ -27,111 +16,26 @@ end
 task 'test:spec' => 'test:spec:run'
 
 # global defaults
-task :test => 'test:spec'
-task :default => :test
-
-###########################################################
-#
-#   Documentation Tasks
-#
-###########################################################
-DOCS_DAEMON = "yard server --reload --daemon --server thin"
-FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker'
-
-def running?( cmdline )
-  ps = `ps -ef`
-  found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ )
-  if found.length > 1
-    raise StandardError, "Found multiple YARD Servers. Don't know what to do."
+task test: 'test:spec'
+task default: :test
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError
+  # github_changelog_generator is an optional group
+else
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
+    config.user = 'voxpupuli'
+    config.project = 'beaker-vcloud'
+    gem_version = Gem::Specification.load("#{config.project}.gemspec").version
+    config.future_release = gem_version
   end
-
-  yes = found.empty? ? false : true
-  return yes, found.first
-end
-
-def pid_from( output )
-  output.squeeze(' ').strip.split(' ')[1]
-end
-
-desc 'Start the documentation server in the foreground'
-task :docs => 'docs:clear' do
-  original_dir = Dir.pwd
-  Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
-  sh FOREGROUND_SERVER
-  Dir.chdir( original_dir )
 end
 
-namespace :docs do
-
-  desc 'Clear the generated documentation cache'
-  task :clear do
-    original_dir = Dir.pwd
-    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
-    sh 'rm -rf docs'
-    Dir.chdir( original_dir )
-  end
-
-  desc 'Generate static documentation'
-  task :gen => 'docs:clear' do
-    original_dir = Dir.pwd
-    Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
-    output = `bundle exec yard doc`
-    puts output
-    if output =~ /\[warn\]|\[error\]/
-      fail "Errors/Warnings during yard documentation generation"
-    end
-    Dir.chdir( original_dir )
-  end
-
-  desc 'Run the documentation server in the background, alias `bg`'
-  task :background => 'docs:clear' do
-    yes, output = running?( DOCS_DAEMON )
-    if yes
-      puts "Not starting a new YARD Server..."
-      puts "Found one running with pid #{pid_from( output )}."
-    else
-      original_dir = Dir.pwd
-      Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
-      sh "bundle exec #{DOCS_DAEMON}"
-      Dir.chdir( original_dir )
-    end
-  end
-
-  task(:bg) { Rake::Task['docs:background'].invoke }
-
-  desc 'Check the status of the documentation server'
-  task :status do
-    yes, output = running?( DOCS_DAEMON )
-    if yes
-      pid = pid_from( output )
-      puts "Found a YARD Server running with pid #{pid}"
-    else
-      puts "Could not find a running YARD Server."
-    end
-  end
-
-  desc "Stop a running YARD Server"
-  task :stop do
-    yes, output = running?( DOCS_DAEMON )
-    if yes
-      pid = pid_from( output )
-      puts "Found a YARD Server running with pid #{pid}"
-      `kill #{pid}`
-      puts "Stopping..."
-      yes, output = running?( DOCS_DAEMON )
-      if yes
-        `kill -9 #{pid}`
-        yes, output = running?( DOCS_DAEMON )
-        if yes
-          puts "Could not Stop Server!"
-        else
-          puts "Server stopped."
-        end
-      else
-        puts "Server stopped."
-      end
-    else
-      puts "Could not find a running YARD Server"
-    end
-  end
+begin
+  require 'voxpupuli/rubocop/rake'
+rescue LoadError
+  # the voxpupuli-rubocop gem is optional
 end

data/beaker-vcloud.gemspec

@@ -1,44 +1,32 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'beaker-vcloud/version'
 
 Gem::Specification.new do |s|
-  s.name        = "beaker-vcloud"
+  s.name        = 'beaker-vcloud'
   s.version     = BeakerVcloud::VERSION
-  s.authors     = ["Rishi Javia, Kevin Imber, Tony Vu"]
-  s.email       = ["rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-vcloud"
-  s.summary     = %q{Beaker DSL Extension Helpers!}
-  s.description = %q{For use for the Beaker acceptance testing tool}
-  s.license     = 'Apache2'
+  s.authors     = ['Vox Pupuli']
+  s.email       = ['voxpupuli@groups.io']
+  s.homepage    = 'https://github.com/voxpupuli/beaker-vcloud'
+  s.summary     = 'Beaker DSL Extension Helpers!'
+  s.description = 'For use for the Beaker acceptance testing tool'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.7'
 
   # Testing dependencies
+  s.add_development_dependency 'fakefs', '~> 2.5'
+  s.add_development_dependency 'rake', '~> 13.2', '>= 13.2.1'
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-its'
-  # pin fakefs for Ruby < 2.3
-  if RUBY_VERSION < "2.3"
-    s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
-  else
-    s.add_development_dependency 'fakefs', '~> 0.6'
-  end
-  s.add_development_dependency 'rake', '~> 10.1'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'pry', '~> 0.10'
-
-  # Documentation dependencies
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
+  s.add_development_dependency 'rspec-its', '~> 1.3'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.6.0'
 
   # Run time dependencies
+  s.add_runtime_dependency 'beaker', '~> 5.8'
+  s.add_runtime_dependency 'beaker-vmware', '~> 2.1'
+  s.add_runtime_dependency 'rbvmomi2', '~> 3.7', '>= 3.7.1'
   s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-  s.add_runtime_dependency 'rbvmomi', '~> 1.9'
-  s.add_runtime_dependency 'beaker-vmware'
-
 end
-

data/bin/beaker-vcloud

@@ -4,7 +4,7 @@ require 'rubygems' unless defined?(Gem)
 require 'beaker-vcloud'
 
 VERSION_STRING =
-"
+  "
                                  _ .--.
                                 ( `    )
         beaker-vcloud         .-'      `--,
@@ -25,8 +25,6 @@ VERSION_STRING =
                      '=='
 "
 
-
-
 puts BeakerVcloud::VERSION
 
 exit 0

data/lib/beaker/hypervisor/vcloud.rb

@@ -4,13 +4,12 @@ require 'rbvmomi'
 
 module Beaker
   class Vcloud < Beaker::Hypervisor
-
     def self.new(vcloud_hosts, options)
       # Warning for pre-vmpooler style hosts configuration. TODO: remove this eventually.
       if options['pooling_api'] && !options['datacenter']
-        options[:logger].warn "It looks like you may be trying to access vmpooler with `hypervisor: vcloud`. "\
-                              "This functionality has been removed. Change your hosts to `hypervisor: vmpooler` "\
-                              "and remove unused :datacenter, :folder, and :datastore from CONFIG."
+        options[:logger].warn 'It looks like you may be trying to access vmpooler with `hypervisor: vcloud`. ' \
+                              'This functionality has been removed. Change your hosts to `hypervisor: vmpooler` ' \
+                              'and remove unused :datacenter, :folder, and :datastore from CONFIG.'
       end
       super
     end
@@ -23,76 +22,71 @@ module Beaker
       raise 'You must specify a datastore for vCloud instances!' unless @options['datastore']
       raise 'You must specify a folder for vCloud instances!' unless @options['folder']
       raise 'You must specify a datacenter for vCloud instances!' unless @options['datacenter']
+
       @vcenter_credentials = get_fog_credentials(@options[:dot_fog], @options[:vcenter_instance] || :default)
     end
 
     def connect_to_vsphere
       @logger.notify "Connecting to vSphere at #{@vcenter_credentials[:vsphere_server]}" +
-        " with credentials for #{@vcenter_credentials[:vsphere_username]}"
+                     " with credentials for #{@vcenter_credentials[:vsphere_username]}"
 
-      @vsphere_helper = VsphereHelper.new :server => @vcenter_credentials[:vsphere_server],
-                                          :user   => @vcenter_credentials[:vsphere_username],
-                                          :pass   => @vcenter_credentials[:vsphere_password]
+      @vsphere_helper = VsphereHelper.new server: @vcenter_credentials[:vsphere_server],
+                                          user: @vcenter_credentials[:vsphere_username],
+                                          pass: @vcenter_credentials[:vsphere_password]
     end
 
-    def wait_for_dns_resolution host, try, attempts
+    def wait_for_dns_resolution(host, try, attempts)
       @logger.notify "Waiting for #{host['vmhostname']} DNS resolution"
       begin
         Socket.getaddrinfo(host['vmhostname'], nil)
-      rescue
-        if try <= attempts
-          sleep 5
-          try += 1
+      rescue StandardError
+        raise "DNS resolution failed after #{@options[:timeout].to_i} seconds" unless try <= attempts
 
-          retry
-        else
-          raise "DNS resolution failed after #{@options[:timeout].to_i} seconds"
-        end
+        sleep 5
+        try += 1
+
+        retry
       end
     end
 
-    def booting_host host, try, attempts
+    def booting_host(host, try, attempts)
       @logger.notify "Booting #{host['vmhostname']} (#{host.name}) and waiting for it to register with vSphere"
-      until
-        @vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.toolsRunningStatus == 'guestToolsRunning' and
-        @vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.ipAddress != nil
-        if try <= attempts
-          sleep 5
-          try += 1
-        else
-          raise "vSphere registration failed after #{@options[:timeout].to_i} seconds"
-        end
+      until @vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.toolsRunningStatus == 'guestToolsRunning' and
+            !@vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.ipAddress.nil?
+        raise "vSphere registration failed after #{@options[:timeout].to_i} seconds" unless try <= attempts
+
+        sleep 5
+        try += 1
+
       end
     end
 
     # Directly borrowed from openstack hypervisor
     def enable_root(host)
-      if host['user'] != 'root'
-        copy_ssh_to_root(host, @options)
-        enable_root_login(host, @options)
-        host['user'] = 'root'
-        host.close
-      end
+      return unless host['user'] != 'root'
+
+      copy_ssh_to_root(host, @options)
+      enable_root_login(host, @options)
+      host['user'] = 'root'
+      host.close
     end
 
-    def create_clone_spec host
+    def create_clone_spec(host)
       # Add VM annotation
       configSpec = RbVmomi::VIM.VirtualMachineConfigSpec(
-        :annotation =>
-          'Base template:  ' + host['template'] + "\n" +
-          'Creation time:  ' + Time.now.strftime("%Y-%m-%d %H:%M") + "\n\n" +
-          'CI build link:  ' + ( ENV['BUILD_URL'] || 'Deployed independently of CI' ) +
+        annotation: 'Base template:  ' + host['template'] + "\n" +
+          'Creation time:  ' + Time.now.strftime('%Y-%m-%d %H:%M') + "\n\n" +
+          'CI build link:  ' + (ENV['BUILD_URL'] || 'Deployed independently of CI') +
           'department:     ' + @options[:department] +
           'project:        ' + @options[:project],
-        :extraConfig => [
-          { :key   => 'guestinfo.hostname',
-            :value => host['vmhostname']
-          }
-        ]
+        extraConfig: [
+          { key: 'guestinfo.hostname',
+            value: host['vmhostname'], },
+        ],
       )
 
       # Are we using a customization spec?
-      customizationSpec = @vsphere_helper.find_customization( host['template'] )
+      customizationSpec = @vsphere_helper.find_customization(host['template'])
 
       if customizationSpec
         # Print a logger message if using a customization spec
@@ -101,45 +95,44 @@ module Beaker
 
       # Put the VM in the specified folder and resource pool
       relocateSpec = RbVmomi::VIM.VirtualMachineRelocateSpec(
-        :datastore    => @vsphere_helper.find_datastore(@options['datacenter'],@options['datastore']),
-        :pool         => @options['resourcepool'] ? @vsphere_helper.find_pool(@options['datacenter'],@options['resourcepool']) : nil,
-        :diskMoveType => :moveChildMostDiskBacking
+        datastore: @vsphere_helper.find_datastore(@options['datacenter'], @options['datastore']),
+        pool: if @options['resourcepool']
+                @vsphere_helper.find_pool(@options['datacenter'],
+                                          @options['resourcepool'])
+              end,
+        diskMoveType: :moveChildMostDiskBacking,
       )
 
       # Create a clone spec
-      spec = RbVmomi::VIM.VirtualMachineCloneSpec(
-        :config        => configSpec,
-        :location      => relocateSpec,
-        :customization => customizationSpec,
-        :powerOn       => true,
-        :template      => false
+      RbVmomi::VIM.VirtualMachineCloneSpec(
+        config: configSpec,
+        location: relocateSpec,
+        customization: customizationSpec,
+        powerOn: true,
+        template: false,
       )
-      spec
     end
 
     def provision
       connect_to_vsphere
       begin
-
         try = 1
         attempts = @options[:timeout].to_i / 5
 
         start = Time.now
         tasks = []
-        @hosts.each_with_index do |h, i|
-          if h['name']
-            h['vmhostname'] = h['name']
-          else
-            h['vmhostname'] = generate_host_name
-          end
+        @hosts.each_with_index do |h, _i|
+          h['vmhostname'] = (h['name'] || generate_host_name)
 
-          if h['template'].nil? and defined?(ENV['BEAKER_vcloud_template'])
-            h['template'] = ENV['BEAKER_vcloud_template']
+          if h['template'].nil? and defined?(ENV.fetch('BEAKER_vcloud_template', nil))
+            h['template'] = ENV.fetch('BEAKER_vcloud_template', nil)
           end
 
-          raise "Missing template configuration for #{h}.  Set template in nodeset or set ENV[BEAKER_vcloud_template]" unless h['template']
+          unless h['template']
+            raise "Missing template configuration for #{h}.  Set template in nodeset or set ENV[BEAKER_vcloud_template]"
+          end
 
-          if h['template'] =~ /\//
+          if %r{/}.match?(h['template'])
             templatefolders = h['template'].split('/')
             h['template'] = templatefolders.pop
           end
@@ -149,60 +142,60 @@ module Beaker
           vm = {}
 
           if templatefolders
-            vm[h['template']] = @vsphere_helper.find_folder(@options['datacenter'],templatefolders.join('/')).find(h['template'])
+            vm[h['template']] =
+              @vsphere_helper.find_folder(@options['datacenter'], templatefolders.join('/')).find(h['template'])
           else
             vm = @vsphere_helper.find_vms(h['template'])
           end
 
-          if vm.length == 0
-            raise "Unable to find template '#{h['template']}'!"
-          end
+          raise "Unable to find template '#{h['template']}'!" if vm.length == 0
 
           spec = create_clone_spec(h)
 
           # Deploy from specified template
-          tasks << vm[h['template']].CloneVM_Task( :folder => @vsphere_helper.find_folder(@options['datacenter'],@options['folder']), :name => h['vmhostname'], :spec => spec )
+          tasks << vm[h['template']].CloneVM_Task(
+            folder: @vsphere_helper.find_folder(@options['datacenter'],
+                                                @options['folder']), name: h['vmhostname'], spec: spec
+          )
         end
 
         try = (Time.now - start) / 5
         @vsphere_helper.wait_for_tasks(tasks, try, attempts)
-        @logger.notify 'Spent %.2f seconds deploying VMs' % (Time.now - start)
+        @logger.notify format('Spent %.2f seconds deploying VMs', (Time.now - start))
 
         try = (Time.now - start) / 5
         duration = run_and_report_duration do
-          @hosts.each_with_index do |h, i|
+          @hosts.each_with_index do |h, _i|
             booting_host(h, try, attempts)
           end
         end
-        @logger.notify "Spent %.2f seconds booting and waiting for vSphere registration" % duration
+        @logger.notify 'Spent %.2f seconds booting and waiting for vSphere registration' % duration
 
         try = (Time.now - start) / 5
         duration = run_and_report_duration do
           @hosts.each do |host|
             repeat_fibonacci_style_for 8 do
-              @vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.ipAddress != nil
+              !@vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.ipAddress.nil?
             end
             host[:ip] = @vsphere_helper.find_vms(host['vmhostname'])[host['vmhostname']].summary.guest.ipAddress
             enable_root(host) unless host.is_cygwin?
           end
         end
 
-        @logger.notify "Spent %.2f seconds waiting for DNS resolution" % duration
-
-      rescue => e
+        @logger.notify 'Spent %.2f seconds waiting for DNS resolution' % duration
+      rescue StandardError => e
         @vsphere_helper.close
-        report_and_raise(@logger, e, "Vcloud.provision")
+        report_and_raise(@logger, e, 'Vcloud.provision')
       end
-
     end
 
     def cleanup
-      @logger.notify "Destroying vCloud boxes"
+      @logger.notify 'Destroying vCloud boxes'
       connect_to_vsphere
 
-      vm_names = @hosts.map {|h| h['vmhostname'] }.compact
+      vm_names = @hosts.map { |h| h['vmhostname'] }.compact
       if @hosts.length != vm_names.length
-        @logger.warn "Some hosts did not have vmhostname set correctly! This likely means VM provisioning was not successful"
+        @logger.warn 'Some hosts did not have vmhostname set correctly! This likely means VM provisioning was not successful'
       end
       vms = @vsphere_helper.find_vms vm_names
       begin
@@ -224,12 +217,11 @@ module Beaker
             vm.Destroy_Task
           end
           @logger.notify "Spent %.2f seconds destroying #{vm.name}" % duration
-
         end
-      rescue RbVmomi::Fault => ex
-        if ex.fault.is_a?(RbVmomi::VIM::ManagedObjectNotFound)
-          #it's already gone, don't bother trying to delete it
-          name = vms.key(ex.fault.obj)
+      rescue RbVmomi::Fault => e
+        if e.fault.is_a?(RbVmomi::VIM::ManagedObjectNotFound)
+          # it's already gone, don't bother trying to delete it
+          name = vms.key(e.fault.obj)
           vms.delete(name)
           vm_names.delete(name)
           @logger.warn "Unable to destroy #{name}, it was not found in vSphere"
@@ -238,6 +230,5 @@ module Beaker
       end
       @vsphere_helper.close
     end
-
   end
 end

data/lib/beaker-vcloud/version.rb

@@ -1,3 +1,3 @@
 module BeakerVcloud
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end