mirror of
https://github.com/gin-gonic/gin.git
synced 2025-10-16 13:22:09 +08:00
7fb5d3b261
The private ResponseWriter implementation in the stdlib implements this interface to enable some optimizations around sendfile. The interface is asserted for in io.Copy, probably the most common way to serve files, so without this method we are missing out on those optimizations. As we're only interested in writing the headers and capturing the number of bytes written, we can just call io.Copy on the wrapped http.ResponseWriter and it will do the right thing, calling ReadFrom if it's implemented and doing a regular copy if not.
140 lines
3.5 KiB
Go
140 lines
3.5 KiB
Go
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
|
|
// Use of this source code is governed by a MIT style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package gin
|
|
|
|
import (
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
// TODO
|
|
// func (w *responseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
|
// func (w *responseWriter) CloseNotify() <-chan bool {
|
|
// func (w *responseWriter) Flush() {
|
|
|
|
var _ ResponseWriter = &responseWriter{}
|
|
var _ http.ResponseWriter = &responseWriter{}
|
|
var _ http.ResponseWriter = ResponseWriter(&responseWriter{})
|
|
var _ http.Hijacker = ResponseWriter(&responseWriter{})
|
|
var _ http.Flusher = ResponseWriter(&responseWriter{})
|
|
var _ http.CloseNotifier = ResponseWriter(&responseWriter{})
|
|
var _ io.ReaderFrom = ResponseWriter(&responseWriter{})
|
|
|
|
func init() {
|
|
SetMode(TestMode)
|
|
}
|
|
|
|
func TestResponseWriterReset(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
var w ResponseWriter = writer
|
|
|
|
writer.reset(testWriter)
|
|
assert.Equal(t, writer.size, -1)
|
|
assert.Equal(t, writer.status, 200)
|
|
assert.Equal(t, writer.ResponseWriter, testWriter)
|
|
assert.Equal(t, w.Size(), -1)
|
|
assert.Equal(t, w.Status(), 200)
|
|
assert.False(t, w.Written())
|
|
}
|
|
|
|
func TestResponseWriterWriteHeader(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
writer.reset(testWriter)
|
|
w := ResponseWriter(writer)
|
|
|
|
w.WriteHeader(300)
|
|
assert.False(t, w.Written())
|
|
assert.Equal(t, w.Status(), 300)
|
|
assert.NotEqual(t, testWriter.Code, 300)
|
|
|
|
w.WriteHeader(-1)
|
|
assert.Equal(t, w.Status(), 300)
|
|
}
|
|
|
|
func TestResponseWriterWriteHeadersNow(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
writer.reset(testWriter)
|
|
w := ResponseWriter(writer)
|
|
|
|
w.WriteHeader(300)
|
|
w.WriteHeaderNow()
|
|
|
|
assert.True(t, w.Written())
|
|
assert.Equal(t, w.Size(), 0)
|
|
assert.Equal(t, testWriter.Code, 300)
|
|
|
|
writer.size = 10
|
|
w.WriteHeaderNow()
|
|
assert.Equal(t, w.Size(), 10)
|
|
}
|
|
|
|
func TestResponseWriterWrite(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
writer.reset(testWriter)
|
|
w := ResponseWriter(writer)
|
|
|
|
n, err := w.Write([]byte("hola"))
|
|
assert.Equal(t, n, 4)
|
|
assert.Equal(t, w.Size(), 4)
|
|
assert.Equal(t, w.Status(), 200)
|
|
assert.Equal(t, testWriter.Code, 200)
|
|
assert.Equal(t, testWriter.Body.String(), "hola")
|
|
assert.NoError(t, err)
|
|
|
|
n, err = w.Write([]byte(" adios"))
|
|
assert.Equal(t, n, 6)
|
|
assert.Equal(t, w.Size(), 10)
|
|
assert.Equal(t, testWriter.Body.String(), "hola adios")
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
func TestResponseWriterHijack(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
writer.reset(testWriter)
|
|
w := ResponseWriter(writer)
|
|
|
|
assert.Panics(t, func() {
|
|
w.Hijack()
|
|
})
|
|
assert.True(t, w.Written())
|
|
|
|
assert.Panics(t, func() {
|
|
w.CloseNotify()
|
|
})
|
|
|
|
w.Flush()
|
|
}
|
|
|
|
func TestResponseWriterReadFrom(t *testing.T) {
|
|
testWriter := httptest.NewRecorder()
|
|
writer := &responseWriter{}
|
|
writer.reset(testWriter)
|
|
w := ResponseWriter(writer)
|
|
|
|
n, err := io.Copy(w, strings.NewReader("hola"))
|
|
assert.Equal(t, n, int64(4))
|
|
assert.Equal(t, w.Size(), 4)
|
|
assert.Equal(t, w.Status(), 200)
|
|
assert.Equal(t, testWriter.Code, 200)
|
|
assert.Equal(t, testWriter.Body.String(), "hola")
|
|
assert.NoError(t, err)
|
|
|
|
n, err = writer.ReadFrom(strings.NewReader(" adios"))
|
|
assert.Equal(t, n, int64(6))
|
|
assert.Equal(t, w.Size(), 10)
|
|
assert.Equal(t, testWriter.Body.String(), "hola adios")
|
|
assert.NoError(t, err)
|
|
}
|