Skip to content
This repository was archived by the owner on Nov 17, 2022. It is now read-only.

Add context to Ruleset validation output #302

Open
hayfield opened this issue Mar 19, 2018 · 1 comment
Open

Add context to Ruleset validation output #302

hayfield opened this issue Mar 19, 2018 · 1 comment
Labels
enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed). rulesets Relating to IATI Rulesets. validation Changes to validation functionality.

Comments

@hayfield
Copy link
Contributor

The validator module contains two types of validation: truthy and detailed.

  • Truthy validation states merely whether a Dataset is valid against given constraints or not.
  • Detailed validation provides information about what errors have occurred and where.

At the moment, detailed Ruleset validation will provide information about which Rule(s) have failed, though nothing about the context. Codelist validation, however, provides additional information such as line numbers so that context can be extracted.

Detailed Ruleset validation should provide context in the output so that it's easier to determine what needs fixing and where.

How this works will vary slightly between different types of Rule (some Rules may need to provide multiple contexts), though it will be possible to obtain useful output for at least some types of Rule.

@hayfield hayfield added enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed). rulesets Relating to IATI Rulesets. validation Changes to validation functionality. labels Mar 19, 2018
@hayfield
Copy link
Contributor Author

Completing #163 first will likely make this a simpler task to complete.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Some sort of new functionality (rather than fixing or tweaking something that already existed). rulesets Relating to IATI Rulesets. validation Changes to validation functionality.
Projects
None yet
Development

No branches or pull requests

1 participant