Skip to content

add comments to help devs when a failure occurs #7283

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

Merged
bheni merged 1 commit into from
Jan 9, 2024
Merged

add comments to help devs when a failure occurs #7283

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
18 changes: 15 additions & 3 deletions go/cmd/dolt/commands/sqlserver/minver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,10 @@ func validateMinVerFunc(field reflect.StructField, depth int) error {

minVerTag := field.Tag.Get("minver")
if minVerTag != "" {
if _, err := version.Encode(minVerTag); err != nil {
return fmt.Errorf("invalid minver tag on field %s '%s': %w", field.Name, minVerTag, err)
if minVerTag != "TBD" {
if _, err := version.Encode(minVerTag); err != nil {
return fmt.Errorf("invalid minver tag on field %s '%s': %w", field.Name, minVerTag, err)
}
}
hasMinVer = true
}
Expand Down Expand Up @@ -204,8 +206,16 @@ func TestMinVer(t *testing.T) {
err = structwalk.Walk(&nullableWithOmitEmpty{}, validateMinVerFunc)
require.NoError(t, err)

// validates the actual config struct
err = structwalk.Walk(&YAMLConfig{}, validateMinVerFunc)

// All new fields must:
// 1. Have a yaml tag with a name and omitempty
// 2. They must be nullable
// 3. They must have a minver tag with a value of TBD which will be replaced with the current version
// as part of the release process
//
// example:
// FieldName *string `yaml:"field_name,omitempty" minver:"TBD"`
require.NoError(t, err)
}

Expand Down Expand Up @@ -280,6 +290,8 @@ func TestMinVersionsValid(t *testing.T) {
if errors.Is(err, io.EOF) {
return fmt.Errorf("new field '%s' added", fi.String())
} else {
// You are seeing this error because a new config field was added that didn't meet the requirements.
// See the comment in "TestMinVer" which covers the requirements of new fields.
return fmt.Errorf("expected '%s' but got '%s'", prevFI.String(), fi.String())
}
})
Expand Down