beaker-vmware 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f7f50dce24d1ebc8f1a54b7764f0d640915e8b5fbcee24b7775e798e065f3c
-  data.tar.gz: cc69b9a923c68bd3cf2c5ec0e24f00cab54acf38533253529a9df8be76d12a96
+  metadata.gz: be69407550d964113e9fb9e3fdcd567c903fbff2e137dd716143e2abe38bd701
+  data.tar.gz: 6b9a1365fec6cbcece962a6906588deeddd37eb87f7b939c9b78c01ab5d8b77e
 SHA512:
-  metadata.gz: b780022ef4f50cd6811225dec75532f6a333d0df4a40bf4335e351800d6a67e02a8248ae26e34ba81f9d7c6c43a9c9820e7078a68029dbee852e452826ac59ac
-  data.tar.gz: 5487718187e70b29b3d0a2eba7546171b736e601d28da8f98cf63c9155560967125bd13f9f8cffd536c460d3d09350d67a46d24e59dd4f01390d96866c54c1c8
+  metadata.gz: dda90f1f25eef41f3cdf32407d95ca6f2482b5de059ee443909f1174e6fdcd0e42f494792c70f41d279c3c3a004ede3e497ad0f461a634f26567eb3882efd78c
+  data.tar.gz: f0293b346e71faec357550a5c955ef5da222b91fba56cfbd41ff69b2899df0223bae1a34d37f5072e60dc56abe9c0fe6c7e59e807d7b02a42847e8b1cf18d069

data/.github/dependabot.yml

@@ -1,8 +1,17 @@
 version: 2
 updates:
+# raise PRs for gem updates
 - package-ecosystem: bundler
   directory: "/"
   schedule:
     interval: daily
     time: "13:00"
   open-pull-requests-limit: 10
+
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -1,29 +1,41 @@
 name: Test
 
 on:
-  - pull_request
-  - push
+  pull_request: {}
+  push:
+    branches:
+      - master
 
 env:
   BUNDLE_WITHOUT: release
 
 jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rake rubocop
+
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         include:
-          - ruby: "2.4"
-          - ruby: "2.5"
-          - ruby: "2.6"
           - ruby: "2.7"
           - ruby: "3.0"
             coverage: "yes"
