mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Alex ShtinandGitHub
8e8f1b0f7c
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.
## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
84 lines
2.1 KiB
Go
84 lines
2.1 KiB
Go
//go:build test_dep
|
|
|
|
package testhooks
|
|
|
|
import (
|
|
"sync"
|
|
|
|
"go.uber.org/fx"
|
|
)
|
|
|
|
var Module = fx.Options(
|
|
fx.Provide(NewTestHooksImpl),
|
|
)
|
|
|
|
type (
|
|
// TestHooks holds a registry of active test hooks. It should be obtained through fx and
|
|
// used with Get and Set.
|
|
//
|
|
// 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 interface {
|
|
// private accessors; access must go through package-level Get/Set
|
|
get(Key) (any, bool)
|
|
set(Key, any)
|
|
del(Key)
|
|
}
|
|
|
|
// testHooksImpl is an implementation of TestHooks.
|
|
testHooksImpl struct {
|
|
m sync.Map
|
|
}
|
|
)
|
|
|
|
// Get gets the value of a test hook from the registry.
|
|
//
|
|
// TestHooks should be used very sparingly, see comment on TestHooks.
|
|
func Get[T any](th TestHooks, key Key) (T, bool) {
|
|
var zero T
|
|
if th == nil {
|
|
return zero, false
|
|
}
|
|
if val, ok := th.get(key); ok {
|
|
// this is only used in test so we want to panic on type mismatch:
|
|
return val.(T), ok // nolint:revive
|
|
}
|
|
return zero, false
|
|
}
|
|
|
|
// Call calls a func() hook if present.
|
|
//
|
|
// TestHooks should be used very sparingly, see comment on TestHooks.
|
|
func Call(th TestHooks, key Key) {
|
|
if hook, ok := Get[func()](th, key); ok {
|
|
hook()
|
|
}
|
|
}
|
|
|
|
// Set sets a test hook to a value and returns a cleanup function to unset it.
|
|
// Calls to Set and the cleanup functions should form a stack.
|
|
func Set[T any](th TestHooks, key Key, val T) func() {
|
|
th.set(key, val)
|
|
return func() { th.del(key) }
|
|
}
|
|
|
|
// NewTestHooksImpl returns a new instance of a test hook registry. This is provided and used
|
|
// in the main "resource" module as a default, but in functional tests, it's overridden by an
|
|
// explicitly constructed instance.
|
|
func NewTestHooksImpl() TestHooks {
|
|
return &testHooksImpl{}
|
|
}
|
|
|
|
func (th *testHooksImpl) get(key Key) (any, bool) {
|
|
return th.m.Load(key)
|
|
}
|
|
|
|
func (th *testHooksImpl) set(key Key, val any) {
|
|
th.m.Store(key, val)
|
|
}
|
|
|
|
func (th *testHooksImpl) del(key Key) {
|
|
th.m.Delete(key)
|
|
}
|