Fix: Using the Latest GitHub Release type filter should return the release marked as latest

[olblak]

Fix #969

Another approach than #988

Test

To test this pull request, you can run the following commands:

cp <to_package_directory>
go test

Additional Information

Tradeoff

Potential improvement

[dduportal]

Proposal:

query getLatestRelease($owner: String!, $repository: String!) {
  rateLimit {
    cost
    remaining
    resetAt
  }
  repository(owner: $owner, name: $repository) {
    latestRelease {
      id
      name
      tagName
    }
  }
}

when "Latest: true" WDYT?

[olblak]

that

Proposal:

query getLatestRelease($owner: String!, $repository: String!) {
  rateLimit {
    cost
    remaining
    resetAt
  }
  repository(owner: $owner, name: $repository) {
    latestRelease {
      id
      name
      tagName
    }
  }
}

when "Latest: true" WDYT?

That would be a better query as it would reduce the amount of information retrieved from the API which ultimately will benefit the api limit usage

[dduportal]

I was able to update the unit test (pkg/plugins/scms/github/release_test.go) to cover:

• The issue I see on the main branch
• The "Draft" and "Prerelease" cases from [source][condition] Allow to filter Github Release per release type #969
• The "Latest" case as you described it + implemented it in the current PR

---

On the main branch (commit 482425f)

ok  	github.com/updatecli/updatecli/pkg/plugins/scms/github	0.684s	coverage: 41.3% of statements

---

Click to view the new content for the `pkg/plugins/scms/github/release_test.go` test file

package github

import (
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestSearchReleases(t *testing.T) {
	tests := []struct {
		name         string
		spec         Spec
		releaseType  ReleaseType
		mockedQuery  *releasesQuery
		mockedError  error
		wantReleases []string
		wantErr      bool
	}{
		{
			name: "Case with a mix of releases (draft, prerelease, release) and default ReleaseType filter",
			spec: Spec{
				Owner:      "updatecli",
				Repository: "updatecli",
				Token:      "superSecretTokenForJoe",
				Username:   "joe",
			},
			mockedQuery: &releasesQuery{
				RateLimit: RateLimit{
					Cost:      1,
					Remaining: 5000,
				},
				Repository: struct {
					Releases repositoryRelease `graphql:"releases(last: 100, before: $before, orderBy: $orderBy)"`
				}{
					Releases: repositoryRelease{
						TotalCount: 4,
						PageInfo: PageInfo{
							HasNextPage: false,
							EndCursor:   "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
						},
						Edges: []releaseEdge{
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:    "v0.18.4 🌈",
									TagName: "v0.18.4",
									IsDraft: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:     "v0.18.3",
									TagName:  "v0.18.3",
									IsLatest: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMS0xMS0xM1QxMjozNzoxMiswMTowMM4DK66W",
								Node: releaseNode{
									Name:         "v1.0.0",
									TagName:      "v1.0.0",
									IsPrerelease: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
								Node: releaseNode{
									Name:    "v0.0.1",
									TagName: "v0.0.1",
								},
							},
						},
					},
				},
			},
			wantReleases: []string{"v0.0.1", "v0.18.3"},
		},
		{
			name: "Case with a mix of releases (draft, prerelease, release) and a ReleaseType with draft, prerelease and releases",
			spec: Spec{
				Owner:      "updatecli",
				Repository: "updatecli",
				Token:      "superSecretTokenForJoe",
				Username:   "joe",
			},
			releaseType: ReleaseType{
				Draft:      true,
				PreRelease: true,
				Release:    true,
			},
			mockedQuery: &releasesQuery{
				RateLimit: RateLimit{
					Cost:      1,
					Remaining: 5000,
				},
				Repository: struct {
					Releases repositoryRelease `graphql:"releases(last: 100, before: $before, orderBy: $orderBy)"`
				}{
					Releases: repositoryRelease{
						TotalCount: 4,
						PageInfo: PageInfo{
							HasNextPage: false,
							EndCursor:   "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
						},
						Edges: []releaseEdge{
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:    "v0.18.4 🌈",
									TagName: "v0.18.4",
									IsDraft: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:     "v0.18.3",
									TagName:  "v0.18.3",
									IsLatest: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMS0xMS0xM1QxMjozNzoxMiswMTowMM4DK66W",
								Node: releaseNode{
									Name:         "v1.0.0",
									TagName:      "v1.0.0",
									IsPrerelease: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
								Node: releaseNode{
									Name:    "v0.0.1",
									TagName: "v0.0.1",
								},
							},
						},
					},
				},
			},
			wantReleases: []string{"v0.0.1", "v1.0.0", "v0.18.3", "v0.18.4"},
		},
		{
			name: "Case with a mix of releases (draft, prerelease, release) and a ReleaseType with 'Latest'",
			spec: Spec{
				Owner:      "updatecli",
				Repository: "updatecli",
				Token:      "superSecretTokenForJoe",
				Username:   "joe",
			},
			releaseType: ReleaseType{
				Latest: true,
			},
			mockedQuery: &releasesQuery{
				RateLimit: RateLimit{
					Cost:      1,
					Remaining: 5000,
				},
				Repository: struct {
					Releases repositoryRelease `graphql:"releases(last: 100, before: $before, orderBy: $orderBy)"`
				}{
					Releases: repositoryRelease{
						TotalCount: 4,
						PageInfo: PageInfo{
							HasNextPage: false,
							EndCursor:   "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
						},
						Edges: []releaseEdge{
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:    "v0.18.4 🌈",
									TagName: "v0.18.4",
									IsDraft: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMi0wMS0xOFQxOTo0Nzo1MyswMTowMM4Da8vn",
								Node: releaseNode{
									Name:     "v0.18.3",
									TagName:  "v0.18.3",
									IsLatest: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMS0xMS0xM1QxMjozNzoxMiswMTowMM4DK66W",
								Node: releaseNode{
									Name:         "v1.0.0",
									TagName:      "v1.0.0",
									IsPrerelease: true,
								},
							},
							{
								Cursor: "Y3Vyc29yOnYyOpK5MjAyMC0wMi0xOVQyMTozMDoxMyswMTowMM4BYOFb",
								Node: releaseNode{
									Name:    "v0.0.1",
									TagName: "v0.0.1",
								},
							},
						},
					},
				},
			},
			wantReleases: []string{"v0.18.3"},
		},
		{
			name:        "Case with error returned from github query",
			mockedQuery: &releasesQuery{},
			mockedError: fmt.Errorf("Random error from GitHub API."),
			wantErr:     true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			require.NotNil(t, tt.mockedQuery)

			sut := Github{
				Spec: tt.spec,
				client: &MockGitHubClient{
					mockedQuery: tt.mockedQuery,
					mockedErr:   tt.mockedError,
				},
			}
			tt.releaseType.Init()

			got, err := sut.SearchReleases(tt.releaseType)

			if tt.wantErr {
				assert.Error(t, err)
				return
			}

			require.NoError(t, err)

			assert.Equal(t, tt.wantReleases, got)
		})
	}
}

---

Result of the test on the main branch (failing as expected because of the bug I described):

time="2022-11-19T14:26:45+01:00" level=error msg="\tRandom error from GitHub API."
--- FAIL: TestSearchReleases (0.00s)
    --- FAIL: TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_default_ReleaseType_filter (0.00s)
        /Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238: 
            	Error Trace:	/Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238
            	Error:      	Not equal: 
            	            	expected: []string{"v0.0.1", "v0.18.3"}
            	            	actual  : []string{"v0.0.1"}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -1,4 +1,3 @@
            	            	-([]string) (len=2) {
            	            	- (string) (len=6) "v0.0.1",
            	            	- (string) (len=7) "v0.18.3"
            	            	+([]string) (len=1) {
            	            	+ (string) (len=6) "v0.0.1"
            	            	 }
            	Test:       	TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_default_ReleaseType_filter
    --- FAIL: TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_a_ReleaseType_with_draft,_prerelease_and_releases (0.00s)
        /Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238: 
            	Error Trace:	/Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238
            	Error:      	Not equal: 
            	            	expected: []string{"v0.0.1", "v1.0.0", "v0.18.3", "v0.18.4"}
            	            	actual  : []string{"v0.0.1", "v1.0.0", "v0.18.4"}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -1,5 +1,4 @@
            	            	-([]string) (len=4) {
            	            	+([]string) (len=3) {
            	            	  (string) (len=6) "v0.0.1",
            	            	  (string) (len=6) "v1.0.0",
            	            	- (string) (len=7) "v0.18.3",
            	            	  (string) (len=7) "v0.18.4"
            	Test:       	TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_a_ReleaseType_with_draft,_prerelease_and_releases
    --- FAIL: TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_a_ReleaseType_with_'Latest' (0.00s)
        /Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238: 
            	Error Trace:	/Users/dadou/workspace/updatecli/updatecli/pkg/plugins/scms/github/release_test.go:238
            	Error:      	Not equal: 
            	            	expected: []string{"v0.18.3"}
            	            	actual  : []string{"v0.0.1", "v0.18.3"}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -1,2 +1,3 @@
            	            	-([]string) (len=1) {
            	            	+([]string) (len=2) {
            	            	+ (string) (len=6) "v0.0.1",
            	            	  (string) (len=7) "v0.18.3"
            	Test:       	TestSearchReleases/Case_with_a_mix_of_releases_(draft,_prerelease,_release)_and_a_ReleaseType_with_'Latest'
FAIL
FAIL	github.com/updatecli/updatecli/pkg/plugins/scms/github	0.289s
FAIL

---

Result on this PR (commit c964768)

ok  	github.com/updatecli/updatecli/pkg/plugins/scms/github	0.688s	coverage: 42.0% of statements

[olblak]

@dduportal Did you push the updated test somewhere ? Or should I copy paste the code from your example?

[dduportal]

@dduportal Did you push the updated test somewhere ? Or should I copy paste the code from your example?

I did not push anything: you have to copy and paste :)

[olblak]

@dduportal Thanks for your UT suggestion