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

Bump EPUBCheck in extension modules from 4.2.2 to 4.2.6 #650

Merged

Conversation

karenhanson
Copy link
Contributor

@karenhanson karenhanson commented Oct 20, 2020

Not sure if dependabot will catch this, so submitting a manual PR for the latest version of EPUBCheck.

Two changes to EPUBCheck since 4.2.2 cause some tests to fail:

  1. A change to the error messages returned for validation of a non-EPUB: fix: fail gracefully when running on a non-EPUB file w3c/epubcheck#1134
    The solution to fixing the test was simply to change the expected message count.
  2. A downgrade of the "encrypted file" message to INFO: feat: downgrade RSC-004 (cannot decrypt resource) to INFO w3c/epubcheck#1136
    This led to a decision point. The original implementation of the JHOVE EPUB module did not include INFO messages generated by EPUBCheck in the JHOVE report, but looking at the kinds of messages that might be listed as INFO messages I thought it might be useful to include them. I have added INFO messages to the report in this PR, but can roll back if this seems inappropriate. For reference, severity levels are defined here. The message values are here.

Update 4/14/2021: since the original PR, EPUBCheck 4.2.5 is now available, and so I've pushed a commit for that. No changes to the code were required, but the new checker identified an issue in one of the test files - this line in the OPF:
<meta refines="title" property="title-type">
needed to be using the fragment reference:
<meta refines="#title" property="title-type">

Update 1/26/2022: EPUBCheck 4.2.6 is now available and so I've incremented the version again. No additional changes required to the code as far as I can tell - tests still pass.

Bumps EPUB Check version from 4.2.2 to 4.2.4.
Two changes to EPUBCheck were causing the tests to change:
The first changes the error messages returned for validation of a non-EPUB:
w3c/epubcheck#1134
The solution was to change the message count.
The second downgrades the encrypted file message to INFO
w3c/epubcheck#1136
The original implementation of the JHOVE EPUB module did not include INFO messages generated by EPUBCheck in the JHOVE report, but looking at the kinds of messages that might be listed as INFO messages I thought it might be useful to include them. The change to add INFO messages is reflected in this commit.
@codecov
Copy link

codecov bot commented Oct 21, 2020

Codecov Report

Merging #650 (a8baf72) into integration (9c17f89) will not change coverage.
The diff coverage is n/a.

@@              Coverage Diff               @@
##             integration     #650   +/-   ##
==============================================
  Coverage          45.63%   45.63%           
  Complexity          1047     1047           
==============================================
  Files                 57       57           
  Lines               9146     9146           
  Branches            1683     1683           
==============================================
  Hits                4174     4174           
  Misses              4422     4422           
  Partials             550      550           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e412867...a8baf72. Read the comment docs.

The changes identified an error in one of the test files that was not previously detected - specifically that "refines" property in the OPF must use the fragment identifier for local IDs.  Updated the test file to reflect this.
@karenhanson karenhanson changed the title Bump EPUBCheck in extension modules from 4.2.2 to 4.2.4 Bump EPUBCheck in extension modules from 4.2.2 to 4.2.5 Apr 14, 2021
Updates to latest available version. No additional code changes are required to support this increment.
@karenhanson karenhanson changed the title Bump EPUBCheck in extension modules from 4.2.2 to 4.2.5 Bump EPUBCheck in extension modules from 4.2.2 to 4.2.6 Jan 26, 2022
@carlwilson carlwilson added feature New functionality to be developed P2 Medium priority issues to be scheduled in a future release RC1.26 labels Apr 7, 2022
@carlwilson carlwilson added this to the JHOVE 1.26 milestone Apr 7, 2022
@carlwilson carlwilson merged commit cbfe80c into openpreserve:integration Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality to be developed P2 Medium priority issues to be scheduled in a future release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants