Fix py_SubjectHierarchyGenericSelfTest test

[jcfr]

Summary

The test py_SubjectHierarchyGenericSelfTest passed on all platform when executed against a build of Slicer 31ba894 and started to fail with Slicer 80ad0a0.

	✅	❌
CDash link	https://slicer.cdash.org/test/25604578	https://slicer.cdash.org/test/25610246
Slicer Source	31ba894	80ad0a0

Useful links

• Compare link: 31ba894...80ad0a0

• Associated pull requests:

  • Empty folder SH visibility #7214
  • BUG: Fix difficult to see slice offset text in Slicer dark mode #7234

• Test sources: https://github.com/Slicer/Slicer/blob/main/Modules/Loadable/SubjectHierarchy/Testing/Python/SubjectHierarchyGenericSelfTest.py

Steps to reproduce

ctest -C Release -R py_SubjectHierarchyGenericSelfTest

[...]

308: FAIL: test_SubjectHierarchyGenericSelfTest_FullTest1 (SubjectHierarchyGenericSelfTest.SubjectHierarchyGenericSelfTestTest)
308: ----------------------------------------------------------------------
308: Traceback (most recent call last):
308:   File "/home/jcfr/Projects/Slicer-Release/Slicer-build/lib/Slicer-5.5/qt-scripted-modules/SubjectHierarchyGenericSelfTest.py", line 113, in test_SubjectHierarchyGenericSelfTest_FullTest1
308:     self.section_AttributeFilters()
308:   File "/home/jcfr/Projects/Slicer-Release/Slicer-build/lib/Slicer-5.5/qt-scripted-modules/SubjectHierarchyGenericSelfTest.py", line 565, in section_AttributeFilters
308:     testAttributeFilters(shProxyModel, shProxyModel)
308:   File "/home/jcfr/Projects/Slicer-Release/Slicer-build/lib/Slicer-5.5/qt-scripted-modules/SubjectHierarchyGenericSelfTest.py", line 480, in testAttributeFilters
308:     self.assertEqual(shProxyModel.acceptedItemCount(shNode.GetSceneItemID()), 5)
308: AssertionError: 6 != 5

Expected behavior

Test should pass on all platform

[cpinter]

It seems that the failure is due to the fact that the showEmptyHierarchyItems flag is on in the proxy model. Trying to see why it is enabled.

[cpinter]

It seems that it has been always on by default, and it seems correct that the empty folder shows up, so the item count of 6 that made the test fail is the correct number. I propose to fix the test by adjusting the expected value.

The six items:

The four markup nodes have the node attribute that was filtered. Their parent shows up anyway, and the empty folder shows up due to the (by default) enabled showEmptyHierarchyItems flag.

[jcfr]

Updating the expected value makes sense and would be consistent with the new default behavior.

Before #7214	After #7214

I also suggest to update to check that setting showEmptyHierarchyItems works as expected.

After loading SubjectHierarchyAttributeFilterTestScene.mrb, I used the following convenient snippet based of the current test:

shTreeView = slicer.qMRMLSubjectHierarchyTreeView()
shTreeView.setMRMLScene(slicer.mrmlScene)
shTreeView.show()
shProxyModel = shTreeView.sortFilterProxyModel()
shNode = slicer.mrmlScene.GetSubjectHierarchyNode()

assert shProxyModel.acceptedItemCount(shNode.GetSceneItemID()) == 9

shProxyModel.includeNodeAttributeNamesFilter = ['Markups.MovingInSliceView']

# By default, shProxyModel.showEmptyHierarchyItems is True
assert shProxyModel.acceptedItemCount(shNode.GetSceneItemID()) == 6

shProxyModel.showEmptyHierarchyItems = False
assert shProxyModel.acceptedItemCount(shNode.GetSceneItemID()) == 5

[cpinter]

PR ready to review.

Yes I also realized the showEmptyHierarchyItems flag was not tested so I added a small test at the end of the attributes test section.