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.

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

Audit assertion improvements: Type check mandatory fields #6987

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
19 changes: 15 additions & 4 deletions base/audit_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ package base

import (
"fmt"
"reflect"
"strconv"
)

Expand Down Expand Up @@ -133,7 +134,7 @@ func (f AuditFields) expandMandatoryFieldGroups(groups []fieldGroup) {

func (i AuditID) MustValidateFields(f AuditFields) {
if err := i.ValidateFields(f); err != nil {
panic(fmt.Errorf("audit event %s(%s) invalid:\n%v", AuditEvents[i].Name, i, err))
panic(fmt.Errorf("audit event %q (%s) invalid:\n%v", i, AuditEvents[i].Name, err))
Copy link
Member Author

Choose a reason for hiding this comment

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

I changed this just to align with the existing assertion messages in TestAuditLoggingFields

}
}

Expand All @@ -151,15 +152,25 @@ func (i AuditID) ValidateFields(f AuditFields) error {
func mandatoryFieldsPresent(fields, mandatoryFields AuditFields, baseName string) error {
me := &MultiError{}
for k, v := range mandatoryFields {
if _, ok := fields[k]; !ok {
me = me.Append(fmt.Errorf("missing mandatory field %s", baseName+k))
continue
}
if !matchingTypes(v, fields[k]) {
me = me.Append(fmt.Errorf("field value for %s%s must be of type %T but had %T", baseName, k, v, fields[k]))
continue
}
// recurse if map
if vv, ok := v.(map[string]any); ok {
if pv, ok := fields[k].(map[string]any); ok {
me = me.Append(mandatoryFieldsPresent(pv, vv, baseName+k+"."))
}
}
if _, ok := fields[k]; !ok {
me = me.Append(fmt.Errorf("missing mandatory field %s", baseName+k))
}
}
return me.ErrorOrNil()
}

// matchingTypes returns true if the types of a and b are the same.
func matchingTypes(a, b any) bool {
return reflect.TypeOf(a).Kind() == reflect.TypeOf(b).Kind()
Copy link
Member Author

Choose a reason for hiding this comment

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

This is too strict for fields we rely on JSON marshalling for... Need to rethink with some spare time.

field value for timestamp must be of type string but had time.Time
field value for id must be of type int but had uint64

}
Loading