Fix Artifact type to a pointer

Prior to this, the Artifacts in TaskRunStatusFields was not set to a pointer of the underlying struct. As a result, it was incompatible with `tkn`. Here we fix that issue by updating it to a `pointer`.
tektoncd · Aug 30, 2024 · c910594 · c910594
1 parent a3bd23e
commit c910594
Show file tree

Hide file tree

Showing 19 changed files with 184 additions and 118 deletions.
diff --git a/pkg/apis/pipeline/v1/artifact_types.go b/pkg/apis/pipeline/v1/artifact_types.go
@@ -52,29 +52,30 @@ type Artifacts struct {
 	Outputs []Artifact `json:"outputs,omitempty"`
 }
 
-func (a *Artifacts) Merge(another Artifacts) {
+func (a *Artifacts) Merge(another *Artifacts) {
 	inputMap := make(map[string][]ArtifactValue)
 	var newInputs []Artifact
 
 	for _, v := range a.Inputs {
 		inputMap[v.Name] = v.Values
 	}
-
-	for _, v := range another.Inputs {
-		_, ok := inputMap[v.Name]
-		if !ok {
-			inputMap[v.Name] = []ArtifactValue{}
-		}
-		for _, vv := range v.Values {
-			exists := false
-			for _, av := range inputMap[v.Name] {
-				if cmp.Equal(vv, av) {
-					exists = true
-					break
-				}
+	if another != nil {
+		for _, v := range another.Inputs {
+			_, ok := inputMap[v.Name]
+			if !ok {
+				inputMap[v.Name] = []ArtifactValue{}
 			}
-			if !exists {
-				inputMap[v.Name] = append(inputMap[v.Name], vv)
+			for _, vv := range v.Values {
+				exists := false
+				for _, av := range inputMap[v.Name] {
+					if cmp.Equal(vv, av) {
+						exists = true
+						break
+					}
+				}
+				if !exists {
+					inputMap[v.Name] = append(inputMap[v.Name], vv)
+				}
 			}
 		}
 	}
@@ -92,31 +93,33 @@ func (a *Artifacts) Merge(another Artifacts) {
 		outputMap[v.Name] = v
 	}
 
-	for _, v := range another.Outputs {
-		_, ok := outputMap[v.Name]
-		if !ok {
-			outputMap[v.Name] = Artifact{Name: v.Name, Values: []ArtifactValue{}, BuildOutput: v.BuildOutput}
-		}
-		// only update buildOutput to true.
-		// Do not convert to false if it was true before.
-		if v.BuildOutput {
-			art := outputMap[v.Name]
-			art.BuildOutput = v.BuildOutput
-			outputMap[v.Name] = art
-		}
-		for _, vv := range v.Values {
-			exists := false
-			for _, av := range outputMap[v.Name].Values {
-				if cmp.Equal(vv, av) {
-					exists = true
-					break
-				}
+	if another != nil {
+		for _, v := range another.Outputs {
+			_, ok := outputMap[v.Name]
+			if !ok {
+				outputMap[v.Name] = Artifact{Name: v.Name, Values: []ArtifactValue{}, BuildOutput: v.BuildOutput}
 			}
-			if !exists {
+			// only update buildOutput to true.
+			// Do not convert to false if it was true before.
+			if v.BuildOutput {
 				art := outputMap[v.Name]
-				art.Values = append(art.Values, vv)
+				art.BuildOutput = v.BuildOutput
 				outputMap[v.Name] = art
 			}
+			for _, vv := range v.Values {
+				exists := false
+				for _, av := range outputMap[v.Name].Values {
+					if cmp.Equal(vv, av) {
+						exists = true
+						break
+					}
+				}
+				if !exists {
+					art := outputMap[v.Name]
+					art.Values = append(art.Values, vv)
+					outputMap[v.Name] = art
+				}
+			}
 		}
 	}
 

diff --git a/pkg/apis/pipeline/v1/artifact_types_test.go b/pkg/apis/pipeline/v1/artifact_types_test.go
@@ -182,7 +182,7 @@ func TestArtifactsMerge(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			tc.a1.Merge(tc.a2)
+			tc.a1.Merge(&tc.a2)
 			got := tc.a1
 			if d := cmp.Diff(tc.expected, got, cmpopts.SortSlices(func(a, b Artifact) bool { return a.Name > b.Name })); d != "" {
 				t.Errorf("TestArtifactsMerge() did not produce expected artifacts for test %s: %s", tc.name, diff.PrintWantGot(d))

diff --git a/pkg/apis/pipeline/v1/openapi_generated.go b/pkg/apis/pipeline/v1/openapi_generated.go
diff --git a/pkg/apis/pipeline/v1/swagger.json b/pkg/apis/pipeline/v1/swagger.json
@@ -2137,7 +2137,6 @@
         },
         "artifacts": {
           "description": "Artifacts are the list of artifacts written out by the task's containers",
-          "default": {},
           "$ref": "#/definitions/v1.Artifacts",
           "x-kubernetes-list-type": "atomic"
         },
@@ -2232,7 +2231,6 @@
       "properties": {
         "artifacts": {
           "description": "Artifacts are the list of artifacts written out by the task's containers",
-          "default": {},
           "$ref": "#/definitions/v1.Artifacts",
           "x-kubernetes-list-type": "atomic"
         },

diff --git a/pkg/apis/pipeline/v1/taskrun_types.go b/pkg/apis/pipeline/v1/taskrun_types.go
@@ -300,7 +300,7 @@ type TaskRunStatusFields struct {
 	// Artifacts are the list of artifacts written out by the task's containers
 	// +optional
 	// +listType=atomic
-	Artifacts Artifacts `json:"artifacts,omitempty"`
+	Artifacts *Artifacts `json:"artifacts,omitempty"`
 
 	// The list has one entry per sidecar in the manifest. Each entry is
 	// represents the imageid of the corresponding sidecar.

diff --git a/pkg/apis/pipeline/v1/zz_generated.deepcopy.go b/pkg/apis/pipeline/v1/zz_generated.deepcopy.go
diff --git a/pkg/pod/status.go b/pkg/pod/status.go
@@ -260,7 +260,7 @@ func setTaskRunStatusBasedOnStepStatus(ctx context.Context, logger *zap.SugaredL
 			logger.Errorf("Failed to set artifacts value from sidecar logs: %v", err)
 			merr = multierror.Append(merr, err)
 		} else {
-			trs.Artifacts = tras
+			trs.Artifacts = &tras
 		}
 	}
 
@@ -343,8 +343,8 @@ func setTaskRunStatusBasedOnStepStatus(ctx context.Context, logger *zap.SugaredL
 						logger.Errorf("error setting step artifacts in taskrun %q: %v", tr.Name, err)
 						merr = multierror.Append(merr, err)
 					}
-					trs.Artifacts.Merge(tras)
-					trs.Artifacts.Merge(sas)
+					trs.Artifacts.Merge(&tras)
+					trs.Artifacts.Merge(&sas)
 				}
 				msg, err = createMessageFromResults(filteredResults)
 				if err != nil {