Add FeatureFlags field to TaskRun.Status.Provenance

This PR adds feature flags field to `TaskRun.Status.Provenance`. TEP0122
wants to add feature flags to `invocation.Environment` for completeness
of build instructions.

Author: chitrangpatel

pkg/apis/pipeline/v1/openapi_generated.go

@@ -13,6 +13,8 @@ limitations under the License.
 
 package v1
 
+import "github.com/tektoncd/pipeline/pkg/apis/config"
+
 // Provenance contains some key authenticated metadata about how a software artifact was
 // built (what sources, what inputs/outputs, etc.). For now, it only contains the subfield
 // `ConfigSource` that identifies the source where a build config file came from.
@@ -22,6 +24,9 @@ package v1
 type Provenance struct {
 	// ConfigSource identifies the source where a resource came from.
 	ConfigSource *ConfigSource `json:"configSource,omitempty"`
+
+	// FeatureFlags identifies the feature flags that were used during the task/pipeline run
+	FeatureFlags *config.FeatureFlags `json:"featureFlags,omitempty"`
 }
 
 // ConfigSource identifies the source where a resource came from.

pkg/apis/pipeline/v1/provenance.go

@@ -1036,6 +1036,10 @@
         "configSource": {
           "description": "ConfigSource identifies the source where a resource came from.",
           "$ref": "#/definitions/v1.ConfigSource"
+        },
+        "featureFlags": {
+          "description": "FeatureFlags identifies the feature flags that were used during the task/pipeline run",
+          "$ref": "#/definitions/github.com.tektoncd.pipeline.pkg.apis.config.FeatureFlags"
         }
       }
     },

pkg/apis/pipeline/v1/swagger.json

@@ -23,6 +23,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
+	"github.com/tektoncd/pipeline/pkg/apis/config"
 	pod "github.com/tektoncd/pipeline/pkg/apis/pipeline/pod"
 	v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
@@ -309,6 +310,15 @@ func TestPipelineRunConversion(t *testing.T) {
 							URI:    "test-uri",
 							Digest: map[string]string{"sha256": "digest"},
 						},
+						FeatureFlags: &config.FeatureFlags{
+							RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+							EnableAPIFields:                  config.DefaultEnableAPIFields,
+							AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+							ResourceVerificationMode:         config.DefaultResourceVerificationMode,
+							ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+							MaxResultSize:                    config.DefaultMaxResultSize,
+							CustomTaskVersion:                config.DefaultCustomTaskVersion,
+						},
 					},
 				},
 			},

pkg/apis/pipeline/v1/zz_generated.deepcopy.go

@@ -13,6 +13,8 @@ limitations under the License.
 
 package v1beta1
 
+import "github.com/tektoncd/pipeline/pkg/apis/config"
+
 // Provenance contains some key authenticated metadata about how a software artifact was
 // built (what sources, what inputs/outputs, etc.). For now, it only contains the subfield
 // `ConfigSource` that identifies the source where a build config file came from.
@@ -22,6 +24,9 @@ package v1beta1
 type Provenance struct {
 	// ConfigSource identifies the source where a resource came from.
 	ConfigSource *ConfigSource `json:"configSource,omitempty"`
+
+	// FeatureFlags identifies the feature flags that were used during the task/pipeline run
+	FeatureFlags *config.FeatureFlags `json:"featureFlags,omitempty"`
 }
 
 // ConfigSource identifies the source where a resource came from.

pkg/apis/pipeline/v1beta1/openapi_generated.go

@@ -20,15 +20,25 @@ import (
 )
 
 func (p Provenance) convertTo(ctx context.Context, sink *v1.Provenance) {
-	new := v1.ConfigSource{}
-	p.ConfigSource.convertTo(ctx, &new)
-	sink.ConfigSource = &new
+	if p.ConfigSource != nil {
+		new := v1.ConfigSource{}
+		p.ConfigSource.convertTo(ctx, &new)
+		sink.ConfigSource = &new
+	}
+	if p.FeatureFlags != nil {
+		sink.FeatureFlags = p.FeatureFlags
+	}
 }
 
 func (p *Provenance) convertFrom(ctx context.Context, source v1.Provenance) {
-	new := ConfigSource{}
-	new.convertFrom(ctx, *source.ConfigSource)
-	p.ConfigSource = &new
+	if source.ConfigSource != nil {
+		new := ConfigSource{}
+		new.convertFrom(ctx, *source.ConfigSource)
+		p.ConfigSource = &new
+	}
+	if source.FeatureFlags != nil {
+		p.FeatureFlags = source.FeatureFlags
+	}
 }
 
 func (cs ConfigSource) convertTo(ctx context.Context, sink *v1.ConfigSource) {

pkg/apis/pipeline/v1beta1/pipelinerun_conversion_test.go

@@ -1680,6 +1680,10 @@
         "configSource": {
           "description": "ConfigSource identifies the source where a resource came from.",
           "$ref": "#/definitions/v1beta1.ConfigSource"
+        },
+        "featureFlags": {
+          "description": "FeatureFlags identifies the feature flags that were used during the task/pipeline run",
+          "$ref": "#/definitions/github.com.tektoncd.pipeline.pkg.apis.config.FeatureFlags"
         }
       }
     },

