Promote the provenance field in status

Fixes tektoncd#6309. Prior, the `provenance` field in status was gated by the dedicated feature flag named `enable-provenance-in-status`. This PR moves the field out of the feature flag. Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 · Apr 5, 2023 · cbfccbd · cbfccbd
1 parent 54c9b51
commit cbfccbd
Show file tree

Hide file tree

Showing 11 changed files with 152 additions and 91 deletions.
diff --git a/config/config-feature-flags.yaml b/config/config-feature-flags.yaml
@@ -81,11 +81,6 @@ data:
   # If it is set to "warn", TaskRuns and PipelineRuns will run to completion if no matching policies are found, and an error will be logged.
   # If it is set to "ignore", TaskRuns and PipelineRuns will run to completion if no matching policies are found, and no error will be logged.
   trusted-resources-verification-no-match-policy: "ignore"
-  # Setting this flag to "true" enables populating the "provenance" field in TaskRun
-  # and PipelineRun status. This field contains metadata about resources used
-  # in the TaskRun/PipelineRun such as the source from where a remote Task/Pipeline
-  # definition was fetched.
-  enable-provenance-in-status: "false"
   # Setting this flag will determine the version for custom tasks created by PipelineRuns.
   # Acceptable values are "v1beta1" and "v1alpha1".
   # The default is "v1beta1".

diff --git a/docs/additional-configs.md b/docs/additional-configs.md
@@ -245,11 +245,6 @@ Defaults to "ignore".
 
 - `results-from`: set this flag to "termination-message" to use the container's termination message to fetch results from. This is the default method of extracting results. Set it to "sidecar-logs" to enable use of a results sidecar logs to extract results instead of termination message.
 
-- `enable-provenance-in-status`: set this flag to "true" to enable recording
-  the `provenance` field in `TaskRun` and `PipelineRun` status. The `provenance`
-  field contains metadata about resources used in the TaskRun/PipelineRun such as the
-  source from where a remote Task/Pipeline definition was fetched.
-
 - `custom-task-version`: set this flag to "v1beta1" to have `PipelineRuns` create `CustomRuns`
   from Custom Tasks. Set it to "v1alpha1" to have `PipelineRuns` create the legacy alpha
   `Runs`. This may be needed if you are using legacy Custom Tasks that listen for `*v1alpha1.Run`
