feat: implement license and contributor scorers

Author: schaermu

config/config.go

@@ -21,21 +21,38 @@ type ScoringConfig struct {
 	Stars          StarsScoringConfig   `mapstructure:"stars"`
 	Issues         IssuesScoringConfig  `mapstructure:"issues"`
 	CommitActivity CommitActivityConfig `mapstructure:"activity"`
+	Contributors   ContributorsConfig   `mapstructure:"contributors"`
+	License        LicenseConfig        `mapstructure:"license"`
 }
 
 type StarsScoringConfig struct {
-	MinStars   int     `mapstructure:"min_stars"`
 	MaxPenalty float64 `mapstructure:"max_penalty"`
+	Enabled    bool    `mapstructure:"enabled"`
+	MinStars   int     `mapstructure:"min_stars"`
 }
 
 type IssuesScoringConfig struct {
-	OpenClosedRatio float64 `mapstructure:"open_closed_ratio"`
 	MaxPenalty      float64 `mapstructure:"max_penalty"`
+	Enabled         bool    `mapstructure:"enabled"`
+	OpenClosedRatio float64 `mapstructure:"open_closed_ratio"`
 }
 
 type CommitActivityConfig struct {
-	WeeklyInactivityPenalty float64 `mapstructure:"weekly_penalty"`
 	MaxPenalty              float64 `mapstructure:"max_penalty"`
+	Enabled                 bool    `mapstructure:"enabled"`
+	WeeklyInactivityPenalty float64 `mapstructure:"weekly_penalty"`
+}
+
+type ContributorsConfig struct {
+	MaxPenalty      float64 `mapstructure:"max_penalty"`
+	Enabled         bool    `mapstructure:"enabled"`
+	MinContributors int     `mapstructure:"min_contributors"`
+}
+
+type LicenseConfig struct {
+	MaxPenalty      float64  `mapstructure:"max_penalty"`
+	Enabled         bool     `mapstructure:"enabled"`
+	ValidLicenseIds []string `mapstructure:"valid_license_ids"`
 }
 
 type Config struct {

go.mod

@@ -4,6 +4,7 @@ go 1.16
 
 require (
 	github.com/google/go-github/v35 v35.2.0
+	github.com/mitchellh/go-spdx v0.1.0 // indirect
 	github.com/slack-go/slack v0.9.1
 	github.com/spf13/viper v1.7.1
 )

go.sum

@@ -81,6 +81,8 @@ github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t
 github.com/hashicorp/consul/api v1.1.0/go.mod h1:VmuI/Lkw1nC05EYQWNKwWGbkg+FbDBtguAZLlVdkD9Q=
 github.com/hashicorp/consul/sdk v0.1.1/go.mod h1:VKf9jXwCTEY1QZP2MOLRhb5i/I/ssyNV1vwHyQBF0x8=
 github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
+github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
+github.com/hashicorp/go-cleanhttp v0.5.1 h1:dH3aiDG9Jvb5r5+bYHsikaOUIpcM0xvgMXVoDkXMzJM=
 github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
 github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60=
 github.com/hashicorp/go-msgpack v0.5.3/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM=
@@ -122,6 +124,8 @@ github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5
 github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=
 github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc=
 github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/mitchellh/go-spdx v0.1.0 h1:50JnVzkL3kWreQ5Qb4Pi3Qx9e+bbYrt8QglJDpfeBEs=
+github.com/mitchellh/go-spdx v0.1.0/go.mod h1:FFi4Cg1fBuN/JCtPtP8PEDmcBjvO3gijQVl28YjIBVQ=
 github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI=
 github.com/mitchellh/gox v0.4.0/go.mod h1:Sd9lOJ0+aimLBi73mGofS1ycjY8lL3uZM3JPS42BGNg=
 github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0QubkSMEySY=

helpers/helpers.go

@@ -14,8 +14,11 @@ 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 {
@@ -43,21 +46,30 @@ func (gh GithubHelper) GetRepositoryData(repoUrl string) (info GithubRepoInfo, e
 	info = GithubRepoInfo{
 		OrgName:        org,
 		RepositoryName: repo,
-		Stars:          *repoInfo.StargazersCount,
+		Stars:          repoInfo.GetStargazersCount(),
+		License:        repoInfo.GetLicense().GetName(),
+		LicenseId:      repoInfo.GetLicense().GetSPDXID(),
 	}
 
 	var waitgroup sync.WaitGroup
-	waitgroup.Add(2)
+	waitgroup.Add(3)
 
 	// fetch additional data
 	go getRepoIssues(&info, client, &waitgroup)
 	go getCommitActivity(&info, client, &waitgroup)
+	go getContributorStats(&info, client, &waitgroup)
 
 	waitgroup.Wait()
 
 	return
 }
 
+func getContributorStats(info *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) {
 	commitActivity, _, _ := client.Repositories.ListCommitActivity(context.Background(), info.OrgName, info.RepositoryName)
 	info.CommitActivity = commitActivity

scoring/contributor_scorer.go

@@ -0,0 +1,33 @@
+package scoring
+
+import (
+	"fmt"
+
+	"github.com/schaermu/go-github-judge-bot/config"
+	"github.com/schaermu/go-github-judge-bot/helpers"
+)
+
+type ContributorScorer struct {
+	data   helpers.GithubRepoInfo
+	config config.ContributorsConfig
+}
+
+func (s ContributorScorer) GetScore(currentScore float64, penalties []ScoringPenalty) (float64, []ScoringPenalty) {
+	// we calculate the percentage of contributors vs. required contributors and apply that percentage as a penalty
+	percentage := 100 / float64(s.config.MinContributors) * float64(len(s.data.Contributors))
+	scoreChange := 0.0
+	if percentage < 100 {
+		scoreChange = percentage * (s.config.MaxPenalty / 100)
+	}
+
+	if scoreChange > 0 {
+		currentScore -= scoreChange
+
+		penalties = append(penalties, ScoringPenalty{
+			Reason: fmt.Sprintf("There are only *%d/%d* required contributors", len(s.data.Contributors), s.config.MinContributors),
+			Amount: scoreChange,
+		})
+	}
+
+	return currentScore, penalties
+}

scoring/license_scorer.go

@@ -0,0 +1,47 @@
+package scoring
+
+import (
+	"fmt"
+
+	"github.com/mitchellh/go-spdx"
+	"github.com/schaermu/go-github-judge-bot/config"
+	"github.com/schaermu/go-github-judge-bot/helpers"
+)
+
+type LicenseScorer struct {
+	data   helpers.GithubRepoInfo
+	config config.LicenseConfig
+}
+
+func (s LicenseScorer) GetScore(currentScore float64, penalties []ScoringPenalty) (float64, []ScoringPenalty) {
+	// the license of the project is either checked against a whitelist or against all osi approved licenses from spdx
+	scoreChange := 0.0
+	if len(s.config.ValidLicenseIds) == 0 {
+		// TODO: cache this list
+		list, _ := spdx.List()
+		for _, spdxLic := range list.Licenses {
+			if spdxLic.OSIApproved && !spdxLic.Deprecated {
+				s.config.ValidLicenseIds = append(s.config.ValidLicenseIds, spdxLic.ID)
+			}
+		}
+	}
+
+	scoreChange = s.config.MaxPenalty
+	for _, id := range s.config.ValidLicenseIds {
+		if id == s.data.LicenseId {
+			scoreChange = s.config.MaxPenalty
+			break
+		}
+	}
+
+	if scoreChange > 0 {
+		currentScore -= scoreChange
+
+		penalties = append(penalties, ScoringPenalty{
+			Reason: fmt.Sprintf("No valid license found: %s", s.data.License),
+			Amount: scoreChange,
+		})
+	}
+
+	return currentScore, penalties
+}

scoring/scoring.go

@@ -28,5 +28,11 @@ func GetTotalScore(data helpers.GithubRepoInfo, scoreConfig config.ScoringConfig
 	commitActivity := CommitActivityScorer{data: data, config: scoreConfig.CommitActivity}
 	score, penalties = commitActivity.GetScore(score, penalties)
 
+	contributors := ContributorScorer{data: data, config: scoreConfig.Contributors}
+	score, penalties = contributors.GetScore(score, penalties)
+
+	license := LicenseScorer{data: data, config: scoreConfig.License}
+	score, penalties = license.GetScore(score, penalties)
+
 	return score, penalties
 }