-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Add chasm test engine for unit tests #9882
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
awln-temporal
wants to merge
10
commits into
main
Choose a base branch
from
awln/chasm-test-engine-base
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+898
−87
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
ea21b9b
Add chasm test engine for engine-backed tests
awln-temporal 171cdf0
Fix test engine root component constraint
awln-temporal 267e896
Remove unnecessary helper to create Root
awln-temporal 9c6bf52
Merge branch 'main' into awln/chasm-test-engine-base
awln-temporal 54ecfd9
Address comments
awln-temporal ab0e979
Address comments
awln-temporal 2e57fc9
fix formatting in tasks_test.go
awln-temporal 1693f89
Merge branch 'main' into awln/chasm-test-engine-base
awln-temporal 66b376f
Remove Ref() helper from chasmtest.Engine
awln-temporal 67b4815
Add conflict policy handling and fuller impl of MockNodeBackend
awln-temporal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package chasmtest | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "go.temporal.io/server/chasm" | ||
| ) | ||
|
|
||
| // ExecutePureTask validates and executes a pure task atomically via [Engine.UpdateComponent]. | ||
| // It returns taskDropped=true if [chasm.PureTaskHandler.Validate] returns (false, nil), | ||
| // indicating the task is no longer relevant and was not executed. | ||
| // | ||
| // For root components, construct ref with [chasm.NewComponentRef]. For subcomponents, obtain | ||
| // the ref via [chasm.Context.Ref] inside a [Engine.ReadComponent] or [Engine.UpdateComponent] | ||
| // callback and deserialize it with [chasm.DeserializeComponentRef]. | ||
| // | ||
| // This helper ensures that Validate is always exercised alongside Execute, matching the real | ||
| // engine's behavior. Use [chasm.MockMutableContext] directly when you need to inspect the | ||
| // typed task payloads added to the context during execution. | ||
| func ExecutePureTask[C chasm.Component, T any]( | ||
| ctx context.Context, | ||
| e *Engine, | ||
| ref chasm.ComponentRef, | ||
| handler chasm.PureTaskHandler[C, T], | ||
| attrs chasm.TaskAttributes, | ||
| task T, | ||
| ) (taskDropped bool, err error) { | ||
| engineCtx := chasm.NewEngineContext(ctx, e) | ||
| _, err = e.UpdateComponent( | ||
| engineCtx, | ||
| ref, | ||
| func(mutableCtx chasm.MutableContext, c chasm.Component) error { | ||
| typedC, ok := c.(C) | ||
| if !ok { | ||
| return fmt.Errorf("component type mismatch: got %T", c) | ||
| } | ||
| var valid bool | ||
| valid, err = handler.Validate(mutableCtx, typedC, attrs, task) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !valid { | ||
| taskDropped = true | ||
| return nil | ||
| } | ||
| return handler.Execute(mutableCtx, typedC, attrs, task) | ||
| }, | ||
| ) | ||
| return taskDropped, err | ||
| } | ||
|
|
||
| // ExecuteSideEffectTask validates and executes a side-effect task. | ||
| // Validation runs via [Engine.ReadComponent] (read-only), and if valid, | ||
| // [chasm.SideEffectTaskHandler.Execute] is called with an engine context so that | ||
| // [chasm.UpdateComponent] and [chasm.ReadComponent] inside the handler route through | ||
| // the test engine. | ||
| // | ||
| // It returns taskDropped=true if [chasm.SideEffectTaskHandler.Validate] returns (false, nil), | ||
| // indicating the task is no longer relevant and was not executed. | ||
| // | ||
| // For root components, construct ref with [chasm.NewComponentRef]. For subcomponents, obtain | ||
| // the ref via [chasm.Context.Ref] inside a [Engine.ReadComponent] or [Engine.UpdateComponent] | ||
| // callback and deserialize it with [chasm.DeserializeComponentRef]. | ||
| // | ||
| // Use [chasm.MockMutableContext] directly when you need to inspect typed task payloads added | ||
| // during execution, since the real engine serializes them into history layer tasks. | ||
| func ExecuteSideEffectTask[C chasm.Component, T any]( | ||
| ctx context.Context, | ||
| e *Engine, | ||
| ref chasm.ComponentRef, | ||
| handler chasm.SideEffectTaskHandler[C, T], | ||
| attrs chasm.TaskAttributes, | ||
| task T, | ||
| ) (taskDropped bool, err error) { | ||
| engineCtx := chasm.NewEngineContext(ctx, e) | ||
|
|
||
| var valid bool | ||
| if err = e.ReadComponent( | ||
| engineCtx, | ||
| ref, | ||
| func(chasmCtx chasm.Context, c chasm.Component) error { | ||
| typedC, ok := c.(C) | ||
| if !ok { | ||
| return fmt.Errorf("component type mismatch: got %T", c) | ||
| } | ||
| valid, err = handler.Validate(chasmCtx, typedC, attrs, task) | ||
| return err | ||
| }, | ||
| ); err != nil { | ||
| return false, err | ||
| } | ||
| if !valid { | ||
| return true, nil | ||
| } | ||
|
|
||
| return false, handler.Execute(engineCtx, ref, attrs, task) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These helpers are a bit redundant to me but no strong objection to keep them.