WIP: Add rules #364
WIP: Add rules #364
Conversation
jdsika
added
Documentation
|
@pmai I would be very happy to get you opinion here! The |
pmai
left a comment
pmai
left a comment
There was a problem hiding this comment.
Seems like a good way to go, I don't mind the doc-syntax.
It should be noted that for the range checking the default 0 values of fields when they are not filled should be taken into account in the actual checking (i.e. it is OK not to provide e.g. the barometric pressure, and in that case the default value will be 0, so that should be deemed valid, even if the range when a value is provided does not include 0); however that is something to handle in the os-validator itself; we should add documentation to the OSI doc however that explains the rules.
This commit adds the feature to define rules in the comments which can be used by the validator. This adds a rules file called rules.yml in which the user can define the regex syntax for valid rules to be parsed.
|
Rebased against master, resolved conflicts, squashed to one commit; waiting for build. |
Reference to a related issue in the repository
#355
Add a description
This PR adds rules to each message field which can be parsed and used by the osi-validator to validate OSI trace files.
Some questions to ask:
What is this change?
This PR adds the feature to define rules in the comments which can be used by the validator. I also added a rules file called rules.yml in which the user can define the regex syntax for valid rules to be parsed.
How has it been tested?
It's been tested with the osi-validator which has a script which generates from the OSI comments yml rule files which then can be used by the validator.
Mention a member
@jdsika pls review and merge after the PR for the osi-validator. Add more rules if you think there should be a rule on a field.
Check the checklist