feat(ro-crate-1.2): introduce validation profile for RO-Crate 1.2#164
Draft
feat(ro-crate-1.2): introduce validation profile for RO-Crate 1.2#164
Conversation
…of contextual entities
…pplication and ComputerLanguage entities
… and ComputerLanguage entities
… Root Data Entity)
…oftwareApplication and ComputerLanguage entities
…ation and ComputerLanguage entities
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces an initial implementation of the validation profile compliant with the RO-Crate 1.2 specification, adding support for validating crates that declare this version in their
conformsToproperty.The implementation covers the core requirements of the specification, in particular those listed in the quick reference. Any additional rules specific to derived profiles (e.g., Workflow RO-Crate) will be addressed in subsequent PRs, where needed.
How to test
The code is available on the
feat/ro-crate-1.2branch and can be installed as usual via Poetry:Development and testing were carried out using the few examples provided by the specification, together with additional ones defined ad hoc and derived from it. These ad hoc examples are located under
tests/data/crates/ro-crate-1.2: for each significant requirement (particularly the new ones) in every section of the quick reference, the folder contains a valid crate along with several invalid ones, each designed to exercise a specific violation of that requirement.CLI options
A few new CLI options have been introduced. In particular, validation now performs additional availability checks on the resources referenced by the RO-Crate. Since these checks require remote connections, they can be disabled via the
--skip-availability-checkflag:Any kind of feedback (bug reports, misinterpretations of the specs, edge cases we may have missed, etc.) is very welcome and much appreciated 🙂
[related to #107]