beaker-docker 1.4.0 → 2.0.0

data/.simplecov

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SimpleCov.configure do
   add_filter 'spec/'
   add_filter 'vendor/'

data/CHANGELOG.md

@@ -1,6 +1,56 @@
 # Changelog
 
-## [1.4.0](https://github.com/voxpupuli/beaker-docker/tree/1.4.0) (2023-03-09)
+## [2.0.0](https://github.com/voxpupuli/beaker-docker/tree/2.0.0) (2023-03-28)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/1.5.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby 2.4/2.5/2.6 support [\#109](https://github.com/voxpupuli/beaker-docker/pull/109) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Drop `beaker-rspec` dependency [\#107](https://github.com/voxpupuli/beaker-docker/pull/107) ([jay7x](https://github.com/jay7x))
+
+**Merged pull requests:**
+
+- Rubocop: fix more violations [\#113](https://github.com/voxpupuli/beaker-docker/pull/113) ([bastelfreak](https://github.com/bastelfreak))
+- rubocop: Use shared config from beaker [\#112](https://github.com/voxpupuli/beaker-docker/pull/112) ([bastelfreak](https://github.com/bastelfreak))
+- Fix even more rubocop issues [\#111](https://github.com/voxpupuli/beaker-docker/pull/111) ([jay7x](https://github.com/jay7x))
+- More rubocop fixes [\#110](https://github.com/voxpupuli/beaker-docker/pull/110) ([jay7x](https://github.com/jay7x))
+- Fix more rubocop warnings [\#108](https://github.com/voxpupuli/beaker-docker/pull/108) ([jay7x](https://github.com/jay7x))
+- Fix multiple Rubocop warnings [\#106](https://github.com/voxpupuli/beaker-docker/pull/106) ([bastelfreak](https://github.com/bastelfreak))
+
+## [1.5.0](https://github.com/voxpupuli/beaker-docker/tree/1.5.0) (2023-03-24)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/1.4.0...1.5.0)
+
+**Implemented enhancements:**
+
+- Ruby 3.2 compatibility [\#100](https://github.com/voxpupuli/beaker-docker/pull/100) ([ekohl](https://github.com/ekohl))
+- Set required Ruby version to 2.4+ [\#99](https://github.com/voxpupuli/beaker-docker/pull/99) ([ekohl](https://github.com/ekohl))
+- Simplify port detection code [\#95](https://github.com/voxpupuli/beaker-docker/pull/95) ([ekohl](https://github.com/ekohl))
+- Add Ruby 3.1 to CI matrix [\#87](https://github.com/voxpupuli/beaker-docker/pull/87) ([bastelfreak](https://github.com/bastelfreak))
+- Use ssh-keygen -A on Red Hat-based distros & SuSE/SLES [\#73](https://github.com/voxpupuli/beaker-docker/pull/73) ([ekohl](https://github.com/ekohl))
+
+**Fixed bugs:**
+
+- Deal with docker\_cmd being an array and remove use of =~ [\#93](https://github.com/voxpupuli/beaker-docker/pull/93) ([ekohl](https://github.com/ekohl))
+
+**Merged pull requests:**
+
+- Remove Gemfile.local from git [\#104](https://github.com/voxpupuli/beaker-docker/pull/104) ([ekohl](https://github.com/ekohl))
+- Fix rubocop Naming/FileName [\#103](https://github.com/voxpupuli/beaker-docker/pull/103) ([jay7x](https://github.com/jay7x))
+- cleanup GitHub actions [\#102](https://github.com/voxpupuli/beaker-docker/pull/102) ([bastelfreak](https://github.com/bastelfreak))
+- Remove unused rspec-its dependency [\#98](https://github.com/voxpupuli/beaker-docker/pull/98) ([ekohl](https://github.com/ekohl))
+- Allow fakefs 2.x [\#97](https://github.com/voxpupuli/beaker-docker/pull/97) ([ekohl](https://github.com/ekohl))
+- Remove yard rake tasks [\#96](https://github.com/voxpupuli/beaker-docker/pull/96) ([ekohl](https://github.com/ekohl))
+- rubocop: fix dependency ordering [\#94](https://github.com/voxpupuli/beaker-docker/pull/94) ([bastelfreak](https://github.com/bastelfreak))
+- GHA: Use builtin podman [\#86](https://github.com/voxpupuli/beaker-docker/pull/86) ([bastelfreak](https://github.com/bastelfreak))
+- GHA: Use builtin docker [\#85](https://github.com/voxpupuli/beaker-docker/pull/85) ([bastelfreak](https://github.com/bastelfreak))
+- Fix rubocop-related issues \(part 1\) [\#75](https://github.com/voxpupuli/beaker-docker/pull/75) ([jay7x](https://github.com/jay7x))
+
+## [1.4.0](https://github.com/voxpupuli/beaker-docker/tree/1.4.0) (2023-03-10)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/1.3.0...1.4.0)
 

data/Gemfile

@@ -1,14 +1,12 @@
+# frozen_string_literal: true
+
 source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
-end
-
 group :coverage, optional: ENV['COVERAGE'] != 'yes' do
-  gem 'simplecov-console', require: false
   gem 'codecov', require: false
+  gem 'simplecov-console', require: false
 end
 
 group :release do

data/Rakefile

@@ -1,24 +1,29 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 
-namespace :lint do
+begin
   require 'rubocop/rake_task'
+rescue LoadError
+  # RuboCop is an optional group
+else
   RuboCop::RakeTask.new(:rubocop) do |task|
-    # Use Rubocop's Github Actions formatter
-    if ENV['GITHUB_ACTIONS'] == 'true'
-      task.formatters << 'github'
-    end
+    # 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
 
 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', '--format documentation']
       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_DOCKER_COVERAGE'] = 'y'
       t.rspec_opts = ['--color', '--format documentation']
@@ -27,26 +32,25 @@ namespace :test do
   end
 
   namespace :acceptance do
-    desc <<-EOS
-A quick acceptance test, named because it has no pre-suites to run
-    EOS
+    desc 'A quick acceptance test, named because it has no pre-suites to run'
     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')
-
-      ENV['BEAKER_setfile'] = 'acceptance/config/nodes/hosts.yaml' unless ENV.key?('BEAKER_setfile')
-      sh("beaker",
-          # We can't run these tests until the rsync support in the main
-          # beaker/host.rb is updated to work with passwords.
-          # "--tests", beaker_test_base_dir,
-          # "--load-path", load_path_option,
-         "--tests", 'acceptance/tests/',
-         "--log-level", "debug",
-         "--debug")
+      ## setup & load_path of beaker's acceptance base and lib directory
+      ## see below for the reason why it's commented out atm
+      # 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')
+
+      ENV['BEAKER_setfile'] = 'acceptance/config/nodes/hosts.yaml'
+      sh('beaker',
+         '--hosts', 'acceptance/config/nodes/hosts.yaml',
+         ## We can't run these tests until the rsync support in the main
+         ## beaker/host.rb is updated to work with passwords.
+         # '--tests', beaker_test_base_dir,
+         # '--load-path', load_path_option,
+         '--tests', 'acceptance/tests/',
+         '--log-level', 'debug',
+         '--debug')
     end
   end
 end
@@ -54,126 +58,22 @@ end
 # namespace-named default tasks.
 # these are the default tasks invoked when only the namespace is referenced.
 # they're needed because `task :default` in those blocks doesn't work as expected.
-task 'test:spec' => 'test:spec:run'
-task 'test:acceptance' => 'test:acceptance:quick'
+task 'test:spec': %i[test:spec:run]
+task 'test:acceptance': %i[test:acceptance:quick]
 
 # global defaults
-task :lint => %i[lint:rubocop]
-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 lint: %i[lint:rubocop]
+task test: %i[test:spec]
+task default: %i[test]
 
 begin
   require 'rubygems'
   require 'github_changelog_generator/task'
 rescue LoadError
+  # Do nothing if no required gem installed
 else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog}
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
     config.user = 'voxpupuli'
     config.project = 'beaker-docker'
     gem_version = Gem::Specification.load("#{config.project}.gemspec").version

data/acceptance/tests/00_default_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'beaker'
-require 'beaker-rspec'
 
-RSpec.describe 'it can connect' do
+test_name 'Ensure docker container is accessible' do
   hosts.each do |host|
-    context "on #{host}" do
-      on(host, 'ls /tmp')
+    step "on #{host}" do
+      on(host, 'true')
     end
   end
 end

data/beaker-docker.gemspec

@@ -1,39 +1,40 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'beaker-docker/version'
 
 Gem::Specification.new do |s|
-  s.name        = "beaker-docker"
+  s.name        = 'beaker-docker'
   s.version     = BeakerDocker::VERSION
   s.authors     = [
-    "Vox Pupuli",
-    "Rishi Javia",
-    "Kevin Imber",
-    "Tony Vu"
+    'Vox Pupuli',
+    'Rishi Javia',
+    'Kevin Imber',
+    'Tony Vu',
   ]
-  s.email       = ["voxpupuli@groups.io"]
-  s.homepage    = "https://github.com/voxpupuli/beaker-docker"
-  s.summary     = %q{Beaker DSL Extension Helpers!}
-  s.description = %q{For use for the Beaker acceptance testing tool}
+  s.email       = ['voxpupuli@groups.io']
+  s.homepage    = 'https://github.com/voxpupuli/beaker-docker'
+  s.summary     = 'Docker hypervisor for Beaker acceptance testing framework'
+  s.description = 'Allows running Beaker tests using Docker'
   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', '< 4'
 
   # Testing dependencies
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-its', '~> 1.3'
-  s.add_development_dependency 'fakefs', '~> 1.3'
+  s.add_development_dependency 'fakefs', '>= 1.3', '< 3.0'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rubocop', '~> 1.12.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  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', '~> 5.0'
   s.add_runtime_dependency 'docker-api', '~> 2.1'
-  s.add_runtime_dependency 'beaker', '>= 4.34'
+  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
 end

data/bin/beaker-docker

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems' unless defined?(Gem)
 require 'beaker-docker'
 
-VERSION_STRING =
-"
+VERSION_STRING = <<'VER'
                                  _ .--.
                                 ( `    )
         beaker-docker         .-'      `--,
@@ -14,19 +14,17 @@ VERSION_STRING =
               ;|  _|  _|  _|  '-'__,--'`--'
               | _|  _|  _|  _| |
           _   ||  _|  _|  _|  _| %s
-        _( `--.\\_|  _|  _|  _|/
+        _( `--.\_|  _|  _|  _|/
      .-'       )--,|  _|  _|.`
     (__, (_      ) )_|  _| /
-      `-.__.\\ _,--'\\|__|__/
+      `-.__.\ _,--'\|__|__/
                     ;____;
-                     \\YT/
+                     \YT/
                       ||
-                     |\"\"|
+                     |""|
                      '=='
-"
+VER
 
-
-
-puts BeakerDocker::VERSION
+puts VERSION_STRING % BeakerDocker::VERSION
 
 exit 0