8.3 Deliverables

This project has the following deliverables:

• A requirements.txt file that identifies the tools used, usually pydantic==1.10.2 and jsonschema==4.16.0.

• Documentation in the docs folder.

• The JSON-format files with the source and analysis schemas. A separate schema directory is the suggested location for these files.

• An acceptance test for the schemas.

We’ll look at the schema acceptance test in some detail. Then we’ll look at using schema to extend other acceptance tests.

8.3.1 Schema acceptance tests

To know if the schema is useful, it is essential to have acceptance test cases. As new sources of data are integrated into an application, and old sources of data mutate through ordinary bug fixes and upgrades, files will change. The new files will often cause problems, and the root cause of the problem will be the unexpected file format change.

Once a file format change is identified, the smallest relevant example needs to be transformed into an acceptance...