dcae-cli/dcae_cli/catalog/mock/schema.py

   1 # ============LICENSE_START=======================================================
   2 # org.onap.dcae
   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
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  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=========================================================
  18 #
  19 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20
  21 # -*- coding: utf-8 -*-
  22 """
  23 Provides jsonschema
  24 """
  25 import json
  26 from functools import partial, reduce
  27
  28 import six
  29 from jsonschema import validate, ValidationError
  30 import requests
  31
  32 from dcae_cli.util import reraise_with_msg, fetch_file_from_web
  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
  36
  37
  38 log = get_logger('Schema')
  39
  40 # UPDATE: This message applies to the component spec which has been moved on a
  41 # remote server.
  42 #
  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
  46 #       provides = foo
  47 #     elif component_type == cdap
  48 #       provides = bar
  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
  50
  51
  52 # TODO: The next step here is to decide how to manage the links to the schemas. Either:
  53 #
  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
  56 #   machine.
  57 #   UPDATE: This item has been mostly completed where at least the path is configurable now.
  58
  59 #   b) Read the links to the schemas from the spec - self-describing jsons. Is
  60 #   this even feasible?
  61
  62 #   c) Both
  63 #
  64
  65 class FetchSchemaError(RuntimeError):
  66     pass
  67
  68 def _fetch_schema(schema_path):
  69     try:
  70         server_url = cli_config.get_server_url()
  71         return fetch_file_from_web(server_url, schema_path)
  72     except requests.HTTPError as e:
  73         raise FetchSchemaError("HTTP error from fetching schema", e)
  74     except Exception as e:
  75         raise FetchSchemaError("Unexpected error from fetching schema", e)
  76
  77
  78 def _safe_dict(obj):
  79     '''Returns a dict from a dict or json string'''
  80     if isinstance(obj, str):
  81         return json.loads(obj)
  82     else:
  83         return obj
  84
  85 def _validate(fetch_schema_func, schema_path, spec):
  86     '''Validate the given spec
  87
  88     Fetch the schema and then validate. Upon a error from fetching or validation,
  89     a DcaeException is raised.
  90
  91     Parameters
  92     ----------
  93     fetch_schema_func: function that takes schema_path -> dict representation of schema
  94         throws a FetchSchemaError upon any failure
  95     schema_path: string - path to schema
  96     spec: dict or string representation of JSON of schema instance
  97
  98     Returns
  99     -------
 100     Nothing, silence is golden
 101     '''
 102     try:
 103         schema = fetch_schema_func(schema_path)
 104         validate(_safe_dict(spec), schema)
 105     except ValidationError as e:
 106         reraise_with_msg(e, as_dcae=True)
 107     except FetchSchemaError as e:
 108         reraise_with_msg(e, as_dcae=True)
 109
 110 _validate_using_nexus = partial(_validate, _fetch_schema)
 111
 112
 113 _path_component_spec = cli_config.get_path_component_spec()
 114
 115 def apply_defaults(properties_definition, properties):
 116     """Utility method to enforce expected defaults
 117
 118     This method is used to enforce properties that are *expected* to have at least
 119     the default if not set by a user.  Expected properties are not required but
 120     have a default set.  jsonschema does not provide this.
 121
 122     Parameters
 123     ----------
 124     properties_definition: dict of the schema definition of the properties to use
 125         for verifying and applying defaults
 126     properties: dict of the target properties to verify and apply defaults to
 127
 128     Return
 129     ------
 130     dict - a new version of properties that has the expected default values
 131     """
 132     # Recursively process all inner objects. Look for more properties and not match
 133     # on type
 134     for k,v in six.iteritems(properties_definition):
 135         if "properties" in v:
 136             properties[k] = apply_defaults(v["properties"], properties.get(k, {}))
 137
 138     # Collect defaults
 139     defaults = [ (k, v["default"]) for k, v in properties_definition.items() if "default" in v ]
 140
 141     def apply_default(accumulator, default):
 142         k, v = default
 143         if k not in accumulator:
 144             # Not doing data type checking and any casting. Assuming that this
 145             # should have been taken care of in validation
 146             accumulator[k] = v
 147         return accumulator
 148
 149     return reduce(apply_default, defaults, properties)
 150
 151 def apply_defaults_docker_config(config):
 152     """Apply expected defaults to Docker config
 153     Parameters
 154     ----------
 155     config: Docker config dict
 156     Return
 157     ------
 158     Updated Docker config dict
 159     """
 160     # Apply health check defaults
 161     healthcheck_type = config["healthcheck"]["type"]
 162     component_spec = _fetch_schema(_path_component_spec)
 163
 164     if healthcheck_type in ["http", "https"]:
 165         apply_defaults_func = partial(apply_defaults,
 166                 component_spec["definitions"]["docker_healthcheck_http"]["properties"])
 167     elif healthcheck_type in ["script"]:
 168         apply_defaults_func = partial(apply_defaults,
 169                 component_spec["definitions"]["docker_healthcheck_script"]["properties"])
 170     else:
 171         # You should never get here
 172         apply_defaults_func = lambda x: x
 173
 174     config["healthcheck"] = apply_defaults_func(config["healthcheck"])
 175
 176     return config
 177
 178 def validate_component(spec):
 179     _validate_using_nexus(_path_component_spec, spec)
 180
 181     # REVIEW: Could not determine how to do this nicely in json schema. This is
 182     # not ideal. We want json schema to be the "it" for validation.
 183     ctype = component_type = spec["self"]["component_type"]
 184
 185     if ctype == "cdap":
 186         invalid = [s for s in spec["streams"].get("subscribes", []) \
 187                 if s["type"] in ["data_router", "data router"]]
 188         if invalid:
 189             raise DcaeException("Cdap component as data router subscriber is not supported.")
 190
 191 def validate_format(spec):
 192     path = cli_config.get_path_data_format()
 193     _validate_using_nexus(path, spec)