tree c377c27323c361590769665ae50372e135b2a552
parent b2fd7ca0969419e449a475c03333a08389035e80
author Brad Bishop <bradleyb@fuzziesquirrel.com> 1588335479 -0400
committer Brad Bishop <bradleyb@fuzziesquirrel.com> 1593468470 +0000

scripts: add configuration validation script

Add a script to validate configurations against the schema.  Use
https://github.com/Julian/jsonschema to perform the json validation.

The script is intended to be run from a continuous integration
environment or by configuration/schema developers.  A key
assumption/feature of the script is that its users will always prefer to
resolve relative references to the local filesystem.  As such, the
script computes a base URI that points to the filesystem and instructs
the validator to use that in place of whatever base_uri it derives from
the global $id attribute.  For additional reading see:

https://json-schema.org/understanding-json-schema/structuring.html#the-id-property
https://github.com/Julian/jsonschema/issues/98

Without any options the script assumes it is being run from an
entity-manager source distribution and attempts to find the schema and
configuration files relative to the location of the script.

Alternatively, the script can validate arbitrary json files against
arbitrary schema:

  ./validate-configs.py -s foo.schema.json -c test1.json -c test2.json

By default the validation stops as soon as a configuration does not
validate.  Use -k to override this behavior and validate as many
configurations as possible.

Provide an option to instruct the script to ignore a list of
configurations that are expected to fail validation to be used in
continuous integration setups - similar in concept to xfail mechanisms
provided by most build systems with unit test support.

Change-Id: I7d67a54993a6d5e00daf552d9d350c80411b997b
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>