-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit is part of #7259. First step to support remote resoluton for StepAction. It adds ResolverRef to Ref, validation and conversion. Signed-off-by: Yongxuan Zhang [email protected]
- Loading branch information
1 parent
7069889
commit 7020de5
Showing
13 changed files
with
518 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| Copyright 2022 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 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1" | ||
| "github.com/tektoncd/pipeline/test/diff" | ||
| "knative.dev/pkg/apis" | ||
| ) | ||
|
|
||
| func TestRef_Valid(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| ref *v1beta1.Ref | ||
| wc func(context.Context) context.Context | ||
| }{{ | ||
| name: "nil ref", | ||
| }, { | ||
| name: "simple ref", | ||
| ref: &v1beta1.Ref{Name: "refname"}, | ||
| }, { | ||
| name: "beta feature: valid resolver", | ||
| ref: &v1beta1.Ref{ResolverRef: v1beta1.ResolverRef{Resolver: "git"}}, | ||
| wc: cfgtesting.EnableBetaAPIFields, | ||
| }, { | ||
| name: "beta feature: valid resolver with alpha flag", | ||
| ref: &v1beta1.Ref{ResolverRef: v1beta1.ResolverRef{Resolver: "git"}}, | ||
| wc: cfgtesting.EnableAlphaAPIFields, | ||
| }, { | ||
| name: "beta feature: valid resolver with params", | ||
| ref: &v1beta1.Ref{ResolverRef: v1beta1.ResolverRef{Resolver: "git", Params: v1beta1.Params{{ | ||
| Name: "repo", | ||
| Value: v1beta1.ParamValue{ | ||
| Type: v1beta1.ParamTypeString, | ||
| StringVal: "https://github.com/tektoncd/pipeline.git", | ||
| }, | ||
| }, { | ||
| Name: "branch", | ||
| Value: v1beta1.ParamValue{ | ||
| Type: v1beta1.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 *v1beta1.Ref | ||
| wantErr *apis.FieldError | ||
| wc func(context.Context) context.Context | ||
| }{{ | ||
| name: "missing ref name", | ||
| ref: &v1beta1.Ref{}, | ||
| wantErr: apis.ErrMissingField("name"), | ||
| }, { | ||
| name: "ref params disallowed without resolver", | ||
| ref: &v1beta1.Ref{ | ||
| ResolverRef: v1beta1.ResolverRef{ | ||
| Params: v1beta1.Params{}, | ||
| }, | ||
| }, | ||
| wantErr: apis.ErrMissingField("resolver"), | ||
| }, { | ||
| name: "ref resolver disallowed in conjunction with ref name", | ||
| ref: &v1beta1.Ref{ | ||
| Name: "foo", | ||
| ResolverRef: v1beta1.ResolverRef{ | ||
| Resolver: "git", | ||
| }, | ||
| }, | ||
| wantErr: apis.ErrMultipleOneOf("name", "resolver"), | ||
| }, { | ||
| name: "ref params disallowed in conjunction with ref name", | ||
| ref: &v1beta1.Ref{ | ||
| Name: "bar", | ||
| ResolverRef: v1beta1.ResolverRef{ | ||
| Params: v1beta1.Params{{ | ||
| Name: "foo", | ||
| Value: v1beta1.ParamValue{ | ||
| Type: v1beta1.ParamTypeString, | ||
| StringVal: "bar", | ||
| }, | ||
| }}, | ||
| }, | ||
| }, | ||
| wantErr: apis.ErrMultipleOneOf("name", "params").Also(apis.ErrMissingField("resolver")), | ||
| }, { | ||
| name: "invalid ref name", | ||
| ref: &v1beta1.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: &v1beta1.Ref{ | ||
| ResolverRef: v1beta1.ResolverRef{ | ||
| Resolver: "some-resolver", | ||
| Params: v1beta1.Params{{ | ||
| Name: "foo", | ||
| Value: v1beta1.ParamValue{ | ||
| Type: v1beta1.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)) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.