Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hopsoft/pry-test
A small test framework that supports debugging test failures & errors when they happen
https://github.com/hopsoft/pry-test
pry ruby test-framework testing testing-framework
Last synced: 18 days ago
JSON representation
A small test framework that supports debugging test failures & errors when they happen
- Host: GitHub
- URL: https://github.com/hopsoft/pry-test
- Owner: hopsoft
- License: mit
- Created: 2012-09-24T14:04:03.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T22:43:15.000Z (about 4 years ago)
- Last Synced: 2024-10-03T09:56:38.204Z (about 1 month ago)
- Topics: pry, ruby, test-framework, testing, testing-framework
- Language: Ruby
- Homepage:
- Size: 211 KB
- Stars: 25
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
[](https://codeclimate.com/github/hopsoft/pry-test/maintainability)
[](https://travis-ci.org/hopsoft/pry-test)
[](https://coveralls.io/r/hopsoft/pry-test?branch=master)
[](http://rubygems.org/gems/pry-test)
_Formerly known as [MicroTest](https://rubygems.org/gems/micro_test)._
# PryTest
> aka pry-test
A small test framework that supports debugging test failures & errors when they happen.
## Values
* __Simplicity__ - writing tests should be easy & devoid of friction
* __Intelligibility__ - tests should be readable & unambiguous
* __Immediacy__ - test failures should be dealt with quickly when they occur
## Benefits
* A simple test API
* An awesome `fail` `pry` `pass` workflow
* Optional async test runs
[An important note on debugging test failures with Pry.](https://github.com/hopsoft/pry-test/wiki/Debug-Test-Failures-with-Pry#gemfile-considerations)
## The API
Everything you need to know about PryTest's API is outlined here.
PryTest::Test
Superclass for all test classes.
test(desc, &block)
Defines a test method.
-
desc- a description of what is being tested -
&block- a block of code which defines the test
assert(value)
Verifies the truthiness of a value.
-
value- the value to assert
refute(value)
Verifies the falsiness of a value.
-
value- the value to refute
before(&block)
A callback that runs before each test method.
-
&block- the block of code to execute
after(&block)
A callback that runs after each test method.
-
&block- the block of code to execute
### A Complete Example
The entire public interface is used in this basic example.
```ruby
class MathTest < PryTest::Test
before do
# runs before each test method
end
after do
# runs after each test method
end
test "basic addition" do
assert 2 + 2 == 4
end
test "all is right in the world" do
refute 0 > 1
end
end
```
## Get Started
PryTest ships with a demo so you can try it out easily.
```sh
gem install pry-test
pry-test --help
pry-test --demo
```
Try some advanced features.
```sh
pry-test --demo --async
pry-test --demo --disable-pry
```
## Testing Your Own Projects
PryTest assumes your test directory is located at `PROJECT_ROOT/test`;
however, this isn't a requirement. You can indicate your test directory location.
```sh
pry-test /path/to/test/dir
```
If you have multiple versions of PryTest installed,
it's safest to run your tests with `bundle exec`.
```sh
bundle exec pry-test /path/to/test/dir
```
PryTest is small & unobtrusive.
It plays nice with other test frameworks, & can be introduced to existing projects incrementally.
## Advanced
[See the wiki](https://github.com/hopsoft/pry-test/wiki)
to troubleshoot or get help with more advanced topics.