grafana/pkg/api/folder_test.go

package api

import (
	"encoding/json"
	"fmt"
	"testing"

	"github.com/grafana/grafana/pkg/api/dtos"
	"github.com/grafana/grafana/pkg/bus"
	m "github.com/grafana/grafana/pkg/models"
	"github.com/grafana/grafana/pkg/services/dashboards"

	. "github.com/smartystreets/goconvey/convey"
)

func TestFoldersApiEndpoint(t *testing.T) {
	Convey("Create/update folder response tests", t, func() {
		Convey("Given a correct request for creating a folder", func() {
			cmd := m.CreateFolderCommand{
				Uid:   "uid",
				Title: "Folder",
			}

			mock := &fakeFolderService{
				CreateFolderResult: &m.Folder{Id: 1, Uid: "uid", Title: "Folder"},
			}

			createFolderScenario("When calling POST on", "/api/folders", "/api/folders", mock, cmd, func(sc *scenarioContext) {
				callCreateFolder(sc)

				Convey("It should return correct response data", func() {
					folder := dtos.Folder{}
					err := json.NewDecoder(sc.resp.Body).Decode(&folder)
					So(err, ShouldBeNil)
					So(folder.Id, ShouldEqual, 1)
					So(folder.Uid, ShouldEqual, "uid")
					So(folder.Title, ShouldEqual, "Folder")
				})
			})
		})

		Convey("Given incorrect requests for creating a folder", func() {
			testCases := []struct {
				Error              error
				ExpectedStatusCode int
			}{
				{Error: m.ErrFolderWithSameUIDExists, ExpectedStatusCode: 400},
				{Error: m.ErrFolderTitleEmpty, ExpectedStatusCode: 400},
				{Error: m.ErrFolderSameNameExists, ExpectedStatusCode: 400},
				{Error: m.ErrDashboardInvalidUid, ExpectedStatusCode: 400},
				{Error: m.ErrDashboardUidToLong, ExpectedStatusCode: 400},
				{Error: m.ErrFolderAccessDenied, ExpectedStatusCode: 403},
				{Error: m.ErrFolderNotFound, ExpectedStatusCode: 404},
				{Error: m.ErrFolderVersionMismatch, ExpectedStatusCode: 412},
				{Error: m.ErrFolderFailedGenerateUniqueUid, ExpectedStatusCode: 500},
			}

			cmd := m.CreateFolderCommand{
				Uid:   "uid",
				Title: "Folder",
			}

			for _, tc := range testCases {
				mock := &fakeFolderService{
					CreateFolderError: tc.Error,
				}

				createFolderScenario(fmt.Sprintf("Expect '%s' error when calling POST on", tc.Error.Error()), "/api/folders", "/api/folders", mock, cmd, func(sc *scenarioContext) {
					callCreateFolder(sc)
					if sc.resp.Code != tc.ExpectedStatusCode {
						t.Errorf("For error '%s' expected status code %d, actual %d", tc.Error, tc.ExpectedStatusCode, sc.resp.Code)
					}
				})
			}
		})

		Convey("Given a correct request for updating a folder", func() {
			cmd := m.UpdateFolderCommand{
				Title: "Folder upd",
			}

			mock := &fakeFolderService{
				UpdateFolderResult: &m.Folder{Id: 1, Uid: "uid", Title: "Folder upd"},
			}

			updateFolderScenario("When calling PUT on", "/api/folders/uid", "/api/folders/:uid", mock, cmd, func(sc *scenarioContext) {
				callUpdateFolder(sc)

				Convey("It should return correct response data", func() {
					folder := dtos.Folder{}
					err := json.NewDecoder(sc.resp.Body).Decode(&folder)
					So(err, ShouldBeNil)
					So(folder.Id, ShouldEqual, 1)
					So(folder.Uid, ShouldEqual, "uid")
					So(folder.Title, ShouldEqual, "Folder upd")
				})
			})
		})

		Convey("Given incorrect requests for updating a folder", func() {
			testCases := []struct {
				Error              error
				ExpectedStatusCode int
			}{
				{Error: m.ErrFolderWithSameUIDExists, ExpectedStatusCode: 400},
				{Error: m.ErrFolderTitleEmpty, ExpectedStatusCode: 400},
				{Error: m.ErrFolderSameNameExists, ExpectedStatusCode: 400},
				{Error: m.ErrDashboardInvalidUid, ExpectedStatusCode: 400},
				{Error: m.ErrDashboardUidToLong, ExpectedStatusCode: 400},
				{Error: m.ErrFolderAccessDenied, ExpectedStatusCode: 403},
				{Error: m.ErrFolderNotFound, ExpectedStatusCode: 404},
				{Error: m.ErrFolderVersionMismatch, ExpectedStatusCode: 412},
				{Error: m.ErrFolderFailedGenerateUniqueUid, ExpectedStatusCode: 500},
			}

			cmd := m.UpdateFolderCommand{
				Title: "Folder upd",
			}

			for _, tc := range testCases {
				mock := &fakeFolderService{
					UpdateFolderError: tc.Error,
				}

				updateFolderScenario(fmt.Sprintf("Expect '%s' error when calling PUT on", tc.Error.Error()), "/api/folders/uid", "/api/folders/:uid", mock, cmd, func(sc *scenarioContext) {
					callUpdateFolder(sc)
					if sc.resp.Code != tc.ExpectedStatusCode {
						t.Errorf("For error '%s' expected status code %d, actual %d", tc.Error, tc.ExpectedStatusCode, sc.resp.Code)
					}
				})
			}
		})
	})
}

