1
0
mirror of https://github.com/labstack/echo.git synced 2025-04-21 12:17:04 +02:00

More coverage and better response adapter for standard/response

Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
Vishal Rana 2016-06-06 22:27:36 -07:00
parent 8fbe719636
commit c654c422c4
7 changed files with 139 additions and 47 deletions

View File

@ -52,7 +52,7 @@ func (r *Response) WriteHeader(code int) {
// Write implements `engine.Response#Write` function. // Write implements `engine.Response#Write` function.
func (r *Response) Write(b []byte) (n int, err error) { func (r *Response) Write(b []byte) (n int, err error) {
if !r.Committed() { if !r.committed {
r.WriteHeader(http.StatusOK) r.WriteHeader(http.StatusOK)
} }
n, err = r.writer.Write(b) n, err = r.writer.Write(b)

View File

@ -14,6 +14,7 @@ type (
// Response implements `engine.Response`. // Response implements `engine.Response`.
Response struct { Response struct {
http.ResponseWriter http.ResponseWriter
adapter *responseAdapter
header engine.Header header engine.Header
status int status int
size int64 size int64
@ -23,19 +24,20 @@ type (
} }
responseAdapter struct { responseAdapter struct {
http.ResponseWriter *Response
response *Response
} }
) )
// NewResponse returns `Response` instance. // NewResponse returns `Response` instance.
func NewResponse(w http.ResponseWriter, l log.Logger) *Response { func NewResponse(w http.ResponseWriter, l log.Logger) (r *Response) {
return &Response{ r = &Response{
ResponseWriter: w, ResponseWriter: w,
header: &Header{Header: w.Header()}, header: &Header{Header: w.Header()},
writer: w, writer: w,
logger: l, logger: l,
} }
r.adapter = &responseAdapter{Response: r}
return
} }
// Header implements `engine.Response#Header` function. // Header implements `engine.Response#Header` function.
@ -56,7 +58,7 @@ func (r *Response) WriteHeader(code int) {
// Write implements `engine.Response#Write` function. // Write implements `engine.Response#Write` function.
func (r *Response) Write(b []byte) (n int, err error) { func (r *Response) Write(b []byte) (n int, err error) {
if !r.Committed() { if !r.committed {
r.WriteHeader(http.StatusOK) r.WriteHeader(http.StatusOK)
} }
n, err = r.writer.Write(b) n, err = r.writer.Write(b)
@ -126,7 +128,8 @@ func (r *Response) CloseNotify() <-chan bool {
} }
func (r *Response) reset(w http.ResponseWriter, a *responseAdapter, h engine.Header) { func (r *Response) reset(w http.ResponseWriter, a *responseAdapter, h engine.Header) {
r.ResponseWriter = a r.ResponseWriter = w
r.adapter = a
r.header = h r.header = h
r.status = http.StatusOK r.status = http.StatusOK
r.size = 0 r.size = 0
@ -134,23 +137,10 @@ func (r *Response) reset(w http.ResponseWriter, a *responseAdapter, h engine.Hea
r.writer = w r.writer = w
} }
func (a *responseAdapter) Write(b []byte) (n int, err error) { func (r *responseAdapter) Header() http.Header {
return a.response.Write(b) return r.ResponseWriter.Header()
} }
func (a *responseAdapter) Flush() { func (r *responseAdapter) reset(res *Response) {
a.ResponseWriter.(http.Flusher).Flush() r.Response = res
}
func (a *responseAdapter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
return a.ResponseWriter.(http.Hijacker).Hijack()
}
func (a *responseAdapter) CloseNotify() <-chan bool {
return a.ResponseWriter.(http.CloseNotifier).CloseNotify()
}
func (a *responseAdapter) reset(w http.ResponseWriter, r *Response) {
a.ResponseWriter = w
a.response = r
} }

View File

@ -1,16 +1,17 @@
package standard package standard
import ( import (
"github.com/labstack/gommon/log"
"github.com/stretchr/testify/assert"
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"testing" "testing"
"time" "time"
"github.com/labstack/gommon/log"
"github.com/stretchr/testify/assert"
) )
func TestResponse_WriteHeader(t *testing.T) { func TestResponseWriteHeader(t *testing.T) {
recorder := httptest.NewRecorder() recorder := httptest.NewRecorder()
resp := NewResponse(recorder, log.New("echo")) resp := NewResponse(recorder, log.New("echo"))
@ -20,7 +21,7 @@ func TestResponse_WriteHeader(t *testing.T) {
assert.True(t, resp.Committed()) assert.True(t, resp.Committed())
} }
func TestResponse_Write(t *testing.T) { func TestResponseWrite(t *testing.T) {
recorder := httptest.NewRecorder() recorder := httptest.NewRecorder()
resp := NewResponse(recorder, log.New("echo")) resp := NewResponse(recorder, log.New("echo"))
resp.Write([]byte("Hello")) resp.Write([]byte("Hello"))
@ -32,7 +33,7 @@ func TestResponse_Write(t *testing.T) {
assert.True(t, recorder.Flushed) assert.True(t, recorder.Flushed)
} }
func TestResponse_SetCookie(t *testing.T) { func TestResponseSetCookie(t *testing.T) {
recorder := httptest.NewRecorder() recorder := httptest.NewRecorder()
resp := NewResponse(recorder, log.New("echo")) resp := NewResponse(recorder, log.New("echo"))

View File

@ -130,7 +130,7 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// Response // Response
res := s.pool.response.Get().(*Response) res := s.pool.response.Get().(*Response)
resAdpt := s.pool.responseAdapter.Get().(*responseAdapter) resAdpt := s.pool.responseAdapter.Get().(*responseAdapter)
resAdpt.reset(w, res) resAdpt.reset(res)
resHdr := s.pool.header.Get().(*Header) resHdr := s.pool.header.Get().(*Header)
resHdr.reset(w.Header()) resHdr.reset(w.Header())
res.reset(w, resAdpt, resHdr) res.reset(w, resAdpt, resHdr)
@ -150,7 +150,7 @@ func WrapHandler(h http.Handler) echo.HandlerFunc {
return func(c echo.Context) error { return func(c echo.Context) error {
req := c.Request().(*Request) req := c.Request().(*Request)
res := c.Response().(*Response) res := c.Response().(*Response)
h.ServeHTTP(res.ResponseWriter, req.Request) h.ServeHTTP(res.adapter, req.Request)
return nil return nil
} }
} }

View File

@ -3,7 +3,6 @@ package middleware
import ( import (
"bytes" "bytes"
"compress/gzip" "compress/gzip"
"io/ioutil"
"net/http" "net/http"
"testing" "testing"
@ -52,13 +51,10 @@ func TestGzipNoContent(t *testing.T) {
h := Gzip()(func(c echo.Context) error { h := Gzip()(func(c echo.Context) error {
return c.NoContent(http.StatusOK) return c.NoContent(http.StatusOK)
}) })
h(c) if assert.NoError(t, h(c)) {
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding))
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding)) assert.Empty(t, rec.Header().Get(echo.HeaderContentType))
assert.Empty(t, rec.Header().Get(echo.HeaderContentType)) assert.Equal(t, 0, len(rec.Body.Bytes()))
b, err := ioutil.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Equal(t, 0, len(b))
} }
} }
@ -71,10 +67,6 @@ func TestGzipErrorReturned(t *testing.T) {
req := test.NewRequest(echo.GET, "/", nil) req := test.NewRequest(echo.GET, "/", nil)
rec := test.NewResponseRecorder() rec := test.NewResponseRecorder()
e.ServeHTTP(req, rec) e.ServeHTTP(req, rec)
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding)) assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding))
b, err := ioutil.ReadAll(rec.Body) assert.Equal(t, "error", rec.Body.String())
if assert.NoError(t, err) {
assert.Equal(t, "error", string(b))
}
} }

