openschemas.main.validate.criteria package

Submodules

openschemas.main.validate.criteria.base module

openschemas.main.validate.criteria.base.dummy(spec, passing=True)

dummy can be used for testing, it returns the status given as an argument

spec: the input spec, in json format (dict) passing: boolean to return True or False (default is True)

openschemas.main.validate.criteria.base.missing(spec)

this function is fired if the user forgets to define a “function” field in the check, which is technically the only required one :) It will always return False.

openschemas.main.validate.criteria.structure module

openschemas.main.validate.criteria.structure.mapping(spec)

test the mapping subgroup in the specification

mapping:

• name: Check for valid structure of list of mappings
• level: error
• function: openschemas.main.validate.criteria.structure.mapping

openschemas.main.validate.criteria.structure.optional(spec)

optional_structure looks for a schema having optional fields, and issues a warning if doesn’t exist. To implement this in a criteria.yml:

checks:

global:

• name: Check for optional global sections and metadata
• level: warning
• function: openschemas.main.validate.criteria.structure.optional

openschemas.main.validate.criteria.structure.required(spec)

required_structure looks for a schema’s required fields, and issues an exit if doesn’t exist. To implement this in a criteria.yml:

checks:

global:

• name: Check for required global sections and metadata
• level: error
• function: openschemas.main.validate.criteria.structure.required

openschemas.main.validate.criteria.structure.semvar(spec)

check that the specification uses semantic versioning

semvar:

• name: Check that the version strings use semantic versioning (x.x.x)
• level: error
• function: openschemas.main.validate.criteria.structure.semvar

openschemas.main.validate.criteria.structure.spec_info(spec)

test that the spec_info has all the required subfields

spec_info:

• name: Check that spec_info has all required subfields
• level: error
• function: openschemas.main.validate.criteria.structure.spec_info

Module contents