-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(dispatch): When registering, compare methods to impl
Registering MethodSets compares the MethodSet against the implementation to make sure they match each other. Add tests for dispatch to ensure common failure cases actually work.
- Loading branch information
Showing
3 changed files
with
261 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| package lib | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestRegisterMethods(t *testing.T) { | ||
| ctx := context.Background() | ||
|
|
||
| inst, cleanup := NewMemTestInstance(ctx, t) | ||
| defer cleanup() | ||
| m := &animalMethods{d: inst} | ||
|
|
||
| reg := make(map[string]callable) | ||
| inst.registerOne("animal", m, animalImpl{}, reg) | ||
|
|
||
| expectToPanic(t, func() { | ||
| reg = make(map[string]callable) | ||
| inst.registerOne("animal", m, badAnimalOneImpl{}, reg) | ||
| }, "animal.cat: bad number of outputs: 1") | ||
|
|
||
| expectToPanic(t, func() { | ||
| reg = make(map[string]callable) | ||
| inst.registerOne("animal", m, badAnimalTwoImpl{}, reg) | ||
| }, "method Doggie not found on MethodSet") | ||
|
|
||
| expectToPanic(t, func() { | ||
| reg = make(map[string]callable) | ||
| inst.registerOne("animal", m, badAnimalThreeImpl{}, reg) | ||
| }, "animal.cat: second input param should be scope, got context.Context") | ||
|
|
||
| expectToPanic(t, func() { | ||
| reg = make(map[string]callable) | ||
| inst.registerOne("animal", m, badAnimalFourImpl{}, reg) | ||
| }, "animal.dog: third input param must be a struct pointer, got string") | ||
|
|
||
| expectToPanic(t, func() { | ||
| reg = make(map[string]callable) | ||
| inst.registerOne("animal", m, badAnimalFiveImpl{}, reg) | ||
| }, "*lib.animalMethods: did not find implementation for method Dog") | ||
| } | ||
|
|
||
| func expectToPanic(t *testing.T, regFunc func(), expectMessage string) { | ||
| t.Helper() | ||
|
|
||
| doneCh := make(chan error) | ||
| panicMessage := "" | ||
|
|
||
| go func() { | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| panicMessage = fmt.Sprintf("%s", r) | ||
| } | ||
| doneCh <- nil | ||
| }() | ||
| regFunc() | ||
| }() | ||
| // Block until the goroutine is done | ||
| _ = <- doneCh | ||
|
|
||
| if panicMessage == "" { | ||
| t.Errorf("expected a panic, did not get one") | ||
| } else if panicMessage != expectMessage { | ||
| t.Errorf("error mismatch, expect: %q, got: %q", expectMessage, panicMessage) | ||
| } | ||
| } | ||
|
|
||
| // Test data: methodSet and implementation | ||
|
|
||
| type animalMethods struct { | ||
| d dispatcher | ||
| } | ||
|
|
||
| func (m *animalMethods) Name() string { | ||
| return "animal" | ||
| } | ||
|
|
||
| type animalParams struct { | ||
| Name string | ||
| } | ||
|
|
||
| func (m *animalMethods) Cat(ctx context.Context, p *animalParams) (string, error) { | ||
| got, err := m.d.Dispatch(ctx, dispatchMethodName(m, "cat"), p) | ||
| if res, ok := got.(string); ok { | ||
| return res, err | ||
| } | ||
| return "", dispatchReturnError(got, err) | ||
| } | ||
|
|
||
| func (m *animalMethods) Dog(ctx context.Context, p *animalParams) (string, error) { | ||
| got, err := m.d.Dispatch(ctx, dispatchMethodName(m, "dog"), p) | ||
| if res, ok := got.(string); ok { | ||
| return res, err | ||
| } | ||
| return "", dispatchReturnError(got, err) | ||
| } | ||
|
|
||
| // Good implementation | ||
|
|
||
| type animalImpl struct {} | ||
|
|
||
| func (animalImpl) Cat(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says meow", p.Name), nil | ||
| } | ||
|
|
||
| func (animalImpl) Dog(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says bark", p.Name), nil | ||
| } | ||
|
|
||
| // Bad implementation #1 (cat doesn't return an error) | ||
|
|
||
| type badAnimalOneImpl struct {} | ||
|
|
||
| func (badAnimalOneImpl) Cat(scp scope, p *animalParams) string { | ||
| return fmt.Sprintf("%s says meow", p.Name) | ||
| } | ||
|
|
||
| func (badAnimalOneImpl) Dog(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says bark", p.Name), nil | ||
| } | ||
|
|
||
| // Bad implementation #2 (dog method name doesn't match) | ||
|
|
||
| type badAnimalTwoImpl struct {} | ||
|
|
||
| func (badAnimalTwoImpl) Cat(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says meow", p.Name), nil | ||
| } | ||
|
|
||
| func (badAnimalTwoImpl) Doggie(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says bark", p.Name), nil | ||
| } | ||
|
|
||
| // Bad implementation #3 (cat doesn't accept a scope) | ||
|
|
||
| type badAnimalThreeImpl struct {} | ||
|
|
||
| func (badAnimalThreeImpl) Cat(ctx context.Context, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says meow", p.Name), nil | ||
| } | ||
|
|
||
| func (badAnimalThreeImpl) Dog(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says bark", p.Name), nil | ||
| } | ||
|
|
||
| // Bad implementation #4 (dog input struct doesn't match) | ||
|
|
||
| type badAnimalFourImpl struct {} | ||
|
|
||
| func (badAnimalFourImpl) Cat(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says meow", p.Name), nil | ||
| } | ||
|
|
||
| func (badAnimalFourImpl) Dog(scp scope, name string) (string, error) { | ||
| return fmt.Sprintf("%s says bark", name), nil | ||
| } | ||
|
|
||
| // Bad implementation #5 (dog method is missing) | ||
|
|
||
| type badAnimalFiveImpl struct {} | ||
|
|
||
| func (badAnimalFiveImpl) Cat(scp scope, p *animalParams) (string, error) { | ||
| return fmt.Sprintf("%s says meow", p.Name), nil | ||
| } |
Oops, something went wrong.