forked from rack/rack-test
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Switches README format to markdown (rack#176)
As discussed in github issue rack#175 the format is supposed to be changed to markdown. This Change changes the file extension and formatting of the file. In addition the copyright and maintainer sections have been updated and/or removed.
- Loading branch information
Dennis Sivia
authored and
Alex Damian Negru
committed
Apr 5, 2021
1 parent
6538d73
commit e3ae7c0
Showing
2 changed files
with
96 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
# Rack::Test | ||
[<img src="https://travis-ci.org/rack-test/rack-test.svg?branch=master" />](https://travis-ci.org/rack-test/rack-test) | ||
[<img src="https://codeclimate.com/github/brynary/rack-test.png" />](https://codeclimate.com/github/brynary/rack-test) | ||
[<img src="https://codeclimate.com/github/brynary/rack-test/coverage.png" />](https://codeclimate.com/github/brynary/rack-test) | ||
|
||
Code: https://github.com/rack-test/rack-test | ||
|
||
## Description | ||
|
||
Rack::Test is a small, simple testing API for Rack apps. It can be used on its | ||
own or as a reusable starting point for Web frameworks and testing libraries | ||
to build on. | ||
|
||
## Features | ||
|
||
* Maintains a cookie jar across requests | ||
* Easily follow redirects when desired | ||
* Set request headers to be used by all subsequent requests | ||
* Small footprint. Approximately 200 LOC | ||
|
||
## Examples | ||
```ruby | ||
require "test/unit" | ||
require "rack/test" | ||
|
||
class HomepageTest < Test::Unit::TestCase | ||
include Rack::Test::Methods | ||
|
||
def app | ||
app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All responses are OK']] } | ||
builder = Rack::Builder.new | ||
builder.run app | ||
end | ||
|
||
def test_response_is_ok | ||
get "/" | ||
|
||
assert last_response.ok? | ||
assert_equal last_response.body, "All responses are OK" | ||
end | ||
|
||
def test_response_is_ok_for_other_paths | ||
get "/other_paths" | ||
|
||
assert last_response.ok? | ||
assert_equal last_response.body, "All responses are OK" | ||
end | ||
end | ||
``` | ||
|
||
If you want to test one app in isolation, you just return that app as shown above. But if you want to test the entire app stack, including middlewares, cascades etc. you need to parse the app defined in config.ru. | ||
|
||
```ruby | ||
OUTER_APP = Rack::Builder.parse_file("config.ru").first | ||
|
||
class TestApp < Test::Unit::TestCase | ||
include Rack::Test::Methods | ||
|
||
def app | ||
OUTER_APP | ||
end | ||
|
||
def test_root | ||
get "/" | ||
assert last_response.ok? | ||
end | ||
end | ||
``` | ||
|
||
|
||
## Install | ||
|
||
To install the latest release as a gem: | ||
|
||
`gem install rack-test` | ||
|
||
Or via Bundler: | ||
|
||
`gem "rack-test", require: "rack/test"` | ||
|
||
## Authors | ||
|
||
- Contributions from Bryan Helmkamp, Simon Rozet, Pat Nakajima and others | ||
- Much of the original code was extracted from Merb 1.0's request helper | ||
|
||
## License | ||
`rack-test` is released under the [MIT License](MIT-LICENSE.txt). | ||
|
||
## Contribution | ||
|
||
Contributions are welcome. Please make sure to: | ||
|
||
* Use a regular forking workflow | ||
* write tests for the new / changed behaviour. | ||
* Provide an explanation/motivation in your commit message / PR message | ||
* Ensure History.txt is updated |
This file was deleted.
Oops, something went wrong.