+          - ruby: "3.1"
     env:
       COVERAGE: ${{ matrix.coverage }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -33,3 +45,12 @@ jobs:
         run: bundle exec rake
       - name: Build gem
         run: gem build *.gemspec
+
+  tests:
+    needs:
+      - rubocop
+      - test
+    runs-on: ubuntu-latest
+    name: Test suite
+    steps:
+      - run: echo Test suite completed

data/.rubocop.yml

@@ -0,0 +1,5 @@
+---
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  beaker: rubocop.yml

data/.rubocop_todo.yml

@@ -0,0 +1,266 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-03-27 20:09:11 UTC using RuboCop version 1.48.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere.rb'
+
+# Offense count: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 2
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+    - 'lib/beaker/hypervisor/vsphere.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments, AllowNil.
+Lint/SuppressedException:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 3
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'spec/beaker/hypervisor/vsphere_spec.rb'
+
+# Offense count: 4
+Naming/AccessorMethodName:
+  Exclude:
+    - 'spec/mock_fission.rb'
+    - 'spec/mock_vsphere.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 30
+# Configuration parameters: EnforcedStyle, AllowedPatterns.
+# SupportedStyles: snake_case, camelCase
+Naming/MethodName:
+  Exclude:
+    - 'spec/mock_vsphere.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 11
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+    - 'spec/mock_vsphere.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 28
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+    - 'spec/mock_vsphere.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/beaker/hypervisor/fusion_spec.rb'
+
+# Offense count: 12
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/beaker/hypervisor/fusion_spec.rb'
+    - 'spec/beaker/hypervisor/vsphere_helper_spec.rb'
+    - 'spec/beaker/hypervisor/vsphere_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/beaker/hypervisor/fusion_spec.rb'
+
+# Offense count: 5
+RSpec/UnspecifiedException:
+  Exclude:
+    - 'spec/beaker/hypervisor/fusion_spec.rb'
+    - 'spec/beaker/hypervisor/vsphere_helper_spec.rb'
+    - 'spec/beaker/hypervisor/vsphere_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/beaker/hypervisor/vsphere_helper_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Rake/Desc:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+
+# Offense count: 12
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowOnConstant, AllowOnSelfClass.
+Style/CaseEquality:
+  Exclude:
+    - 'spec/beaker/hypervisor/vsphere_helper_spec.rb'
+
+# Offense count: 7
+Style/ClassVars:
+  Exclude:
+    - 'spec/mock_fission.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/beaker/hypervisor/fusion.rb'
+    - 'lib/beaker/hypervisor/vsphere.rb'
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+    - 'lib/beaker/hypervisor/vsphere.rb'
+
+# Offense count: 16
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/InfiniteLoop:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere_helper.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/LineEndConcatenation:
+  Exclude:
+    - 'lib/beaker/hypervisor/vsphere.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'bin/beaker-vmware'
+    - 'lib/beaker-vmware/version.rb'
+
+# Offense count: 2
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/mock_vsphere.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'spec/mock_vsphere.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowComments.
+Style/RedundantInitialize:
+  Exclude:
+    - 'spec/mock_vsphere.rb'
+    - 'spec/mock_vsphere_helper.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'spec/mock_vsphere.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
+# AllowedMethods: define_method
+Style/SymbolProc:
+  Exclude:
+    - 'lib/beaker/hypervisor/fusion.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 152

data/.simplecov

@@ -6,4 +6,4 @@ SimpleCov.configure do
   end
 end
 
-SimpleCov.start if ENV['BEAKER_VMWARE_COVERAGE']
+SimpleCov.start if ENV['BEAKER_VMWARE_COVERAGE']

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [2.0.0](https://github.com/voxpupuli/beaker-vmware/tree/2.0.0) (2023-03-28)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-vmware/compare/1.0.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby 2.4/2.5/2.6 support; Add 3.1 [\#25](https://github.com/voxpupuli/beaker-vmware/pull/25) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Implement rubocop [\#26](https://github.com/voxpupuli/beaker-vmware/pull/26) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- Update fakefs requirement from ~\> 0.6 to ~\> 2.4 [\#23](https://github.com/voxpupuli/beaker-vmware/pull/23) ([dependabot[bot]](https://github.com/apps/dependabot))
+- CI: Apply Vox Pupuli best practices [\#22](https://github.com/voxpupuli/beaker-vmware/pull/22) ([bastelfreak](https://github.com/bastelfreak))
+- Bump actions/checkout from 2 to 3 [\#21](https://github.com/voxpupuli/beaker-vmware/pull/21) ([dependabot[bot]](https://github.com/apps/dependabot))
+- dependabot: check for github actions and gems [\#20](https://github.com/voxpupuli/beaker-vmware/pull/20) ([bastelfreak](https://github.com/bastelfreak))
+- Update rbvmomi requirement from ~\> 1.9 to \>= 1.9, \< 4.0 [\#12](https://github.com/voxpupuli/beaker-vmware/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [1.0.0](https://github.com/voxpupuli/beaker-vmware/tree/1.0.0) (2021-08-09)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-vmware/compare/0.3.0...1.0.0)

data/Gemfile

@@ -1,31 +1,12 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
-
-
-def location_for(place, fake_version = nil)
-  if place =~ /^git:([^#]*)#(.*)/
-    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
-  elsif place =~ /^file:\/\/(.*)/
-    ['>= 0', { :path => File.expand_path($1), :require => false }]
-  else
-    [place, { :require => false }]
-  end
-end
-
-
-# We don't put beaker in as a test dependency because we
-# don't want to create a transitive dependency
-group :acceptance_testing do
-  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3.0')
-end
-
 group :release do
   gem 'github_changelog_generator', require: false
 end
 
-group :coverage, optional: ENV['COVERAGE']!='yes' do
-  gem 'simplecov-console', :require => false
-  gem 'codecov', :require => false
+group :coverage, optional: ENV['COVERAGE'] != 'yes' do
+  gem 'codecov', require: false
+  gem 'simplecov-console', require: false
 end

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,119 +43,14 @@ 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."
-  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
-end
+task test: 'test:spec'
+task default: :test
 
 begin
   require 'rubygems'
   require 'github_changelog_generator/task'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+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]
@@ -172,3 +60,16 @@ else
     config.future_release = gem_version
   end
 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