adapter/acumos/aoconversion/spec_gen.py

   1 # ============LICENSE_START====================================================
   2 # org.onap.dcae
   3 # =============================================================================
   4 # Copyright (c) 2019-2020 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 """
  20 Generates DCAE component specs
  21 """
  22
  23
  24 import json
  25 from jsonschema import validate
  26 from aoconversion import utils
  27
  28
  29 def _get_format_version(target_name, data_formats):
  30     """
  31     search through the data formats for name, make sure we have it, and retrieve the version
  32     """
  33     # the df must exist, since the data formats were generated from the same metadata, or dataformats call blew up.
  34     # So we don't do error checking here
  35     for df in data_formats:
  36         if df["self"]["name"] == target_name:
  37             return df["self"]["version"]
  38
  39
  40 def _generate_spec(model_name, meta, dcae_cs_schema, data_formats, docker_uri):
  41     """
  42     Function that generates the component spec from the model metadata and docker info
  43     Broken out to be unit-testable.
  44     """
  45
  46     spec = {
  47         "self": {
  48             "version": "1.0.0",  # hopefully we get this from somewhere and not hardcode this
  49             "name": model_name,
  50             "description": "Automatically generated from Acumos model",
  51             "component_type": "docker",
  52         },
  53         "services": {"calls": [], "provides": []},
  54         "streams": {"subscribes": [], "publishes": []},
  55         "parameters": [],
  56         "auxilary": {"healthcheck": {"type": "http", "endpoint": "/healthcheck"}},
  57         "artifacts": [{"type": "docker image", "uri": docker_uri}],
  58     }
  59
  60     # from https://pypi.org/project/acumos-dcae-model-runner/
  61     # each model method gets a subscruber and a publisher, using the methood name
  62     pstype = "message_router"
  63     for method in meta["methods"]:
  64
  65         df_in_name = meta["methods"][method]["input"]
  66         subscriber = {
  67             "config_key": "{0}_subscriber".format(method),
  68             "format": df_in_name,
  69             "version": _get_format_version(df_in_name, data_formats),
  70             "type": pstype,
  71         }
  72
  73         spec["streams"]["subscribes"].append(subscriber)
  74
  75         df_out_name = meta["methods"][method]["output"]
  76
  77         publisher = {
  78             "config_key": "{0}_publisher".format(method),
  79             "format": df_out_name,
  80             "version": _get_format_version(df_out_name, data_formats),
  81             "type": pstype,
  82         }
  83
  84         spec["streams"]["publishes"].append(publisher)
  85
  86     # Validate that we have a valid spec
  87     validate(instance=spec, schema=dcae_cs_schema)
  88
  89     return spec
  90
  91
  92 def generate_spec(model_repo_path, model_name, data_formats, docker_uri):
  93     """
  94     Generate and write the component spec to disk
  95     Returns the spec
  96     """
  97     spec = _generate_spec(
  98         model_name, utils.get_metadata(model_repo_path, model_name), utils.component_schema.get(), data_formats, docker_uri
  99     )
 100     fname = "{0}_dcae_component_specification.json".format(model_name)
 101     with open("{0}/{1}".format(model_repo_path, fname), "w") as f:
 102         f.write(json.dumps(spec))
 103
 104     return spec