The current documentation does not specify how to run test_runner.py directly when using the new CMake build system. Attempting to run it without flags leads to a FileNotFoundError: config.ini.
This PR adds a note to test/README.md explaining that users must point to build/test/config.ini using the --configfile flag when running tests from the source root.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/34073.
See the guideline for information on the review process. A summary of reviews will appear here.
72@@ -73,6 +73,10 @@ or can be run through the test_runner harness, eg:
73 build/test/functional/test_runner.py feature_rbf.py
74 ```
75
76+> **Note for CMake users:** The configuration file (`config.ini`) is generated in the build directory. When running the test runner directly, you must specify the path:
77+>
78+> ./test/functional/test_runner.py --configfile=build/test/config.ini
Does your OS not support linking the files?
This shouldn’t matter, as CMake will copy files in this case.
This shouldn’t matter, as CMake will copy files in this case.
Yes, that is my point: With symlinks, it is easy to modify a test and just run it again. With copies, cmake would have to be called every single time?
So I wonder if such a system exists, that is also used by devs.
Thanks for the review!
The main use-case here is improving the new contributor experience. The current README.md lists examples like build/test/functional/test_runner.py feature_rbf.py, which implies that running from the source root is the standard way to run tests. However, on a fresh CMake build (on macOS), this command fails with a FileNotFoundError because it can’t locate config.ini.
I ran into this error myself while setting up. If the preferred workflow is to run tests from inside the build directory (to ensure symlinks work correctly and config is found), I would be happy to update the PR to clarify that in the docs instead of suggesting the --configfile flag.
The current
README.mdlists examples likebuild/test/functional/test_runner.py feature_rbf.py, which implies that running from the source root is the standard way to run tests.
How? ./build/... generally means the build dir, not the source dir.
I ran into this error myself while setting up. If the preferred workflow is to run tests from inside the build directory (to ensure symlinks work correctly and config is found), I would be happy to update the PR to clarify that in the docs instead of suggesting the
--configfileflag.
Sure, but I fail to see which places in the docs are not up to date?