beaker-vmware 0.3.0 → 2.0.0

data/Rakefile

@@ -1,46 +1,39 @@
 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"
+    desc 'Run spec tests with coverage'
     RSpec::Core::RakeTask.new(:coverage) do |t|
       ENV['BEAKER_VMWARE_COVERAGE'] = 'y'
       t.rspec_opts = ['--color']
       t.pattern = 'spec/'
     end
-
   end
 
   namespace :acceptance do
-
-    desc <<-EOS
-A quick acceptance test, named because it has no pre-suites to run
+    desc <<~EOS
+      A quick acceptance test, named because it has no pre-suites to run
     EOS
     task :quick do
-
       # setup & load_path of beaker's acceptance base and lib directory
       beaker_gem_spec = Gem::Specification.find_by_name('beaker')
       beaker_gem_dir = beaker_gem_spec.gem_dir
       beaker_test_base_dir = File.join(beaker_gem_dir, 'acceptance/tests/base')
       load_path_option = File.join(beaker_gem_dir, 'acceptance/lib')
 
-      sh("beaker",
-         "--hosts", "acceptance/config/nodes/test-nodes.yml",
-         "--tests", beaker_test_base_dir,
-         "--log-level", "debug",
-         "--load-path", load_path_option)
+      sh('beaker',
+         '--hosts', 'acceptance/config/nodes/test-nodes.yml',
+         '--tests', beaker_test_base_dir,
+         '--log-level', 'debug',
+         '--load-path', load_path_option)
     end
-
   end
-
 end
 
 # namespace-named default tasks.
@@ -50,111 +43,33 @@ task 'test:spec' => 'test:spec:run'
 task 'test:acceptance' => 'test:acceptance:quick'
 
 # 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]
+    config.user = 'voxpupuli'
+    config.project = 'beaker-vmware'
+    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
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+  # RuboCop is an optional group
+else
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    # These make the rubocop experience maybe slightly less terrible
+    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+    # Use Rubocop's Github Actions formatter if possible
+    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
   end
 end

data/beaker-vmware.gemspec

@@ -1,44 +1,34 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'beaker-vmware/version'
 
 Gem::Specification.new do |s|
-  s.name        = "beaker-vmware"
+  s.name        = 'beaker-vmware'
   s.version     = BeakerVmware::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-vmware"
-  s.summary     = %q{Beaker DSL Extension Helpers!}
-  s.description = %q{For use for the Beaker acceptance testing tool}
+  s.authors     = ['Vox Pupuli']
+  s.email       = ['voxpupuli@groups.io']
+  s.homepage    = 'https://github.com/voxpupuli/beaker-vmware'
+  s.summary     = 'Beaker DSL Extension Helpers!'
+  s.description = 'For use for the Beaker acceptance testing tool'
   s.license     = 'Apache2'
 
   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 = Gem::Requirement.new('>= 2.7')
 
   # Testing dependencies
+  s.add_development_dependency 'fakefs', '~> 2.4'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  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'
-  s.add_development_dependency 'beaker', '~> 3.0'
-
-  # Documentation dependencies
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
-
+  s.add_development_dependency 'rubocop', '~> 1.48.1'
+  s.add_development_dependency 'rubocop-performance', '~> 1.10'
+  s.add_development_dependency 'rubocop-rake', '~> 0.2'
+  s.add_development_dependency 'rubocop-rspec', '>= 1.44'
   # Run time dependencies
-  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
+  s.add_runtime_dependency 'beaker', '>= 4', '< 6'
   s.add_runtime_dependency 'fission', '~> 0.4'
-  s.add_runtime_dependency 'rbvmomi', '~> 1.9'
-
+  s.add_runtime_dependency 'rbvmomi', '>= 1.9', '< 4.0'
+  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
 end
-

data/bin/beaker-vmware

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

data/lib/beaker/hypervisor/fusion.rb

@@ -1,29 +1,30 @@
 module Beaker
   class Fusion < Beaker::Hypervisor
-
     def initialize(fusion_hosts, options)
       require 'rubygems' unless defined?(Gem)
       begin
         require 'fission'
       rescue LoadError
-        raise "Unable to load fission, please ensure it is installed!"
+        raise 'Unable to load fission, please ensure it is installed!'
       end
       @logger = options[:logger]
       @options = options
       @hosts = fusion_hosts
-      #check preconditions for fusion
+      # check preconditions for fusion
       @hosts.each do |host|
-        raise "You must specify a snapshot for Fusion instances, no snapshot defined for #{host.name}!" unless host["snapshot"]
+        unless host['snapshot']
+          raise "You must specify a snapshot for Fusion instances, no snapshot defined for #{host.name}!"
+        end
       end
       @fission = Fission::VM
     end
 
     def provision
-      available = @fission.all.data.collect{|vm| vm.name}.sort.join(", ")
+      available = @fission.all.data.collect { |vm| vm.name }.sort.join(', ')
       @logger.notify "Available VM names: #{available}"
 
       @hosts.each do |host|
-        vm_name = host["vmname"] || host.name
+        vm_name = host['vmname'] || host.name
         vm = @fission.new vm_name
         raise "Could not find VM '#{vm_name}' for #{host.name}!" unless vm.exists?
 
@@ -32,34 +33,31 @@ module Beaker
           raise "No snapshots available for VM #{host.name} (vmname: '#{vm_name}')"
         end
 
