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

Don't call cmp in non testing file #5370

Merged
merged 2 commits into from
May 23, 2022
Merged

Don't call cmp in non testing file #5370

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dbb89d
Don't call cmp in non testing file
zasweq May 19, 2022
6fe1452
Responded to Doug's comments
zasweq May 23, 2022
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
2 changes: 1 addition & 1 deletion xds/internal/balancer/clusterresolver/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func (dm DiscoveryMechanism) Equal(b DiscoveryMechanism) bool {
return false
case dm.DNSHostname != b.DNSHostname:
return false
case !dm.OutlierDetection.Equal(b.OutlierDetection):
case !dm.OutlierDetection.EqualODOnly(b.OutlierDetection):
return false
}

Expand Down
12 changes: 5 additions & 7 deletions xds/internal/balancer/outlierdetection/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ package outlierdetection
import (
"time"

"github.com/google/go-cmp/cmp"
internalserviceconfig "google.golang.org/grpc/internal/serviceconfig"
"google.golang.org/grpc/serviceconfig"
)
Expand Down Expand Up @@ -154,8 +153,10 @@ type LBConfig struct {
ChildPolicy *internalserviceconfig.BalancerConfig `json:"childPolicy,omitempty"`
}

// Equal returns whether the LBConfig is the same with the parameter.
func (lbc *LBConfig) Equal(lbc2 *LBConfig) bool {
// EqualODOnly returns whether the LBConfig is same with the parameter outside
// of the child policy, only comparing the Outlier Detection specific
// configuration.
func (lbc *LBConfig) EqualODOnly(lbc2 *LBConfig) bool {
Copy link
Member

Choose a reason for hiding this comment

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

Nit:

EqualIgnoringChildPolicy?

"ODOnly" seems less informative to me since we're comparing OD LB policy structs in the OD package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Switched.

Copy link
Member

Choose a reason for hiding this comment

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

Also, we should probably have a test of this function that will fail if we add new fields to the config struct.

Even a purely change-detector test would help; something like:

func TestEqualFields(t *testing.T) {
	fields := map[string]bool{"LoadBalancingConfig": true, "Interval": true, "BaseEjectionTime": true, ....}
	t := reflect.TypeOf((*LBConfig)(nil))
	for i := 0; i < t.NumField(); i++ { // that's probably not the right method name
		if n := t.Field(i).Name; !fields[n] {
			t.Error("New field %q; update this test and EqualIgnoringChildPolicy", n)
		}
	}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this change-detector test for every node in the config tree.

if lbc == nil && lbc2 == nil {
return true
}
Expand All @@ -177,8 +178,5 @@ func (lbc *LBConfig) Equal(lbc2 *LBConfig) bool {
if !lbc.SuccessRateEjection.Equal(lbc2.SuccessRateEjection) {
return false
}
if !lbc.FailurePercentageEjection.Equal(lbc2.FailurePercentageEjection) {
return false
}
return cmp.Equal(lbc.ChildPolicy, lbc2.ChildPolicy)
return lbc.FailurePercentageEjection.Equal(lbc2.FailurePercentageEjection)
}