[VVP] Fixed issue in unused parameter detection
[vvp/validation-scripts.git] / ice_validator / tests / utils / nested_iterables.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 from tests.helpers import traverse
40
41
42 def is_pseudo_param(parameter):
43     pseudo_parameters = ["OS::stack_name", "OS::stack_id", "OS::project_id"]
44     return parameter in pseudo_parameters
45
46
47 class ParameterCollector:
48     def __init__(self):
49         self.params = set()
50
51     def __call__(self, _, value):
52         if isinstance(value, str):
53             self.params.add(value)
54         elif isinstance(value, list) and len(value) >= 1:
55             self.params.add(value[0])
56
57
58 def find_all_get_param_in_yml(yml):
59     """
60     Recursively find all referenced parameters in a parsed yaml body
61     and return a list of parameters
62     """
63     collector = ParameterCollector()
64     traverse(yml, "get_param", collector)
65     return {p for p in collector.params if not is_pseudo_param(p)}
66
67
68 def find_all_get_resource_in_yml(yml):
69     """
70     Recursively find all referenced resources
71     in a parsed yaml body and return a list of resource ids
72     """
73     collector = ParameterCollector()
74     traverse(yml, "get_resource", collector)
75     return collector.params
76
77
78 def find_all_get_file_in_yml(yml):
79     """
80     Recursively find all get_file in a parsed yaml body
81     and return the list of referenced files/urls
82     """
83     collector = ParameterCollector()
84     traverse(yml, "get_file", collector)
85     return collector.params