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

Audit assertion improvements: Type check mandatory fields #6987

Closed
wants to merge 1 commit into from
Closed

Audit assertion improvements: Type check mandatory fields #6987

wants to merge 1 commit into from

Conversation

bbrks
Copy link
Member

@bbrks bbrks commented Jul 19, 2024

Example output:

panic: audit event "54000" (Create database) invalid:
4 errors:
missing mandatory field remote.ip
missing mandatory field remote.port
field value for id must be of type int but had string
field value for local must be of type map[string]interface {} but had string

Integration Tests

bbrks
bbrks commented Jul 19, 2024
View reviewed changes
base/audit_types.go
@@ -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

base/audit_types.go

// 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

@bbrks
Copy link
Member Author

bbrks commented Jul 19, 2024

will revisit after code complete

@bbrks bbrks closed this Jul 19, 2024
@bbrks bbrks mentioned this pull request Jul 24, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@bbrks