Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testSaneUsedFiles: check getCurrentFile is the first file in the getUsedFiles list #4172

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented Mar 25, 2024

From an discussion with @melissalinkert and @jburel, this was opening initially to assess how many formats deviate from this assumption in the nightly CI builds

FormatReaderTest.testSaneUsedFiles is currently testing that the first item of IFormatReader.getUsedFiles() is equal to IFormatReader.getCurrentFile() for single-file formats.

This change extends the test logic to assert this condition for all file formats manually excluding the 10 readers where the automated tests have identified the condition was not met.

As next steps, the individual readers can be updated individually to meet the condition and reincluded in the tests. Once all readers have been updated, the API contract could be updated to clarify the expectation and the relationship between the first file of getUsedFiles and the output of getCurrentFile although doing this will likely require a major version increment.

@sbesson sbesson force-pushed the getcurrentfile_getusedfiles branch from 2a60d54 to ca66ec1 Compare March 25, 2024 22:21
@sbesson sbesson marked this pull request as draft March 26, 2024 09:32
@sbesson
Copy link
Member Author

sbesson commented Mar 26, 2024

As expected, quite a few failures reported in the nightly CI builds. The reader for the following curated QA folders should likely be reviewed as a next step:

  • biorad
  • metamorph
  • flex
  • cellsens
  • ultraview
  • fuji
  • micromanager
  • perkinelmer
  • bdv
  • zeiss-tiff
  • scanr

Marking this PR as draft in the meantime

@sbesson sbesson added this to the 8.0.0 milestone Apr 8, 2024
@sbesson
Copy link
Member Author

sbesson commented Apr 8, 2024

As discussed today, assigning to the 8.0.0 milestone with the aim to:
1- review and update the contract of IFormatReader to enforce consistency between getCurrentFile and getUsedFiles
2- review and update all the readers for the failing formats

@sbesson sbesson marked this pull request as ready for review July 22, 2024 11:42
@sbesson sbesson marked this pull request as draft July 22, 2024 21:19
@sbesson sbesson marked this pull request as ready for review July 23, 2024 09:43
@sbesson sbesson marked this pull request as draft July 24, 2024 19:29
@melissalinkert melissalinkert modified the milestones: 8.0.0, 9.0.0 Sep 30, 2024
@sbesson sbesson marked this pull request as ready for review November 2, 2024 13:36
…atch

This approach will allow to incrementally work through each reader
and re-include them in the getCurrentFile/getUsedFiles test
@sbesson
Copy link
Member Author

sbesson commented Nov 3, 2024

Updated the PR and the description to test getUsedFiles[0] == getCurrentFile and exclude the formats that do not meet the criterion. These readers can be reviewed and relaxed as part of future PRs.

@melissalinkert melissalinkert modified the milestones: 9.0.0, 8.0.1 Nov 4, 2024
Copy link
Member

@melissalinkert melissalinkert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes sense since, as discussed, the goal is to remove the reader format checks incrementally in follow-up PRs.

This would have been included in https://merge-ci.openmicroscopy.org/jenkins/job/BIOFORMATS-test-repo/244/, so merging.

@melissalinkert melissalinkert merged commit 808ffe5 into ome:develop Nov 4, 2024
18 checks passed
@sbesson sbesson deleted the getcurrentfile_getusedfiles branch November 4, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants