findings: values should be exported consts owned by the probe

[spencerschrock]

All the places in our code that read values in a finding shouldn't need to redefine what the key is.

[AdamKorcz]

Could you write a short example for this?

[spencerschrock]

Could you write a short example for this?

This came up in the SAST/Maintained checks:
Both the probe

scorecard/probes/commitsInLast90Days/impl.go

Lines 62 to 64 in 6dd91c0

	f = f.WithValues(map[string]int{
	"commitsWithinThreshold": commitsWithinThreshold,
	})

And then consumer (evaluation code) need to remember "commitsWithinThreshold"

scorecard/checks/evaluation/maintained.go

Lines 65 to 75 in 6dd91c0

	for i := range findings {
	f := &findings[i]
	if f.Outcome == finding.OutcomePositive {
	switch f.Probe {
	case issueActivityByProjectMember.Probe:
	numberOfIssuesUpdatedWithinThreshold = f.Values["numberOfIssuesUpdatedWithinThreshold"]
	case commitsInLast90Days.Probe:
	commitsWithinThreshold = f.Values["commitsWithinThreshold"]
	}
	}
	}

Not to mention all the tests:

scorecard/checks/evaluation/maintained_test.go

Lines 37 to 39 in 6dd91c0

	Values: map[string]int{
	"commitsWithinThreshold": 2,
	},

So if the probe defined the values it can produce (if known) as a const, then it creates a single source of truth for the key value.

const (
    Probe = "commitsInLast90Days"
    // I'm not set on the name
    CommitsValue = "commitsWithinThreshold" 
)