rename probe

Signed-off-by: Adam Korczynski <[email protected]>
ossf · Dec 4, 2023 · d407833 · d407833
1 parent 6ed0073
commit d407833
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 27 deletions.
diff --git a/checks/evaluation/webhooks.go b/checks/evaluation/webhooks.go
@@ -20,15 +20,15 @@ import (
 	"github.com/ossf/scorecard/v4/checker"
 	sce "github.com/ossf/scorecard/v4/errors"
 	"github.com/ossf/scorecard/v4/finding"
-	"github.com/ossf/scorecard/v4/probes/webhooksWithoutSecret"
+	"github.com/ossf/scorecard/v4/probes/webhooksUseSecrets"
 )
 
 // Webhooks applies the score policy for the Webhooks check.
 func Webhooks(name string,
 	findings []finding.Finding, dl checker.DetailLogger,
 ) checker.CheckResult {
 	expectedProbes := []string{
-		webhooksWithoutSecret.Probe,
+		webhooksUseSecrets.Probe,
 	}
 
 	if !finding.UniqueProbesEqual(findings, expectedProbes) {

diff --git a/checks/evaluation/webhooks_test.go b/checks/evaluation/webhooks_test.go
@@ -34,7 +34,7 @@ func TestWebhooks(t *testing.T) {
 			name: "no webhooks",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNotApplicable,
 				},
 			},
@@ -46,7 +46,7 @@ func TestWebhooks(t *testing.T) {
 			name: "1 webhook with no secret",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 				},
 			},
@@ -58,7 +58,7 @@ func TestWebhooks(t *testing.T) {
 			name: "1 webhook with secret",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomePositive,
 					Values: map[string]int{
 						"totalWebhooks": 1,
@@ -73,7 +73,7 @@ func TestWebhooks(t *testing.T) {
 			name: "2 webhooks one of which has secret",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 2,
@@ -88,14 +88,14 @@ func TestWebhooks(t *testing.T) {
 			name: "Five webhooks three of which have secrets",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 5,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 5,
@@ -110,7 +110,7 @@ func TestWebhooks(t *testing.T) {
 			name: "One of 12 webhooks does not have secrets",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
@@ -125,84 +125,84 @@ func TestWebhooks(t *testing.T) {
 			name: "Score should not drop below min score",
 			findings: []finding.Finding{
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,
 					},
 				},
 				{
-					Probe:   "webhooksWithoutSecret",
+					Probe:   "webhooksUseSecrets",
 					Outcome: finding.OutcomeNegative,
 					Values: map[string]int{
 						"totalWebhooks": 12,

diff --git a/probes/entries.go b/probes/entries.go
@@ -52,7 +52,7 @@ import (
 	"github.com/ossf/scorecard/v4/probes/toolDependabotInstalled"
 	"github.com/ossf/scorecard/v4/probes/toolPyUpInstalled"
 	"github.com/ossf/scorecard/v4/probes/toolRenovateInstalled"
-	"github.com/ossf/scorecard/v4/probes/webhooksWithoutSecret"
+	"github.com/ossf/scorecard/v4/probes/webhooksUseSecrets"
 )
 
 // ProbeImpl is the implementation of a probe.
@@ -123,7 +123,7 @@ var (
 		hasOpenSSFBadge.Run,
 	}
 	Webhook = []ProbeImpl{
-		webhooksWithoutSecret.Run,
+		webhooksUseSecrets.Run,
 	}
 )
 

diff --git a/probes/webhooksWithoutSecret/def.yml → probes/webhooksUseSecrets/def.yml b/probes/webhooksWithoutSecret/def.yml → probes/webhooksUseSecrets/def.yml
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-id: webhooksWithoutSecret
+id: webhooksUseSecrets
 short: This check determines whether the webhooks defined in the repository have secrets configured to authenticate the origins of requests.
 motivation: >
   Webhooks without secret authorization have the potential to make projects accessible to third-parties.

diff --git a/probes/webhooksWithoutSecret/impl.go → probes/webhooksUseSecrets/impl.go b/probes/webhooksWithoutSecret/impl.go → probes/webhooksUseSecrets/impl.go
@@ -13,7 +13,7 @@
 // limitations under the License.
 
 //nolint:stylecheck
-package webhooksWithoutSecret
+package webhooksUseSecrets
 
 import (
 	"embed"
@@ -27,7 +27,7 @@ import (
 //go:embed *.yml
 var fs embed.FS
 
-const Probe = "webhooksWithoutSecret"
+const Probe = "webhooksUseSecrets"
 
 func Run(raw *checker.RawResults) ([]finding.Finding, string, error) {
 	if raw == nil {

diff --git a/probes/webhooksWithoutSecret/impl_test.go → probes/webhooksUseSecrets/impl_test.go b/probes/webhooksWithoutSecret/impl_test.go → probes/webhooksUseSecrets/impl_test.go
@@ -13,7 +13,7 @@
 // limitations under the License.
 
 //nolint:stylecheck
-package webhooksWithoutSecret
+package webhooksUseSecrets
 
 import (
 	"testing"