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

Validate Array and Map for struct:pkg:path Meta #3474

Merged
merged 6 commits into from
Feb 7, 2024
Merged

Validate Array and Map for struct:pkg:path Meta #3474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0006875
Add and use expr.AttributeExpr.validatePkgPath()
tchssk Feb 1, 2024
e82730b
Add test cases about conflicting custom packages
tchssk Feb 1, 2024
2b4da97
Avoid panic in test
tchssk Feb 1, 2024
b5cf1ae
Validate Array for struct:pkg:path Meta
tchssk Feb 1, 2024
1eb3d7d
Validate Map key for struct:pkg:path Meta
tchssk Feb 1, 2024
066c44b
Validate Map element for struct:pkg:path Meta
tchssk Feb 1, 2024
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
37 changes: 26 additions & 11 deletions expr/attribute.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,17 +225,7 @@ func (a *AttributeExpr) Validate(ctx string, parent eval.Expression) *eval.Valid
}
}
for _, nat := range *o {
if ut, ok := nat.Attribute.Type.(UserType); pkgPath != "" && ok {
// This check ensures we error if a sub-type has a different custom package type set
// or if two user types have different custom packages but share a sub-type (field that's a user type)
if ut.Attribute().Meta != nil &&
ut.Attribute().Meta["struct:pkg:path"] != nil &&
ut.Attribute().Meta["struct:pkg:path"][0] != pkgPath {
verr.Add(a, "type \"%s\" has conflicting packages %s and %s", ut.Name(), ut.Attribute().Meta["struct:pkg:path"][0], pkgPath)
}

ut.Attribute().AddMeta("struct:pkg:path", pkgPath)
}
verr.Merge(a.validatePkgPath(pkgPath, nat.Attribute.Type))
ctx = fmt.Sprintf("field %s", nat.Name)
verr.Merge(nat.Attribute.Validate(ctx, parent))
}
Expand Down Expand Up @@ -275,6 +265,31 @@ func (a *AttributeExpr) Validate(ctx string, parent eval.Expression) *eval.Valid
return verr
}

func (a *AttributeExpr) validatePkgPath(pkgPath string, t DataType) *eval.ValidationErrors {
verr := new(eval.ValidationErrors)
if ar := AsArray(t); ar != nil {
verr.Merge(a.validatePkgPath(pkgPath, ar.ElemType.Type))
}
if mp := AsMap(t); mp != nil {
verr.Merge(a.validatePkgPath(pkgPath, mp.KeyType.Type))
verr.Merge(a.validatePkgPath(pkgPath, mp.ElemType.Type))
}
if ut, ok := t.(UserType); pkgPath != "" && ok {
// This check ensures we error if a sub-type has a different custom package type set
// or if two user types have different custom packages but share a sub-type (field that's a user type)
if ut.Attribute().Meta != nil &&
ut.Attribute().Meta["struct:pkg:path"] != nil &&
ut.Attribute().Meta["struct:pkg:path"][0] != pkgPath {
verr.Add(a, "type \"%s\" has conflicting packages %s and %s", ut.Name(), ut.Attribute().Meta["struct:pkg:path"][0], pkgPath)
}
ut.Attribute().AddMeta("struct:pkg:path", pkgPath)
}
if len(verr.Errors) > 0 {
return verr
}
return nil
}

// Finalize merges base and reference type attributes and finalizes the Type
// attribute.
func (a *AttributeExpr) Finalize() {
Expand Down
112 changes: 111 additions & 1 deletion expr/attribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,114 @@ func TestAttributeExprValidate(t *testing.T) {
},
expected: &eval.ValidationErrors{Errors: []error{errConflictingTypes}},
},
"conflicting custom packages between sub-type in array and parent": {
typ: &UserTypeExpr{
TypeName: "FirstType",
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types"}},
Type: &Object{
&NamedAttributeExpr{
Name: "thing",
Attribute: &AttributeExpr{
Type: &Array{
ElemType: &AttributeExpr{
Type: &UserTypeExpr{
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types2"}},
Type: &Object{
&NamedAttributeExpr{
Name: "Description",
Attribute: &AttributeExpr{
Type: String,
},
},
},
},
TypeName: "SecondType",
},
},
},
},
},
},
},
},
expected: &eval.ValidationErrors{Errors: []error{errConflictingTypes}},
},
"conflicting custom packages between sub-type in map key and parent": {
typ: &UserTypeExpr{
TypeName: "FirstType",
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types"}},
Type: &Object{
&NamedAttributeExpr{
Name: "thing",
Attribute: &AttributeExpr{
Type: &Map{
KeyType: &AttributeExpr{
Type: &UserTypeExpr{
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types2"}},
Type: &Object{
&NamedAttributeExpr{
Name: "Description",
Attribute: &AttributeExpr{
Type: String,
},
},
},
},
TypeName: "SecondType",
},
},
ElemType: &AttributeExpr{
Type: String,
},
},
},
},
},
},
},
expected: &eval.ValidationErrors{Errors: []error{errConflictingTypes}},
},
"conflicting custom packages between sub-type in map element and parent": {
typ: &UserTypeExpr{
TypeName: "FirstType",
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types"}},
Type: &Object{
&NamedAttributeExpr{
Name: "thing",
Attribute: &AttributeExpr{
Type: &Map{
KeyType: &AttributeExpr{
Type: String,
},
ElemType: &AttributeExpr{
Type: &UserTypeExpr{
AttributeExpr: &AttributeExpr{
Meta: MetaExpr{"struct:pkg:path": []string{"types2"}},
Type: &Object{
&NamedAttributeExpr{
Name: "Description",
Attribute: &AttributeExpr{
Type: String,
},
},
},
},
TypeName: "SecondType",
},
},
},
},
},
},
},
},
expected: &eval.ValidationErrors{Errors: []error{errConflictingTypes}},
},
}

for k, tc := range cases {
Expand All @@ -414,7 +522,9 @@ func TestAttributeExprValidate(t *testing.T) {
if actual := attribute.Validate(ctx, nil); tc.expected != actual {
if len(tc.expected.Errors) != len(actual.Errors) {
t.Errorf("%s: expected the number of error values to match %d got %d ", k, len(tc.expected.Errors), len(actual.Errors))
t.Errorf("%#v", actual.Errors[0])
if len(actual.Errors) > 0 {
t.Errorf("%#v", actual.Errors[0])
}
} else {
for i, err := range actual.Errors {
if err.Error() != tc.expected.Errors[i].Error() {
Expand Down