# -*- coding: utf8 -*-
# ============LICENSE_START====================================================
# org.onap.vvp/validation-scripts
# ===================================================================
# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
# ===================================================================
#
# Unless otherwise specified, all software contained herein is licensed
# under the Apache License, Version 2.0 (the "License");
# you may not use this software 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.
#
#
#
# Unless otherwise specified, all documentation contained herein is licensed
# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
# you may not use this documentation except in compliance with the License.
# You may obtain a copy of the License at
#
#             https://creativecommons.org/licenses/by/4.0/
#
# Unless required by applicable law or agreed to in writing, documentation
# 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============================================
#
#

"""environment context
"""

import pytest
from tests import cached_yaml as yaml

from .helpers import validates, get_param


VERSION = "1.0.0"


@validates("R-20308")
def test_environment_context(yaml_file):
    """
    A VNF's Heat Orchestration Template's OS::Nova::Server Resource
    **MUST**
    contain the metadata map value parameter 'environment_context'.

    A VNF's Heat Orchestration Template's OS::Nova::Server Resource
    metadata map value parameter 'environment_context' **MUST**
    be declared as type: 'string'.
    """
    with open(yaml_file) as fh:
        yml = yaml.load(fh)

    if "parameters" not in yml:
        pytest.skip("No parameters specified in the heat template")
    if "resources" not in yml:
        pytest.skip("No resources specified in the heat template")

    for resource, v in yml["resources"].items():
        if (
            not isinstance(v, dict)
            or v.get("type") != "OS::Nova::Server"
            or "properties" not in v
        ):
            continue
        metadata = v["properties"].get("metadata")
        if not isinstance(metadata, dict):
            continue
        error = validate_metadata(metadata, yml["parameters"])
        if error:
            assert False, '%s resource "%s" %s' % (yaml_file, resource, error)


def validate_metadata(metadata, parameters):
    """validate metatdata.
    Ensure metadata references parameter environment_context,
    and that it is a string.
    Return error message string or None if no errors.
    """
    for value in metadata.values():
        if get_param(value) == "environment_context" and parameters.get("environment_context", {}).get("type", "") != "string":
            return 'must have parameter "environment_context" of type "string"'