1 # ============LICENSE_START=======================================================
3 # ================================================================================
4 # Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
5 # ================================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ============LICENSE_END=========================================================
19 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 # -*- coding: utf-8 -*-
26 from functools import partial, reduce
29 from jsonschema import validate, ValidationError
32 from dcae_cli.util import reraise_with_msg
33 from dcae_cli.util import config as cli_config
34 from dcae_cli.util.exc import DcaeException
35 from dcae_cli.util.logger import get_logger
38 log = get_logger('Schema')
40 # UPDATE: This message applies to the component spec which has been moved on a
43 # WARNING: The below has a "oneOf" for service provides, that will validate as long as any of them are chosen.
44 # However, this is wrong because what we really want is something like:
45 # if component_type == docker
47 # elif component_type == cdap
49 # The unlikely but problematic case is the cdap developer gets a hold of the docker documentation, uses that, it validates, and blows up at cdap runtime
52 # TODO: The next step here is to decide how to manage the links to the schemas. Either:
54 # a) Manage the links in the dcae-cli tool here and thus need to ask if this
55 # belongs in the config to point to some remote server or even point to local
57 # UPDATE: This item has been mostly completed where at least the path is configurable now.
59 # b) Read the links to the schemas from the spec - self-describing jsons. Is
64 # TODO: Source this from app's configuration [ONAP URL TBD]
65 _nexus_uri = "http://make-me-valid"
67 class FetchSchemaError(RuntimeError):
70 def _fetch_schema_from_web(server_uri, schema_path):
72 schema_url = "{0}/{1}".format(server_uri, schema_path)
73 r = requests.get(schema_url)
75 return json.loads(r.text)
76 except requests.HTTPError as e:
77 raise FetchSchemaError("HTTP error from fetching schema", e)
78 except Exception as e:
79 raise FetchSchemaError("Unexpected error from fetching schema", e)
81 _fetch_schema_from_nexus = partial(_fetch_schema_from_web, _nexus_uri)
85 '''Returns a dict from a dict or json string'''
86 if isinstance(obj, str):
87 return json.loads(obj)
91 def _validate(fetch_schema_func, schema_path, spec):
92 '''Validate the given spec
94 Fetch the schema and then validate. Upon a error from fetching or validation,
95 a DcaeException is raised.
99 fetch_schema_func: function that takes schema_path -> dict representation of schema
100 throws a FetchSchemaError upon any failure
101 schema_path: string - path to schema
102 spec: dict or string representation of JSON of schema instance
106 Nothing, silence is golden
109 schema = fetch_schema_func(schema_path)
110 validate(_safe_dict(spec), schema)
111 except ValidationError as e:
112 reraise_with_msg(e, as_dcae=True)
113 except FetchSchemaError as e:
114 reraise_with_msg(e, as_dcae=True)
116 _validate_using_nexus = partial(_validate, _fetch_schema_from_nexus)
119 _path_component_spec = cli_config.get_path_component_spec()
121 def apply_defaults(properties_definition, properties):
122 """Utility method to enforce expected defaults
124 This method is used to enforce properties that are *expected* to have at least
125 the default if not set by a user. Expected properties are not required but
126 have a default set. jsonschema does not provide this.
130 properties_definition: dict of the schema definition of the properties to use
131 for verifying and applying defaults
132 properties: dict of the target properties to verify and apply defaults to
136 dict - a new version of properties that has the expected default values
138 # Recursively process all inner objects. Look for more properties and not match
140 for k,v in six.iteritems(properties_definition):
141 if "properties" in v:
142 properties[k] = apply_defaults(v["properties"], properties.get(k, {}))
145 defaults = [ (k, v["default"]) for k, v in properties_definition.items() if "default" in v ]
147 def apply_default(accumulator, default):
149 if k not in accumulator:
150 # Not doing data type checking and any casting. Assuming that this
151 # should have been taken care of in validation
155 return reduce(apply_default, defaults, properties)
157 def apply_defaults_docker_config(config):
158 """Apply expected defaults to Docker config
161 config: Docker config dict
164 Updated Docker config dict
166 # Apply health check defaults
167 healthcheck_type = config["healthcheck"]["type"]
168 component_spec = _fetch_schema_from_nexus(_path_component_spec)
170 if healthcheck_type in ["http", "https"]:
171 apply_defaults_func = partial(apply_defaults,
172 component_spec["definitions"]["docker_healthcheck_http"]["properties"])
173 elif healthcheck_type in ["script"]:
174 apply_defaults_func = partial(apply_defaults,
175 component_spec["definitions"]["docker_healthcheck_script"]["properties"])
177 # You should never get here
178 apply_defaults_func = lambda x: x
180 config["healthcheck"] = apply_defaults_func(config["healthcheck"])
184 def validate_component(spec):
185 _validate_using_nexus(_path_component_spec, spec)
187 # REVIEW: Could not determine how to do this nicely in json schema. This is
188 # not ideal. We want json schema to be the "it" for validation.
189 ctype = component_type = spec["self"]["component_type"]
192 invalid = [s for s in spec["streams"].get("subscribes", []) \
193 if s["type"] in ["data_router", "data router"]]
195 raise DcaeException("Cdap component as data router subscriber is not supported.")
197 def validate_format(spec):
198 path = cli_config.get_path_data_format()
199 _validate_using_nexus(path, spec)