Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add validation for results object properties types #5169

Merged
merged 1 commit into from
Aug 2, 2022
Merged

Add validation for results object properties types #5169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion pkg/apis/pipeline/v1/result_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ func (tr TaskResult) Validate(ctx context.Context) (errs *apis.FieldError) {
}
// Array and Object are alpha features
if tr.Type == ResultsTypeArray || tr.Type == ResultsTypeObject {
return errs.Also(version.ValidateEnabledAPIFields(ctx, "results type", config.AlphaAPIFields))
errs := validateObjectResult(tr)
errs = errs.Also(version.ValidateEnabledAPIFields(ctx, "results type", config.AlphaAPIFields))
return errs
}

// Resources created before the result. Type was introduced may not have Type set
Expand All @@ -51,3 +53,26 @@ func (tr TaskResult) Validate(ctx context.Context) (errs *apis.FieldError) {

return nil
}

// validateObjectResult validates the object result and check if the Properties is missing
// for Properties values it will check if the type is string.
Comment on lines +57 to +58
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// validateObjectResult validates the object result and check if the Properties is missing
// for Properties values it will check if the type is string.
// validateObjectResult validates that the object result has Properties,
// and that all Properties are strings.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, is there a reason PropertySpec has a type if the only supported type is string?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah it is required in tep75 and I think the reason is to support future extension

func validateObjectResult(tr TaskResult) (errs *apis.FieldError) {
Yongxuanzhang marked this conversation as resolved.
Show resolved Hide resolved
if ParamType(tr.Type) == ParamTypeObject && tr.Properties == nil {
return apis.ErrMissingField(fmt.Sprintf("%s.properties", tr.Name))
}

invalidKeys := []string{}
for key, propertySpec := range tr.Properties {
if propertySpec.Type != ParamTypeString {
invalidKeys = append(invalidKeys, key)
}
}

if len(invalidKeys) != 0 {
return &apis.FieldError{
Message: fmt.Sprintf("The value type specified for these keys %v is invalid, the type must be string", invalidKeys),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Message: fmt.Sprintf("The value type specified for these keys %v is invalid, the type must be string", invalidKeys),
Message: fmt.Sprintf("The value type specified for these keys %v are invalid, the type must be string", invalidKeys),

Paths: []string{fmt.Sprintf("%s.properties", tr.Name)},
}
}
return nil
}
38 changes: 32 additions & 6 deletions pkg/apis/pipeline/v1/result_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type string",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: "string",
Type: v1.ResultsTypeString,
Description: "my great result",
},

Expand All @@ -53,7 +53,7 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type array",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1.ResultsTypeArray,
Description: "my great result",
},

Expand All @@ -62,10 +62,10 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type object",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1.PropertySpec{"hello": {Type: v1.ParamTypeString}},
},

