Add Filtering, HealthCheck, Better Tests (#350)

feat: add filtering when choosing merge requests (#346)
feat: Add healthcheck (#345)
refactor: Move to gomock (#349)
feat: Makes the remote of the plugin configurable (#348)

This is a #MINOR release.
This commit is contained in:
Harrison (Harry) Cramer
2024-08-23 14:01:59 -04:00
committed by GitHub
parent aa5d3c1f52
commit 4ae623cd65
61 changed files with 2174 additions and 1082 deletions

View File

@@ -1,65 +1,64 @@
package main
import (
"errors"
"net/http"
"testing"
"time"
"github.com/xanzy/go-gitlab"
mock_main "gitlab.com/harrisoncramer/gitlab.nvim/cmd/mocks"
"go.uber.org/mock/gomock"
)
func listMergeRequestDiscussions(pid interface{}, mergeRequest int, opt *gitlab.ListMergeRequestDiscussionsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Discussion, *gitlab.Response, error) {
now := time.Now()
newer := now.Add(time.Second * 100)
discussions := []*gitlab.Discussion{
{
Notes: []*gitlab.Note{
{
CreatedAt: &now,
Type: "DiffNote",
Author: Author{
Username: "hcramer",
},
var now = time.Now()
var newer = now.Add(time.Second * 100)
type Author struct {
ID int `json:"id"`
Username string `json:"username"`
Email string `json:"email"`
Name string `json:"name"`
State string `json:"state"`
AvatarURL string `json:"avatar_url"`
WebURL string `json:"web_url"`
}
var testListDiscussionsResponse = []*gitlab.Discussion{
{
Notes: []*gitlab.Note{
{
CreatedAt: &now,
Type: "DiffNote",
Author: Author{
Username: "hcramer",
},
},
},
{
Notes: []*gitlab.Note{
{
CreatedAt: &newer,
Type: "DiffNote",
Author: Author{
Username: "hcramer2",
},
},
{
Notes: []*gitlab.Note{
{
CreatedAt: &newer,
Type: "DiffNote",
Author: Author{
Username: "hcramer2",
},
},
},
}
return discussions, makeResponse(http.StatusOK), nil
}
func listMergeRequestDiscussionsErr(pid interface{}, mergeRequest int, opt *gitlab.ListMergeRequestDiscussionsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Discussion, *gitlab.Response, error) {
return nil, nil, errors.New("Some error from Gitlab")
}
func listMergeRequestDiscussionsNon200(pid interface{}, mergeRequest int, opt *gitlab.ListMergeRequestDiscussionsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Discussion, *gitlab.Response, error) {
return nil, makeResponse(http.StatusSeeOther), nil
}
func listMergeRequestAwardEmojiOnNote(pid interface{}, mr int, noteID int, opt *gitlab.ListAwardEmojiOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.AwardEmoji, *gitlab.Response, error) {
return []*gitlab.AwardEmoji{}, makeResponse(http.StatusOK), nil
}
func listMergeRequestAwardEmojiOnNoteFailure(pid interface{}, mr int, noteID int, opt *gitlab.ListAwardEmojiOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.AwardEmoji, *gitlab.Response, error) {
return nil, makeResponse(http.StatusBadRequest), errors.New("Some error from Gitlab")
},
}
func TestListDiscussionsHandler(t *testing.T) {
t.Run("Returns sorted discussions", func(t *testing.T) {
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
client.EXPECT().ListMergeRequestDiscussions("", mock_main.MergeId, gomock.Any()).Return(testListDiscussionsResponse, makeResponse(http.StatusOK), nil)
client.EXPECT().ListMergeRequestAwardEmojiOnNote("", mock_main.MergeId, gomock.Any(), gomock.Any()).Return([]*gitlab.AwardEmoji{}, makeResponse(http.StatusOK), nil).Times(2)
request := makeRequest(t, http.MethodPost, "/mr/discussions/list", DiscussionsRequest{})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussions, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNote})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, DiscussionsResponse{})
assert(t, data.SuccessResponse.Message, "Discussions retrieved")
assert(t, data.SuccessResponse.Status, http.StatusOK)
assert(t, data.Discussions[0].Notes[0].Author.Username, "hcramer2") /* Sorting applied */
@@ -67,9 +66,15 @@ func TestListDiscussionsHandler(t *testing.T) {
})
t.Run("Uses blacklist to filter unwanted authors", func(t *testing.T) {
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
client.EXPECT().ListMergeRequestDiscussions("", mock_main.MergeId, gomock.Any()).Return(testListDiscussionsResponse, makeResponse(http.StatusOK), nil)
client.EXPECT().ListMergeRequestAwardEmojiOnNote("", mock_main.MergeId, gomock.Any(), gomock.Any()).Return([]*gitlab.AwardEmoji{}, makeResponse(http.StatusOK), nil).Times(2)
request := makeRequest(t, http.MethodPost, "/mr/discussions/list", DiscussionsRequest{Blacklist: []string{"hcramer"}})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussions, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNote})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, DiscussionsResponse{})
assert(t, data.SuccessResponse.Message, "Discussions retrieved")
assert(t, data.SuccessResponse.Status, http.StatusOK)
assert(t, len(data.Discussions), 1)
@@ -77,30 +82,51 @@ func TestListDiscussionsHandler(t *testing.T) {
})
t.Run("Disallows non-POST method", func(t *testing.T) {
request := makeRequest(t, http.MethodPatch, "/mr/discussions/list", DiscussionsRequest{})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussions, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNote})
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
request := makeRequest(t, http.MethodPut, "/mr/discussions/list", DiscussionsRequest{})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, ErrorResponse{})
checkBadMethod(t, *data, http.MethodPost)
})
t.Run("Handles errors from Gitlab client", func(t *testing.T) {
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
client.EXPECT().ListMergeRequestDiscussions("", mock_main.MergeId, gomock.Any()).Return(nil, nil, errorFromGitlab)
request := makeRequest(t, http.MethodPost, "/mr/discussions/list", DiscussionsRequest{})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussionsErr, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNote})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, ErrorResponse{})
checkErrorFromGitlab(t, *data, "Could not list discussions")
})
t.Run("Handles non-200s from Gitlab client", func(t *testing.T) {
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
client.EXPECT().ListMergeRequestDiscussions("", mock_main.MergeId, gomock.Any()).Return(nil, makeResponse(http.StatusSeeOther), nil)
request := makeRequest(t, http.MethodPost, "/mr/discussions/list", DiscussionsRequest{})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussionsNon200, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNote})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, ErrorResponse{})
checkNon200(t, *data, "Could not list discussions", "/mr/discussions/list")
})
t.Run("Handles error from emoji service", func(t *testing.T) {
client := mock_main.NewMockClient(t)
mock_main.WithMr(t, client)
client.EXPECT().ListMergeRequestDiscussions("", mock_main.MergeId, gomock.Any()).Return(testListDiscussionsResponse, makeResponse(http.StatusOK), nil)
client.EXPECT().ListMergeRequestAwardEmojiOnNote("", mock_main.MergeId, gomock.Any(), gomock.Any()).Return(nil, nil, errorFromGitlab).Times(2)
request := makeRequest(t, http.MethodPost, "/mr/discussions/list", DiscussionsRequest{})
server, _ := createRouterAndApi(fakeClient{listMergeRequestDiscussions: listMergeRequestDiscussions, listMergeRequestAwardEmojiOnNote: listMergeRequestAwardEmojiOnNoteFailure})
server, _ := CreateRouterAndApi(client)
data := serveRequest(t, server, request, ErrorResponse{})
checkErrorFromGitlab(t, *data, "Could not fetch emojis")
})
}