Files
temporal/temporaltest/README.md
Jacob LeGrone eda8e9ae23 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 <yimin.chen@live.com>
2023-10-17 22:07:05 -07:00

629 B

The temporaltest package provides helpers for writing end to end tests against a real Temporal server which can be run via the go test command.

Backwards Compatibility

This package must not break Go API backwards compatibility in accordance with semantic versioning. One exception to this policy is the WithBaseServerOptions function, which may have breaking changes in any Temporal server release.

The base configuration (eg. dynamic config values) and behavior of TestServer may also be modified in any release. Such changes should be for the purposes of improving performance or stability for testing scenarios.