|
1
|
|
|
import codecs |
|
|
|
|
|
|
2
|
|
|
import yaml |
|
|
|
|
|
|
3
|
|
|
|
|
4
|
|
|
from ssg._jinja import _extract_substitutions_dict_from_template |
|
5
|
|
|
from ssg._jinja import _rename_items |
|
6
|
|
|
from ssg._jinja import * |
|
|
|
|
|
|
7
|
|
|
from ssg._constants import * |
|
|
|
|
|
|
8
|
|
|
|
|
9
|
|
|
try: |
|
10
|
|
|
from yaml import CSafeLoader as yaml_SafeLoader |
|
|
|
|
|
|
11
|
|
|
except ImportError: |
|
12
|
|
|
from yaml import SafeLoader as yaml_SafeLoader |
|
13
|
|
|
|
|
14
|
|
|
|
|
15
|
|
|
def _bool_constructor(self, node): |
|
16
|
|
|
return self.construct_scalar(node) |
|
17
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
# Don't follow python bool case |
|
20
|
|
|
yaml_SafeLoader.add_constructor(u'tag:yaml.org,2002:bool', _bool_constructor) |
|
21
|
|
|
|
|
22
|
|
|
|
|
23
|
|
|
def _save_rename(result, stem, prefix): |
|
24
|
|
|
result["{0}_{1}".format(prefix, stem)] = stem |
|
25
|
|
|
|
|
26
|
|
|
|
|
27
|
|
|
def _open_yaml(stream): |
|
28
|
|
|
""" |
|
29
|
|
|
Open given file-like object and parse it as YAML |
|
30
|
|
|
Return None if it contains "documentation_complete" key set to "false". |
|
31
|
|
|
""" |
|
32
|
|
|
yaml_contents = yaml.load(stream, Loader=yaml_SafeLoader) |
|
33
|
|
|
|
|
34
|
|
|
if yaml_contents.pop("documentation_complete", "true") == "false": |
|
35
|
|
|
return None |
|
36
|
|
|
|
|
37
|
|
|
return yaml_contents |
|
38
|
|
|
|
|
39
|
|
|
|
|
40
|
|
|
def _identify_special_macro_mapping(existing_properties): |
|
41
|
|
|
result = dict() |
|
42
|
|
|
|
|
43
|
|
|
pkg_manager = existing_properties.get("pkg_manager") |
|
44
|
|
|
if pkg_manager is not None: |
|
45
|
|
|
_save_rename(result, "describe_package_install", pkg_manager) |
|
46
|
|
|
_save_rename(result, "describe_package_remove", pkg_manager) |
|
47
|
|
|
|
|
48
|
|
|
pkg_system = existing_properties.get("pkg_system") |
|
49
|
|
|
if pkg_system is not None: |
|
50
|
|
|
_save_rename(result, "ocil_package", pkg_system) |
|
51
|
|
|
_save_rename(result, "complete_ocil_entry_package", pkg_system) |
|
52
|
|
|
|
|
53
|
|
|
init_system = existing_properties.get("init_system") |
|
54
|
|
|
if init_system is not None: |
|
55
|
|
|
_save_rename(result, "describe_service_enable", init_system) |
|
56
|
|
|
_save_rename(result, "describe_service_disable", init_system) |
|
57
|
|
|
_save_rename(result, "ocil_service_enabled", init_system) |
|
58
|
|
|
_save_rename(result, "ocil_service_disabled", init_system) |
|
59
|
|
|
_save_rename(result, "describe_socket_enable", init_system) |
|
60
|
|
|
_save_rename(result, "describe_socket_disable", init_system) |
|
61
|
|
|
_save_rename(result, "complete_ocil_entry_socket_and_service_disabled", |
|
62
|
|
|
init_system) |
|
63
|
|
|
|
|
64
|
|
|
return result |
|
65
|
|
|
|
|
66
|
|
|
|
|
67
|
|
|
def _get_implied_properties(existing_properties): |
|
68
|
|
|
result = dict() |
|
69
|
|
|
if ("pkg_manager" in existing_properties and |
|
70
|
|
|
"pkg_system" not in existing_properties): |
|
71
|
|
|
pkg_manager = existing_properties["pkg_manager"] |
|
72
|
|
|
result["pkg_system"] = PKG_MANAGER_TO_SYSTEM[pkg_manager] |
|
|
|
|
|
|
73
|
|
|
return result |
|
74
|
|
|
|
|
75
|
|
|
|
|
76
|
|
|
def open_and_expand(yaml_file, substitutions_dict=None): |
|
77
|
|
|
""" |
|
78
|
|
|
Process the file as a template, using substitutions_dict to perform |
|
79
|
|
|
expansion. Then, process the expansion result as a YAML content. |
|
80
|
|
|
|
|
81
|
|
|
See also: _open_yaml |
|
82
|
|
|
""" |
|
83
|
|
|
if substitutions_dict is None: |
|
84
|
|
|
substitutions_dict = dict() |
|
85
|
|
|
|
|
86
|
|
|
expanded_template = process_file(yaml_file, substitutions_dict) |
|
|
|
|
|
|
87
|
|
|
yaml_contents = _open_yaml(expanded_template) |
|
88
|
|
|
return yaml_contents |
|
89
|
|
|
|
|
90
|
|
|
|
|
91
|
|
|
def open_and_macro_expand(yaml_file, substitutions_dict=None): |
|
92
|
|
|
""" |
|
93
|
|
|
Do the same as open_and_expand, but load definitions of macros |
|
94
|
|
|
so they can be expanded in the template. |
|
95
|
|
|
""" |
|
96
|
|
|
if substitutions_dict is None: |
|
97
|
|
|
substitutions_dict = dict() |
|
98
|
|
|
|
|
99
|
|
|
try: |
|
100
|
|
|
macro_definitions = _extract_substitutions_dict_from_template( |
|
101
|
|
|
JINJA_MACROS_DEFINITIONS, substitutions_dict) |
|
|
|
|
|
|
102
|
|
|
except Exception as exc: |
|
103
|
|
|
msg = ("Error extracting macro definitions from {0}: {1}" |
|
104
|
|
|
.format(JINJA_MACROS_DEFINITIONS, str(exc))) |
|
105
|
|
|
raise RuntimeError(msg) |
|
106
|
|
|
mapping = _identify_special_macro_mapping(substitutions_dict) |
|
107
|
|
|
special_macros = _rename_items(macro_definitions, mapping) |
|
108
|
|
|
substitutions_dict.update(macro_definitions) |
|
109
|
|
|
substitutions_dict.update(special_macros) |
|
110
|
|
|
return open_and_expand(yaml_file, substitutions_dict) |
|
111
|
|
|
|
|
112
|
|
|
|
|
113
|
|
|
def open_raw(yaml_file): |
|
114
|
|
|
""" |
|
115
|
|
|
Open given file-like object and parse it as YAML |
|
116
|
|
|
without performing any kind of template processing |
|
117
|
|
|
|
|
118
|
|
|
See also: _open_yaml |
|
119
|
|
|
""" |
|
120
|
|
|
with codecs.open(yaml_file, "r", "utf8") as stream: |
|
121
|
|
|
yaml_contents = _open_yaml(stream) |
|
122
|
|
|
return yaml_contents |
|
123
|
|
|
|
|
124
|
|
|
|
|
125
|
|
|
def open_environment(build_config_yaml, product_yaml): |
|
|
|
|
|
|
126
|
|
|
contents = open_raw(build_config_yaml) |
|
127
|
|
|
contents.update(open_raw(product_yaml)) |
|
128
|
|
|
contents.update(_get_implied_properties(contents)) |
|
129
|
|
|
return contents |
|
130
|
|
|
|
ComplianceAsCode /
content
Loading history...
The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:
If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.