Sonarfix: Reduce cognitive complexity
[vvp/validation-scripts.git] / ice_validator / tests / test_nova_servers_workload_context.py
1 # -*- coding: utf8 -*-
2 # ============LICENSE_START====================================================
3 # org.onap.vvp/validation-scripts
4 # ===================================================================
5 # Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 # ===================================================================
7 #
8 # Unless otherwise specified, all software contained herein is licensed
9 # under the Apache License, Version 2.0 (the "License");
10 # you may not use this software except in compliance with the License.
11 # You may obtain a copy of the License at
12 #
13 #             http://www.apache.org/licenses/LICENSE-2.0
14 #
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
20 #
21 #
22 #
23 # Unless otherwise specified, all documentation contained herein is licensed
24 # under the Creative Commons License, Attribution 4.0 Intl. (the "License");
25 # you may not use this documentation except in compliance with the License.
26 # You may obtain a copy of the License at
27 #
28 #             https://creativecommons.org/licenses/by/4.0/
29 #
30 # Unless required by applicable law or agreed to in writing, documentation
31 # distributed under the License is distributed on an "AS IS" BASIS,
32 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33 # See the License for the specific language governing permissions and
34 # limitations under the License.
35 #
36 # ============LICENSE_END============================================
37 #
38 #
39
40 """workload context
41 """
42
43 import pytest
44 from tests import cached_yaml as yaml
45
46 from .helpers import validates, get_param
47
48 VERSION = "1.0.0"
49
50
51 @validates("R-74978")
52 def test_workload_context(yaml_file):
53     """
54     A VNF's Heat Orchestration Template's OS::Nova::Server Resource
55     **MUST**
56     contain the metadata map value parameter 'workload_context'.
57
58     A VNF's Heat Orchestration Template's OS::Nova::Server Resource
59     metadata map value parameter 'workload_context' **MUST**
60     be declared as type: 'string'.
61     """
62     with open(yaml_file) as fh:
63         yml = yaml.load(fh)
64
65     if "parameters" not in yml:
66         pytest.skip("No parameters specified in the heat template")
67     if "resources" not in yml:
68         pytest.skip("No resources specified in the heat template")
69
70     for resource, v in yml["resources"].items():
71         if (
72             not isinstance(v, dict)
73             or v.get("type") != "OS::Nova::Server"
74             or "properties" not in v
75         ):
76             continue
77         metadata = v["properties"].get("metadata")
78         if not isinstance(metadata, dict):
79             continue
80         error = validate_metadata(metadata, yml["parameters"])
81         if error:
82             assert False, '%s resource "%s" %s' % (yaml_file, resource, error)
83
84
85 def validate_metadata(metadata, parameters):
86     """validate metatdata.
87     Ensure metadata references parameter workload_context,
88     and that it is a string.
89     Return error message string or None if no errors.
90     """
91     for value in metadata.values():
92         if get_param(value) == "workload_context" and parameters.get("workload_context", {}).get("type", "") != "string":
93             return 'must have parameter "workload_context" of type "string"'
94         else:
95             return None