Repository navigation
VERS: Update to EbsdLib v3.1.4 - #1976
imikejackson merged 2 commits into
Conversation
|
/azp run |
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
|
Azure Pipelines: Successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
PR 1976 Code Review
Reviewed all three changed files at a811154914566a14a9762ab3023905b388da242a.
1. Implementation findings
- 1.1 [Important, CONFIRMED] Handle space group 0 in GrainMapper preflight. The reader accepts the HDF5
SpaceGroupvalue without a range check. WithSpaceGroup = 0, EbsdLib 3.1.3 returned a Laue operator, but 3.1.4 returns null. The preflight code dereferences that result. Reject values outside 1–230 with an error that names the file, phase, and value. Add a regression test for 0. EbsdReaderUtilities.hpp:327 · EbsdLib lookup - 1.2 [Minor, CONFIRMED] Correct the EbsdLib package source hash. The registry portfile supplies
98e8dad2…toVersion::GitHash(), while thev3.1.4tag points tod0f4769e…. The archive SHA-512 matches. Publish a corrected port revision and verify the hash that the package reports. Registry portfile:9 · EbsdLib v3.1.4 source
2. Current architectural problems
- 2.1 [Important, CONFIRMED] Raise the Conda pin with the vcpkg pin. The Conda recipe still builds EbsdLib 3.1.3, which lacks
GetLaueOpsFromSpaceGroupNumber(). An MSVC syntax check of the GrainMapper translation unit passed with the base code and 3.1.3 headers. It failed with the PR code and 3.1.3 headers and passed with the PR code and 3.1.4 headers. Update the Conda pin and verify a package build. conda/meta.yaml:12 - 2.2 [Important, CONFIRMED] Handle crystal-structure value 11 at the dependency boundary. The GMT exporter indexes the library’s Laue operator vector with the selected phase’s stored crystal-structure value. EbsdLib 3.1.3 returned orthorhombic operators at slot 11. EbsdLib 3.1.4 removes that slot, so the same input now reads past the vector. Reject unsupported values with an error or explicitly map 11 if compatibility is required. Add a regression case and check other consumers of the vector for the same change. WriteGBCDGMTFile.cpp:155
3. Verified and pending evidence
- 3.1 The pin points to the official registry baseline and changes only EbsdLib. The registry tree matches the 3.1.4 port entry, and the source archive matches its SHA-512. The new lookup maps space group 194 to hexagonal-high, consistent with the upstream reference test. Registry PR #40 · EbsdLib PR #67
- 3.2 Clang-format 19.1.1 and the comment audit passed. Scoped clang-tidy exited nonzero on unchanged lines and produced no diagnostic on the changed line. The vcpkg dry run stalled during registry fetch. Azure results, full builds, runtime tests, and DREAM3D-NX validation remain unverified. Azure build 10731
REQUEST CHANGES — Address the Conda build failure and both crash paths before merging.
5a79231 to
9c6f625
Compare
|
/azp run |
|
Azure Pipelines: Successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines: Successfully started running 1 pipeline(s). |
jmarquisbq
left a comment
There was a problem hiding this comment.
PR 1976 re-review
Reviewed all seven changed files at f504afec3ad4aefe4630bf4990f2eda3a74173bd. Three of the four items from the original review are addressed.
1. Original review items
- 1.1 GrainMapper space group. Partially fixed. Preflight now displays
Unknownfor an invalid space group and allows execution. See finding 2.1. - 1.2 Registry source hash. Fixed. The portfile embeds the commit behind
v3.1.4. The port tree and source archive SHA-512 match. Registry commit - 2.1 Conda build. Pin fixed. The Conda recipe now uses 3.1.4. The GrainMapper source passed a focused MSVC syntax check with those headers. A full Conda build remains unverified. Conda pin
- 2.2 GMT export. Fixed in source. Execute checks both indexes before use. The new test covers crystal-structure values
11and999and a phase missing from the Crystal Structures array. Regression test
2. Re-review findings
- 2.1 [Important, CONFIRMED] Current architectural problem. Use the same checked space-group mapping in preflight and execute. A GrainMapper file with
SpaceGroup = 231now passes preflight asUnknown, then execute silently writes cubic-high intoCrystalStructures. With0, the execute lookup underflows its table index and throws. The PR exposes the existing execute defect by allowing these inputs past preflight. Validate the file value against1–230in the shared phase reader and return an error with the file, phase, and value. Use the checked EbsdLib mapping for valid inputs and add regression cases for0and231. Preflight lookup · Execute lookup - 2.2 [Minor, CONFIRMED] Update the CTF validation record. The revised test correctly expects EbsdLib error
-102312forZCells = 0. The filter comment and V&V coverage table still say that this fixture exercises the simplnx-19603guard. Update both to say that the reader rejects the fixture before the copy guard, and record the guard’s coverage separately. Filter comment · V&V coverage
3. Validation
Focused MSVC syntax checks with EbsdLib 3.1.4 headers, clang-format 19.1.1, and the comment audit passed. Scoped clang-tidy exited nonzero on include and style diagnostics, including Catch2 macro diagnostics. Azure test results, full builds, runtime tests, and DREAM3D-NX/OOC validation remain unverified. Azure build 10739
REQUEST CHANGES. Make GrainMapper handle invalid space groups consistently in preflight and execute before merging.
|
@jmarquisbq Here's where your re-review items stand: 2.1 (GrainMapper space groups): fixed in #1973 (from #1962). 2.2 (CTF validation record): #1973 also rewrites the CTF V&V record. The #1976 has to merge first because #1973 needs EbsdLib 3.1.4, so I'd like to merge this one with both items tracked in #1973. |
f504afe to
13f6308
Compare
|
/azp run |
|
Azure Pipelines: Successfully started running 1 pipeline(s). |
Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…hold - WriteGBCDGMTFile returns -96714 when the selected phase's crystal structure is outside the LaueOps table (0-10). EbsdLib 3.1.4 removed slot 11, so the value 11 and the 999 Unknown sentinel previously read past the table. - WriteGBCDGMTFile returns -96715 when the selected phase index is outside the Crystal Structures array. - Add a regression test for crystal structures 11 and 999 and a missing phase. - ReadCtfData: EbsdLib 3.1.4 rejects a ZCells 0 header itself with -102312; update the test to expect that code. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
13f6308 to
bcdd9e4
Compare
|
@jmarquisbq A correction to my comment above about 2.2: the |
No description provided.