Fix #5401 - BCL measure update picks up subfolders like resources/__pycache__ or tests/.pytest_cache #5402
Conversation
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
```
/media/DataExt4/Software/Others/OpenStudio2/src/utilities/bcl/test/BCLMeasure_GTest.cpp:517: Failure
Expected equality of these values:
numFiles + addedFiles
Which is: 13
files.size()
Which is: 14
/media/DataExt4/Software/Others/OpenStudio2/src/utilities/bcl/test/BCLMeasure_GTest.cpp:587: Failure
Value of: std::equal(newXMLPaths.begin(), newXMLPaths.end(), expectedAfterNewFilesAbsolutePaths.begin(), expectedAfterNewFilesAbsolutePaths.end())
Actual: false
Expected: true
/media/DataExt4/Software/Others/OpenStudio2/src/utilities/bcl/test/BCLMeasure_GTest.cpp:598: Failure
Value of: paths.empty()
Actual: false
Expected: true
There are 1 extra files in the XML:
* docs/.hidden_folder/subfolder/file.txt
/media/DataExt4/Software/Others/OpenStudio2/src/utilities/bcl/test/BCLMeasure_GTest.cpp:703: Failure
Value of: std::equal(xmlFilePaths.begin(), xmlFilePaths.end(), expectedAfterNewFilesAbsolutePaths.begin(), expectedAfterNewFilesAbsolutePaths.end())
Actual: false
Expected: true
```
…able_recursion_pending
jmarrec
commented
Apr 25, 2025
Comment on lines
+1018
to
+1033
| for (auto it = openstudio::filesystem::recursive_directory_iterator(approvedSubFolderAbsolutePath); | ||
| it != openstudio::filesystem::recursive_directory_iterator(); ++it) { | ||
| const auto& absoluteFilePath = it->path(); | ||
|
|
||
| if (openstudio::filesystem::is_directory(absoluteFilePath)) { | ||
| const std::string name = absoluteFilePath.filename().string(); | ||
| if (!name.empty() && (name[0] == '.' || name == "__pycache__")) { | ||
| // Skip this directory and all its children | ||
| it.disable_recursion_pending(); | ||
| } | ||
| } else if (openstudio::filesystem::is_regular_file(absoluteFilePath)) { | ||
| if (!isApprovedFile(absoluteFilePath, m_directory)) { | ||
| continue; | ||
| } | ||
| const openstudio::path relativeFilePath = openstudio::filesystem::relative(absoluteFilePath, m_directory); | ||
| result |= addWithUsageTypeIfNotExisting(relativeFilePath, std::string(usageType)); |
Collaborator
Author
There was a problem hiding this comment.
use a recursive_directory_iterator and use disable_recursion_pending to skip it and children if it's a hidden folder or named "pycache"
Collaborator
|
CI Results for d063960:
|
Collaborator
joseph-robertson
left a comment
There was a problem hiding this comment.
Do we want to generalize this a bit, and begin some sort of list of folder names to exclude? "pycache" would be the first entry in the list.
Collaborator
Author
I actually thought the same thing! If we find another one, then we'll do it |
joseph-robertson
approved these changes
Apr 30, 2025
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.
Pull request overview
Pull Request Author
Labels:
IDDChangeAPIChangePull Request - Ready for CIso that CI builds your PRReview Checklist
This will not be exhaustively relevant to every PR.