Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drewolson/testflight
Painless http testing in Go
https://github.com/drewolson/testflight
Last synced: about 1 month ago
JSON representation
Painless http testing in Go
- Host: GitHub
- URL: https://github.com/drewolson/testflight
- Owner: drewolson
- License: mit
- Created: 2012-12-07T20:47:15.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2020-04-02T07:46:00.000Z (over 4 years ago)
- Last Synced: 2024-06-18T14:54:09.061Z (6 months ago)
- Language: Go
- Homepage: https://godoc.org/github.com/drewolson/testflight
- Size: 34.2 KB
- Stars: 149
- Watchers: 6
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# testflight
[](https://travis-ci.org/drewolson/testflight)
## Installation
```bash
go get github.com/drewolson/testflight
```
```go
import "github.com/drewolson/testflight"
```
## Usage
testflight makes it simple to test your http servers in Go. Suppose you're using [pat](https://github.com/bmizerany/pat) to create a simple http handler, like so:
```go
func Handler() http.Handler {
m := pat.New()
m.Get("/hello/:name", http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
io.WriteString(w, "hello, "+req.URL.Query().Get(":name"))
}))
m.Post("/post/form", http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
req.ParseForm()
name := req.Form.Get("name")
w.WriteHeader(201)
io.WriteString(w, name+" created")
}))
return m
}
```
Let's use testflight to test our handler. Keep in mind that testflight is doing full-stack http tests. We're also using assert for test assertions.
```go
func TestGet(t *testing.T) {
testflight.WithServer(Handler(), func(r *testflight.Requester) {
response := r.Get("/hello/drew")
assert.Equal(t, 200, response.StatusCode)
assert.Equal(t, "hello, drew", response.Body)
})
}
func TestPostWithForm(t *testing.T) {
testflight.WithServer(Handler(), func(r *testflight.Requester) {
response := r.Post("/post/form", testflight.FORM_ENCODED, "name=Drew")
assert.Equal(t, 201, response.StatusCode)
assert.Equal(t, "Drew created", response.Body)
})
}
```
The testflight.Requester struct has the following methods: Get, Post, Put, Delete and Do. Do accepts an *http.Request for times when you need more explicit control of your request. See testflight_test.go for more usage information.
## Testing Websockets
Testflight also allows you to perform full-stack testing of websockets. You'll want to import both the testflight and testflight/ws packages.
```go
import (
"github.com/drewolson/testflight"
"github.com/drewolson/testflight/ws"
)
```
Now, let's make a handler with a websocket route.
```go
func Handler() http.Handler {
mux := http.NewServeMux()
mux.Handle("/websocket", websocket.Handler(func(ws *websocket.Conn) {
var name string
websocket.Message.Receive(ws, &name)
websocket.Message.Send(ws, "Hello, "+name)
}))
return mux
}
```
Finally, let's write the test.
```go
func TestWebSocket(t *testing.T) {
testflight.WithServer(Handler(), func(r *testflight.Requester) {
connection := ws.Connect(r, "/websocket")
connection.SendMessage("Drew")
message, _ := connection.ReceiveMessage()
assert.Equal(t, "Hello, Drew", message)
})
}
```
## Contributing
Requires go `>= 1.11`.
Run the tests.
```bash
go test -v ./...
```
Now write new tests, fix them and send me a pull request!