func callGetFolderByUID(sc *scenarioContext) {
	sc.handlerFunc = GetFolderByUID
	sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
}

func callDeleteFolder(sc *scenarioContext) {
	sc.handlerFunc = DeleteFolder
	sc.fakeReqWithParams("DELETE", sc.url, map[string]string{}).exec()
}

func callCreateFolder(sc *scenarioContext) {
	sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
}

func createFolderScenario(desc string, url string, routePattern string, mock *fakeFolderService, cmd m.CreateFolderCommand, fn scenarioFunc) {
	Convey(desc+" "+url, func() {
		defer bus.ClearBusHandlers()

		sc := setupScenarioContext(url)
		sc.defaultHandler = Wrap(func(c *m.ReqContext) Response {
			sc.context = c
			sc.context.SignedInUser = &m.SignedInUser{OrgId: TestOrgID, UserId: TestUserID}

			return CreateFolder(c, cmd)
		})

		origNewFolderService := dashboards.NewFolderService
		mockFolderService(mock)

		sc.m.Post(routePattern, sc.defaultHandler)

		defer func() {
			dashboards.NewFolderService = origNewFolderService
		}()

		fn(sc)
	})
}

func callUpdateFolder(sc *scenarioContext) {
	sc.fakeReqWithParams("PUT", sc.url, map[string]string{}).exec()
}

func updateFolderScenario(desc string, url string, routePattern string, mock *fakeFolderService, cmd m.UpdateFolderCommand, fn scenarioFunc) {
	Convey(desc+" "+url, func() {
		defer bus.ClearBusHandlers()

		sc := setupScenarioContext(url)
		sc.defaultHandler = Wrap(func(c *m.ReqContext) Response {
			sc.context = c
			sc.context.SignedInUser = &m.SignedInUser{OrgId: TestOrgID, UserId: TestUserID}

			return UpdateFolder(c, cmd)
		})

		origNewFolderService := dashboards.NewFolderService
		mockFolderService(mock)

		sc.m.Put(routePattern, sc.defaultHandler)

		defer func() {
			dashboards.NewFolderService = origNewFolderService
		}()

		fn(sc)
	})
}

type fakeFolderService struct {
	GetFoldersResult     []*m.Folder
	GetFoldersError      error
	GetFolderByUIDResult *m.Folder
	GetFolderByUIDError  error
	GetFolderByIDResult  *m.Folder
	GetFolderByIDError   error
	CreateFolderResult   *m.Folder
	CreateFolderError    error
	UpdateFolderResult   *m.Folder
	UpdateFolderError    error
	DeleteFolderResult   *m.Folder
	DeleteFolderError    error
	DeletedFolderUids    []string
}

func (s *fakeFolderService) GetFolders(limit int) ([]*m.Folder, error) {
	return s.GetFoldersResult, s.GetFoldersError
}

func (s *fakeFolderService) GetFolderByID(id int64) (*m.Folder, error) {
	return s.GetFolderByIDResult, s.GetFolderByIDError
}

func (s *fakeFolderService) GetFolderByUID(uid string) (*m.Folder, error) {
	return s.GetFolderByUIDResult, s.GetFolderByUIDError
}

func (s *fakeFolderService) CreateFolder(cmd *m.CreateFolderCommand) error {
	cmd.Result = s.CreateFolderResult
	return s.CreateFolderError
}

func (s *fakeFolderService) UpdateFolder(existingUID string, cmd *m.UpdateFolderCommand) error {
	cmd.Result = s.UpdateFolderResult
	return s.UpdateFolderError
}

func (s *fakeFolderService) DeleteFolder(uid string) (*m.Folder, error) {
	s.DeletedFolderUids = append(s.DeletedFolderUids, uid)
	return s.DeleteFolderResult, s.DeleteFolderError
}

func mockFolderService(mock *fakeFolderService) {
	dashboards.NewFolderService = func(orgId int64, user *m.SignedInUser) dashboards.FolderService {
		return mock
	}
}