ENH: Add unit test functions for comparing full datastructure #1500
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
imikejackson
force-pushed
the
topic/DataStructureCompareUnitTest
branch
3 times, most recently
from
0fd375f to
2c687c1
Compare
imikejackson
force-pushed
the
topic/DataStructureCompareUnitTest
branch
from
2c687c1 to
2db7460
Compare
imikejackson
force-pushed
the
topic/DataStructureCompareUnitTest
branch
from
2db7460 to
c02c3c8
Compare
imikejackson
requested review from
JDuffeyBQ
and removed request for
imikejackson
JDuffeyBQ
requested changes
Jan 23, 2026
Collaborator
JDuffeyBQ
left a comment
JDuffeyBQ
left a comment
There was a problem hiding this comment.
We should probably also check objects like geometries and attribute matrices for equality as well.
| #include <catch2/catch.hpp> | ||
|
|
||
| #include "simplnx/Core/Application.hpp" | ||
| #include "simplnx/DataStructure/IO/HDF5/DataStructureWriter.hpp" |
Collaborator
There was a problem hiding this comment.
Were these includes missing before? And same for other files.
Comment on lines
+1458
to
+1474
| // groupACDPath.createChildPath(arrayI->getName()); | ||
| // groupBCDPath.createChildPath(arrayI->getName()); | ||
| // | ||
| // groupBCDPath.createChildPath(arrayJ->getName()); | ||
| // groupACEPath.createChildPath(arrayJ->getName()); | ||
| // groupBCEPath.createChildPath(arrayJ->getName()); | ||
| // groupBEPath.createChildPath(arrayJ->getName()); | ||
| // groupBFEPath.createChildPath(arrayJ->getName()); | ||
| // | ||
| // groupACEPath.createChildPath(arrayK->getName()); | ||
| // groupBCEPath.createChildPath(arrayK->getName()); | ||
| // groupBEPath.createChildPath(arrayK->getName()); | ||
| // groupBFEPath.createChildPath(arrayK->getName()); | ||
| // | ||
| // groupBFGPath.createChildPath(arrayL->getName()); | ||
| // | ||
| // groupBFGPath.createChildPath(arrayM->getName()); |
Comment on lines
+886
to
+891
| if(parentA == nullptr || parentB == nullptr) | ||
| { | ||
| // std::cout << "DEBUG TEST: parentA or parentB is null!"; | ||
| INFO("DEBUG TEST: parentA or parentB is null!"); | ||
| REQUIRE(false); | ||
| } |
Collaborator
There was a problem hiding this comment.
Suggested change
| if(parentA == nullptr || parentB == nullptr) | |
| { | |
| // std::cout << "DEBUG TEST: parentA or parentB is null!"; | |
| INFO("DEBUG TEST: parentA or parentB is null!"); | |
| REQUIRE(false); | |
| } | |
| REQUIRE(parentA != nullptr); | |
| REQUIRE(parentB != nullptr); |
| childrenNamesB = parentB->getDataMap().getNames(); | ||
| } | ||
|
|
||
| for(int i = 0; i < childrenNamesA.size(); ++i) |
Collaborator
There was a problem hiding this comment.
Suggested change
| for(int i = 0; i < childrenNamesA.size(); ++i) | |
| for(usize i = 0; i < childrenNamesA.size(); ++i) |
Comment on lines
+912
to
+913
| auto objectA = dataStructureA.getData(childPath); | ||
| auto objectB = dataStructureB.getData(childPath); |
Collaborator
There was a problem hiding this comment.
Suggested change
| auto objectA = dataStructureA.getData(childPath); | |
| auto objectB = dataStructureB.getData(childPath); | |
| const DataObject* objectA = dataStructureA.getData(childPath); | |
| const DataObject* objectB = dataStructureB.getData(childPath); | |
| REQUIRE(objectA != nullptr); | |
| REQUIRE(objectB != nullptr); |
Comment on lines
+958
to
+960
| REQUIRE(dataArrayA != nullptr); | ||
| REQUIRE(dataArrayB != nullptr); | ||
| CompareStringArrays(*dataArrayA, *dataArrayB); |
Collaborator
There was a problem hiding this comment.
Suggested change
| REQUIRE(dataArrayA != nullptr); | |
| REQUIRE(dataArrayB != nullptr); | |
| CompareStringArrays(*dataArrayA, *dataArrayB); | |
| REQUIRE(stringArrayA != nullptr); | |
| REQUIRE(stringArrayB != nullptr); | |
| CompareStringArrays(*stringArrayA, *stringArrayB); |
Comment on lines
+914
to
+915
| // Make sure both are the same object type | ||
| // If this fails the test will throw and return at this point |
Collaborator
There was a problem hiding this comment.
Suggested change
| // Make sure both are the same object type | |
| // If this fails the test will throw and return at this point |
Comment on lines
+1018
to
+1021
| } catch(std::exception& e) | ||
| { | ||
| REQUIRE(false); | ||
| } |
Collaborator
There was a problem hiding this comment.
Suggested change
| } catch(std::exception& e) | |
| { | |
| REQUIRE(false); | |
| } | |
| } catch(const std::exception& e) | |
| { | |
| INFO(fmt::format("Caught exception: {}", e.what())); | |
| REQUIRE(false); | |
| } |
Is there a particular exception we are expecting to catch?
Comment on lines
+1010
to
+1014
| default: | ||
| std::cout << "Missing DataType: " << static_cast<uint32>(objectA->getDataObjectType()) << std::endl; | ||
| INFO(fmt::format("DEBUG TEST: Child path ({}) cannot be found or has different array types in data structures A and B!", childPath.toString())); | ||
| REQUIRE(false); | ||
| break; |
Collaborator
There was a problem hiding this comment.
Suggested change
| default: | |
| std::cout << "Missing DataType: " << static_cast<uint32>(objectA->getDataObjectType()) << std::endl; | |
| INFO(fmt::format("DEBUG TEST: Child path ({}) cannot be found or has different array types in data structures A and B!", childPath.toString())); | |
| REQUIRE(false); | |
| break; | |
| default: { | |
| auto underlyingDataType = to_underlying(objectA->getDataObjectType()); | |
| std::cout << "Missing DataType: " << underlyingDataType << std::endl; | |
| INFO(fmt::format("Object at path ({}) has unhandled type ({})", childPath.toString(), underlyingDataType)); | |
| REQUIRE(false); | |
| break; | |
| } |
Also might as well store the data object type before this point since we use it before the switch.
| DataPath childPath = parentGroup.createChildPath(childrenNamesA[i]); | ||
| if(dataStructureA.getDataAs<BaseGroup>(childPath)) | ||
| { | ||
| CompareDataStructures(dataStructureA, dataStructureB, childPath); |
Collaborator
There was a problem hiding this comment.
Since this is recursive, it is possible a very deep DataStructure would theoretically be an issue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.