fix: re-factors code, adds unit tests for helpers

Author: schaermu

data/data.go

@@ -0,0 +1,14 @@
+package data
+
+import "github.com/google/go-github/v35/github"
+
+type GithubRepoInfo struct {
+	OrgName        string
+	RepositoryName string
+	Stars          int
+	License        string
+	LicenseId      string
+	Issues         []*github.Issue
+	CommitActivity []*github.WeeklyCommitActivity
+	Contributors   []*github.ContributorStats
+}

helpers/helpers.go

@@ -3,30 +3,23 @@ package helpers
 import (
 	"context"
 	"errors"
+	"fmt"
 	"net/http"
 	"regexp"
 	"sync"
 
 	"github.com/google/go-github/v35/github"
 	"github.com/schaermu/go-github-judge-bot/config"
+	"github.com/schaermu/go-github-judge-bot/data"
+	"github.com/schaermu/go-github-judge-bot/scoring"
+	"github.com/slack-go/slack"
 )
 
-type GithubRepoInfo struct {
-	OrgName        string
-	RepositoryName string
-	Stars          int
-	License        string
-	LicenseId      string
-	Issues         []*github.Issue
-	CommitActivity []*github.WeeklyCommitActivity
-	Contributors   []*github.ContributorStats
-}
-
 type GithubHelper struct {
 	Config config.GithubConfig
 }
 
