Merge lp:~pedronis/ubuntu-push/expose-api-helpers into lp:ubuntu-push

[Samuele Pedroni]

expose a couple of helpers for reuse

expose a couple of helpers for reuse

[Nicola Larosa (teknico)]

LGTM. Only, "isn't event read" in TestReadBodyTooBig looks like a question, maybe "event is not read".

review: Approve

[lp:~pedronis/ubuntu-push/expose-api-helpers]

73. By Samuele Pedroni on 2014-02-21

fix comment

=== modified file 'server/api/handlers.go'
--- server/api/handlers.go	2014-02-18 14:15:55 +0000
+++ server/api/handlers.go	2014-02-21 11:31:14 +0000
@@ -47,7 +47,7 @@
 const (
 	ioError        = "io-error"
 	invalidRequest = "invalid-request"
-	unknownChannel = "unknown channel"
+	unknownChannel = "unknown-channel"
 	unavailable    = "unavailable"
 	internalError  = "internal"
 )
@@ -143,7 +143,8 @@
 	Data     json.RawMessage `json:"data"`
 }
 
-func respondError(writer http.ResponseWriter, apiErr *APIError) {
+// RespondError writes back a JSON error response for a APIError.
+func RespondError(writer http.ResponseWriter, apiErr *APIError) {
 	wireError, err := json.Marshal(apiErr)
 	if err != nil {
 		panic(fmt.Errorf("couldn't marshal our own errors: %v", err))
@@ -153,21 +154,21 @@
 	writer.Write(wireError)
 }
 
-func checkContentLength(request *http.Request) *APIError {
+func checkContentLength(request *http.Request, maxBodySize int64) *APIError {
 	if request.ContentLength == -1 {
 		return ErrNoContentLengthProvided
 	}
 	if request.ContentLength == 0 {
 		return ErrRequestBodyEmpty
 	}
-	if request.ContentLength > MaxRequestBodyBytes {
+	if request.ContentLength > maxBodySize {
 		return ErrRequestBodyTooLarge
 	}
 	return nil
 }
 
-func checkRequestAsPost(request *http.Request) *APIError {
-	if err := checkContentLength(request); err != nil {
+func checkRequestAsPost(request *http.Request, maxBodySize int64) *APIError {
+	if err := checkContentLength(request, maxBodySize); err != nil {
 		return err
 	}
 	if request.Header.Get("Content-Type") != JSONMediaType {
@@ -179,8 +180,9 @@
 	return nil
 }
 
-func readBody(request *http.Request) ([]byte, *APIError) {
-	if err := checkRequestAsPost(request); err != nil {
+// ReadBody checks that a POST request is well-formed and reads its body.
+func ReadBody(request *http.Request, maxBodySize int64) ([]byte, *APIError) {
+	if err := checkRequestAsPost(request, maxBodySize); err != nil {
 		return nil, err
 	}
 
@@ -264,11 +266,11 @@
 	var apiErr *APIError
 	defer func() {
 		if apiErr != nil {
-			respondError(writer, apiErr)
+			RespondError(writer, apiErr)
 		}
 	}()
 
-	body, apiErr := readBody(request)
+	body, apiErr := ReadBody(request, MaxRequestBodyBytes)
 	if apiErr != nil {
 		return
 	}

=== modified file 'server/api/handlers_test.go'
--- server/api/handlers_test.go	2014-02-18 14:15:55 +0000
+++ server/api/handlers_test.go	2014-02-21 11:31:14 +0000
@@ -59,16 +59,26 @@
 	c.Check(string(wire), Equals, `{"error":"invalid-request","message":"Message"}`)
 }
 
-func (s *handlersSuite) TestReadyBodyReadError(c *C) {
+func (s *handlersSuite) TestReadBodyReadError(c *C) {
 	r := bytes.NewReader([]byte{}) // eof too early
 	req, err := http.NewRequest("POST", "", r)
+	c.Assert(err, IsNil)
 	req.Header.Set("Content-Type", "application/json")
 	req.ContentLength = 1000
-	c.Assert(err, IsNil)
-	_, err = readBody(req)
+	_, err = ReadBody(req, 2000)
 	c.Check(err, Equals, ErrCouldNotReadBody)
 }
 
+func (s *handlersSuite) TestReadBodyTooBig(c *C) {
+	r := bytes.NewReader([]byte{}) // not read
+	req, err := http.NewRequest("POST", "", r)
+	c.Assert(err, IsNil)
+	req.Header.Set("Content-Type", "application/json")
+	req.ContentLength = 3000
+	_, err = ReadBody(req, 2000)
+	c.Check(err, Equals, ErrRequestBodyTooLarge)
+}
+
 func (s *handlersSuite) TestGetStore(c *C) {
 	ctx := &context{storeForRequest: func(w http.ResponseWriter, r *http.Request) (store.PendingStore, error) {
 		return nil, ErrStoreUnavailable