Make test_framework available for users when creating scenarios#621
Merged
m3dwards merged 13 commits intobitcoin-dev-project:mainfrom Sep 30, 2024
Merged
Make test_framework available for users when creating scenarios#621m3dwards merged 13 commits intobitcoin-dev-project:mainfrom
m3dwards merged 13 commits intobitcoin-dev-project:mainfrom
Conversation
Collaborator
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones: If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
This was referenced Sep 26, 2024
scenarios will need a callable entrypoint for the pyz archive
also filter out unused files from the archive sent to the commander
f5641e0 to
5ee0c8b
Compare
Collaborator
|
LGTM. I changed the test_framework and I checked that this change was reflected the next time I ran a scenario. Will be very useful! |
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
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 changes two important things about how scenarios are written:
test_frameworkmain()function, instead of (or in addition to) the__name__ == "__main__"logic:example:
Projects
When a user creates a project, they will get a
scenarios/directory which includes our default scenarios likeminer_std.pyas well as a complete copy oftest_framework. They are welcome to edit the framework, the code in that directory is actually deployed.Running Scenarios
When executing
warnet run <path>this PR bundles up the scenario file,commander.pyand the entiretest_frameworkdirectory into a.pyzarchive which is compressed, base64 encoded, and added to a volume via an initContainer that is deployed along with a vanilla, unmodified image ofpython:3.12-slim.Side effects
The grossest thing about this PR in my opinion is that all the scenarios we use only for tests have to be moved as well, so they are in a directory with
test_framework. To deal with that, I adjusted the "exclude" logic incopy_scenario_defaults()to filter by regex and then excludetestscenario_*.py.TODO
warnet initon an empty directory, runs a network and scenario from there to fully test the user flow (reccomend reviewers do this!)