[ENH TEST] Improve compare_folders
error message
#918
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 PR proposes to improve the error message of the testing utility function
compare_folders
.The function currently returns
True
if the two folders have the same file trees and raises aValueError
otherwise. The error message contains both trees.It is easy to spot differences when the folders are not too large/deep, but quickly becomes difficult when they increase in size.
For instance, I'm having troubles seing the differences when non-regression tests for converters fail as the folders are quite large for these pipelines.
This PR adds a section at the end of the error message: it gives the number of lines which differ between the two trees and it prints the differences explicitly.
Here is a small example: