gitlab.nvim/cmd/app/comment_test.go

package app

import (
	"net/http"
	"testing"

	gitlab "gitlab.com/gitlab-org/api/client-go"
)

type fakeCommentClient struct {
	testBase
}

func (f fakeCommentClient) CreateMergeRequestDiscussion(pid interface{}, mergeRequest int64, opt *gitlab.CreateMergeRequestDiscussionOptions, options ...gitlab.RequestOptionFunc) (*gitlab.Discussion, *gitlab.Response, error) {
	resp, err := f.handleGitlabError()
	if err != nil {
		return nil, nil, err
	}

	return &gitlab.Discussion{Notes: []*gitlab.Note{{}}}, resp, err
}
func (f fakeCommentClient) UpdateMergeRequestDiscussionNote(pid interface{}, mergeRequest int64, discussion string, note int64, opt *gitlab.UpdateMergeRequestDiscussionNoteOptions, options ...gitlab.RequestOptionFunc) (*gitlab.Note, *gitlab.Response, error) {
	resp, err := f.handleGitlabError()
	if err != nil {
		return nil, nil, err
	}

	return &gitlab.Note{}, resp, err
}

func (f fakeCommentClient) DeleteMergeRequestDiscussionNote(pid interface{}, mergeRequest int64, discussion string, note int64, options ...gitlab.RequestOptionFunc) (*gitlab.Response, error) {
	resp, err := f.handleGitlabError()
	if err != nil {
		return nil, err
	}
	return resp, err
}

func TestPostComment(t *testing.T) {
	var testCommentCreationData = PostCommentRequest{Comment: "Some comment"}
	t.Run("Creates a new note (unlinked comment)", func(t *testing.T) {
		request := makeRequest(t, http.MethodPost, "/mr/comment", testCommentCreationData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data := getSuccessData(t, svc, request)
		assert(t, data.Message, "Comment created successfully")
	})

	t.Run("Creates a new comment", func(t *testing.T) {
		testCommentCreationData := PostCommentRequest{ // Re-create comment creation data to avoid mutating this variable in other tests
			Comment: "Some comment",
			PositionData: PositionData{
				FileName: "file.txt",
			},
		}
		request := makeRequest(t, http.MethodPost, "/mr/comment", testCommentCreationData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data := getSuccessData(t, svc, request)
		assert(t, data.Message, "Comment created successfully")
	})

	t.Run("Handles errors from Gitlab client", func(t *testing.T) {
		request := makeRequest(t, http.MethodPost, "/mr/comment", testCommentCreationData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{testBase{errFromGitlab: true}}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data, _ := getFailData(t, svc, request)
		checkErrorFromGitlab(t, data, "Could not create discussion")
	})

	t.Run("Handles non-200s from Gitlab client", func(t *testing.T) {
		request := makeRequest(t, http.MethodPost, "/mr/comment", testCommentCreationData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{testBase{status: http.StatusSeeOther}}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data, _ := getFailData(t, svc, request)
		checkNon200(t, data, "Could not create discussion", "/mr/comment")
	})
}

func TestDeleteComment(t *testing.T) {
	var testCommentDeletionData = DeleteCommentRequest{NoteId: 3, DiscussionId: "abc123"}
	t.Run("Deletes a comment", func(t *testing.T) {
		request := makeRequest(t, http.MethodDelete, "/mr/comment", testCommentDeletionData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data := getSuccessData(t, svc, request)
		assert(t, data.Message, "Comment deleted successfully")
	})
}

func TestEditComment(t *testing.T) {
	var testEditCommentData = EditCommentRequest{Comment: "Some comment", NoteId: 3, DiscussionId: "abc123"}
	t.Run("Edits a comment", func(t *testing.T) {
		request := makeRequest(t, http.MethodPatch, "/mr/comment", testEditCommentData)
		svc := middleware(
			commentService{testProjectData, fakeCommentClient{}},
			withMr(testProjectData, fakeMergeRequestLister{}),
			withPayloadValidation(methodToPayload{
				http.MethodPost:   newPayload[PostCommentRequest],
				http.MethodDelete: newPayload[DeleteCommentRequest],
				http.MethodPatch:  newPayload[EditCommentRequest],
			}),
			withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
		)
		data := getSuccessData(t, svc, request)
		assert(t, data.Message, "Comment updated successfully")
	})
}