Add in logs if the config is incorrect

Author: Priya Wadhwa

pkg/chains/signing.go

@@ -132,13 +132,13 @@ func allFormatters(cfg config.Config, l *zap.SugaredLogger) map[formats.PayloadT
 		case formats.PayloadTypeSimpleSigning:
 			formatter, err := simple.NewFormatter()
 			if err != nil {
-				l.Warnf("error configuring tekton formatter: %s", err)
+				l.Warnf("error configuring simplesigning formatter: %s", err)
 			}
 			all[f] = formatter
 		case formats.PayloadTypeInTotoIte6:
 			formatter, err := intotoite6.NewFormatter(cfg)
 			if err != nil {
-				l.Warnf("error configuring tekton formatter: %s", err)
+				l.Warnf("error configuring intoto formatter: %s", err)
 			}
 			all[f] = formatter
 		}

pkg/config/store.go

@@ -123,40 +123,42 @@ var supportedValues = map[string][]string{
 	ociSignerKey:      {"pgp", "x509", "kms"},
 }
 
-func parse(data map[string]string) Config {
+func parse(data map[string]string, logger *zap.SugaredLogger) Config {
 	cfg := Config{}
 
 	// Artifact-specific configs
 
 	// TaskRuns
-	cfg.Artifacts.TaskRuns.Format = valueOrDefault(taskrunFormatKey, data)
-	cfg.Artifacts.TaskRuns.StorageBackend = valueOrDefault(taskrunStorageKey, data)
-	cfg.Artifacts.TaskRuns.Signer = valueOrDefault(taskrunSignerKey, data)
+	cfg.Artifacts.TaskRuns.Format = valueOrDefault(taskrunFormatKey, data, logger)
+	cfg.Artifacts.TaskRuns.StorageBackend = valueOrDefault(taskrunStorageKey, data, logger)
+	cfg.Artifacts.TaskRuns.Signer = valueOrDefault(taskrunSignerKey, data, logger)
 
 	// OCI
-	cfg.Artifacts.OCI.Format = valueOrDefault(ociFormatKey, data)
-	cfg.Artifacts.OCI.StorageBackend = valueOrDefault(ociStorageKey, data)
-	cfg.Artifacts.OCI.Signer = valueOrDefault(ociSignerKey, data)
+	cfg.Artifacts.OCI.Format = valueOrDefault(ociFormatKey, data, logger)
+	cfg.Artifacts.OCI.StorageBackend = valueOrDefault(ociStorageKey, data, logger)
+	cfg.Artifacts.OCI.Signer = valueOrDefault(ociSignerKey, data, logger)
 
 	// Storage level configs
 
-	cfg.Storage.GCS.Bucket = valueOrDefault(gcsBucketKey, data)
-	cfg.Storage.OCI.Repository = valueOrDefault(ociRepositoryKey, data)
-	cfg.Storage.OCI.Insecure = (valueOrDefault(ociRepositoryInsecureKey, data) == "true")
-	cfg.Storage.DocDB.URL = valueOrDefault(docDBUrlKey, data)
+	cfg.Storage.GCS.Bucket = valueOrDefault(gcsBucketKey, data, logger)
+	cfg.Storage.OCI.Repository = valueOrDefault(ociRepositoryKey, data, logger)
+	cfg.Storage.OCI.Insecure = (valueOrDefault(ociRepositoryInsecureKey, data, logger) == "true")
+	cfg.Storage.DocDB.URL = valueOrDefault(docDBUrlKey, data, logger)
 
-	cfg.Signers.KMS.KMSRef = valueOrDefault(kmsSignerKMSRef, data)
+	cfg.Signers.KMS.KMSRef = valueOrDefault(kmsSignerKMSRef, data, logger)
 
 	// Build config
-	cfg.Builder.ID = valueOrDefault(builderIDKey, data)
+	cfg.Builder.ID = valueOrDefault(builderIDKey, data, logger)
 
 	return cfg
 }
 
-func valueOrDefault(key string, data map[string]string) string {
+func valueOrDefault(key string, data map[string]string, logger *zap.SugaredLogger) string {
 	if v, ok := data[key]; ok {
 		if validate(key, v) {
 			return v
+		} else {
+			logger.Warnf("[%s] is not a valid option for key [%s], using default [%s] instead. please set [%s] to one of %v in the config\n", v, key, defaults[key], key, supportedValues[key])
 		}
 	}
 	return defaults[key]
@@ -193,7 +195,7 @@ func (cs *ConfigStore) watch() {
 		for evt := range cs.c {
 			cm := evt.Object.(*corev1.ConfigMap)
 			cs.logger.Debugf("watch event %s on %s/%s", evt.Type, cm.Namespace, cm.Name)
-			config := parse(cm.Data)
+			config := parse(cm.Data, cs.logger)
 			// Swap the values!
 			cs.config.Store(config)
 			cs.logger.Infof("config store %s updated: %v", cs.name, cm.Data)

pkg/config/store_test.go

@@ -134,7 +134,7 @@ func TestParse(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := parse(tt.data)
+			got := parse(tt.data, logtesting.TestLogger(t))
 			if diff := cmp.Diff(got, tt.want); diff != "" {
 				t.Errorf("parse() = %v", diff)
 			}
@@ -173,7 +173,7 @@ func TestValueOrDefault(t *testing.T) {
 	}
 	for _, test := range tests {
 		t.Run(test.description, func(t *testing.T) {
-			got := valueOrDefault(test.key, map[string]string{test.key: test.value})
+			got := valueOrDefault(test.key, map[string]string{test.key: test.value}, logtesting.TestLogger(t))
 			if got != test.expected {
 				t.Fatalf("got (%s) is not expected (%s)", got, test.expected)
 			}