@@ -290,7 +285,6 @@ Features currently in "alpha" are:
 | [Task-level Resource Requirements](compute-resources.md#task-level-compute-resources-configuration) | [TEP-0104](https://github.com/tektoncd/community/blob/main/teps/0104-tasklevel-resource-requirements.md)                   | [v0.39.0](https://github.com/tektoncd/pipeline/releases/tag/v0.39.0) |                               |
 | [Object Params and Results](pipelineruns.md#specifying-parameters)                                  | [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md)                     | [v0.38.0](https://github.com/tektoncd/pipeline/releases/tag/v0.38.0) |                               |                             |
 | [Trusted Resources](./trusted-resources.md)                                                         | [TEP-0091](https://github.com/tektoncd/community/blob/main/teps/0091-trusted-resources.md)                                 | N/A                                                                  | `trusted-resources-verification-no-match-policy`  |
-| [`Provenance` field in Status](pipeline-api.md#provenance)                                          | [issue#5550](https://github.com/tektoncd/pipeline/issues/5550)                                                             | N/A                                                                  | `enable-provenance-in-status` |
 | [Larger Results via Sidecar Logs](#enabling-larger-results-using-sidecar-logs)                      | [TEP-0127](https://github.com/tektoncd/community/blob/main/teps/0127-larger-results-via-sidecar-logs.md)                   | [v0.43.0](https://github.com/tektoncd/pipeline/releases/tag/v0.43.0) | `results-from`                |
 | [Configure Default Resolver](./resolution.md#configuring-built-in-resolvers)                        | [TEP-0133](https://github.com/tektoncd/community/blob/main/teps/0133-configure-default-resolver.md)                        | N/A                                 |                                |
 

diff --git a/pkg/apis/config/feature_flags.go b/pkg/apis/config/feature_flags.go
@@ -76,8 +76,6 @@ const (
 	DefaultEnforceNonfalsifiability = EnforceNonfalsifiabilityNone
 	// DefaultNoMatchPolicyConfig is the default value for "trusted-resources-verification-no-match-policy".
 	DefaultNoMatchPolicyConfig = IgnoreNoMatchPolicy
-	// DefaultEnableProvenanceInStatus is the default value for "enable-provenance-status".
-	DefaultEnableProvenanceInStatus = false
 	// DefaultResultExtractionMethod is the default value for ResultExtractionMethod
 	DefaultResultExtractionMethod = ResultExtractionMethodTerminationMessage
 	// DefaultMaxResultSize is the default value in bytes for the size of a result
@@ -95,7 +93,6 @@ const (
 	sendCloudEventsForRuns              = "send-cloudevents-for-runs"
 	enforceNonfalsifiability            = "enforce-nonfalsifiability"
 	verificationNoMatchPolicy           = "trusted-resources-verification-no-match-policy"
-	enableProvenanceInStatus            = "enable-provenance-in-status"
 	resultExtractionMethod              = "results-from"
 	maxResultSize                       = "max-result-size"
 	customTaskVersion                   = "custom-task-version"
@@ -120,7 +117,6 @@ type FeatureFlags struct {
 	// warn: skip trusted resources verification when no matching verification policies found and log a warning
 	// fail: fail the taskrun or pipelines run if no matching verification policies found
 	VerificationNoMatchPolicy string
-	EnableProvenanceInStatus  bool
 	ResultExtractionMethod    string
 	MaxResultSize             int
 	CustomTaskVersion         string
@@ -191,9 +187,6 @@ func NewFeatureFlagsFromMap(cfgMap map[string]string) (*FeatureFlags, error) {
 	if err := setVerificationNoMatchPolicy(cfgMap, DefaultNoMatchPolicyConfig, &tc.VerificationNoMatchPolicy); err != nil {
 		return nil, err
 	}
-	if err := setFeature(enableProvenanceInStatus, DefaultEnableProvenanceInStatus, &tc.EnableProvenanceInStatus); err != nil {
-		return nil, err
-	}
 	if err := setResultExtractionMethod(cfgMap, DefaultResultExtractionMethod, &tc.ResultExtractionMethod); err != nil {
 		return nil, err
 	}

diff --git a/pkg/apis/config/feature_flags_test.go b/pkg/apis/config/feature_flags_test.go
@@ -48,7 +48,6 @@ func TestNewFeatureFlagsFromConfigMap(t *testing.T) {
 				EnableAPIFields:           config.DefaultEnableAPIFields,
 				SendCloudEventsForRuns:    config.DefaultSendCloudEventsForRuns,
 				VerificationNoMatchPolicy: config.DefaultNoMatchPolicyConfig,
-				EnableProvenanceInStatus:  config.DefaultEnableProvenanceInStatus,
 				ResultExtractionMethod:    config.DefaultResultExtractionMethod,
 				MaxResultSize:             config.DefaultMaxResultSize,
 				CustomTaskVersion:         config.DefaultCustomTaskVersion,
@@ -66,7 +65,6 @@ func TestNewFeatureFlagsFromConfigMap(t *testing.T) {
 				SendCloudEventsForRuns:           true,
 				EnforceNonfalsifiability:         "spire",
 				VerificationNoMatchPolicy:        config.FailNoMatchPolicy,
-				EnableProvenanceInStatus:         true,
 				ResultExtractionMethod:           "termination-message",
 				MaxResultSize:                    4096,
 				CustomTaskVersion:                "v1beta1",
@@ -179,7 +177,6 @@ func TestNewFeatureFlagsFromEmptyConfigMap(t *testing.T) {
 		SendCloudEventsForRuns:           config.DefaultSendCloudEventsForRuns,
 		EnforceNonfalsifiability:         config.DefaultEnforceNonfalsifiability,
 		VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
-		EnableProvenanceInStatus:         config.DefaultEnableProvenanceInStatus,
 		ResultExtractionMethod:           config.DefaultResultExtractionMethod,
 		MaxResultSize:                    config.DefaultMaxResultSize,
 		CustomTaskVersion:                config.DefaultCustomTaskVersion,

diff --git a/pkg/apis/config/testdata/feature-flags-all-flags-set.yaml b/pkg/apis/config/testdata/feature-flags-all-flags-set.yaml
@@ -28,5 +28,4 @@ data:
   send-cloudevents-for-runs: "true"
   enforce-nonfalsifiability: "spire"
   trusted-resources-verification-no-match-policy: "fail"
-  enable-provenance-in-status: "true"
   custom-task-version: "v1beta1"
diff --git a/pkg/reconciler/pipelinerun/pipelinerun.go b/pkg/reconciler/pipelinerun/pipelinerun.go
@@ -1257,19 +1257,17 @@ func storePipelineSpecAndMergeMeta(ctx context.Context, pr *v1beta1.PipelineRun,
 	// Propagate refSource from remote resolution to PipelineRun Status
 	// This lives outside of the status.spec check to avoid the case where only the spec is available in the first reconcile and source comes in next reconcile.
 	cfg := config.FromContextOrDefaults(ctx)
-	if cfg.FeatureFlags.EnableProvenanceInStatus {
-		if pr.Status.Provenance == nil {
-			pr.Status.Provenance = &v1beta1.Provenance{}
-		}
-		// Store FeatureFlags in the Provenance.
-		pr.Status.Provenance.FeatureFlags = cfg.FeatureFlags
+	if pr.Status.Provenance == nil {
+		pr.Status.Provenance = &v1beta1.Provenance{}
+	}
+	// Store FeatureFlags in the Provenance.
+	pr.Status.Provenance.FeatureFlags = cfg.FeatureFlags
 
-		if meta != nil && meta.RefSource != nil && pr.Status.Provenance.RefSource == nil {
-			pr.Status.Provenance.RefSource = meta.RefSource
-		}
-		if meta != nil && meta.RefSource != nil && pr.Status.Provenance.ConfigSource == nil {
-			pr.Status.Provenance.ConfigSource = (*v1beta1.ConfigSource)(meta.RefSource)
-		}
+	if meta != nil && meta.RefSource != nil && pr.Status.Provenance.RefSource == nil {
+		pr.Status.Provenance.RefSource = meta.RefSource
+	}
+	if meta != nil && meta.RefSource != nil && pr.Status.Provenance.ConfigSource == nil {
+		pr.Status.Provenance.ConfigSource = (*v1beta1.ConfigSource)(meta.RefSource)
 	}
 
 	return nil

diff --git a/pkg/reconciler/pipelinerun/pipelinerun_test.go b/pkg/reconciler/pipelinerun/pipelinerun_test.go
@@ -4521,6 +4521,17 @@ status:
 `)
 
 	expectedPr := expectedPrStatus
+	expectedPr.Status.Provenance = &v1beta1.Provenance{
+		FeatureFlags: &config.FeatureFlags{
+			RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+			EnableAPIFields:                  config.DefaultEnableAPIFields,
+			AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+			VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+			ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+			MaxResultSize:                    config.DefaultMaxResultSize,
+			CustomTaskVersion:                config.DefaultCustomTaskVersion,
+		},
+	}
 
 	if d := cmp.Diff(expectedPr, reconciledRun, ignoreResourceVersion, ignoreLastTransitionTime, ignoreCompletionTime, ignoreStartTime, cmpopts.EquateEmpty()); d != "" {
 		t.Errorf("expected to see pipeline run results created. Diff %s", diff.PrintWantGot(d))
@@ -4669,6 +4680,17 @@ status:
 `)
 
 	expectedPr := expectedPrStatus
+	expectedPr.Status.Provenance = &v1beta1.Provenance{
+		FeatureFlags: &config.FeatureFlags{
+			RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+			EnableAPIFields:                  config.DefaultEnableAPIFields,
+			AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+			VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+			ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+			MaxResultSize:                    config.DefaultMaxResultSize,
+			CustomTaskVersion:                config.DefaultCustomTaskVersion,
+		},
+	}
 
 	if d := cmp.Diff(expectedPr, reconciledRun, ignoreResourceVersion, ignoreLastTransitionTime, ignoreCompletionTime, ignoreStartTime, cmpopts.EquateEmpty()); d != "" {
 		t.Errorf("expected to see pipeline run results created. Diff %s", diff.PrintWantGot(d))
@@ -4833,7 +4855,6 @@ metadata:
 					EnableAPIFields:                  config.DefaultEnableAPIFields,
 					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
 					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
-					EnableProvenanceInStatus:         true,
 					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
 					MaxResultSize:                    config.DefaultMaxResultSize,
 					CustomTaskVersion:                config.DefaultCustomTaskVersion,
@@ -4888,17 +4909,16 @@ metadata:
 	}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
-			ctx := ttesting.EnableFeatureFlagField(context.Background(), t, "enable-provenance-in-status")
 			// mock first reconcile
-			if err := storePipelineSpecAndMergeMeta(ctx, pr, tc.reconcile1Args.pipelineSpec, tc.reconcile1Args.resolvedObjectMeta); err != nil {
+			if err := storePipelineSpecAndMergeMeta(context.Background(), pr, tc.reconcile1Args.pipelineSpec, tc.reconcile1Args.resolvedObjectMeta); err != nil {
 				t.Errorf("storePipelineSpec() error = %v", err)
 			}
 			if d := cmp.Diff(pr, tc.wantPipelineRun); d != "" {
 				t.Fatalf(diff.PrintWantGot(d))
 			}
 
 			// mock second reconcile
-			if err := storePipelineSpecAndMergeMeta(ctx, pr, tc.reconcile2Args.pipelineSpec, tc.reconcile2Args.resolvedObjectMeta); err != nil {
+			if err := storePipelineSpecAndMergeMeta(context.Background(), pr, tc.reconcile2Args.pipelineSpec, tc.reconcile2Args.resolvedObjectMeta); err != nil {
 				t.Errorf("storePipelineSpec() error = %v", err)
 			}
 			if d := cmp.Diff(pr, tc.wantPipelineRun); d != "" {
@@ -7985,6 +8005,18 @@ spec:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, ignoreFinallyStartTime, cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}
@@ -8523,6 +8555,18 @@ spec:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, ignoreFinallyStartTime, cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}
@@ -8745,6 +8789,18 @@ spec:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, ignoreFinallyStartTime, cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}
@@ -9338,6 +9394,18 @@ spec:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, ignoreFinallyStartTime, cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}
@@ -9782,6 +9850,18 @@ status:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, cmpopts.SortSlices(lessChildReferences), cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}
@@ -10302,6 +10382,18 @@ spec:
 			if err != nil {
 				t.Fatalf("Got an error getting reconciled run out of fake client: %s", err)
 			}
+			tt.expectedPipelineRun.Status.Provenance = &v1beta1.Provenance{
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableTektonOCIBundles:           true,
+					EnableAPIFields:                  "alpha",
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					VerificationNoMatchPolicy:        config.DefaultNoMatchPolicyConfig,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
+			}
 			if d := cmp.Diff(tt.expectedPipelineRun, pipelineRun, ignoreResourceVersion, ignoreTypeMeta, ignoreLastTransitionTime, ignoreStartTime, ignoreFinallyStartTime, cmpopts.EquateEmpty()); d != "" {
 				t.Errorf("expected PipelineRun was not created. Diff %s", diff.PrintWantGot(d))
 			}