mirror of
https://github.com/hanzoai/tasks.git
synced 2026-11-03 03:56:04 +00:00
zeekay
5a601d081b
Full module path rebrand from Temporal to Hanzo Tasks: - go.mod module: github.com/hanzoai/tasks - All internal Go imports updated (1906 files) - cmd/server renamed to cmd/tasksd - Binary name: tasksd (was temporal-server) - Docker images: hanzoai/tasks (was temporalio/server) - README rewritten with Hanzo Tasks branding - LLM.md created with integration notes - Makefile, goreleaser, CI workflows updated - go.temporal.io/sdk and go.temporal.io/api imports preserved (separate repos) Fork of Temporal.io (MIT license).
46 lines
2.0 KiB
Go
46 lines
2.0 KiB
Go
// softassert provides utilities for performing assertions.
|
|
//
|
|
// Unlike traditional assertions that may terminate the program or panic, soft assertions log an
|
|
// error message when a condition is not met but allow the program to continue running. The runner
|
|
// of the program, such as a Go test, is expected to flag failed assertions.
|
|
//
|
|
// Best practices:
|
|
// - Use it to check for programming errors and invariants.
|
|
// - Use it to communicate assumptions about the code.
|
|
// - Use it to abort or recover from an unexpected state.
|
|
// - Never use it as a substitute for regular error handling, validation, or control flow.
|
|
package softassert
|
|
|
|
import (
|
|
"github.com/hanzoai/tasks/common/log"
|
|
"github.com/hanzoai/tasks/common/log/tag"
|
|
)
|
|
|
|
// That performs a soft assertion by logging an error if the given condition is false.
|
|
// It is meant to indicate a condition is always expected to be true.
|
|
// Returns true if the condition is met, otherwise false.
|
|
//
|
|
// `staticMessage` is expected to be a static string to help with grouping and searching logs.
|
|
// Dynamic information should be passed via `tags`.
|
|
//
|
|
// Example:
|
|
// softassert.That(logger, object.state == "ready", "object is not ready")
|
|
func That(logger log.Logger, condition bool, staticMessage string, tags ...tag.Tag) bool {
|
|
if !condition {
|
|
// By using the same prefix for all assertions, they can be reliably found in logs.
|
|
logger.Error("failed assertion: "+staticMessage, append([]tag.Tag{tag.FailedAssertion}, tags...)...)
|
|
}
|
|
return condition
|
|
}
|
|
|
|
// Fail logs an error using `staticMessage` to indicate a failed assertion.
|
|
//
|
|
// `staticMessage` is expected to be a static string to help with grouping and searching logs.
|
|
// Dynamic information should be passed via `tags`.
|
|
//
|
|
// Example:
|
|
// softassert.Fail(logger, "unreachable code reached", tag.String("state", object.state))
|
|
func Fail(logger log.Logger, staticMessage string, tags ...tag.Tag) {
|
|
logger.Error("failed assertion: "+staticMessage, append([]tag.Tag{tag.FailedAssertion}, tags...)...)
|
|
}
|