🐛 Address friction logs' comments (#899)

* fixes

* fix

* fix

* fixes

* doc

* missing file

* fixes

* comments

* typo

checks/automatic_dependency_update.go → checks/dependency_update_tool.go

@@ -25,11 +25,11 @@ const CheckDependencyUpdateTool = "Dependency-Update-Tool"
 
 //nolint
 func init() {
-	registerCheck(CheckDependencyUpdateTool, AutomaticDependencyUpdate)
+	registerCheck(CheckDependencyUpdateTool, UsesDependencyUpdateTool)
 }
 
-// AutomaticDependencyUpdate will check the repository if it contains Automatic dependency update.
-func AutomaticDependencyUpdate(c *checker.CheckRequest) checker.CheckResult {
+// UsesDependencyUpdateTool will check the repository uses a dependency update tool.
+func UsesDependencyUpdateTool(c *checker.CheckRequest) checker.CheckResult {
 	var r bool
 	err := CheckIfFileExists(CheckDependencyUpdateTool, c, fileExists, &r)
 	if err != nil {

checks/active.go → checks/maintained.go

@@ -23,37 +23,37 @@ import (
 )
 
 const (
-	// CheckActive is the exported check name for Active.
-	CheckActive    = "Active"
-	lookBackDays   = 90
-	commitsPerWeek = 1
-	daysInOneWeek  = 7
+	// CheckMaintained is the exported check name for Maintained.
+	CheckMaintained = "Maintained"
+	lookBackDays    = 90
+	commitsPerWeek  = 1
+	daysInOneWeek   = 7
 )
 
 //nolint:gochecknoinits
 func init() {
-	registerCheck(CheckActive, IsActive)
+	registerCheck(CheckMaintained, IsMaintained)
 }
 
-// IsActive runs Active check.
-func IsActive(c *checker.CheckRequest) checker.CheckResult {
+// IsMaintained runs Maintained check.
+func IsMaintained(c *checker.CheckRequest) checker.CheckResult {
 	archived, err := c.RepoClient.IsArchived()
 	if err != nil {
-		return checker.CreateRuntimeErrorResult(CheckActive, err)
+		return checker.CreateRuntimeErrorResult(CheckMaintained, err)
 	}
 	if archived {
-		return checker.CreateMinScoreResult(CheckActive, "repo is marked as archived")
+		return checker.CreateMinScoreResult(CheckMaintained, "repo is marked as archived")
 	}
 
 	commits, err := c.RepoClient.ListCommits()
 	if err != nil {
-		return checker.CreateRuntimeErrorResult(CheckActive, err)
+		return checker.CreateRuntimeErrorResult(CheckMaintained, err)
 	}
 
 	tz, err := time.LoadLocation("UTC")
 	if err != nil {
 		e := sce.Create(sce.ErrScorecardInternal, fmt.Sprintf("time.LoadLocation: %v", err))
-		return checker.CreateRuntimeErrorResult(CheckActive, e)
+		return checker.CreateRuntimeErrorResult(CheckMaintained, e)
 	}
 	threshold := time.Now().In(tz).AddDate(0, 0, -1*lookBackDays)
 	totalCommits := 0
@@ -62,7 +62,7 @@ func IsActive(c *checker.CheckRequest) checker.CheckResult {
 			totalCommits++
 		}
 	}
-	return checker.CreateProportionalScoreResult(CheckActive,
+	return checker.CreateProportionalScoreResult(CheckMaintained,
 		fmt.Sprintf("%d commit(s) found in the last %d days", totalCommits, lookBackDays),
 		totalCommits, commitsPerWeek*lookBackDays/daysInOneWeek)
 }

checks/write.md

@@ -1,3 +1,27 @@
+# Requirements for a check
+
+If you'd like to add a check, make sure it is something that meets the following
+criteria and then create a new GitHub Issue to discuss with the team:
+
+-   The scorecard must only be composed of automate-able, objective data. For
+    example, a project having 10 contributors doesn’t necessarily mean it’s more
+    secure than a project with say 50 contributors. But, having two maintainers
+    might be preferable to only having one - the larger bus factor and ability
+    to provide code reviews is objectively better.
+-   The scorecard criteria can be as specific as possible and not limited
+    general recommendations. For example, for Go, we can recommend/require
+    specific linters and analyzers to be run on the codebase.
+-   The scorecard can be populated for any open source project without any work
+    or interaction from maintainers.
+-   Maintainers must be provided with a mechanism to correct any automated
+    scorecard findings they feel were made in error, provide "hints" for
+    anything we can't detect automatically, and even dispute the applicability
+    of a given scorecard finding for that repository.
+-   Any criteria in the scorecard must be actionable. It should be possible,
+    with help, for any project to "check all the boxes".
+-   Any solution to compile a scorecard should be usable by the greater open
+    source community to monitor upstream security.
+
 # How to write a check
 
 The steps to writting a check are as follow:
@@ -25,6 +49,8 @@ The steps to writting a check are as follow:
     *   Use `checker.DetailLogger.Debug()` to provide detail in verbose mode:
         this is showed only when the user supplies the `--verbosity Debug`
         option.
+    *   If your message relates to a file, try to provide information such as
+        the `Path`, line number `Offset` and `Snippet`.
 
 4.  If the checks fails in a way that is irrecoverable, return a result with
     `checker.CreateRuntimeErrorResult()` function: For example, if an error is

docs/checks.md

@@ -13,7 +13,7 @@ please contribute!
 
 This check tries to determine if the project is "actively maintained".
 A project which is not active may not be patched, may not have its dependencies patched, or may not be actively tested and used. A low score is therefore considered `High` risk.
-The check currently works by looking for commits within the last 90 days, and outputs the highest score if there are at least 1 commit/week during this period. 
+The check currently works by looking whether the repo is archived or not. If it is archived, it returns the minimum score. If it is not, the check looks for commits within the last 90 days, and outputs the highest score if there are at least 1 commit/week during this period. 
 
 **Remediation steps**
 - There is *NO* remediation work needed here. This is just to indicate your project activity and maintenance commitment.

docs/checks/checks.yaml

@@ -15,7 +15,7 @@
 # This is the source of truth for all check descriptions and remediation steps.
 # Run `cd checks/main && go run /main` to generate `checks.json` and `checks.md`.
 checks:
-  Active:
+  Maintained:
     risk: High
     tags: supply-chain, security
     short: Determines if the project is "actively maintained".
@@ -26,7 +26,9 @@ checks:
       dependencies patched, or may not be actively tested and used.
       A low score is therefore considered `High` risk.
 
-      The check currently works by looking for commits within the last 90 days, and
+      The check currently works by looking whether the repo is archived or not.
+      If it is archived, it returns the minimum score. If it is not,
+      the check looks for commits within the last 90 days, and
       outputs the highest score if there are at least 1 commit/week during this period.
     remediation:
       - >-

e2e/automatic_deps_test.go → e2e/dependency_update_tool_test.go

@@ -29,9 +29,9 @@ import (
 
 // TODO: use dedicated repo that don't change.
 // TODO: need negative results.
-var _ = Describe("E2E TEST:Automatic-Dependency-Update", func() {
-	Context("E2E TEST:Validating dependencies are automatically updated", func() {
-		It("Should return deps are automatically updated for dependabot", func() {
+var _ = Describe("E2E TEST:"+checks.CheckDependencyUpdateTool, func() {
+	Context("E2E TEST:Validating dependencies are updated with a tool", func() {
+		It("Should return repo uses dependabot", func() {
 			dl := scut.TestDetailLogger{}
 			repoClient := githubrepo.CreateGithubRepoClient(context.Background(), ghClient, graphClient)
 			err := repoClient.InitRepo("ossf", "scorecard")
@@ -54,15 +54,15 @@ var _ = Describe("E2E TEST:Automatic-Dependency-Update", func() {
 				NumberOfDebug: 0,
 			}
 
-			result := checks.AutomaticDependencyUpdate(&req)
+			result := checks.UsesDependencyUpdateTool(&req)
 			// UPGRADEv2: to remove.
 			// Old version.
 			Expect(result.Error).Should(BeNil())
 			Expect(result.Pass).Should(BeTrue())
 			// New version.
 			Expect(scut.ValidateTestReturn(nil, "dependabot", &expected, &result, &dl)).Should(BeTrue())
 		})
-		It("Should return deps are automatically updated for renovatebot", func() {
+		It("Should return repo uses renovatebot", func() {
 			dl := scut.TestDetailLogger{}
 			repoClient := githubrepo.CreateGithubRepoClient(context.Background(), ghClient, graphClient)
 			err := repoClient.InitRepo("netlify", "netlify-cms")
@@ -84,7 +84,7 @@ var _ = Describe("E2E TEST:Automatic-Dependency-Update", func() {
 				NumberOfInfo:  1,
 				NumberOfDebug: 0,
 			}
-			result := checks.AutomaticDependencyUpdate(&req)
+			result := checks.UsesDependencyUpdateTool(&req)
 			// UPGRADEv2: to remove.
 			// Old version.
 			Expect(result.Error).Should(BeNil())

e2e/executable_test.go

@@ -52,7 +52,9 @@ var _ = Describe("E2E TEST:executable", func() {
 
 			for _, c := range data.Checks {
 				switch c.CheckName {
-				case checks.CheckActive:
+				case checks.CheckMaintained:
+					Expect(c.Pass).Should(BeTrue(), c.CheckName)
+				case checks.CheckDependencyUpdateTool:
 					Expect(c.Pass).Should(BeTrue(), c.CheckName)
 				case checks.CheckBranchProtection:
 					Expect(c.Pass).Should(BeTrue(), c.CheckName)

e2e/active_test.go → e2e/maintained_test.go

@@ -27,9 +27,9 @@ import (
 	scut "github.com/ossf/scorecard/v2/utests"
 )
 
-var _ = Describe("E2E TEST:Active", func() {
-	Context("E2E TEST:Validating active status", func() {
-		It("Should return valid active status", func() {
+var _ = Describe("E2E TEST:"+checks.CheckMaintained, func() {
+	Context("E2E TEST:Validating maintained status", func() {
+		It("Should return valid maintained status", func() {
 			dl := scut.TestDetailLogger{}
 			repoClient := githubrepo.CreateGithubRepoClient(context.Background(), ghClient, graphClient)
 			err := repoClient.InitRepo("apache", "airflow")
@@ -51,7 +51,7 @@ var _ = Describe("E2E TEST:Active", func() {
 				NumberOfInfo:  0,
 				NumberOfDebug: 0,
 			}
-			result := checks.IsActive(&req)
+			result := checks.IsMaintained(&req)
 			// UPGRADEv2: to remove.
 			// Old version.
 			Expect(result.Error).Should(BeNil())

pkg/scorecard_result.go

@@ -87,12 +87,12 @@ func (r *ScorecardResult) AsString(showDetails bool, logLevel zapcore.Level, wri
 		if row.Score == checker.InconclusiveResultScore {
 			x[0] = "?"
 		} else {
-			x[0] = fmt.Sprintf("%d", row.Score)
+			x[0] = fmt.Sprintf("%d / %d", row.Score, checker.MaxResultScore)
 		}
 
 		doc := fmt.Sprintf("github.com/ossf/scorecard/blob/main/docs/checks.md#%s", strings.ToLower(row.Name))
-		x[1] = row.Reason
-		x[2] = row.Name
+		x[1] = row.Name
+		x[2] = row.Reason
 		if showDetails {
 			details, show := detailsToString(row.Details2, logLevel)
 			if show {
@@ -107,7 +107,7 @@ func (r *ScorecardResult) AsString(showDetails bool, logLevel zapcore.Level, wri
 	}
 
 	table := tablewriter.NewWriter(os.Stdout)
-	header := []string{"Score", "Reason", "Name"}
+	header := []string{"Score", "Name", "Reason"}
 	if showDetails {
 		header = append(header, "Details")
 	}