View File

@ -2,6 +2,8 @@ package middleware
import ( import (
"net/http" "net/http"
"net/url"
"strings"
"testing" "testing"
"github.com/labstack/echo" "github.com/labstack/echo"
@ -14,11 +16,20 @@ func TestCSRF(t *testing.T) {
req := test.NewRequest(echo.GET, "/", nil) req := test.NewRequest(echo.GET, "/", nil)
rec := test.NewResponseRecorder() rec := test.NewResponseRecorder()
c := e.NewContext(req, rec) c := e.NewContext(req, rec)
csrf := CSRF([]byte("secret")) csrf := CSRFWithConfig(CSRFConfig{
Secret: []byte("secret"),
CookiePath: "/",
CookieDomain: "labstack.com",
})
h := csrf(func(c echo.Context) error { h := csrf(func(c echo.Context) error {
return c.String(http.StatusOK, "test") return c.String(http.StatusOK, "test")
}) })
// No secret
assert.Panics(t, func() {
CSRF(nil)
})
// Generate CSRF token // Generate CSRF token
h(c) h(c)
assert.Contains(t, rec.Header().Get(echo.HeaderSetCookie), "csrf") assert.Contains(t, rec.Header().Get(echo.HeaderSetCookie), "csrf")
@ -35,6 +46,38 @@ func TestCSRF(t *testing.T) {
salt, _ := generateSalt(8) salt, _ := generateSalt(8)
token := generateCSRFToken([]byte("secret"), salt) token := generateCSRFToken([]byte("secret"), salt)
req.Header().Set(echo.HeaderXCSRFToken, token) req.Header().Set(echo.HeaderXCSRFToken, token)
h(c) if assert.NoError(t, h(c)) {
assert.Equal(t, http.StatusOK, rec.Status()) assert.Equal(t, http.StatusOK, rec.Status())
}
}
func TestCSRFTokenFromForm(t *testing.T) {
f := make(url.Values)
f.Set("csrf", "token")
e := echo.New()
req := test.NewRequest(echo.POST, "/", strings.NewReader(f.Encode()))
req.Header().Add(echo.HeaderContentType, echo.MIMEApplicationForm)
c := e.NewContext(req, nil)
token, err := csrfTokenFromForm("csrf")(c)
if assert.NoError(t, err) {
assert.Equal(t, "token", token)
}
token, err = csrfTokenFromForm("invalid")(c)
assert.Error(t, err)
}
func TestCSRFTokenFromQuery(t *testing.T) {
q := make(url.Values)
q.Set("csrf", "token")
e := echo.New()
req := test.NewRequest(echo.GET, "/?"+q.Encode(), nil)
req.Header().Add(echo.HeaderContentType, echo.MIMEApplicationForm)
c := e.NewContext(req, nil)
token, err := csrfTokenFromQuery("csrf")(c)
if assert.NoError(t, err) {
assert.Equal(t, "token", token)
}
token, err = csrfTokenFromQuery("invalid")(c)
assert.Error(t, err)
csrfTokenFromQuery("csrf")
} }

View File

@ -1 +1,67 @@
package middleware package middleware
import (
"net/http"
"testing"
"github.com/labstack/echo"
"github.com/labstack/echo/test"
"github.com/stretchr/testify/assert"
)
func TestStatic(t *testing.T) {
e := echo.New()
req := test.NewRequest(echo.GET, "/", nil)
rec := test.NewResponseRecorder()
c := e.NewContext(req, rec)
h := Static("../_fixture")(func(c echo.Context) error {
return echo.ErrNotFound
})
// Directory
if assert.NoError(t, h(c)) {
assert.Contains(t, rec.Body.String(), "Echo")
}
// HTML5 mode
req = test.NewRequest(echo.GET, "/client", nil)
rec = test.NewResponseRecorder()
c = e.NewContext(req, rec)
static := StaticWithConfig(StaticConfig{
Root: "../_fixture",
HTML5: true,
})
h = static(func(c echo.Context) error {
return echo.ErrNotFound
})
if assert.NoError(t, h(c)) {
assert.Equal(t, http.StatusOK, rec.Status())
}
// Browse
req = test.NewRequest(echo.GET, "/", nil)
rec = test.NewResponseRecorder()
c = e.NewContext(req, rec)
static = StaticWithConfig(StaticConfig{
Root: "../_fixture/images",
Browse: true,
})
h = static(func(c echo.Context) error {
return echo.ErrNotFound
})
if assert.NoError(t, h(c)) {
assert.Contains(t, rec.Body.String(), "walle")
}
// Not found
req = test.NewRequest(echo.GET, "/not-found", nil)
rec = test.NewResponseRecorder()
c = e.NewContext(req, rec)
static = StaticWithConfig(StaticConfig{
Root: "../_fixture/images",
})
h = static(func(c echo.Context) error {
return echo.ErrNotFound
})
assert.Error(t, h(c))
}