summaryrefslogtreecommitdiffstats
path: root/adapter/acumos/aoconversion/spec_gen.py
blob: 85644345ef92cad9a36cc034e3a388ed9d64e3b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# ============LICENSE_START====================================================
# org.onap.dcae
# =============================================================================
# Copyright (c) 2019-2020 AT&T Intellectual Property. All rights reserved.
# =============================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END======================================================

"""
Generates DCAE component specs
"""


import json
from jsonschema import validate
from aoconversion import utils


def _get_format_version(target_name, data_formats):
    """
    search through the data formats for name, make sure we have it, and retrieve the version
    """
    # the df must exist, since the data formats were generated from the same metadata, or dataformats call blew up.
    # So we don't do error checking here
    for df in data_formats:
        if df["self"]["name"] == target_name:
            return df["self"]["version"]


def _generate_spec(model_name, meta, dcae_cs_schema, data_formats, docker_uri):
    """
    Function that generates the component spec from the model metadata and docker info
    Broken out to be unit-testable.
    """

    spec = {
        "self": {
            "version": "1.0.0",  # hopefully we get this from somewhere and not hardcode this
            "name": model_name,
            "description": "Automatically generated from Acumos model",
            "component_type": "docker",
        },
        "services": {"calls": [], "provides": []},
        "streams": {"subscribes": [], "publishes": []},
        "parameters": [],
        "auxilary": {"healthcheck": {"type": "http", "endpoint": "/healthcheck"}},
        "artifacts": [{"type": "docker image", "uri": docker_uri}],
    }

    # from https://pypi.org/project/acumos-dcae-model-runner/
    # each model method gets a subscruber and a publisher, using the methood name
    pstype = "message_router"
    for method in meta["methods"]:

        df_in_name = meta["methods"][method]["input"]
        subscriber = {
            "config_key": "{0}_subscriber".format(method),
            "format": df_in_name,
            "version": _get_format_version(df_in_name, data_formats),
            "type": pstype,
        }

        spec["streams"]["subscribes"].append(subscriber)

        df_out_name = meta["methods"][method]["output"]

        publisher = {
            "config_key": "{0}_publisher".format(method),
            "format": df_out_name,
            "version": _get_format_version(df_out_name, data_formats),
            "type": pstype,
        }

        spec["streams"]["publishes"].append(publisher)

    # Validate that we have a valid spec
    validate(instance=spec, schema=dcae_cs_schema)

    return spec


def generate_spec(model_repo_path, model_name, data_formats, docker_uri):
    """
    Generate and write the component spec to disk
    Returns the spec
    """
    spec = _generate_spec(
        model_name, utils.get_metadata(model_repo_path, model_name), utils.component_schema.get(), data_formats, docker_uri
    )
    fname = "{0}_dcae_component_specification.json".format(model_name)
    with open("{0}/{1}".format(model_repo_path, fname), "w") as f:
        f.write(json.dumps(spec))

    return spec