Merge pull request #70 from GlassyMedia/feature/test-doc

as requested, reverting MakeRequestWitHeader and adding more godoc to test package

Author: ant0ine

Diff for: rest/test/doc.go

@@ -0,0 +1,31 @@
+// Utility functions to help writing tests for a Go-Json-Rest app
+//
+// Go comes with net/http/httptest to help writing test for an http
+// server. When this http server implements a JSON REST API, some basic
+// checks end up to be always the same. This test package tries to save
+// some typing by providing helpers for this particular use case.
+//
+// Example:
+//
+//	package main
+//
+//	import (
+//		"github.com/ant0ine/go-json-rest/rest/test"
+//		"testing"
+//	)
+//
+//	func TestSimpleRequest(t *testing.T) {
+//		handler := ResourceHandler{}
+//		handler.SetRoutes(
+// 		&Route{"GET", "/r",
+// 			func(w ResponseWriter, r *Request) {
+// 				w.WriteJson(map[string]string{"Id": "123"})
+//				},
+//			},
+//		)
+//		recorded := test.RunRequest(t, &handler,
+//			test.MakeSessionRequest("POST", "http://1.2.3.4/r", nil))
+//		recorded.CodeIs(200)
+//		recorded.ContentTypeIsJson()
+//	}
+package test

Diff for: rest/test/util.go

@@ -1,9 +1,3 @@
-// Utility functions to help writing tests for a Go-Json-Rest app
-//
-// Go comes with net/http/httptest to help writing test for an http
-// server. When this http server implements a JSON REST API, some basic
-// checks end up to be always the same. This test package tries to save
-// some typing by providing helpers for this particular use case.
 package test
 
 import (
@@ -16,8 +10,10 @@ import (
 	"testing"
 )
 
-func MakeRequestWithHeader(method, urlStr string, header http.Header, payload interface{}) *http.Request {
-	s := ""
+// MakeSimpleRequest returns a http.Request. The returned request object can be
+// further prepared by adding headers and query string parmaters, for instance.
+func MakeSimpleRequest(method string, urlStr string, payload interface{}) *http.Request {
+	var s string
 
 	if payload != nil {
 		b, err := json.Marshal(payload)
@@ -31,27 +27,22 @@ func MakeRequestWithHeader(method, urlStr string, header http.Header, payload in
 	if err != nil {
 		panic(err)
 	}
-	r.Header = header
 	r.Header.Set("Accept-Encoding", "gzip")
-
 	if payload != nil {
 		r.Header.Set("Content-Type", "application/json")
 	}
 
 	return r
 }
 
-func MakeSimpleRequest(method string, urlStr string, payload interface{}) *http.Request {
-	return MakeRequestWithHeader(method, urlStr, http.Header{}, payload)
-}
-
+// CodeIs compares the rescorded status code
 func CodeIs(t *testing.T, r *httptest.ResponseRecorder, expectedCode int) {
 	if r.Code != expectedCode {
 		t.Errorf("Code %d expected, got: %d", expectedCode, r.Code)
 	}
 }
 
-// Test the first value for the given headerKey
+// HeaderIs tests the first value for the given headerKey
 func HeaderIs(t *testing.T, r *httptest.ResponseRecorder, headerKey, expectedValue string) {
 	value := r.HeaderMap.Get(headerKey)
 	if value != expectedValue {
@@ -96,6 +87,7 @@ type Recorded struct {
 	Recorder *httptest.ResponseRecorder
 }
 
+// RunRequest runs a HTTP request through the given handler
 func RunRequest(t *testing.T, handler http.Handler, request *http.Request) *Recorded {
 	recorder := httptest.NewRecorder()
 	handler.ServeHTTP(recorder, request)