airship/deckhand
Code Issues Proposed changes

Add kind param to SchemaVersion class.

Browse Source
This commit is contained in:
Felipe Monteiro 2017-07-13 04:50:57 +01:00
parent ff65d14fee
commit e829e521ee
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
deckhand/engine/schema/v1_0/default_schema.py
View File

@ -47,6 +47,7 @@ schema = {
'type': 'string',
'pattern': '^([A-Za-z]+\/v[0-9]{1})$'
},
# TODO: The kind should be an enum.
'kind': {'type': 'string'},
'metadata': {
'type': 'object',

21
deckhand/engine/secret_substitution.py
View File

@ -40,7 +40,7 @@ class SecretSubstitution(object):
raise errors.InvalidFormat(
'The provided YAML file cannot be parsed.')
self.validate_data()
self.pre_validate_data()
class SchemaVersion(object):
"""Class for retrieving correct schema for pre-validation on YAML.
@ -50,17 +50,21 @@ class SecretSubstitution(object):
YAML data.
"""
schema_versions_info = [{'version': 'v1', 'schema': default_schema}]
# TODO: Update kind according to requirements.
schema_versions_info = [{'version': 'v1', 'kind': 'default',
'schema': default_schema}]
def __init__(self, schema_version):
def __init__(self, schema_version, kind):
self.schema_version = schema_version
self.kind = kind
@property
def schema(self):
# TODO: return schema based on version and kind.
return [v['schema'] for v in self.schema_versions_info
if v['version'] == self.schema_version][0].schema
def validate_data(self):
def pre_validate_data(self):
"""Pre-validate that the YAML file is correctly formatted."""
self._validate_with_schema()
@ -82,17 +86,18 @@ class SecretSubstitution(object):
# TODO(fm577c): Query Deckhand API to validate "src" values.
def _validate_with_schema(self):
# Validate that a schema with "schemaVersion" version number exists,
# then use that schema to validate the YAML data.
# Validate the document using the schema defined by the document's
# `schemaVersion` and `kind`.
try:
schema_version = self.data['schemaVersion'].split('/')[-1]
data_schema_version = self.SchemaVersion(schema_version)
doc_kind = self.data['kind']
doc_schema_version = self.SchemaVersion(schema_version, doc_kind)
except (AttributeError, IndexError, KeyError) as e:
raise errors.InvalidFormat(
'The provided schemaVersion is invalid or missing. Exception: '
'%s.' % e)
try:
jsonschema.validate(self.data, data_schema_version.schema)
jsonschema.validate(self.data, doc_schema_version.schema)
except jsonschema.exceptions.ValidationError as e:
raise errors.InvalidFormat('The provided YAML file is invalid. '
'Exception: %s.' % e.message)