Add test for getWorkingRelease

Tests help show the bounding behaviour when only one release is present. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
alexellis · Nov 1, 2019 · 6d9b47f · 6d9b47f
1 parent d3d9c1b
commit 6d9b47f
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 10 deletions.
diff --git a/handler/release_handler.go b/handler/release_handler.go
@@ -46,12 +46,14 @@ func (h *UpdatingReleaseHandler) Handle(req github.ReleaseEvent) error {
 
 func updateReleaseNotes(client *github.Client, owner, repo, latestTag string) error {
 
-	workingReleases, err := getWorkingReleases(client, owner, repo, latestTag)
-
+	listOptions := &github.ListOptions{}
+	releases, _, err := client.Repositories.ListReleases(context.Background(), owner, repo, listOptions)
 	if err != nil {
 		return err
 	}
 
+	workingReleases := getWorkingReleases(releases, owner, repo, latestTag)
+
 	opts := &github.PullRequestListOptions{
 		State:     "closed",
 		Base:      "master",
@@ -96,13 +98,8 @@ func updateReleaseNotes(client *github.Client, owner, repo, latestTag string) er
 	return err
 }
 
-func getWorkingReleases(client *github.Client, owner, repo, tag string) (WorkingRelease, error) {
+func getWorkingReleases(releases []*github.RepositoryRelease, owner, repo, tag string) WorkingRelease {
 	rel := WorkingRelease{}
-	listOptions := &github.ListOptions{}
-	releases, _, err := client.Repositories.ListReleases(context.Background(), owner, repo, listOptions)
-	if err != nil {
-		return WorkingRelease{}, err
-	}
 
 	var count int
 	var r *github.RepositoryRelease
@@ -113,7 +110,7 @@ func getWorkingReleases(client *github.Client, owner, repo, tag string) (Working
 			rel.CurrentTag = tag
 			rel.CurrentRelease = r
 
-			if count+1 <= len(releases) {
+			if count+1 < len(releases) {
 				prior := releases[count+1]
 				rel.PreviousDate = prior.CreatedAt.Time
 				rel.PreviousTag = prior.GetTagName()
@@ -123,7 +120,7 @@ func getWorkingReleases(client *github.Client, owner, repo, tag string) (Working
 		}
 	}
 
-	return rel, nil
+	return rel
 }
 
 func includePR(pr github.PullRequest, previous, current time.Time) bool {

diff --git a/handler/release_handler_test.go b/handler/release_handler_test.go
@@ -71,3 +71,85 @@ func Test_includePR_WithinCurrentRange_ButNotMerged(t *testing.T) {
 		t.Fail()
 	}
 }
+
+func Test_getWorkingReleases_TwoReleases(t *testing.T) {
+	owner := "alexellis"
+	repo := "derek"
+	tag := "0.2.0"
+	lastTag := "0.1.0"
+
+	releases := []*github.RepositoryRelease{
+		&github.RepositoryRelease{
+			TagName: &tag,
+			CreatedAt: &github.Timestamp{
+				Time: time.Now(),
+			},
+		},
+		&github.RepositoryRelease{
+			TagName: &lastTag,
+			CreatedAt: &github.Timestamp{
+				Time: time.Now().Add(time.Hour * -1),
+			},
+		},
+	}
+	workingReleases := getWorkingReleases(releases, owner, repo, tag)
+
+	gotCurrentDate := workingReleases.CurrentDate
+	wantCurrentDate := releases[0].GetCreatedAt().Time
+
+	if gotCurrentDate != wantCurrentDate {
+		t.Errorf("current date, got: %s, want: %s", gotCurrentDate, wantCurrentDate)
+	}
+
+	gotPreviousDate := workingReleases.PreviousDate
+	wantPreviousDate := releases[1].GetCreatedAt().Time
+
+	if gotPreviousDate != wantPreviousDate {
+		t.Errorf("previous date, got: %s, want: %s", gotPreviousDate, wantPreviousDate)
+	}
+
+	gotPreviousTag := workingReleases.PreviousTag
+	wantPreviousTag := *releases[1].TagName
+
+	if gotPreviousTag != wantPreviousTag {
+		t.Errorf("previous tag, got: %s, want: %s", gotPreviousTag, wantPreviousTag)
+	}
+}
+
+func Test_getWorkingReleases_OneRelease(t *testing.T) {
+	owner := "alexellis"
+	repo := "derek"
+	tag := "0.2.0"
+
+	releases := []*github.RepositoryRelease{
+		&github.RepositoryRelease{
+			TagName: &tag,
+			CreatedAt: &github.Timestamp{
+				Time: time.Now(),
+			},
+		},
+	}
+	workingReleases := getWorkingReleases(releases, owner, repo, tag)
+
+	gotCurrentDate := workingReleases.CurrentDate
+	wantCurrentDate := releases[0].GetCreatedAt().Time
+
+	if gotCurrentDate != wantCurrentDate {
+		t.Errorf("current date, got: %s, want: %s", gotCurrentDate, wantCurrentDate)
+	}
+
+	gotPreviousDate := workingReleases.PreviousDate
+	wantPreviousDate := time.Time{}
+
+	if gotPreviousDate != wantPreviousDate {
+		t.Errorf("previous date, got: %s, want: %s", gotPreviousDate, wantPreviousDate)
+	}
+
+	gotPreviousTag := workingReleases.PreviousTag
+	wantPreviousTag := ""
+
+	if gotPreviousTag != wantPreviousTag {
+		t.Errorf("previous tag, got: %s, want: %s", gotPreviousTag, wantPreviousTag)
+	}
+
+}