mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
1bf831546a
## What changed? - Add generic hook interface for fine-grained control of behavior in tests - Use the hooks for matching varying behavior tests (force load balancer to target partitions and disable sync match) - Use the hooks to force a race condition in an update-with-start test (by @stephanos) ## Why? To write integration/functional tests that require tweaking behavior of code under test, without affecting non-test builds. ## Potential risks Hooks are disabled by default, so there should be zero risk to production code, and zero overhead (assuming the Go compiler can do very basic inlining and dead code elimination). The downside is that functional tests now have to be run with `-tags test_dep` everywhere. --------- Co-authored-by: Stephan Behnke <[email protected]>
57 lines
2.1 KiB
Go
57 lines
2.1 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2024 Temporal Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
//go:build !test_dep
|
|
|
|
package testhooks
|
|
|
|
import "go.uber.org/fx"
|
|
|
|
var Module = fx.Options(
|
|
fx.Provide(func() (_ TestHooks) { return }),
|
|
)
|
|
|
|
type (
|
|
// TestHooks (in production mode) is an empty struct just so the build works.
|
|
// See TestHooks in test_impl.go.
|
|
//
|
|
// TestHooks are an inherently unclean way of writing tests. They require mixing test-only
|
|
// concerns into production code. In general you should prefer other ways of writing tests
|
|
// wherever possible, and only use TestHooks sparingly, as a last resort.
|
|
TestHooks struct{}
|
|
)
|
|
|
|
// Get gets the value of a test hook. In production mode it always returns the zero value and
|
|
// false, which hopefully the compiler will inline and remove the hook as dead code.
|
|
//
|
|
// TestHooks should be used very sparingly, see comment on TestHooks.
|
|
func Get[T any](_ TestHooks, key Key) (T, bool) {
|
|
var zero T
|
|
return zero, false
|
|
}
|
|
|
|
// Call calls a func() hook if present.
|
|
//
|
|
// TestHooks should be used very sparingly, see comment on TestHooks.
|
|
func Call(_ TestHooks, key Key) {
|
|
}
|