beaker 4.37.2 → 4.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94de428f52b80007b5443a3694bfba1c6cf8fb694373a760ba825d0b044117bb
-  data.tar.gz: 0d28d5a725253b87ca396639767778f1a70d143094b94049a60616d7e7accd0d
+  metadata.gz: e1ac6690e4ad7436057320fe86b41db78a6f805e7fa93e1a5565ca84c778a5e0
+  data.tar.gz: 54cdf1e43fea24d2b1a1421612b12c9cc41cd9a529d00d78a79d37a6b746dadd
 SHA512:
-  metadata.gz: 73f8ec5ae3893fe1b99b08515eac624b1531505c2793d507837a30e5bd0a6d87196fee04828d291e1c8bb1f2ab8dc3b158864270aa75a50d43a3759019ddbb94
-  data.tar.gz: c81de7019a75a1532ec4ae1b52826c93bc3cfee7060ee52948c364be6ae50174177743bea06edd52b6cbd0866ed3d501d34c686bfe1c0e2c94ae9edfb4915a7b
+  metadata.gz: afe3ecdd06a58edf0a841aac2009eb0f03974edeaf4441d5843760dfa30e364be94c030c144173080abcdfc12f3b4b87dac1deaef6644e6cc56cc83297b51f2a
+  data.tar.gz: 5d7ec12ffce5318ca9470d9e66d689c6a9f51ef10fd29e5fa26d43bebcf47d6978d2f5d392a43223aba21f4d2372fe69994217adbaff73f4bb078a40a5633359

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.38.0](https://github.com/voxpupuli/beaker/tree/4.37.2) (2022-08-11)
+
+## Added
+
+- Drop pry dependency, allow using debug gem ([#1737](https://github.com/voxpupuli/beaker/pull/1737))
+
 ## [4.37.2](https://github.com/voxpupuli/beaker/tree/4.37.2) (2022-07-28)
 
 ## Fixed

data/beaker.gemspec

@@ -32,9 +32,6 @@ Gem::Specification.new do |s|
   # Run time dependencies
   s.add_runtime_dependency 'minitest', '~> 5.4'
   s.add_runtime_dependency 'minitar', '~> 0.6'
-  s.add_runtime_dependency 'pry-byebug', '~> 3.9'
-  # pry-byebug can have issues with native readline libs so add rb-readline
-  s.add_runtime_dependency 'rb-readline', '~> 0.5.3'
   s.add_runtime_dependency 'rexml'
 
   s.add_runtime_dependency 'hocon', '~> 1.0'

data/docs/how_to/debug_beaker_tests.md

@@ -1,6 +1,6 @@
 # Debug beaker tests
 
-beaker includes [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug), a gem that combines two powerful related tools: pry and byebug
+beaker can use [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug), a gem that combines two powerful related tools: pry and byebug. It falls back to [debug](https://github.com/ruby/debug) if pry is unavailable.
 
 ### What is Pry?
 
@@ -16,6 +16,10 @@ There are several ways to have your tests break and enter debugging:
  2. [Use the --debug-errors option](#use-the---debug-errors-option)
  3. [Defining external breakpoints with byebug](#defining-external-breakpoints-with-byebug)
 
+### What is debug?
+
+[debug](https://github.com/ruby/debug) is the new debugger bundled since Ruby 3.1.
+
 ## Add a breakpoint to your test file
 
 Add Pry to individual tests by adding `require 'pry'` to the Ruby test file. Then add the statement `binding.pry` at the point in code where you want access to the full, current Beaker environment.
@@ -232,7 +236,7 @@ Simply `exit` the console.
 
 ## Use the --debug-errors option
 
-You can run beaker and pass the option `--debug-errors` to have beaker enter the pry console if or when a test error occurs. This is useful for transient/intermittent errors where you may need to run the test a large number of times before seeing the failure. It's also useful to keep your hosts at the state where error occurred, as the test's teardown will not (yet) have executed.
+You can run beaker and pass the option `--debug-errors` to have beaker enter the pry or debug console if or when a test error occurs. This is useful for transient/intermittent errors where you may need to run the test a large number of times before seeing the failure. It's also useful to keep your hosts at the state where error occurred, as the test's teardown will not (yet) have executed.
 
 ### Example
 
@@ -249,10 +253,10 @@ Consider this example test case _test.rb_, which is going to fail:
 
 You can run this test using `beaker -t test.rb` or (to use the `run` subcommand and just run the test and bypass host provisioning etc) `beaker run -t test.rb`. It fails.
 
-Now try `beaker run -t test.rb --debug-errors` This will enter a pry console when the failure occurs.
+Now try `beaker run -t test.rb --debug-errors` This will enter a pry or debug console when the failure occurs.
 
     * Assert expected matches actual
-      Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #<Minitest::Assertion: This product is faulty.
+      Exception raised during step execution and debug-errors option is set, entering pry or debug. Exception was: #<Minitest::Assertion: This product is faulty.
        Expected: 3
         Actual: 2>
       HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code

data/lib/beaker/dsl/structure.rb

@@ -31,7 +31,6 @@ module Beaker
     #     end
     #
     module Structure
-      require 'pry'
       # Provides a method to help structure tests into coherent steps.
       # @param [String] step_name The name of the step to be logged.
       # @param [Proc] block The actions to be performed in this step.
@@ -45,9 +44,22 @@ module Beaker
             end
           rescue Exception => e
             if(@options.has_key?(:debug_errors) && @options[:debug_errors] == true)
-              logger.info("Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #{e.inspect}")
-              logger.info("HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code")
-              binding.pry
+              begin
+                require 'pry'
+              rescue LoadError
+                begin
+                  require 'debug'
+                rescue LoadError
+                  logger.exception('Unable to load pry and debug while debug_errors was true')
+                else
+                  logger.info("Exception raised during step execution and debug-errors option is set, entering debug. Exception was: #{e.inspect}")
+                  binding.break
+                end
+              else
+                logger.info("Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #{e.inspect}")
+                logger.info("HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code")
+                binding.pry
+              end
             end
             raise e
           end

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.37.2'
+    STRING = '4.38.0'
   end
 end

data/lib/beaker.rb

@@ -38,11 +38,4 @@ module Beaker
 
   # MiniTest, for including MiniTest::Assertions
   require 'minitest/test'
-
-  # Add pry support when available
-  begin
-    require 'pry'
-  rescue LoadError
-    # do nothing
-  end
 end

data/spec/beaker/dsl/structure_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'readline'
 
 class ClassMixedWithDSLStructure
   include Beaker::DSL::Structure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.37.2
+  version: 4.38.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -108,34 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rb-readline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement