From 4880bdf0b7eb36abfbf2971567e84b4f6130afac Mon Sep 17 00:00:00 2001 From: mlosicki Date: Mon, 24 Jan 2022 00:30:09 +0100 Subject: [PATCH 1/3] fix: support pagination for GetBranches The docs mention that this is a Paged API, yet there is no support for limit and start query params. --- default_api.go | 12 ++++++++++++ default_api_test.go | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/default_api.go b/default_api.go index 1091790..1ab2a33 100644 --- a/default_api.go +++ b/default_api.go @@ -3260,7 +3260,19 @@ func (a *DefaultApiService) GetBranches(project, repository string, localVarOpti if err := typeCheckParameter(localVarOptionals["orderBy"], "string", "orderBy"); err != nil { return nil, err } + if err := typeCheckParameter(localVarOptionals["limit"], "int", "limit"); err != nil { + return nil, err + } + if err := typeCheckParameter(localVarOptionals["start"], "int", "start"); err != nil { + return nil, err + } + if localVarTempParam, localVarOk := localVarOptionals["limit"].(int); localVarOk { + localVarQueryParams.Add("limit", parameterToString(localVarTempParam, "")) + } + if localVarTempParam, localVarOk := localVarOptionals["start"].(int); localVarOk { + localVarQueryParams.Add("start", parameterToString(localVarTempParam, "")) + } if localVarTempParam, localVarOk := localVarOptionals["base"].(string); localVarOk { localVarQueryParams.Add("base", parameterToString(localVarTempParam, "")) } diff --git a/default_api_test.go b/default_api_test.go index 9e43a3c..fc0af54 100644 --- a/default_api_test.go +++ b/default_api_test.go @@ -5,6 +5,9 @@ package bitbucketv1 import ( + "io" + "net/http" + "net/http/httptest" "os" "reflect" "testing" @@ -2331,6 +2334,47 @@ func TestDefaultApiService_GetBranches(t *testing.T) { } } +func TestDefaultApiService_GetBranchesPagination(t *testing.T) { + ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + switch r.RequestURI { + case "/api/1.0/projects/PROJECT/repos/REPO/branches?limit=100&start=0": + io.WriteString(w, `{ + "size": 1, + "limit": 100, + "isLastPage": true, + "values": [ + { + "id": "refs/heads/main", + "displayId": "main", + "type": "BRANCH", + "latestCommit": "8d51122def5632836d1cb1026e879069e10a1e13", + "latestChangeset": "8d51122def5632836d1cb1026e879069e10a1e13", + "isDefault": true + } + ], + "start": 0 + }`) + default: + t.Errorf("DefaultApiService.GetBranches() error = unhandled request %s", r.RequestURI) + } + })) + defer ts.Close() + + client := NewAPIClient( + context.TODO(), + NewConfiguration(ts.URL), + ) + _, err := client.DefaultApi.GetBranches("PROJECT", "REPO", map[string]interface{}{ + "limit": 100, + "start": 0, + }) + if err != nil { + t.Errorf("DefaultApiService.GetBranches() error = %v", err) + return + } +} + func TestDefaultApiService_GetChanges(t *testing.T) { type fields struct { client *APIClient From b5aee2ce516df0d4b91192f3e06ba55f8de4da3c Mon Sep 17 00:00:00 2001 From: mlosicki Date: Mon, 24 Jan 2022 01:01:54 +0100 Subject: [PATCH 2/3] improve test --- default_api_test.go | 53 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 7 deletions(-) diff --git a/default_api_test.go b/default_api_test.go index fc0af54..ba42205 100644 --- a/default_api_test.go +++ b/default_api_test.go @@ -2365,13 +2365,52 @@ func TestDefaultApiService_GetBranchesPagination(t *testing.T) { context.TODO(), NewConfiguration(ts.URL), ) - _, err := client.DefaultApi.GetBranches("PROJECT", "REPO", map[string]interface{}{ - "limit": 100, - "start": 0, - }) - if err != nil { - t.Errorf("DefaultApiService.GetBranches() error = %v", err) - return + type fields struct { + client *APIClient + } + type args struct { + project string + repository string + localVarOptionals map[string]interface{} + } + tests := []struct { + name string + fields fields + args args + want *APIResponse + wantErr, integrationTest bool + }{ + {"limitAndStartSet", fields{client: client}, args{ + project: "PROJECT", repository: "REPO", + localVarOptionals: map[string]interface{}{ + "limit": 100, + "start": 0, + }}, nil, false, false}, + {"incorrectLimit", fields{client: client}, args{ + project: "PROJECT", repository: "REPO", + localVarOptionals: map[string]interface{}{ + "limit": "wrong", + }}, nil, true, false}, + {"incorrectStart", fields{client: client}, args{ + project: "PROJECT", repository: "REPO", + localVarOptionals: map[string]interface{}{ + "start": "wrong", + }}, nil, true, false}, + } + for _, tt := range tests { + if tt.integrationTest != runIntegrationTests { + continue + } + t.Run(tt.name, func(t *testing.T) { + a := &DefaultApiService{ + client: tt.fields.client, + } + _, err := a.GetBranches(tt.args.project, tt.args.repository, tt.args.localVarOptionals) + if (err != nil) != tt.wantErr { + t.Errorf("DefaultApiService.GetBranches() error = %v, wantErr %v", err, tt.wantErr) + return + } + }) } } From bb0818da2971eb612e76d86797877e9c348761cd Mon Sep 17 00:00:00 2001 From: mlosicki Date: Mon, 24 Jan 2022 02:23:49 +0100 Subject: [PATCH 3/3] fix: lint error --- default_api_test.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/default_api_test.go b/default_api_test.go index ba42205..b6f5f10 100644 --- a/default_api_test.go +++ b/default_api_test.go @@ -2339,7 +2339,7 @@ func TestDefaultApiService_GetBranchesPagination(t *testing.T) { w.Header().Set("Content-Type", "application/json") switch r.RequestURI { case "/api/1.0/projects/PROJECT/repos/REPO/branches?limit=100&start=0": - io.WriteString(w, `{ + _, err := io.WriteString(w, `{ "size": 1, "limit": 100, "isLastPage": true, @@ -2355,6 +2355,9 @@ func TestDefaultApiService_GetBranchesPagination(t *testing.T) { ], "start": 0 }`) + if err != nil { + t.Errorf("DefaultApiService.GetBranches() error = i/o error %v", err) + } default: t.Errorf("DefaultApiService.GetBranches() error = unhandled request %s", r.RequestURI) }