[TEP-0142] Add ResolverRef to Ref

docs/pipeline-api.md

@@ -3300,6 +3300,21 @@ string
 <p>Name of the referenced step</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ResolverRef</code><br/>
+<em>
+<a href="#tekton.dev/v1.ResolverRef">
+ResolverRef
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>ResolverRef allows referencing a StepAction in a remote location
+like a git repo.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="tekton.dev/v1.RefSource">RefSource
@@ -3371,7 +3386,7 @@ requested.</p>
 <h3 id="tekton.dev/v1.ResolverRef">ResolverRef
 </h3>
 <p>
-(<em>Appears on:</em><a href="#tekton.dev/v1.PipelineRef">PipelineRef</a>, <a href="#tekton.dev/v1.TaskRef">TaskRef</a>)
+(<em>Appears on:</em><a href="#tekton.dev/v1.PipelineRef">PipelineRef</a>, <a href="#tekton.dev/v1.Ref">Ref</a>, <a href="#tekton.dev/v1.TaskRef">TaskRef</a>)
 </p>
 <div>
 <p>ResolverRef can be used to refer to a Pipeline or Task in a remote
@@ -11831,6 +11846,21 @@ string
 <p>Name of the referenced step</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ResolverRef</code><br/>
+<em>
+<a href="#tekton.dev/v1beta1.ResolverRef">
+ResolverRef
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>ResolverRef allows referencing a StepAction in a remote location
+like a git repo.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="tekton.dev/v1beta1.RefSource">RefSource
@@ -11902,7 +11932,7 @@ requested.</p>
 <h3 id="tekton.dev/v1beta1.ResolverRef">ResolverRef
 </h3>
 <p>
-(<em>Appears on:</em><a href="#tekton.dev/v1beta1.PipelineRef">PipelineRef</a>, <a href="#tekton.dev/v1beta1.TaskRef">TaskRef</a>)
+(<em>Appears on:</em><a href="#tekton.dev/v1beta1.PipelineRef">PipelineRef</a>, <a href="#tekton.dev/v1beta1.Ref">Ref</a>, <a href="#tekton.dev/v1beta1.TaskRef">TaskRef</a>)
 </p>
 <div>
 <p>ResolverRef can be used to refer to a Pipeline or Task in a remote

pkg/apis/pipeline/v1/container_types.go

