Files
tasks/temporaltest/options.go
69ea501e38 Migrate temporalite & temporaltest packages (#4026)
<!-- Describe what has changed in this PR -->
**What changed?**

Moved `temporalite` and `temporaltest` packages from Temporalite. This
is an alternate version of
https://github.com/temporalio/temporal/pull/4006.

<!-- Tell your future self why have you made these changes -->
**Why?**

Step 1 in the plan to deprecate the Temporalite repository:
https://github.com/temporalio/temporalite/issues/202

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**

`go test ./temporaltest`

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**

A non-semver-breaking backwards compatibility guarantee is being
included in the new packages which we would need to abide by. For now
only the `temporaltest` package is public, so we are free to perform
additional refactoring on `temporalite` and potentially consolidate it
into a simple set of `temporal.ServerOption` functions.

<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**

No

---------

Co-authored-by: Yimin Chen <[email protected]>
2023-10-17 22:07:05 -07:00

80 lines
2.8 KiB
Go

// The MIT License
//
// Copyright (c) 2021 Datadog, Inc.
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber 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.
package temporaltest
import (
"testing"
"go.temporal.io/sdk/client"
"go.temporal.io/sdk/worker"
"go.temporal.io/server/temporal"
)
type TestServerOption interface {
apply(*TestServer)
}
type applyFunc func(*TestServer)
func (f applyFunc) apply(s *TestServer) { f(s) }
// WithT directs all worker and client logs to the test logger.
//
// If this option is specified, then server will automatically be stopped when the
// test completes.
func WithT(t *testing.T) TestServerOption {
return applyFunc(func(server *TestServer) {
server.t = t
})
}
// WithBaseClientOptions configures options for the default clients and workers connected to the test server.
func WithBaseClientOptions(o client.Options) TestServerOption {
return applyFunc(func(server *TestServer) {
server.defaultClientOptions = o
})
}
// WithBaseWorkerOptions configures default options for workers connected to the test server.
//
// WorkflowPanicPolicy is always set to worker.FailWorkflow so that workflow executions
// fail fast when workflow code panics or detects non-determinism.
func WithBaseWorkerOptions(o worker.Options) TestServerOption {
o.WorkflowPanicPolicy = worker.FailWorkflow
return applyFunc(func(server *TestServer) {
server.defaultWorkerOptions = o
})
}
// WithBaseServerOptions enables configuring additional server options not directly exposed via temporaltest.
func WithBaseServerOptions(options ...temporal.ServerOption) TestServerOption {
return applyFunc(func(server *TestServer) {
server.serverOptions = append(server.serverOptions, options...)
})
}