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,46 +1,23 @@
package main
import (
"errors"
"fmt"
"net/http"
"testing"
"github.com/xanzy/go-gitlab"
mock_main "gitlab.com/harrisoncramer/gitlab.nvim/cmd/mocks"
"go.uber.org/mock/gomock"
)
func listPipelineJobs(pid interface{}, pipelineID int, opts *gitlab.ListJobsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Job, *gitlab.Response, error) {
return []*gitlab.Job{}, makeResponse(http.StatusOK), nil
}
var testPipelineId = 12435
var testPipelineCommit = "abc123"
var fakeProjectPipelines = []*gitlab.PipelineInfo{{ID: testPipelineId}}
func listPipelineJobsErr(pid interface{}, pipelineID int, opts *gitlab.ListJobsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Job, *gitlab.Response, error) {
return nil, nil, errors.New("Some error from Gitlab")
}
func listPipelineJobsNon200(pid interface{}, pipelineID int, opts *gitlab.ListJobsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Job, *gitlab.Response, error) {
return nil, makeResponse(http.StatusSeeOther), nil
}
func retryPipelineBuild(pid interface{}, pipeline int, options ...gitlab.RequestOptionFunc) (*gitlab.Pipeline, *gitlab.Response, error) {
return &gitlab.Pipeline{}, makeResponse(http.StatusOK), nil
}
func retryPipelineBuildErr(pid interface{}, pipeline int, options ...gitlab.RequestOptionFunc) (*gitlab.Pipeline, *gitlab.Response, error) {
return nil, nil, errors.New("Some error from Gitlab")
}
func retryPipelineBuildNon200(pid interface{}, pipeline int, options ...gitlab.RequestOptionFunc) (*gitlab.Pipeline, *gitlab.Response, error) {
return nil, makeResponse(http.StatusSeeOther), nil
}
func listProjectPipelines(pid interface{}, opt *gitlab.ListProjectPipelinesOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.PipelineInfo, *gitlab.Response, error) {
return []*gitlab.PipelineInfo{
{ID: 12345},
}, makeResponse(http.StatusOK), nil
}
func withGitInfo(a *api) error {
a.gitInfo.GetLatestCommitOnRemote = func(a *api) (string, error) {
return "123abc", nil
/* This helps us stub out git interactions that the server would normally run in the project directory */
func withGitInfo(a *Api) error {
a.gitInfo.GetLatestCommitOnRemote = func(a *Api) (string, error) {
return testPipelineCommit, nil
}
a.gitInfo.BranchName = "some-feature"
return nil
@@ -48,74 +25,82 @@ func withGitInfo(a *api) error {
func TestPipelineHandler(t *testing.T) {
t.Run("Gets all pipeline jobs", func(t *testing.T) {
client := mock_main.NewMockClient(t)
client.EXPECT().ListProjectPipelines("", gomock.Any()).Return(fakeProjectPipelines, makeResponse(http.StatusOK), nil)
client.EXPECT().ListPipelineJobs("", testPipelineId, &gitlab.ListJobsOptions{}).Return([]*gitlab.Job{}, makeResponse(http.StatusOK), nil)
request := makeRequest(t, http.MethodGet, "/pipeline", nil)
server, _ := createRouterAndApi(fakeClient{
listPipelineJobs: listPipelineJobs,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, GetPipelineAndJobsResponse{})
assert(t, data.SuccessResponse.Message, "Pipeline retrieved")
assert(t, data.SuccessResponse.Status, http.StatusOK)
})
t.Run("Disallows non-GET, non-POST methods", func(t *testing.T) {
client := mock_main.NewMockClient(t)
request := makeRequest(t, http.MethodPatch, "/pipeline", nil)
server, _ := createRouterAndApi(fakeClient{
listPipelineJobs: listPipelineJobs,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkBadMethod(t, *data, http.MethodGet, http.MethodPost)
})
t.Run("Handles errors from Gitlab client", func(t *testing.T) {
client := mock_main.NewMockClient(t)
client.EXPECT().ListProjectPipelines("", gomock.Any()).Return(fakeProjectPipelines, makeResponse(http.StatusOK), nil)
client.EXPECT().ListPipelineJobs("", testPipelineId, &gitlab.ListJobsOptions{}).Return(nil, nil, errorFromGitlab)
request := makeRequest(t, http.MethodGet, "/pipeline", nil)
server, _ := createRouterAndApi(fakeClient{
listPipelineJobs: listPipelineJobsErr,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkErrorFromGitlab(t, *data, "Could not get pipeline jobs")
})
t.Run("Handles non-200s from Gitlab client", func(t *testing.T) {
client := mock_main.NewMockClient(t)
client.EXPECT().ListProjectPipelines("", gomock.Any()).Return(fakeProjectPipelines, makeResponse(http.StatusOK), nil)
client.EXPECT().ListPipelineJobs("", testPipelineId, &gitlab.ListJobsOptions{}).Return(nil, makeResponse(http.StatusSeeOther), nil)
request := makeRequest(t, http.MethodGet, "/pipeline", nil)
server, _ := createRouterAndApi(fakeClient{
listPipelineJobs: listPipelineJobsNon200,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkNon200(t, *data, "Could not get pipeline jobs", "/pipeline")
})
t.Run("Handles errors from Gitlab client", func(t *testing.T) {
request := makeRequest(t, http.MethodPost, "/pipeline/trigger/1", nil)
server, _ := createRouterAndApi(fakeClient{
retryPipelineBuild: retryPipelineBuildErr,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkErrorFromGitlab(t, *data, "Could not retrigger pipeline")
})
t.Run("Retriggers pipeline", func(t *testing.T) {
request := makeRequest(t, http.MethodPost, "/pipeline/trigger/1", nil)
server, _ := createRouterAndApi(fakeClient{
retryPipelineBuild: retryPipelineBuild,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
client := mock_main.NewMockClient(t)
client.EXPECT().RetryPipelineBuild("", testPipelineId).Return(&gitlab.Pipeline{}, makeResponse(http.StatusOK), nil)
request := makeRequest(t, http.MethodPost, fmt.Sprintf("/pipeline/trigger/%d", testPipelineId), nil)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, GetPipelineAndJobsResponse{})
assert(t, data.SuccessResponse.Message, "Pipeline retriggered")
assert(t, data.SuccessResponse.Status, http.StatusOK)
})
t.Run("Handles non-200s from Gitlab client on retrigger", func(t *testing.T) {
request := makeRequest(t, http.MethodPost, "/pipeline/trigger/1", nil)
server, _ := createRouterAndApi(fakeClient{
retryPipelineBuild: retryPipelineBuildNon200,
listProjectPipelines: listProjectPipelines,
}, withGitInfo)
client := mock_main.NewMockClient(t)
client.EXPECT().RetryPipelineBuild("", testPipelineId).Return(nil, makeResponse(http.StatusSeeOther), nil)
request := makeRequest(t, http.MethodPost, fmt.Sprintf("/pipeline/trigger/%d", testPipelineId), nil)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkNon200(t, *data, "Could not retrigger pipeline", "/pipeline")
})
t.Run("Handles error from Gitlab client on retrigger", func(t *testing.T) {
client := mock_main.NewMockClient(t)
client.EXPECT().RetryPipelineBuild("", testPipelineId).Return(nil, nil, errorFromGitlab)
request := makeRequest(t, http.MethodPost, fmt.Sprintf("/pipeline/trigger/%d", testPipelineId), nil)
server, _ := CreateRouterAndApi(client, withGitInfo)
data := serveRequest(t, server, request, ErrorResponse{})
checkErrorFromGitlab(t, *data, "Could not retrigger pipeline")
})
}