-        available_snapshots = vm_snapshots.sort.join(", ")
+        available_snapshots = vm_snapshots.sort.join(', ')
         @logger.notify "Available snapshots for #{host.name}: #{available_snapshots}"
-        snap_name = host["snapshot"]
-        raise "Could not find snapshot '#{snap_name}' for host #{host.name}!" unless vm.snapshots.data.include? snap_name
+        snap_name = host['snapshot']
+        unless vm.snapshots.data.include? snap_name
+          raise "Could not find snapshot '#{snap_name}' for host #{host.name}!"
+        end
 
         @logger.notify "Reverting #{host.name} to snapshot '#{snap_name}'"
         start = Time.now
         vm.revert_to_snapshot snap_name
-        while vm.running?.data
-          sleep 1
-        end
+        sleep 1 while vm.running?.data
         time = Time.now - start
-        @logger.notify "Spent %.2f seconds reverting" % time
+        @logger.notify 'Spent %.2f seconds reverting' % time
 
         @logger.notify "Resuming #{host.name}"
         start = Time.now
-        vm.start :headless => true
-        until vm.running?.data
-          sleep 1
-        end
+        vm.start headless: true
+        sleep 1 until vm.running?.data
         time = Time.now - start
-        @logger.notify "Spent %.2f seconds resuming VM" % time
-      end
-      end #revert_fusion
-
-      def cleanup
-        @logger.notify "No cleanup for fusion boxes"
+        @logger.notify 'Spent %.2f seconds resuming VM' % time
       end
+    end # revert_fusion
 
+    def cleanup
+      @logger.notify 'No cleanup for fusion boxes'
+    end
   end
 end

data/lib/beaker/hypervisor/vsphere.rb

@@ -3,7 +3,6 @@ require 'beaker/hypervisor/vsphere_helper'
 
 module Beaker
   class Vsphere < Beaker::Hypervisor
-
     def initialize(vsphere_hosts, options)
       @options = options
       @logger = options[:logger]
@@ -14,14 +13,14 @@ module Beaker
       vsphere_credentials = VsphereHelper.load_config(@options[:dot_fog])
 
       @logger.notify "Connecting to vSphere at #{vsphere_credentials[:server]}" +
-        " with credentials for #{vsphere_credentials[:user]}"
+                     " with credentials for #{vsphere_credentials[:user]}"
 
-      vsphere_helper = VsphereHelper.new( vsphere_credentials )
+      vsphere_helper = VsphereHelper.new(vsphere_credentials)
 
       vsphere_vms = {}
       @hosts.each do |h|
-        name = h["vmname"] || h.name
-        vsphere_vms[name] = h["snapshot"]
+        name = h['vmname'] || h.name
+        vsphere_vms[name] = h['snapshot']
       end
       vms = vsphere_helper.find_vms(vsphere_vms.keys)
       vsphere_vms.each_pair do |name, snap|
@@ -40,47 +39,47 @@ module Beaker
           snapshot.RevertToSnapshot_Task.wait_for_completion
 
           time = Time.now - start
-          @logger.notify "Spent %.2f seconds reverting" % time
+          @logger.notify 'Spent %.2f seconds reverting' % time
         end
 
-        unless vm.runtime.powerState == "poweredOn"
-          @logger.notify "Booting #{vm.name}"
-          start = Time.now
-          vm.PowerOnVM_Task.wait_for_completion
-          @logger.notify "Spent %.2f seconds booting #{vm.name}" % (Time.now - start)
-        end
+        next if vm.runtime.powerState == 'poweredOn'
+
+        @logger.notify "Booting #{vm.name}"
+        start = Time.now
+        vm.PowerOnVM_Task.wait_for_completion
+        @logger.notify format("Spent %.2f seconds booting #{vm.name}", (Time.now - start))
       end
 
       vsphere_helper.close
     end
 
     def cleanup
-      @logger.notify "Destroying vsphere boxes"
+      @logger.notify 'Destroying vsphere boxes'
       vsphere_credentials = VsphereHelper.load_config(@options[:dot_fog])
 
       @logger.notify "Connecting to vSphere at #{vsphere_credentials[:server]}" +
-        " with credentials for #{vsphere_credentials[:user]}"
+                     " with credentials for #{vsphere_credentials[:user]}"
 
-      vsphere_helper = VsphereHelper.new( vsphere_credentials )
+      vsphere_helper = VsphereHelper.new(vsphere_credentials)
 
-      vm_names = @hosts.map {|h| h['vmname'] || h.name }
+      vm_names = @hosts.map { |h| h['vmname'] || h.name }
       vms = vsphere_helper.find_vms vm_names
       vm_names.each do |name|
         unless vm = vms[name]
           raise "Couldn't find VM #{name} in vSphere!"
         end
 
-        if vm.runtime.powerState == "poweredOn"
-          @logger.notify "Shutting down #{vm.name}"
-          start = Time.now
-          vm.PowerOffVM_Task.wait_for_completion
-          @logger.notify(
-            "Spent %.2f seconds halting #{vm.name}" % (Time.now - start) )
-        end
+        next unless vm.runtime.powerState == 'poweredOn'
+
+        @logger.notify "Shutting down #{vm.name}"
+        start = Time.now
+        vm.PowerOffVM_Task.wait_for_completion
+        @logger.notify(
+          format("Spent %.2f seconds halting #{vm.name}", (Time.now - start)),
+        )
       end
 
       vsphere_helper.close
     end
-
   end
 end