boltapi_test.go

package boltapi_test

import (
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"os/exec"
	"testing"
	"time"

	"github.com/ant0ine/go-json-rest/rest"
	"github.com/ant0ine/go-json-rest/rest/test"
	"github.com/boltdb/bolt"
	"github.com/marconi/boltapi"
	. "github.com/smartystreets/goconvey/convey"
)

type ResponseRecorder struct {
	*httptest.ResponseRecorder
}

func (r *ResponseRecorder) WriteJson(v interface{}) error {
	b, err := json.Marshal(v)
	if err != nil {
		return err
	}
	_, err = r.Write(b)
	return err
}

func (r *ResponseRecorder) EncodeJson(v interface{}) ([]byte, error) {
	return json.Marshal(v)
}

func NewRecorder() *ResponseRecorder {
	return &ResponseRecorder{
		ResponseRecorder: httptest.NewRecorder(),
	}
}

func TestBucketsEndpoint(t *testing.T) {
	Convey("testing buckets endpoint", t, func() {
		restapi, db := prepDB(t)

		Convey("should be able to add and retrieve bucket", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			// existing bucket returns error
			request = createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response = NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusInternalServerError)
			So(response.Body.String(), ShouldEqual, `{"Error":"bucket already exists"}`)

			request = createRequest("GET", "/api/v1/buckets/bucket1", nil, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.GetBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `[]`)
		})

		Convey("should be able to list buckets", func() {
			request := createRequest("GET", "/api/v1/buckets", nil, nil)
			response := NewRecorder()
			restapi.ListBuckets(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `[]`)

			request = createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response = NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("GET", "/api/v1/buckets", nil, nil)
			response = NewRecorder()
			restapi.ListBuckets(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `["bucket1"]`)
		})

		Reset(func() {
			db.Close()
		})
	})
}

func TestBucketEndpoint(t *testing.T) {
	Convey("testing bucket endpoint", t, func() {
		restapi, db := prepDB(t)

		Convey("should be able to add bucket item", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload := map[string]interface{}{
				"key": "item1",
				"value": map[string]interface{}{
					"name":   "apple",
					"price":  2.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `{"isRipe":true,"name":"apple","price":2.5}`)

			request = createRequest("GET", "/api/v1/buckets/bucket1/item1", nil, map[string]string{"name": "bucket1", "key": "item1"})
			response = NewRecorder()
			restapi.GetBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `{"isRipe":true,"name":"apple","price":2.5}`)
		})

		Convey("should be able to list bucket items", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload := map[string]interface{}{
				"key": "item1",
				"value": map[string]interface{}{
					"name":   "apple",
					"price":  2.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload = map[string]interface{}{
				"key": "item2",
				"value": map[string]interface{}{
					"name":   "orange",
					"price":  3.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("GET", "/api/v1/buckets/bucket1", nil, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.GetBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `[{"Key":"item1","Value":{"isRipe":true,"name":"apple","price":2.5}},{"Key":"item2","Value":{"isRipe":true,"name":"orange","price":3.5}}]`)
		})

		Convey("should be able to delete bucket", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("DELETE", "/api/v1/buckets/bucket1", nil, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.DeleteBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("GET", "/api/v1/buckets/bucket1", nil, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.GetBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusInternalServerError)
			So(response.Body.String(), ShouldEqual, `{"Error":"bucket doesn't exist"}`)
		})

		Reset(func() {
			db.Close()
		})
	})
}

func TestBucketItemEndpoint(t *testing.T) {
	Convey("testing bucket endpoint", t, func() {
		restapi, db := prepDB(t)

		Convey("should be able to retrieve bucket item", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload := map[string]interface{}{
				"key": "item1",
				"value": map[string]interface{}{
					"name":   "apple",
					"price":  2.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			// non-existing item returns error
			request = createRequest("GET", "/api/v1/buckets/bucket1/item2", nil, map[string]string{"name": "bucket1", "key": "item2"})
			response = NewRecorder()
			restapi.GetBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusInternalServerError)
			So(response.Body.String(), ShouldEqual, `{"Error":"error reading bucket item"}`)

			request = createRequest("GET", "/api/v1/buckets/bucket1/item1", nil, map[string]string{"name": "bucket1", "key": "item1"})
			response = NewRecorder()
			restapi.GetBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `{"isRipe":true,"name":"apple","price":2.5}`)
		})

		Convey("should be able to delete bucket item", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload := map[string]interface{}{
				"key": "item1",
				"value": map[string]interface{}{
					"name":   "apple",
					"price":  2.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("DELETE", "/api/v1/buckets/bucket1/item1", nil, map[string]string{"name": "bucket1", "key": "item1"})
			response = NewRecorder()
			restapi.DeleteBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("GET", "/api/v1/buckets/bucket1/item2", nil, map[string]string{"name": "bucket1", "key": "item2"})
			response = NewRecorder()
			restapi.GetBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusInternalServerError)
			So(response.Body.String(), ShouldEqual, `{"Error":"error reading bucket item"}`)
		})

		Convey("should be able to update bucket item", func() {
			request := createRequest("POST", "/api/v1/buckets", map[string]string{"name": "bucket1"}, nil)
			response := NewRecorder()
			restapi.AddBucket(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload := map[string]interface{}{
				"key": "item1",
				"value": map[string]interface{}{
					"name":   "apple",
					"price":  2.50,
					"isRipe": true,
				},
			}
			request = createRequest("POST", "/api/v1/buckets/bucket1", payload, map[string]string{"name": "bucket1"})
			response = NewRecorder()
			restapi.AddBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			payload = map[string]interface{}{
				"name":   "mango",
				"price":  4.50,
				"isRipe": true,
			}
			request = createRequest("PUT", "/api/v1/buckets/bucket1/item1", payload, map[string]string{"name": "bucket1", "key": "item1"})
			response = NewRecorder()
			restapi.UpdateBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)

			request = createRequest("GET", "/api/v1/buckets/bucket1/item1", nil, map[string]string{"name": "bucket1", "key": "item1"})
			response = NewRecorder()
			restapi.GetBucketItem(response, request)
			So(response.Code, ShouldEqual, http.StatusOK)
			So(response.Body.String(), ShouldEqual, `{"isRipe":true,"name":"mango","price":4.5}`)
		})

		Reset(func() {
			db.Close()
		})
	})
}

func prepDB(t *testing.T) (*boltapi.RestApi, *bolt.DB) {
	err := exec.Command("rm", "./test.db").Run()
	if err != nil {
		t.Error(err)
	}

	db, err := bolt.Open("./test.db", 0600, &bolt.Options{Timeout: 1 * time.Second})
	if err != nil {
		t.Error(err)
	}

	restapi, err := boltapi.NewRestApi(db)
	if err != nil {
		t.Error(err)
	}
	return restapi, db
}

func createRequest(method, urlStr string, body interface{}, pathParams map[string]string) *rest.Request {
	request := test.MakeSimpleRequest(method, urlStr, body)
	return &rest.Request{Request: request, PathParams: pathParams}
}