Re-structured functional tests. #402
Conversation
Davidson-Souza
added
dependencies
qlrd
force-pushed
the
uv-dep-management
branch
2 times, most recently
from
94d6357 to
9fef5fc
Compare
README.md
Outdated
| # recomended way | ||
| pipx install poetry | ||
| # create a virtual environment | ||
| # (it's good to not messing up with your OS) |
There was a problem hiding this comment.
nit: it's good to not mess up with your os
| # official isntaller (windows - powershell) | ||
| (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py - | ||
| # Alternatively, you can synchronize it | ||
| uv sync |
There was a problem hiding this comment.
Isn't uv pip install -r pyproject.toml redundant with uv sync?
There was a problem hiding this comment.
From what i understood in docs:
-
uv pip install -r pyproject.tomlinstalls dependencies listed inpyproject.toml(in local development environment, it do not remove existing packages). -
uv syncuses theuv.lockfile to enforce reproducible installations.
So the sync reproduced what i made here. Maybe it's better add this warning?
|
|
||
| ```bash | ||
| pip3 install -r tests/requirements.txt | ||
| python tests/run_tests.py | ||
| uv run tests/run_tests.py --test-suite <suite> |
There was a problem hiding this comment.
Add that to run all tests, just omit --test-suite.
Also, is there a way to list all available ones?
There was a problem hiding this comment.
I made the same suggestion to @qlrd while he was at casavinteum. And looks like he already implemented.
When tests.py are invoked without -t or --test-suite set, it computes every subfolder of tests/ as a suite. test_framework isnt added as suite.
There was a problem hiding this comment.
i agree with davidson, a uv run tests/run_tests.py --list-suites would be nice, one that is debugging our python tests can use this command to undersand what run_tests.py see as a suite.
There was a problem hiding this comment.
Sure!
@jaoleal, i improved it and i think is more clear. I added here a --list-suite and will do a rebase.
| from test_framework.test_framework import FlorestaTestFramework | ||
| from test_framework.electrum_client import ElectrumClient | ||
| from test_framework.floresta_rpc import REGTEST_RPC_SERVER | ||
| from tests.test_framework.test_framework import FlorestaTestFramework |
There was a problem hiding this comment.
Isn't there a way to set the root dir to /tests/. Not a roadblocker, but a minor annoyance to need this tests.*
There was a problem hiding this comment.
Not sure, i will need try here @Davidson-Souza.
This commit aims to optmize developer flow and the experience with tests tool through 1) a replacement of the current python package management; 2) a more organized folder tree strucutre inside tests/; and 3) changes in tests/run_tests.py, tests/prepare.sh and tests/run.sh to comply with the already mentioned changes. The replacement in python package management is from poetry to uv (a rust-based python management tool); this approach have some PROS: (i) built with rust; (ii) faster than poetry; (iii) cleanup some unecessary python dependencies; (iv) more readable pyproject.toml; (v) compatible with python pip install -r approach (for old-school pythonists). Until now, a CON is: (i) this remove some poetry macros. Still seems like a good replacement. The folder structure organization allows you to define test suites in separate folders (e.g. "florestad", "floresta-cli") without needing to define each of them in pyproject.toml. Files ending with "-test.py" in each folder will be recognized and executed. To comply with above mentioned changes, tests/run_tests.py was modified to inlcude an argument `--test-suite` that will search for a folder `tests/<test-suite>`. It was also necessary to change `tests/prepare.sh` and `tests/run.sh` to replace poetry to uv. The README helps the developer to: (i) install uv; (ii) configure functional test environment; (iii) format code; (iv) lint code; (v) run tests. It also updated .gitignore so it can help to avoid add .venv folder that is created by uv tool. updated run_tests.py updated README updated run_tests.py
Improves #252
What is the purpose of this pull request?
Which crates are being modified?
Description
This re-structure aims to optmize developer flow and the experience with tests tool through 1) a replacement of the current python package management; 2) a more organized folder tree strucutre inside tests/; and 3) changes in tests/run_tests.py, tests/prepare.sh and tests/run.sh to comply with the already mentioned changes.
The replacement in python package management is from poetry to uv (a rust-based python management tool); this approach have some PROS: (i) built with rust; (ii) faster than poetry; (iii) cleanup some unecessary python dependencies; (iv) more readable pyproject.toml; (v) compatible with python pip install -r approach (for old-school pythonists). Until now, a CON is: (i) this remove some poetry macros. Still seems like a good replacement.
The folder structure organization allows you to define test suites in separate folders (e.g. "florestad", "floresta-cli") without needing to define each of them in pyproject.toml. Files ending with "-test.py" in each folder will be recognized and executed.
To comply with above mentioned changes, tests/run_tests.py was modified to inlcude an argument
--test-suitethat will search for a foldertests/<test-suite>. It was also necessary to changetests/prepare.shandtests/run.shto replace poetry to uv.Notes to the reviewers
A better context about this change is available in #252 (comment) and #391. Tested this approach in https://github.com/qlrd/Floresta/actions/runs/13722793641/job/38381971781
Checklist
just lintcargo test