pkg/apis/pipeline/v1beta1/provenance.go

@@ -22,6 +22,7 @@ import (
 	"time"
 
 	"github.com/google/go-cmp/cmp"
+	"github.com/tektoncd/pipeline/pkg/apis/config"
 	pod "github.com/tektoncd/pipeline/pkg/apis/pipeline/pod"
 	v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
@@ -236,6 +237,15 @@ func TestTaskRunConversion(t *testing.T) {
 							URI:    "test-uri",
 							Digest: map[string]string{"sha256": "digest"},
 						},
+						FeatureFlags: &config.FeatureFlags{
+							RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+							EnableAPIFields:                  config.DefaultEnableAPIFields,
+							AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+							ResourceVerificationMode:         config.DefaultResourceVerificationMode,
+							ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+							MaxResultSize:                    config.DefaultMaxResultSize,
+							CustomTaskVersion:                config.DefaultCustomTaskVersion,
+						},
 					}},
 			},
 		},

pkg/apis/pipeline/v1beta1/provenance_conversion.go

@@ -1264,11 +1264,14 @@ func storePipelineSpecAndMergeMeta(ctx context.Context, pr *v1beta1.PipelineRun,
 	// Propagate ConfigSource 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 && meta != nil && meta.ConfigSource != nil {
+	if cfg.FeatureFlags.EnableProvenanceInStatus {
 		if pr.Status.Provenance == nil {
 			pr.Status.Provenance = &v1beta1.Provenance{}
 		}
-		if pr.Status.Provenance.ConfigSource == nil {
+		// Store FeatureFlags in the Provenance.
+		pr.Status.Provenance.FeatureFlags = cfg.FeatureFlags
+
+		if meta != nil && meta.ConfigSource != nil && pr.Status.Provenance.ConfigSource == nil {
 			pr.Status.Provenance.ConfigSource = meta.ConfigSource
 		}
 	}

pkg/apis/pipeline/v1beta1/swagger.json

@@ -5029,6 +5029,16 @@ metadata:
 			PipelineSpec: ps.DeepCopy(),
 			Provenance: &v1beta1.Provenance{
 				ConfigSource: configSource.DeepCopy(),
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableAPIFields:                  config.DefaultEnableAPIFields,
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					ResourceVerificationMode:         config.DefaultResourceVerificationMode,
+					EnableProvenanceInStatus:         true,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
 			},
 		},
 	}

pkg/apis/pipeline/v1beta1/taskrun_conversion_test.go

@@ -957,17 +957,20 @@ func storeTaskSpecAndMergeMeta(ctx context.Context, tr *v1beta1.TaskRun, ts *v1b
 		}
 	}
 
-	// Propagate ConfigSource from remote resolution to TaskRun 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 && meta != nil && meta.ConfigSource != nil {
+	if cfg.FeatureFlags.EnableProvenanceInStatus {
 		if tr.Status.Provenance == nil {
 			tr.Status.Provenance = &v1beta1.Provenance{}
 		}
-		if tr.Status.Provenance.ConfigSource == nil {
+		// Store FeatureFlags in the Provenance.
+		tr.Status.Provenance.FeatureFlags = cfg.FeatureFlags
+		// Propagate ConfigSource from remote resolution to TaskRun 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.
+		if meta != nil && meta.ConfigSource != nil && tr.Status.Provenance.ConfigSource == nil {
 			tr.Status.Provenance.ConfigSource = meta.ConfigSource
 		}
 	}
+
 	return nil
 }
 

pkg/apis/pipeline/v1beta1/zz_generated.deepcopy.go

@@ -4159,6 +4159,16 @@ spec:
 			TaskSpec: ts.DeepCopy(),
 			Provenance: &v1beta1.Provenance{
 				ConfigSource: configSource.DeepCopy(),
+				FeatureFlags: &config.FeatureFlags{
+					RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
+					EnableAPIFields:                  config.DefaultEnableAPIFields,
+					AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,
+					ResourceVerificationMode:         config.DefaultResourceVerificationMode,
+					EnableProvenanceInStatus:         true,
+					ResultExtractionMethod:           config.DefaultResultExtractionMethod,
+					MaxResultSize:                    config.DefaultMaxResultSize,
+					CustomTaskVersion:                config.DefaultCustomTaskVersion,
+				},
 			},
 		},
 	}