• Stars
    star
    178
  • Rank 214,989 (Top 5 %)
  • Language
    Ruby
  • License
    Other
  • Created almost 13 years ago
  • Updated about 12 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Start Pry in the context of a failed test

plymouth

(C) John Mair (banisterfiend) 2012

Start Pry in the context of a failed test

Warning BETA software: Please file an issue if you have any problems

plymouth is a gem to automatically start a Pry session when a test fails, putting you in the context of the failure. It currently supports Bacon, Minitest, and RSpec. Support for other testing libraries is (usually) trivial to add.

plymouth utilizes the powerful pry-exception_explorer gem.

plymouth currently only runs on MRI 1.9.2+ (including 1.9.3)

How to use:

After installing the gem, simply add the following line to your test suite:

require 'plymouth'

plymouth should auto-detect which testing library you're using, and 'just work' :)

Example: Intercept a failing test in RSpec

Inside the test file:

require 'plymouth'

describe Array do
  before do
    @array = [1]
  end

  it 'should be empty' do
    @array.empty?.should == true
  end
end

And here is the result of running the above test with the rspec executable:

Test failure: expected: true
     got: false (using ==)

Frame number: 0/14
Frame type: block

From: /Users/john/ruby/play/rspec_intercept.rb @ line 9:

     4:   before do
     5:     @array = [1]
     6:   end
     7: 
     8:   it 'should be empty' do
 =>  9:     @array.empty?.should == true
    10:   end
    11: end

[1] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> @array.size                                                                                                                           
=> 1
[2] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> edit --current
Waiting for Emacs...
[3] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> ^D
F

Failures:

  1) Array should be empty
     Failure/Error: @array.empty?.should == true
       expected: true
            got: false (using ==)
     # ./rspec_intercept.rb:9:in `block (2 levels) in <top (required)>'

Finished in 7.74 seconds
1 example, 1 failure

Failed examples:

rspec ./rspec_intercept.rb:8 # Array should be empty

Edit the failing test code in an editor

Notice the line edit --current from the example above. Entering this command will take you to the line in the test file where the failing test was defined. Once here you can modify the test code as you please. Note that the file will not be reloaded after editing is complete, instead any modifications you make will only take effect the next time you run the test suite.

Turning plymouth off mid-test

If you are inside an interactive session and do not want plymouth to intercept further failing tests you can enter the command plymouth-off. This will disable plymouth for the remainder of the test suite.

The 'USE_PLYMOUTH' Environment variable

To make it easier to run your test suite normally (without plymouth's intervention) a USE_PLYMOUTH environment variable can be defined. If the USE_PLYMOUTH environment variable is set to "false", "0", or "no" plymouth will not intercept test failures. If USE_PLYMOUTH is not defined at all, plymouth will be used by default.

Travis Compatibility

To prevent plymouth messing up testing on travis, add the following line to your .travis.yml file:

env: USE_PLYMOUTH="no"

Limitations

  • Occasional (very rare) segfault on 1.9.3 (seems to work fine on 1.9.2). Please report all segfaults with a full backtrace!
  • Only supports MRI.
  • Currently limited to just Bacon, RSpec and Minitest. Support for more testing libraries will be added in the future.
  • Only intercepts test failures, does not yet (generally) intercept test errors. Support for this will be added soon.
  • Does not work with Bacon's should.raise and should.not.raise constructions.

Contact

Problems or questions contact me at github

License

(The MIT License)

Copyright (c) 2012 John Mair (banisterfiend)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

More Repositories

1

binding_of_caller

Retrieve the binding of a method's caller in MRI 1.9.2+
Ruby
661
star
2

method_source

return the sourcecode for a method
Ruby
355
star
3

funkify

Haskell-style partial application and composition for Ruby methods
Ruby
153
star
4

texplay

image manipulation tool for ruby and gosu
C
66
star
5

devil

ruby bindings for devil cross platform image loading library
Ruby
60
star
6

debug_inspector

A Ruby wrapper for the MRI 2.0 debug_inspector API
Ruby
58
star
7

free

force immediate garbage collection of an object
C
36
star
8

remix

Ruby modules re-mixed and remastered
Ruby
32
star
9

include_complete

Fixing the limitations in traditional Module#include
Ruby
19
star
10

pry-stack_explorer

MOVED TO https://github.com/pry/pry-stack_explorer
Ruby
18
star
11

prepend

prepends modules in front of a class; so method lookup starts with the module
C
16
star
12

selene

ruby spaceship game
Ruby
13
star
13

tremolo

Worms-like game for Ruby
Ruby
10
star
14

method_reload

fine grained code reloading
Ruby
10
star
15

state-ology

Clean and fast Object state transitions in Ruby using the Mixology C extension
Ruby
9
star
16

object2module

Convert Classes and Objects to Modules so they can be extended/included.
Ruby
9
star
17

pry-doc

Provide MRI Core documentation and source code for the Pry REPL
Ruby
9
star
18

mixology19

A version of the Mixology C extension that is 1.9.1 and 1.8.6 compatible
Ruby
8
star
19

pry-exception_explorer

MOVED TO https://github.com/pry/pry-exception_explorer
Ruby
7
star
20

gen_eval

a strange new breed of instance_eval
C
6
star
21

tweak

enhance classes with temporary functionality
Ruby
4
star
22

compat

Managing Ruby 1.9 and 1.8 C extension compatibility in one header file
C
3
star
23

custom_boolean

a hack to have if/else_if/else conditions with user-defined truthiness
Ruby
3
star
24

dup_eval

A souped up version of instance_eval in the vein of mix_eval
Ruby
3
star
25

pry-note

Ease refactoring and exploration by attaching notes to methods and classes in Pry"
Ruby
3
star
26

strange_evals

a hodgepodge of alternatives to instance_eval
Ruby
3
star
27

local_eval

instance_eval without changing self
Ruby
3
star
28

mult

a few utility functions written in C
C
2
star
29

basis

personal system setup for new *nix boxes
Shell
2
star
30

change_class2

change class of an object
Ruby
2
star
31

window-rotate-for-emacs

rotate the buffers for the active windows in emacs
2
star
32

pry_time

pry error console
Ruby
1
star
33

RailsExceptionExamples

Pry's @banisterfiend wanted a sample rails application to use for developmentโ€ฆ This is it with documentation.
Ruby
1
star
34

raise_shim

A shim for rb_raise
C
1
star
35

rumi

magic
C++
1
star
36

exercise

learning objc
Objective-C
1
star
37

baseline

organize project benchmarks into contexts
Ruby
1
star