os-autoinst-distri-fedora/schemas/README.md

# FIF and openQA template schemas

This directory contains [JSON Schema](https://json-schema.org/) format schemas for the FIF and
upstream openQA template data formats. `fif-complete.json` and `fif-incomplete.json` are the FIF
schemas; `openqa-complete.json` and `openqa-incomplete.json` are the upstream schemas. The
'complete' schemas expect the input to contain a *complete* set of template data (enough for an
openQA instance to schedule and run tests); the *incomplete* schemas expect the input to contain
only *some* valid template data (these may be files that will be combined into complete data, or
files intended to be loaded without `--clean` only as supplementary data to an openQA deployment
with existing data). The other files are subcomponents of the schemas that are loaded by reference.
Add fifloader tests, template schemas, update README This adds a test suite for fifloader (renamed fifloader.py for test sanity). It adds JSON Schema form schemas for both FIF and upstream openQA template data, and has fifloader (optionally, but by default) validate both input and output data against the schemas. It also adds a tox.ini configured to run the fifloader tests, use fifloader to validate the template files, and do diff coverage and lint checks. It also adjusts the Zuul config to run tox instead of the test job. There are also some pylint cleanups, since the new tests run pylint. fifcheck, fifconverter and tojson.pm are removed, as they were mainly only needed for one-time conversion of the old format templates; now they are in the git history we can always recover them if we need them. Along with all this I updated the README a bit to explain some of it (and explain FIF better), and to explicitly state that this repo is GPLv2+ licensed, and added GPL headers to some of the files. Signed-off-by: Adam Williamson <awilliam@redhat.com> 2020-01-25 15:35:26 +00:00			`# FIF and openQA template schemas`

			`This directory contains [JSON Schema](https://json-schema.org/) format schemas for the FIF and`
			upstream openQA template data formats. `fif-complete.json` and `fif-incomplete.json` are the FIF
			schemas; `openqa-complete.json` and `openqa-incomplete.json` are the upstream schemas. The
			`'complete' schemas expect the input to contain a complete set of template data (enough for an`
			`openQA instance to schedule and run tests); the incomplete schemas expect the input to contain`
			`only some valid template data (these may be files that will be combined into complete data, or`
			files intended to be loaded without `--clean` only as supplementary data to an openQA deployment
			`with existing data). The other files are subcomponents of the schemas that are loaded by reference.`