@@ -144,6 +144,10 @@ type Step struct {
 type Ref struct {
 	// Name of the referenced step
 	Name string `json:"name,omitempty"`
+	// ResolverRef allows referencing a StepAction in a remote location
+	// like a git repo.
+	// +optional
+	ResolverRef `json:",omitempty"`
 }
 
 // OnErrorType defines a list of supported exiting behavior of a container on error

pkg/apis/pipeline/v1/container_validation.go

@@ -0,0 +1,62 @@
+/*
+Copyright 2023 The Tekton Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	"context"
+	"strings"
+
+	"github.com/tektoncd/pipeline/pkg/apis/config"
+	"k8s.io/apimachinery/pkg/util/validation"
+	"knative.dev/pkg/apis"
+)
+
+// Validate ensures that a supplied Ref field is populated
+// correctly. No errors are returned for a nil Ref.
+func (ref *Ref) Validate(ctx context.Context) (errs *apis.FieldError) {
+	if ref == nil {
+		return
+	}
+
+	switch {
+	case ref.Resolver != "" || ref.Params != nil:
+		if ref.Resolver != "" {
+			errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "resolver", config.BetaAPIFields).ViaField("resolver"))
+			if ref.Name != "" {
+				errs = errs.Also(apis.ErrMultipleOneOf("name", "resolver"))
+			}
+		}
+		if ref.Params != nil {
+			errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "resolver params", config.BetaAPIFields).ViaField("params"))
+			if ref.Name != "" {
+				errs = errs.Also(apis.ErrMultipleOneOf("name", "params"))
+			}
+			if ref.Resolver == "" {
+				errs = errs.Also(apis.ErrMissingField("resolver"))
+			}
+			errs = errs.Also(ValidateParameters(ctx, ref.Params))
+		}
+	case ref.Name != "":
+		// ref name must be a valid k8s name
+		if errSlice := validation.IsQualifiedName(ref.Name); len(errSlice) != 0 {
+			errs = errs.Also(apis.ErrInvalidValue(strings.Join(errSlice, ","), "name"))
+		}
+	default:
+		errs = errs.Also(apis.ErrMissingField("name"))
+	}
+	return errs
+}

pkg/apis/pipeline/v1/container_validation_test.go

@@ -0,0 +1,157 @@
+/*
+Copyright 2023 The Tekton Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	cfgtesting "github.com/tektoncd/pipeline/pkg/apis/config/testing"
+	v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
+	"github.com/tektoncd/pipeline/test/diff"
+	"knative.dev/pkg/apis"
+)
+
+func TestRef_Valid(t *testing.T) {
+	tests := []struct {
+		name string
+		ref  *v1.Ref
+		wc   func(context.Context) context.Context
+	}{{
+		name: "nil ref",
+	}, {
+		name: "simple ref",
+		ref:  &v1.Ref{Name: "refname"},
+	}, {
+		name: "beta feature: valid resolver",
+		ref:  &v1.Ref{ResolverRef: v1.ResolverRef{Resolver: "git"}},
+		wc:   cfgtesting.EnableBetaAPIFields,
+	}, {
+		name: "beta feature: valid resolver with alpha flag",
+		ref:  &v1.Ref{ResolverRef: v1.ResolverRef{Resolver: "git"}},
+		wc:   cfgtesting.EnableAlphaAPIFields,
+	}, {
+		name: "beta feature: valid resolver with params",
+		ref: &v1.Ref{ResolverRef: v1.ResolverRef{Resolver: "git", Params: v1.Params{{
+			Name: "repo",
+			Value: v1.ParamValue{
+				Type:      v1.ParamTypeString,
+				StringVal: "https://github.com/tektoncd/pipeline.git",
+			},
+		}, {
+			Name: "branch",
+			Value: v1.ParamValue{
+				Type:      v1.ParamTypeString,
+				StringVal: "baz",
+			},
+		}}}},
+	}}
+	for _, ts := range tests {
+		t.Run(ts.name, func(t *testing.T) {
+			ctx := context.Background()
+			if ts.wc != nil {
+				ctx = ts.wc(ctx)
+			}
+			if err := ts.ref.Validate(ctx); err != nil {
+				t.Errorf("Ref.Validate() error = %v", err)
+			}
+		})
+	}
+}
+
+func TestRef_Invalid(t *testing.T) {
+	tests := []struct {
+		name    string
+		ref     *v1.Ref
+		wantErr *apis.FieldError
+		wc      func(context.Context) context.Context
+	}{{
+		name:    "missing ref name",
+		ref:     &v1.Ref{},
+		wantErr: apis.ErrMissingField("name"),
+	}, {
+		name: "ref params disallowed without resolver",
+		ref: &v1.Ref{
+			ResolverRef: v1.ResolverRef{
+				Params: v1.Params{},
+			},
+		},
+		wantErr: apis.ErrMissingField("resolver"),
+	}, {
+		name: "ref resolver disallowed in conjunction with ref name",
+		ref: &v1.Ref{
+			Name: "foo",
+			ResolverRef: v1.ResolverRef{
+				Resolver: "git",
+			},
+		},
+		wantErr: apis.ErrMultipleOneOf("name", "resolver"),
+	}, {
+		name: "ref params disallowed in conjunction with ref name",
+		ref: &v1.Ref{
+			Name: "bar",
+			ResolverRef: v1.ResolverRef{
+				Params: v1.Params{{
+					Name: "foo",
+					Value: v1.ParamValue{
+						Type:      v1.ParamTypeString,
+						StringVal: "bar",
+					},
+				}},
+			},
+		},
+		wantErr: apis.ErrMultipleOneOf("name", "params").Also(apis.ErrMissingField("resolver")),
+	}, {
+		name: "invalid ref name",
+		ref:  &v1.Ref{Name: "_foo"},
+		wantErr: &apis.FieldError{
+			Message: `invalid value: name part must consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName',  or 'my.name',  or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]')`,
+			Paths:   []string{"name"},
+		},
+	}, {
+		name: "ref param object requires beta",
+		ref: &v1.Ref{
+			ResolverRef: v1.ResolverRef{
+				Resolver: "some-resolver",
+				Params: v1.Params{{
+					Name: "foo",
+					Value: v1.ParamValue{
+						Type:      v1.ParamTypeObject,
+						ObjectVal: map[string]string{"bar": "baz"},
+					},
+				}},
+			},
+		},
+		wc: cfgtesting.EnableStableAPIFields,
+		wantErr: apis.ErrGeneric("resolver requires \"enable-api-fields\" feature gate to be \"alpha\" or \"beta\" but it is \"stable\"").Also(
+			apis.ErrGeneric("resolver params requires \"enable-api-fields\" feature gate to be \"alpha\" or \"beta\" but it is \"stable\"")).Also(
+			apis.ErrGeneric("object type parameter requires \"enable-api-fields\" feature gate to be \"alpha\" or \"beta\" but it is \"stable\"")),
+	}}
+	for _, ts := range tests {
+		t.Run(ts.name, func(t *testing.T) {
+			ctx := context.Background()
+			if ts.wc != nil {
+				ctx = ts.wc(ctx)
+			}
+			err := ts.ref.Validate(ctx)
+			if d := cmp.Diff(ts.wantErr.Error(), err.Error()); d != "" {
+				t.Error(diff.PrintWantGot(d))
+			}
+		})
+	}
+}

pkg/apis/pipeline/v1/task_validation.go

@@ -268,6 +268,7 @@ func validateStep(ctx context.Context, s Step, names sets.String) (errs *apis.Fi
 		if !config.FromContextOrDefaults(ctx).FeatureFlags.EnableStepActions {
 			return apis.ErrGeneric("feature flag %s should be set to true to reference StepActions in Steps.", config.EnableStepActions)
 		}
+		errs = s.Ref.Validate(ctx)
 		if s.Image != "" {
 			errs = errs.Also(&apis.FieldError{
 				Message: "image cannot be used with Ref",

pkg/apis/pipeline/v1beta1/container_conversion.go

@@ -24,10 +24,16 @@ import (
 
 func (r Ref) convertTo(ctx context.Context, sink *v1.Ref) {
 	sink.Name = r.Name
+	new := v1.ResolverRef{}
+	r.ResolverRef.convertTo(ctx, &new)
+	sink.ResolverRef = new
 }
 
 func (r *Ref) convertFrom(ctx context.Context, source v1.Ref) {
 	r.Name = source.Name
+	new := ResolverRef{}
+	new.convertFrom(ctx, source.ResolverRef)
+	r.ResolverRef = new
 }
 
 func (s Step) convertTo(ctx context.Context, sink *v1.Step) {

pkg/apis/pipeline/v1beta1/container_types.go

@@ -238,6 +238,10 @@ type Step struct {
 type Ref struct {
 	// Name of the referenced step
 	Name string `json:"name,omitempty"`
+	// ResolverRef allows referencing a StepAction in a remote location
+	// like a git repo.
+	// +optional
+	ResolverRef `json:",omitempty"`
 }
 
 // OnErrorType defines a list of supported exiting behavior of a container on error