Merge pull request #77 from adavila0703/date-within-duration

add WithinDuration to date package and use in tests in matchedBy's

Author: dillonstreator

internal/github/contributions_test.go

@@ -1,6 +1,7 @@
 package github
 
 import (
+	"bot/pkg/date"
 	"context"
 	"testing"
 	"time"
@@ -191,9 +192,9 @@ func TestGithubService_GetContributionsByUsername__DatesZeroValue(t *testing.T)
 		ctx,
 		mock.AnythingOfType("*github.contributionsQuery"),
 		mock.MatchedBy(func(params map[string]interface{}) bool {
-			assert.WithinDuration(time.Now(), params["to"].(githubv4.DateTime).Time, time.Millisecond)
-			assert.WithinDuration(time.Now().AddDate(-1, 0, 0), params["from"].(githubv4.DateTime).Time, time.Millisecond)
-			return githubv4.String(options.Username) == params["username"]
+			return githubv4.String(options.Username) == params["username"] &&
+				date.WithinDuration(time.Now(), params["to"].(githubv4.DateTime).Time, time.Millisecond) &&
+				date.WithinDuration(time.Now().AddDate(-1, 0, 0), params["from"].(githubv4.DateTime).Time, time.Millisecond)
 		}),
 	).Return(nil).Run(func(args mock.Arguments) {
 		a := args.Get(1).(*contributionsQuery)
@@ -378,9 +379,9 @@ func TestGithubService_GetLongestContributionStreakByUsername(t *testing.T) {
 		ctx,
 		mock.AnythingOfType("*github.contributionsQuery"),
 		mock.MatchedBy(func(params map[string]interface{}) bool {
-			assert.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond)
-			assert.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
-			return githubv4.String(username) == params["username"]
+			return githubv4.String(username) == params["username"] &&
+				date.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond) &&
+				date.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
 		}),
 	).Return(nil).Run(func(args mock.Arguments) {
 		a := args.Get(1).(*contributionsQuery)
@@ -471,9 +472,9 @@ func TestGithubService_GetLongestContributionStreakByUsername__NoEndDateCurrentS
 		ctx,
 		mock.AnythingOfType("*github.contributionsQuery"),
 		mock.MatchedBy(func(params map[string]interface{}) bool {
-			assert.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond)
-			assert.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
-			return githubv4.String(username) == params["username"]
+			return githubv4.String(username) == params["username"] &&
+				date.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond) &&
+				date.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
 		}),
 	).Return(nil).Run(func(args mock.Arguments) {
 		a := args.Get(1).(*contributionsQuery)
@@ -554,9 +555,9 @@ func TestGithubService_GetLongestContributionStreakByUsername__NoContributionDay
 		ctx,
 		mock.AnythingOfType("*github.contributionsQuery"),
 		mock.MatchedBy(func(params map[string]interface{}) bool {
-			assert.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond)
-			assert.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
-			return githubv4.String(username) == params["username"]
+			return githubv4.String(username) == params["username"] &&
+				date.WithinDuration(from, params["from"].(githubv4.DateTime).Time, time.Millisecond) &&
+				date.WithinDuration(year, params["to"].(githubv4.DateTime).Time, time.Millisecond)
 		}),
 	).Return(nil).Run(func(args mock.Arguments) {
 		a := args.Get(1).(*contributionsQuery)
@@ -621,9 +622,9 @@ func TestGithubService_GetTotalContributionsByUsername(t *testing.T) {
 		ctx,
 		mock.AnythingOfType("*github.contributionsQuery"),
 		mock.MatchedBy(func(params map[string]interface{}) bool {
-			assert.WithinDuration(year, params["from"].(githubv4.DateTime).Time, time.Millisecond)
-			assert.WithinDuration(time.Now(), params["to"].(githubv4.DateTime).Time, time.Millisecond)
-			return githubv4.String(username) == params["username"]
+			return githubv4.String(username) == params["username"] &&
+				date.WithinDuration(year, params["from"].(githubv4.DateTime).Time, time.Millisecond) &&
+				date.WithinDuration(time.Now(), params["to"].(githubv4.DateTime).Time, time.Millisecond)
 		}),
 	).Return(nil).Run(func(args mock.Arguments) {
 		a := args.Get(1).(*contributionsQuery)

pkg/date/date.go

@@ -23,3 +23,10 @@ func SOY(t time.Time, loc *time.Location) time.Time {
 func EOY(t time.Time, loc *time.Location) time.Time {
 	return time.Date(t.Year(), 12, 31, 59, 59, 0, 0, loc)
 }
+
+// WithinDuration test to see if two time.Time's are within a duration of eachother
+func WithinDuration(expected, actual time.Time, delta time.Duration) bool {
+	dt := expected.Sub(actual)
+
+	return dt > -delta && dt < delta
+}

pkg/date/date_test.go

@@ -0,0 +1,63 @@
+package date
+
+import (
+	"testing"
+	"time"
+)
+
+func TestWithinDuration(t *testing.T) {
+	type args struct {
+		expected time.Time
+		actual   time.Time
+		delta    time.Duration
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{
+			name: "is within duration",
+			args: args{
+				expected: time.Date(2021, 12, 21, 0, 0, 0, 0, time.UTC),
+				actual:   time.Date(2021, 12, 21, 0, 0, 1, 0, time.UTC),
+				delta:    time.Millisecond * 1500,
+			},
+			want: true,
+		},
+		{
+			name: "not within duration",
+			args: args{
+				expected: time.Date(2021, 12, 21, 0, 0, 0, 0, time.UTC),
+				actual:   time.Date(2021, 12, 21, 0, 0, 1, 0, time.UTC),
+				delta:    time.Millisecond * 900,
+			},
+			want: false,
+		},
+		{
+			name: "not inclusive start",
+			args: args{
+				expected: time.Date(2021, 12, 21, 0, 0, 0, 0, time.UTC),
+				actual:   time.Date(2021, 12, 21, 0, 0, 1, 0, time.UTC),
+				delta:    time.Second,
+			},
+			want: false,
+		},
+		{
+			name: "not inclusive end",
+			args: args{
+				expected: time.Date(2021, 12, 21, 0, 0, 1, 0, time.UTC),
+				actual:   time.Date(2021, 12, 21, 0, 0, 0, 0, time.UTC),
+				delta:    time.Second,
+			},
+			want: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := WithinDuration(tt.args.expected, tt.args.actual, tt.args.delta); got != tt.want {
+				t.Errorf("WithinDuration() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}