mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
0c9ff0b45a
Implement a ReadJSON() utility to help reduce some code-duplication,
and to make sure we handle JSON requests consistently (e.g. always
check for the content-type).
Differences compared to current handling:
- prevent possible panic if request.Body is nil ("should never happen")
- always require Content-Type to be "application/json"
- be stricter about additional content after JSON (previously ignored)
- but, allow the body to be empty (an empty body is not invalid);
update TestContainerInvalidJSON accordingly, which was testing the
wrong expectation.
- close body after reading (some code did this)
We should consider to add a "max body size" on this function, similar to
7b9275c0da/api/server/middleware/debug.go (L27-L40)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
130 lines
3.6 KiB
Go
130 lines
3.6 KiB
Go
package httputils // import "github.com/docker/docker/api/server/httputils"
|
|
|
|
import (
|
|
"net/http"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// matchesContentType
|
|
func TestJsonContentType(t *testing.T) {
|
|
err := matchesContentType("application/json", "application/json")
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
err = matchesContentType("application/json; charset=utf-8", "application/json")
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
expected := "unsupported Content-Type header (dockerapplication/json): must be 'application/json'"
|
|
err = matchesContentType("dockerapplication/json", "application/json")
|
|
if err == nil || err.Error() != expected {
|
|
t.Errorf(`expected "%s", got "%v"`, expected, err)
|
|
}
|
|
|
|
expected = "malformed Content-Type header (foo;;;bar): mime: invalid media parameter"
|
|
err = matchesContentType("foo;;;bar", "application/json")
|
|
if err == nil || err.Error() != expected {
|
|
t.Errorf(`expected "%s", got "%v"`, expected, err)
|
|
}
|
|
}
|
|
|
|
func TestReadJSON(t *testing.T) {
|
|
t.Run("nil body", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", nil)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
foo := struct{}{}
|
|
err = ReadJSON(req, &foo)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
})
|
|
|
|
t.Run("empty body", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", strings.NewReader(""))
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
foo := struct{ SomeField string }{}
|
|
err = ReadJSON(req, &foo)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
if foo.SomeField != "" {
|
|
t.Errorf("expected: '', got: %s", foo.SomeField)
|
|
}
|
|
})
|
|
|
|
t.Run("with valid request", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", strings.NewReader(`{"SomeField":"some value"}`))
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
foo := struct{ SomeField string }{}
|
|
err = ReadJSON(req, &foo)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
if foo.SomeField != "some value" {
|
|
t.Errorf("expected: 'some value', got: %s", foo.SomeField)
|
|
}
|
|
})
|
|
t.Run("with whitespace", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", strings.NewReader(`
|
|
|
|
{"SomeField":"some value"}
|
|
|
|
`))
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
foo := struct{ SomeField string }{}
|
|
err = ReadJSON(req, &foo)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
if foo.SomeField != "some value" {
|
|
t.Errorf("expected: 'some value', got: %s", foo.SomeField)
|
|
}
|
|
})
|
|
|
|
t.Run("with extra content", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", strings.NewReader(`{"SomeField":"some value"} and more content`))
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
foo := struct{ SomeField string }{}
|
|
err = ReadJSON(req, &foo)
|
|
if err == nil {
|
|
t.Error("expected an error, got none")
|
|
}
|
|
expected := "unexpected content after JSON"
|
|
if err.Error() != expected {
|
|
t.Errorf("expected: '%s', got: %s", expected, err.Error())
|
|
}
|
|
})
|
|
|
|
t.Run("invalid JSON", func(t *testing.T) {
|
|
req, err := http.NewRequest("POST", "https://example.com/some/path", strings.NewReader(`{invalid json`))
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
foo := struct{ SomeField string }{}
|
|
err = ReadJSON(req, &foo)
|
|
if err == nil {
|
|
t.Error("expected an error, got none")
|
|
}
|
|
expected := "invalid JSON: invalid character 'i' looking for beginning of object key string"
|
|
if err.Error() != expected {
|
|
t.Errorf("expected: '%s', got: %s", expected, err.Error())
|
|
}
|
|
})
|
|
}
|