Ouranosinc / miranda / 17134902652

18%

push

github

Validation module (#233)

### What kind of change does this PR introduce?

* Refactors the `validators.py` file into the `validate` submodule
* Adds tests for the `validate` module based on test-examples as well as
existing configurations under `miranda/convert/data`.
* The `ecmwf_cf_attrs.json` configuration now passes validation rules.
* Several obsolete/nonexistent configuration files have been removed
from `miranda.convert.corrections`.
* Skips PDF generation on ReadTheDocs (currently broken).
* Enables Coverage reporting as comments on Pull Requests.
* Allows a connection needed for a GitHub workflow.
* Updates the `README.rst` to remove obsolete project entries.

### Does this PR introduce a breaking change?

Yes. Validation has been completely overhauled:
- `schema.Schema`-based validation is now defined for "Headers",
variables, and dimensions.
- Several formatting rules for JSON files have been put into force.
- Most configuration files are currently failing validation; I might
need some help bringing some of these up to standard.

### Other information:

https://github.com/keleshev/schema

It's very likely that we need to further constrain some checks and relax
others. Some special keys that are needed for validation need to have
more regimented rules, e.g.:
- All JSON configurations need "Headers"
- The expected values associated with underscored keys (e.g.
`_cf_standard_name`) need to be more explicitly-defined.
- Validation of output metadata has not yet been defined (e.g. ensuring
that underscored keys unique to `miranda` have been removed after
formatting).

88 of 110 new or added lines in 14 files covered. (80.0%)

1211 of 6398 relevant lines covered (18.93%)

1.31 hits per line