Move build vcs code into a package so it can be reused. (#500)

Signed-off-by: Caleb Brown <[email protected]>

cmd/collect_signals/main.go

@@ -29,6 +29,7 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 
+	"github.com/ossf/criticality_score/cmd/collect_signals/vcs"
 	"github.com/ossf/criticality_score/internal/collector"
 	log "github.com/ossf/criticality_score/internal/log"
 )
@@ -93,7 +94,7 @@ func main() {
 	defer logger.Sync()
 
 	// Embed the commitID with all log messages.
-	if commitID != "" {
+	if commitID := vcs.CommitID(); commitID != vcs.MissingCommitID {
 		logger = logger.With(zap.String("commit_id", commitID))
 	}
 

cmd/collect_signals/vcs.go → cmd/collect_signals/vcs/vcs.go

@@ -12,22 +12,23 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package vcs
 
 import (
 	"runtime/debug"
 )
 
-const commitIDKey = "vcs.revision"
+const (
+	MissingCommitID = "-missing-"
+	commitIDKey     = "vcs.revision"
+)
 
-var commitID = getCommitID()
+var commitID string
 
-// getCommitID returns the vcs commit ID embedded in the binary when the
-// -buildvcs flag is set while building.
-func getCommitID() string {
+func fetchCommitID() string {
 	info, ok := debug.ReadBuildInfo()
 	if !ok {
-		return ""
+		return MissingCommitID
 	}
 
 	for _, setting := range info.Settings {
@@ -36,5 +37,14 @@ func getCommitID() string {
 		}
 	}
 
-	return ""
+	return MissingCommitID
+}
+
+// CommitID returns the vcs commit ID embedded in the binary when the
+// -buildvcs flag is set while building.
+func CommitID() string {
+	if commitID == "" {
+		commitID = fetchCommitID()
+	}
+	return commitID
 }

cmd/collect_signals/worker.go

@@ -16,6 +16,7 @@ import (
 	"go.opencensus.io/stats/view"
 	"go.uber.org/zap"
 
+	"github.com/ossf/criticality_score/cmd/collect_signals/vcs"
 	"github.com/ossf/criticality_score/internal/collector"
 	"github.com/ossf/criticality_score/internal/scorer"
 	"github.com/ossf/criticality_score/internal/signalio"
@@ -55,7 +56,7 @@ func (w *collectWorker) Process(ctx context.Context, req *data.ScorecardBatchReq
 		extras = append(extras, w.scoreColumnName)
 	}
 	extras = append(extras, collectionDateColumnName)
-	if commitID != "" {
+	if commitID := vcs.CommitID(); commitID != vcs.MissingCommitID {
 		extras = append(extras, commitIDColumnName)
 	}
 
@@ -111,7 +112,7 @@ func (w *collectWorker) Process(ctx context.Context, req *data.ScorecardBatchReq
 
 		// Ensure the commit ID is included with each record for helping
 		// identify which Git commit is associated with this record.
-		if commitID != "" {
+		if commitID := vcs.CommitID(); commitID != vcs.MissingCommitID {
 			extras = append(extras, signalio.Field{
 				Key:   commitIDColumnName,
 				Value: commitID,