⚠️ Simplify RunScorecard with functional optionals

clients/githubrepo/branches.go

@@ -228,13 +228,13 @@ type branchesHandler struct {
 	once              *sync.Once
 	ctx               context.Context
 	errSetup          error
-	repourl           *repoURL
+	repourl           *Repo
 	defaultBranchRef  *clients.BranchRef
 	defaultBranchName string
 	ruleSets          []*repoRuleSet
 }
 
-func (handler *branchesHandler) init(ctx context.Context, repourl *repoURL) {
+func (handler *branchesHandler) init(ctx context.Context, repourl *Repo) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.errSetup = nil

clients/githubrepo/branches_e2e_test.go

@@ -36,7 +36,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should not have increased for HEAD query", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -51,7 +51,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should fail for non-HEAD query", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: "de5224bbc56eceb7a25aece55d2d53bbc561ed2d",
@@ -66,7 +66,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should return the correct default branch", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -83,7 +83,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should return a branch", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -98,7 +98,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should return an error for nonexistent branch", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -114,7 +114,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should return a branch", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -126,7 +126,7 @@ var _ = Describe("E2E TEST: githubrepo.branchesHandler", func() {
 		It("Should fail for non-HEAD query", func() {
 			skipIfTokenIsNot(patTokenType, "PAT only")
 
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: "de5224bbc56eceb7a25aece55d2d53bbc561ed2d",

clients/githubrepo/checkruns.go

@@ -71,7 +71,7 @@ type checkRunsByRef = map[string][]clients.CheckRun
 type checkrunsHandler struct {
 	client         *github.Client
 	graphClient    *githubv4.Client
-	repourl        *repoURL
+	repourl        *Repo
 	logger         *log.Logger
 	checkData      *checkRunsGraphqlData
 	setupOnce      *sync.Once
@@ -81,7 +81,7 @@ type checkrunsHandler struct {
 	errSetup       error
 }
 
-func (handler *checkrunsHandler) init(ctx context.Context, repourl *repoURL, commitDepth int) {
+func (handler *checkrunsHandler) init(ctx context.Context, repourl *Repo, commitDepth int) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.commitDepth = commitDepth

clients/githubrepo/checkruns_e2e_test.go

@@ -40,7 +40,7 @@ var _ = Describe("E2E TEST: githubrepo.checkrunsHandler", func() {
 
 	Context("E2E TEST: Validate query cost", func() {
 		It("Should not have increased query cost", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -54,7 +54,7 @@ var _ = Describe("E2E TEST: githubrepo.checkrunsHandler", func() {
 	})
 	Context("E2E TEST: listCheckRunsForRef", func() {
 		It("Should return check runs for a valid ref", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -75,7 +75,7 @@ var _ = Describe("E2E TEST: githubrepo.checkrunsHandler", func() {
 		})
 	})
 	It("Should return an error for an invalid ref", func() {
-		repourl := &repoURL{
+		repourl := &Repo{
 			owner:     "ossf",
 			repo:      "scorecard",
 			commitSHA: clients.HeadSHA,

clients/githubrepo/client.go

@@ -42,7 +42,7 @@ var (
 
 // Client is GitHub-specific implementation of RepoClient.
 type Client struct {
-	repourl       *repoURL
+	repourl       *Repo
 	repo          *github.Repository
 	repoClient    *github.Client
 	graphClient   *graphqlHandler
@@ -66,7 +66,7 @@ const defaultGhHost = "github.com"
 
 // InitRepo sets up the GitHub repo in local storage for improving performance and GitHub token usage efficiency.
 func (client *Client) InitRepo(inputRepo clients.Repo, commitSHA string, commitDepth int) error {
-	ghRepo, ok := inputRepo.(*repoURL)
+	ghRepo, ok := inputRepo.(*Repo)
 	if !ok {
 		return fmt.Errorf("%w: %v", errInputRepoType, inputRepo)
 	}
@@ -81,7 +81,7 @@ func (client *Client) InitRepo(inputRepo clients.Repo, commitSHA string, commitD
 	}
 	client.commitDepth = commitDepth
 	client.repo = repo
-	client.repourl = &repoURL{
+	client.repourl = &Repo{
 		owner:         repo.Owner.GetLogin(),
 		repo:          repo.GetName(),
 		defaultBranch: repo.GetDefaultBranch(),

clients/githubrepo/contributors.go

@@ -30,11 +30,11 @@ type contributorsHandler struct {
 	once         *sync.Once
 	ctx          context.Context
 	errSetup     error
-	repourl      *repoURL
+	repourl      *Repo
 	contributors []clients.User
 }
 
-func (handler *contributorsHandler) init(ctx context.Context, repourl *repoURL) {
+func (handler *contributorsHandler) init(ctx context.Context, repourl *Repo) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.errSetup = nil

clients/githubrepo/contributors_e2e_test.go

@@ -45,7 +45,7 @@ var _ = Describe("E2E TEST: githubrepo.contributorsHandler", func() {
 	Context("getContributors()", func() {
 		skipIfTokenIsNot(patTokenType, "PAT only")
 		It("returns contributors for valid HEAD query", func() {
-			repoURL := repoURL{
+			repoURL := Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,

clients/githubrepo/graphql.go

@@ -140,14 +140,14 @@ type graphqlHandler struct {
 	setupOnce   *sync.Once
 	ctx         context.Context
 	errSetup    error
-	repourl     *repoURL
+	repourl     *Repo
 	commits     []clients.Commit
 	issues      []clients.Issue
 	archived    bool
 	commitDepth int
 }
 
-func (handler *graphqlHandler) init(ctx context.Context, repourl *repoURL, commitDepth int) {
+func (handler *graphqlHandler) init(ctx context.Context, repourl *Repo, commitDepth int) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.data = new(graphqlData)

clients/githubrepo/graphql_e2e_test.go

@@ -38,7 +38,7 @@ var _ = Describe("E2E TEST: githubrepo.graphqlHandler", func() {
 
 	Context("E2E TEST: Confirm Paging Commits Works", func() {
 		It("Should only have 1 commit", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -71,7 +71,7 @@ var _ = Describe("E2E TEST: githubrepo.graphqlHandler", func() {
 			Expect(len(commits)).Should(BeEquivalentTo(1))
 		})
 		It("Should have 30 commits", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -104,7 +104,7 @@ var _ = Describe("E2E TEST: githubrepo.graphqlHandler", func() {
 			Expect(len(commits)).Should(BeEquivalentTo(30))
 		})
 		It("Should have 101 commits", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -140,7 +140,7 @@ var _ = Describe("E2E TEST: githubrepo.graphqlHandler", func() {
 
 	Context("E2E TEST: Validate query cost", func() {
 		It("Should not have increased for HEAD query", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,
@@ -152,7 +152,7 @@ var _ = Describe("E2E TEST: githubrepo.graphqlHandler", func() {
 			Expect(*graphqlhandler.data.RateLimit.Cost).Should(BeNumerically("<=", 1))
 		})
 		It("Should not have increased for commit query", func() {
-			repourl := &repoURL{
+			repourl := &Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: "de5224bbc56eceb7a25aece55d2d53bbc561ed2d",

clients/githubrepo/graphql_test.go

@@ -43,7 +43,7 @@ func Test_getCommits_retry(t *testing.T) {
 			Transport: rt,
 		}),
 	}
-	handler.init(context.Background(), &repoURL{}, 1)
+	handler.init(context.Background(), &Repo{}, 1)
 	_, err := handler.getCommits()
 	if err == nil {
 		t.Error("expected error")

clients/githubrepo/languages.go

@@ -30,11 +30,11 @@ type languagesHandler struct {
 	once      *sync.Once
 	ctx       context.Context
 	errSetup  error
-	repourl   *repoURL
+	repourl   *Repo
 	languages []clients.Language
 }
 
-func (handler *languagesHandler) init(ctx context.Context, repourl *repoURL) {
+func (handler *languagesHandler) init(ctx context.Context, repourl *Repo) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.errSetup = nil

clients/githubrepo/languages_e2e_test.go

@@ -41,7 +41,7 @@ var _ = Describe("E2E TEST: githubrepo.languagesHandler", func() {
 	})
 	Context("listProgrammingLanguages()", func() {
 		It("returns a list of programming languages for a valid repository", func() {
-			repoURL := repoURL{
+			repoURL := Repo{
 				owner: "ossf",
 				repo:  "scorecard",
 			}

clients/githubrepo/licenses.go

@@ -31,11 +31,11 @@ type licensesHandler struct {
 	once     *sync.Once
 	ctx      context.Context
 	errSetup error
-	repourl  *repoURL
+	repourl  *Repo
 	licenses []clients.License
 }
 
-func (handler *licensesHandler) init(ctx context.Context, repourl *repoURL) {
+func (handler *licensesHandler) init(ctx context.Context, repourl *Repo) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.errSetup = nil

clients/githubrepo/licenses_e2e_test.go

@@ -44,7 +44,7 @@ var _ = Describe("E2E TEST: githubrepo.licensesHandler", func() {
 	})
 	Context("listLicenses()", func() {
 		It("returns licenses", func() {
-			repoURL := repoURL{
+			repoURL := Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,

clients/githubrepo/releases.go

@@ -31,11 +31,11 @@ type releasesHandler struct {
 	once     *sync.Once
 	ctx      context.Context
 	errSetup error
-	repourl  *repoURL
+	repourl  *Repo
 	releases []clients.Release
 }
 
-func (handler *releasesHandler) init(ctx context.Context, repourl *repoURL) {
+func (handler *releasesHandler) init(ctx context.Context, repourl *Repo) {
 	handler.ctx = ctx
 	handler.repourl = repourl
 	handler.errSetup = nil

clients/githubrepo/releases_e2e_test.go

@@ -44,7 +44,7 @@ var _ = Describe("E2E TEST: githubrepo.releasesHandler", func() {
 	})
 	Context("getReleases()", func() {
 		It("returns releases", func() {
-			repoURL := repoURL{
+			repoURL := Repo{
 				owner:     "ossf",
 				repo:      "scorecard",
 				commitSHA: clients.HeadSHA,

clients/githubrepo/repo.go

@@ -24,14 +24,14 @@ import (
 	sce "github.com/ossf/scorecard/v5/errors"
 )
 
-type repoURL struct {
+type Repo struct {
 	host, owner, repo, defaultBranch, commitSHA string
 	metadata                                    []string
 }
 
 // Parses input string into repoURL struct.
 // Accepts "owner/repo" or "github.com/owner/repo".
-func (r *repoURL) parse(input string) error {
+func (r *Repo) parse(input string) error {
 	var t string
 
 	const two = 2
@@ -73,21 +73,21 @@ func (r *repoURL) parse(input string) error {
 }
 
 // URI implements Repo.URI().
-func (r *repoURL) URI() string {
+func (r *Repo) URI() string {
 	return fmt.Sprintf("%s/%s/%s", r.host, r.owner, r.repo)
 }
 
-func (r *repoURL) Host() string {
+func (r *Repo) Host() string {
 	return r.host
 }
 
 // String implements Repo.String.
-func (r *repoURL) String() string {
+func (r *Repo) String() string {
 	return fmt.Sprintf("%s-%s-%s", r.host, r.owner, r.repo)
 }
 
 // IsValid implements Repo.IsValid.
-func (r *repoURL) IsValid() error {
+func (r *Repo) IsValid() error {
 	githubHost := os.Getenv("GH_HOST")
 	switch r.host {
 	case "github.com":
@@ -103,16 +103,16 @@ func (r *repoURL) IsValid() error {
 	return nil
 }
 
-func (r *repoURL) AppendMetadata(metadata ...string) {
+func (r *Repo) AppendMetadata(metadata ...string) {
 	r.metadata = append(r.metadata, metadata...)
 }
 
 // Metadata implements Repo.Metadata.
-func (r *repoURL) Metadata() []string {
+func (r *Repo) Metadata() []string {
 	return r.metadata
 }
 
-func (r *repoURL) commitExpression() string {
+func (r *Repo) commitExpression() string {
 	if strings.EqualFold(r.commitSHA, clients.HeadSHA) {
 		// TODO(#575): Confirm that this works as expected.
 		return fmt.Sprintf("heads/%s", r.defaultBranch)
@@ -123,7 +123,7 @@ func (r *repoURL) commitExpression() string {
 // MakeGithubRepo takes input of form "owner/repo" or "github.com/owner/repo"
 // and returns an implementation of clients.Repo interface.
 func MakeGithubRepo(input string) (clients.Repo, error) {
-	var repo repoURL
+	var repo Repo
 	if err := repo.parse(input); err != nil {
 		return nil, fmt.Errorf("error during parse: %w", err)
 	}
@@ -134,6 +134,6 @@ func MakeGithubRepo(input string) (clients.Repo, error) {
 }
 
 // Path() implements RepoClient.Path.
-func (r *repoURL) Path() string {
+func (r *Repo) Path() string {
 	return fmt.Sprintf("%s/%s", r.owner, r.repo)
 }