GD-607: Fix discovery of root test suites #604
Conversation
|
Hi, thanks for contributing to the project. 👍 Please, before fixing a bug you have to create a bug issue and describe the problem, then build your branch and commit your pull request. Please create a bug report and move the details described here to the bug report. Thanks for your work, I'll take a look at it later |
|
Thank you for the guidance! I'll see about structuring this properly soon. |
MikeSchulze
changed the title
|
Thank you for creating and assigning the error problem. To finally fix the bug, please add the missing test case. Thank you again for your work. |
|
@esainane do you continue here? |
|
I do. My apologies for the delay, I should be free to finish this up shortly. |
The gdUnit4 settings description for `Test Lookup Folder` states: > Subfolder where test suites are located (or empty to use source folder directly) However, leaving this setting empty (or set to /, or res://) will cause gdUnit4 to not find any test suites in the root folder. `scan_test_directories` starts by examining subfolders, though it is very permissive with any of these test directory settings. This refactors external calls to `scan_test_directories` into a `scan_all_test_directories` instead, which performs the common call if any specific test directory is set, and returns the base directory otherwise. With this change, it will now correctly pick up a `[TestSuite]` annotated class at `res://Test.cs`. This would still be bad practice in a proper project, since it has to perform a lot of scanning which a dedicated test directory would avoid. However, this should eliminate much confusion when trying to create a minimal reproducible test project and wondering why the test suite is silently not being detected.
`scan_all_test_directories` will still retrieve the value from settings if not otherwise specified.
esainane
force-pushed
the
root-cause-analysis
branch
from
9189572 to
959b9b1
Compare
Why
The GdUnit4 Godot Editor plugin currently does not find any tests in the project root directory, even when configured to do so.
Fixes #607.
What
scan_test_directoriesinto a newscan_all_test_directoriesinstead. These external calls all had the formscan_test_directorys("res://", GdUnitSettings.test_root_folder(), []). This provides a cleaner API, and a logical place to add handling for the "include all resources" special case.scan_all_test_directoriesis called to determine which resource paths should be included, and the project is configured to include all resources, it early returns["res://"]. Otherwise, it performs the current subfolder scanning logic viascan_test_directories("res://", GdUnitSettings.test_root_folder(), []).suits->suitesscan_test_directorys->scan_test_directories