apiFields: "alpha",
}}
for _, tt := range tests {
Expand Down Expand Up @@ -117,7 +117,7 @@ func TestResultsValidateError(t *testing.T) {
name: "invalid array result type in stable",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1.ResultsTypeArray,
Description: "my great result",
},
apiFields: "stable",
Expand All @@ -128,13 +128,39 @@ func TestResultsValidateError(t *testing.T) {
name: "invalid object result type in stable",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: "object",
Type: v1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1.PropertySpec{"hello": {Type: v1.ParamTypeString}},
},
apiFields: "stable",
expectedError: apis.FieldError{
Message: "results type requires \"enable-api-fields\" feature gate to be \"alpha\" but it is \"stable\"",
},
}, {
name: "invalid object properties type",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: v1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1.PropertySpec{"hello": {Type: "wrong type"}},
},
apiFields: "alpha",
expectedError: apis.FieldError{
Message: "The value type specified for these keys [hello] is invalid, the type must be string",
Paths: []string{"MY-RESULT.properties"},
},
}, {
name: "invalid object properties empty",
Result: v1.TaskResult{
Name: "MY-RESULT",
Type: v1.ResultsTypeObject,
Description: "my great result",
},
apiFields: "alpha",
expectedError: apis.FieldError{
Message: "missing field(s)",
Paths: []string{"MY-RESULT.properties"},
},
}}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
4 changes: 4 additions & 0 deletions pkg/apis/pipeline/v1/task_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,10 @@ func TestTaskSpecValidate(t *testing.T) {
Name: "MY-RESULT",
Type: v1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1.PropertySpec{
"url": {"string"},
"commit": {"string"},
},
}},
},
}, {
Expand Down
27 changes: 26 additions & 1 deletion pkg/apis/pipeline/v1beta1/result_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ func (tr TaskResult) Validate(ctx context.Context) (errs *apis.FieldError) {
}
// Array and Object is alpha feature
if tr.Type == ResultsTypeArray || tr.Type == ResultsTypeObject {
return errs.Also(version.ValidateEnabledAPIFields(ctx, "results type", config.AlphaAPIFields))
errs := validateObjectResult(tr)
errs = errs.Also(version.ValidateEnabledAPIFields(ctx, "results type", config.AlphaAPIFields))
return errs
}

// Resources created before the result. Type was introduced may not have Type set
Expand All @@ -45,3 +47,26 @@ func (tr TaskResult) Validate(ctx context.Context) (errs *apis.FieldError) {

return nil
}

// validateObjectResult validates the object result and check if the Properties is missing
// for Properties values it will check if the type is string.
func validateObjectResult(tr TaskResult) (errs *apis.FieldError) {
if ParamType(tr.Type) == ParamTypeObject && tr.Properties == nil {
return apis.ErrMissingField(fmt.Sprintf("%s.properties", tr.Name))
}

invalidKeys := []string{}
for key, propertySpec := range tr.Properties {
if propertySpec.Type != ParamTypeString {
invalidKeys = append(invalidKeys, key)
}
}

if len(invalidKeys) != 0 {
return &apis.FieldError{
Message: fmt.Sprintf("The value type specified for these keys %v is invalid, the type must be string", invalidKeys),
Paths: []string{fmt.Sprintf("%s.properties", tr.Name)},
}
}
return nil
}
38 changes: 32 additions & 6 deletions pkg/apis/pipeline/v1beta1/result_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type string",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: "string",
Type: v1beta1.ResultsTypeString,
Description: "my great result",
},

Expand All @@ -53,7 +53,7 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type array",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1beta1.ResultsTypeArray,
Description: "my great result",
},

Expand All @@ -62,10 +62,10 @@ func TestResultsValidate(t *testing.T) {
name: "valid result type object",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1beta1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1beta1.PropertySpec{"hello": {Type: v1beta1.ParamTypeString}},
},

apiFields: "alpha",
}}
for _, tt := range tests {
Expand Down Expand Up @@ -117,7 +117,7 @@ func TestResultsValidateError(t *testing.T) {
name: "invalid array result type in stable",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: "array",
Type: v1beta1.ResultsTypeArray,
Description: "my great result",
},
apiFields: "stable",
Expand All @@ -128,13 +128,39 @@ func TestResultsValidateError(t *testing.T) {
name: "invalid object result type in stable",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: "object",
Type: v1beta1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1beta1.PropertySpec{"hello": {Type: v1beta1.ParamTypeString}},
},
apiFields: "stable",
expectedError: apis.FieldError{
Message: "results type requires \"enable-api-fields\" feature gate to be \"alpha\" but it is \"stable\"",
},
}, {
name: "invalid object properties type",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: v1beta1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1beta1.PropertySpec{"hello": {Type: "wrong type"}},
},
apiFields: "alpha",
expectedError: apis.FieldError{
Message: "The value type specified for these keys [hello] is invalid, the type must be string",
Paths: []string{"MY-RESULT.properties"},
},
}, {
name: "invalid object properties empty",
Result: v1beta1.TaskResult{
Name: "MY-RESULT",
Type: v1beta1.ResultsTypeObject,
Description: "my great result",
},
apiFields: "alpha",
expectedError: apis.FieldError{
Message: "missing field(s)",
Paths: []string{"MY-RESULT.properties"},
},
}}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
4 changes: 4 additions & 0 deletions pkg/apis/pipeline/v1beta1/task_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,10 @@ func TestTaskSpecValidate(t *testing.T) {
Name: "MY-RESULT",
Type: v1beta1.ResultsTypeObject,
Description: "my great result",
Properties: map[string]v1beta1.PropertySpec{
"url": {"string"},
"commit": {"string"},
},
}},
},
}, {
Expand Down