Add test for image names when resolutions are not flattened

melissalinkert commented 10 months ago

In most cases, the Image names stored in a MetadataStore will not depend on hasFlattenedResolutions(). For some pyramid formats (e.g. SVS, CZI), the Image names are noticeably different.

This updates the config file generation to add an Alternate_Name representing the unflattened Image name, if the unflattened Image name is different from the flattened Image name for a particular series/resolution. The new testUnflattenedImageNames checks this value, and errors if the name provided by an unflattened reader does not match either configured name.

I would expect this to cause test failures for SVS, CZI, and potentially others. I am happy for this to be excluded once at least test run has completed (so we know the scope of config changes required).

melissalinkert commented 10 months ago

Unsurprisingly, this caused a number of build failures:

Excluding for the moment, can re-include once a configuration PR is ready.

sbesson commented 10 months ago

On the positive side, it looks like tests have been failing if and only if the format is multi-resolution which was the expectation.

sbesson commented 9 months ago

As discussed today with @melissalinkert and @joshmoore, I agree the latest state of this PR puts us in a nice compromise between:

allowing the non-regression test to check image names when using the sub-resolution API - which is a prerequisite to add coverage for issues of the like of #4103
and making minimal changes to the existing test-suite infrastructure and the set of existing configuration samples.

Next step here is to update the configuration files for all pyramidal file formats and re-include this PR in the nightly CI builds

ome / bioformats

Add test for image names when resolutions are not flattened #4114