icann / lgr-core

Label Generation Ruleset — Core library and manipulation functions
Other
8 stars 10 forks source link

LGR validation #12

Closed mattias-p closed 5 years ago

mattias-p commented 5 years ago

LGR files are validated as part of Registry System Testing. This validation is facilitated by a set of tools that are based on a modified version of lgr-core. The modifications expand the focus of lgr-core from manipulation of LGR files to also include validation of LGR files. This PR contains those modifications.

The validation is supported by the following means:

The goal of the proposal is that it will not affect current applications, i.e. even though the API has been expanded with new feature, current calls will work as before.

Please note that while this PR includes API documentation of (the most important) the new interfaces, it does not include any mention in the high-level documentation of the new validation tool, the validation feature, nor of the test labels.

Edit: Also, this PR contains no unit tests for the new code. Edit 2: An effort was made to make the changes as new code instead of changing existing code when possible. This should avoid introducing breaking changes and make review easier. On the other hand it introduces some duplication which is less than ideal for other reasons.

mattias-p commented 5 years ago

We'll come back with an update regarding the failing test.