-func (gh GithubHelper) GetRepositoryData(repoUrl string) (info GithubRepoInfo, err error) {
+func (gh GithubHelper) GetRepositoryData(repoUrl string) (info data.GithubRepoInfo, err error) {
 	tp := http.DefaultClient
 	if gh.Config.Username != "" && gh.Config.PersonalAccessToken != "" {
 		basicAuth := github.BasicAuthTransport{
@@ -49,7 +42,7 @@ func (gh GithubHelper) GetRepositoryData(repoUrl string) (info GithubRepoInfo, e
 		return
 	}
 
-	info = GithubRepoInfo{
+	info = data.GithubRepoInfo{
 		OrgName:        org,
 		RepositoryName: repo,
 		Stars:          repoInfo.GetStargazersCount(),
@@ -70,19 +63,19 @@ func (gh GithubHelper) GetRepositoryData(repoUrl string) (info GithubRepoInfo, e
 	return
 }
 
-func getContributorStats(info *GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
+func getContributorStats(info *data.GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
 	contributors, _, _ := client.Repositories.ListContributorsStats(context.Background(), info.OrgName, info.RepositoryName)
 	info.Contributors = contributors
 	waitgroup.Done()
 }
 
-func getCommitActivity(info *GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
+func getCommitActivity(info *data.GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
 	commitActivity, _, _ := client.Repositories.ListCommitActivity(context.Background(), info.OrgName, info.RepositoryName)
 	info.CommitActivity = commitActivity
 	waitgroup.Done()
 }
 
-func getRepoIssues(info *GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
+func getRepoIssues(info *data.GithubRepoInfo, client *github.Client, waitgroup *sync.WaitGroup) {
 	issues, _, _ := client.Issues.ListByRepo(context.Background(), info.OrgName, info.RepositoryName, &github.IssueListByRepoOptions{
 		Sort:  "updated",
 		State: "all",
@@ -99,3 +92,44 @@ func ExtractInfoFromUrl(repoUrl string) (org string, repo string, err error) {
 	}
 	return matches[1], matches[2], nil
 }
+
+func GetSlackMessageColorAndIcon(score float64, maxScore float64) (color string, icon string) {
+	if maxScore/100*score < .4 {
+		return "danger", ":exclamation:"
+	}
+	if maxScore/100*score < .8 {
+		return "warning", ":warning:"
+	}
+	return "good", ":+1::skin-tone-2:"
+}
+
+func BuildSlackResponse(org string, repository string, score float64, maxScore float64, penalties []scoring.ScoringPenalty) []slack.MsgOption {
+	messageColor, messageIcon := GetSlackMessageColorAndIcon(score, maxScore)
+
+	// build default message
+	res := []slack.MsgOption{
+		slack.MsgOptionIconEmoji(messageIcon),
+		slack.MsgOptionText(fmt.Sprintf("Analysis of `%s/%s` complete, final score is *%.2f/10.00* points!", org, repository, score), false),
+	}
+
+	// append penalty attachment containing details
+	if len(penalties) > 0 {
+		penaltyOutput := ""
+		for _, penalty := range penalties {
+			penaltyOutput += fmt.Sprintf("-*%.2f* _%s_\n", penalty.Amount, penalty.Reason)
+		}
+
+		attachment := slack.MsgOptionAttachments(
+			slack.Attachment{
+				Color:      messageColor,
+				MarkdownIn: []string{"text"},
+				Text:       penaltyOutput,
+				Pretext:    "The following reasons lead to penalties",
+			},
+		)
+
+		res = append(res, attachment)
+	}
+
+	return res
+}

helpers/helpers_test.go

@@ -3,6 +3,7 @@ package helpers
 import (
 	"testing"
 
+	"github.com/schaermu/go-github-judge-bot/scoring"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -35,3 +36,36 @@ func TestGetRepositoryData(t *testing.T) {
 	assert.Equal(t, "github-judge-bot", info.RepositoryName)
 	assert.GreaterOrEqual(t, 1, len(info.Contributors))
 }
+
+func TestGetSlackMessageColors(t *testing.T) {
+	color, icon := GetSlackMessageColorAndIcon(10, 10)
+	assert.Equal(t, "good", color)
+	assert.Equal(t, ":+1::skin-tone-2:", icon)
+}
+
+func TestGetSlackMessageColorsWarn(t *testing.T) {
+	color, icon := GetSlackMessageColorAndIcon(10, 7)
+	assert.Equal(t, "warning", color)
+	assert.Equal(t, ":warning:", icon)
+}
+func TestGetSlackMessageColorsDanger(t *testing.T) {
+	color, icon := GetSlackMessageColorAndIcon(10, 2)
+	assert.Equal(t, "danger", color)
+	assert.Equal(t, ":exclamation:", icon)
+}
+
+func TestBuildSlackResponse(t *testing.T) {
+	penalties := []scoring.ScoringPenalty{}
+
+	msgBlocks := BuildSlackResponse("foo", "bar", 10, 10, penalties)
+
+	assert.Len(t, msgBlocks, 2)
+}
+
+func TestBuildSlackResponsePenalties(t *testing.T) {
+	penalties := []scoring.ScoringPenalty{{Reason: "Test reason", Amount: 3}}
+
+	msgBlocks := BuildSlackResponse("foo", "bar", 7, 10, penalties)
+
+	assert.Len(t, msgBlocks, 3)
+}

main.go

@@ -78,8 +78,8 @@ func main() {
 								fmt.Printf("Error while fetching github info: %e", err)
 							}
 
-							score, penalties := scoring.GetTotalScore(info, cfg.Scorers)
-							msgBlocks := buildSlackResponse(info.OrgName, info.RepositoryName, score, penalties)
+							score, maxScore, penalties := scoring.GetTotalScore(info, cfg.Scorers)
+							msgBlocks := helpers.BuildSlackResponse(info.OrgName, info.RepositoryName, score, maxScore, penalties)
 							api.PostMessage(ev.Channel, msgBlocks...)
 						}
 					}
@@ -94,45 +94,3 @@ func main() {
 
 	client.Run()
 }
-
-func buildSlackResponse(org string, repository string, score float64, penalties []scoring.ScoringPenalty) []slack.MsgOption {
-	messageColor := "good"
-	messageIcon := ":+1::skin-tone-2:"
-
-	if score < 8 {
-		messageColor = "warning"
-		messageIcon = ":warning:"
-	}
-
-	if score < 4 {
-		messageColor = "danger"
-		messageIcon = ":exclamation:"
-	}
-
-	// build default message
-	res := []slack.MsgOption{
-		slack.MsgOptionIconEmoji(messageIcon),
-		slack.MsgOptionText(fmt.Sprintf("Analysis of `%s/%s` complete, final score is *%.2f/10.00* points!", org, repository, score), false),
-	}
-
-	// append penalty attachment containing details
-	if len(penalties) > 0 {
-		penaltyOutput := ""
-		for _, penalty := range penalties {
-			penaltyOutput += fmt.Sprintf("-*%.2f* _%s_\n", penalty.Amount, penalty.Reason)
-		}
-
-		attachment := slack.MsgOptionAttachments(
-			slack.Attachment{
-				Color:      messageColor,
-				MarkdownIn: []string{"text"},
-				Text:       penaltyOutput,
-				Pretext:    "The following reasons lead to penalties",
-			},
-		)
-
-		res = append(res, attachment)
-	}
-
-	return res
-}

scoring/commit_activity_scorer.go

@@ -5,11 +5,11 @@ import (
 	"math"
 
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 )
 
 type CommitActivityScorer struct {
-	data   helpers.GithubRepoInfo
+	data   data.GithubRepoInfo
 	config config.ScorerConfig
 }
 

scoring/commit_activity_scorer_test.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/google/go-github/v35/github"
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -29,7 +29,7 @@ func getTestCommitActivityData(inactiveWeekCount int) []*github.WeeklyCommitActi
 
 func getTestCommitActivityScorer(inactiveWeekCount int, penaltyPerWeek float64) CommitActivityScorer {
 	return CommitActivityScorer{
-		data: helpers.GithubRepoInfo{
+		data: data.GithubRepoInfo{
 			CommitActivity: getTestCommitActivityData(inactiveWeekCount),
 		},
 		config: config.ScorerConfig{

scoring/contributors_scorer.go

@@ -5,12 +5,12 @@ import (
 	"math"
 
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 )
 
 type ContributorsScorer struct {
 	Scorer
-	data   helpers.GithubRepoInfo
+	data   data.GithubRepoInfo
 	config config.ScorerConfig
 }
 

scoring/contributors_scorer_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/google/go-github/v35/github"
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -23,7 +23,7 @@ func getTestContributorData(contributorCount int) []*github.ContributorStats {
 
 func getTestContributorScorer(contributorCount int, minContributors int) ContributorsScorer {
 	return ContributorsScorer{
-		data: helpers.GithubRepoInfo{
+		data: data.GithubRepoInfo{
 			Contributors: getTestContributorData(contributorCount),
 		},
 		config: config.ScorerConfig{

scoring/issue_scorer_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/google/go-github/v35/github"
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -25,7 +25,7 @@ func getTestIssueData(closedOpenRatio float64, closedIssueCount int, openIssueCo
 
 func getTestIssueScorer(closedOpenRatio float64, closedIssueCount int, openIssueCount int) IssuesScorer {
 	return IssuesScorer{
-		data: helpers.GithubRepoInfo{
+		data: data.GithubRepoInfo{
 			Issues: getTestIssueData(closedOpenRatio, closedIssueCount, openIssueCount),
 		},
 		config: config.ScorerConfig{

scoring/issues_scorer.go

@@ -5,11 +5,11 @@ import (
 	"math"
 
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 )
 
 type IssuesScorer struct {
-	data   helpers.GithubRepoInfo
+	data   data.GithubRepoInfo
 	config config.ScorerConfig
 }
 

scoring/license_scorer.go

@@ -5,11 +5,11 @@ import (
 
 	"github.com/mitchellh/go-spdx"
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 )
 
 type LicenseScorer struct {
-	data   helpers.GithubRepoInfo
+	data   data.GithubRepoInfo
 	config config.ScorerConfig
 }
 

scoring/license_scorer_test.go

@@ -5,13 +5,13 @@ import (
 	"testing"
 
 	"github.com/schaermu/go-github-judge-bot/config"
-	"github.com/schaermu/go-github-judge-bot/helpers"
+	"github.com/schaermu/go-github-judge-bot/data"
 	"github.com/stretchr/testify/assert"
 )
 
 func getTestLicenseScorer(license string, validLicenses []string) LicenseScorer {
 	return LicenseScorer{
-		data: helpers.GithubRepoInfo{
+		data: data.GithubRepoInfo{
 			License:   license,
 			LicenseId: license,
 		},