-
-
Notifications
You must be signed in to change notification settings - Fork 511
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement new MultiStrategy design (#580)
* feat: implement new MultiStrategy design design: #559 - add: Strategy#Timeout - add: MultiStrategy#WithDeadline - add: NopStrategy & NopStrategyTarget - deprecate: MultiStrategy#WithStartupTimeout * docs: update Multi Wait Strategy * docs: fix WithStartupTimeout references * review: fix WithPollInterval godoc * review: add wait/all_test.go error tests * refactor: simplify wait/all_test.go * review: remove noopStrategyTarget for NopStrategyTarget * fix: resolve conflicts for NopStrategy * review: move Strategy#Timeout to StrategyTimeout interface Co-authored-by: Manuel de la Peña <[email protected]>
- Loading branch information
1 parent
eb22bbd
commit 9ad2a50
Showing
14 changed files
with
374 additions
and
117 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
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,121 @@ | ||
| package wait | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "errors" | ||
| "io" | ||
| "testing" | ||
| "time" | ||
| ) | ||
|
|
||
| func TestMultiStrategy_WaitUntilReady(t *testing.T) { | ||
| t.Parallel() | ||
| type args struct { | ||
| ctx context.Context | ||
| target StrategyTarget | ||
| } | ||
| tests := []struct { | ||
| name string | ||
| strategy Strategy | ||
| args args | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "returns error when no WaitStrategies are passed", | ||
| strategy: ForAll(), | ||
| args: args{ | ||
| ctx: context.Background(), | ||
| target: NopStrategyTarget{}, | ||
| }, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "returns WaitStrategy error", | ||
| strategy: ForAll( | ||
| ForNop( | ||
| func(ctx context.Context, target StrategyTarget) error { | ||
| return errors.New("intentional failure") | ||
| }, | ||
| ), | ||
| ), | ||
| args: args{ | ||
| ctx: context.Background(), | ||
| target: NopStrategyTarget{}, | ||
| }, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "WithDeadline sets context Deadline for WaitStrategy", | ||
| strategy: ForAll( | ||
| ForNop( | ||
| func(ctx context.Context, target StrategyTarget) error { | ||
| if _, set := ctx.Deadline(); !set { | ||
| return errors.New("expected context.Deadline to be set") | ||
| } | ||
| return nil | ||
| }, | ||
| ), | ||
| ForLog("docker"), | ||
| ).WithDeadline(1 * time.Second), | ||
| args: args{ | ||
| ctx: context.Background(), | ||
| target: NopStrategyTarget{ | ||
| ReaderCloser: io.NopCloser(bytes.NewReader([]byte("docker"))), | ||
| }, | ||
| }, | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "WithStartupTimeoutDefault skips setting context.Deadline when WaitStrategy.Timeout is defined", | ||
| strategy: ForAll( | ||
| ForNop( | ||
| func(ctx context.Context, target StrategyTarget) error { | ||
| if _, set := ctx.Deadline(); set { | ||
| return errors.New("expected context.Deadline not to be set") | ||
| } | ||
| return nil | ||
| }, | ||
| ).WithStartupTimeout(2*time.Second), | ||
| ForLog("docker"), | ||
| ).WithStartupTimeoutDefault(1 * time.Second), | ||
| args: args{ | ||
| ctx: context.Background(), | ||
| target: NopStrategyTarget{ | ||
| ReaderCloser: io.NopCloser(bytes.NewReader([]byte("docker"))), | ||
| }, | ||
| }, | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "WithStartupTimeoutDefault sets context.Deadline for nil WaitStrategy.Timeout", | ||
| strategy: ForAll( | ||
| ForNop( | ||
| func(ctx context.Context, target StrategyTarget) error { | ||
| if _, set := ctx.Deadline(); !set { | ||
| return errors.New("expected context.Deadline to be set") | ||
| } | ||
| return nil | ||
| }, | ||
| ), | ||
| ForLog("docker"), | ||
| ).WithStartupTimeoutDefault(1 * time.Second), | ||
| args: args{ | ||
| ctx: context.Background(), | ||
| target: NopStrategyTarget{ | ||
| ReaderCloser: io.NopCloser(bytes.NewReader([]byte("docker"))), | ||
| }, | ||
| }, | ||
| wantErr: false, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| if err := tt.strategy.WaitUntilReady(tt.args.ctx, tt.args.target); (err != nil) != tt.wantErr { | ||
| t.Errorf("ForAll.WaitUntilReady() error = %v, wantErr = %v", err, tt.wantErr) | ||
| } | ||
| }) | ||
| } | ||
| } |
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
Oops, something went wrong.