Simulation framework for multi-client server testing #358
Conversation
This file contains 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
This PR introduces a simulation framework designed to test the server by simulating multiple clients performing various actions over several rounds. The framework reads simulation configurations from YAML files, validates them against a predefined schema, and executes the simulation accordingly. Here's a summary of the key changes made: 1. **New `simulation` Module**: - Added a new Go module `simulation` with its own `go.mod` and `go.sum`. - Introduced a main application for running simulations based on a YAML configuration. - Included functions for setting up clients, performing actions like onboarding, sending transactions, and claiming funds. - Added validation of simulation configuration against a schema using `gojsonschema`. 2. **Simulation Configuration**: - Added `simulation1.yaml` as an example configuration file for running simulations. - Defined a `schema.yaml` for validating simulation configurations. 3. **`.gitignore` Updates**: - Added `.idea` to ignore IntelliJ IDEA project files. 4. **`Dockerfile` Update**: - Updated the base image version of Golang from `1.23.1` to `1.23.2`. 5. **`go.work` Update**: - Updated the Go version from `1.23.1` to `1.23.2`. - Added a new directory `./simulation` to the workspace. 6. **`go.work.sum` Update**: - Added new dependencies `github.com/coreos/go-systemd` and `github.com/go-task/slim-sprig`. 7. **`e2e_test.go` Modifications**: - Removed the `setupAspWallet` function and replaced its usage with `utils.SetupAspWalletCovenantless`. 8. **`test_utils.go` Modifications**: - Added a new function `SetupAspWalletCovenantless` to handle wallet setup with optional initial funding.
tiero
requested changes
Oct 18, 2024
There was a problem hiding this comment.
I would not bump version in this PR, best to make one to go in master in a dedicated commit before this if is needed. Want to square out potential bugs/replication issues coming from different go versions.
Also please add a README documentation on how to run the simulation
tiero
reviewed
Oct 18, 2024
Reverted |
tiero
reviewed
Oct 18, 2024
altafan
reviewed
Oct 18, 2024
altafan
reviewed
Oct 18, 2024
altafan
reviewed
Oct 18, 2024
bordalix
approved these changes
Oct 21, 2024
simulation/schema.yaml
Outdated
| - number: int(min=1) | ||
| actions: | ||
| regex('^client_\d+$'): | ||
| - type: enum('Onboard', 'SendAsync', 'SendOffchain', 'SendOnchain', 'Claim', 'CollaborativeExit', 'UnilateralExit') |
There was a problem hiding this comment.
In order to maintain coherence with method's names, I think "CollaborativeExit" should be renamed to "CollaborativeRedeem"
Suggested change
| - type: enum('Onboard', 'SendAsync', 'SendOffchain', 'SendOnchain', 'Claim', 'CollaborativeExit', 'UnilateralExit') | |
| - type: enum('Onboard', 'SendAsync', 'SendOffchain', 'SendOnchain', 'Claim', 'CollaborativeRedeem', 'UnilateralExit') |
There was a problem hiding this comment.
but redeem can be confused with Redeem Tx for oor?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This introduces a simulation framework designed to test the server by simulating multiple clients performing various actions over several rounds. The framework reads simulation configurations from YAML files, validates them against a predefined schema, and executes the simulation accordingly.
simulation1.yaml is configured as per this requirement, but this was created with idea that any scenario can be configured.
@tiero @altafan @louisinger @bordalix please review.