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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
#!/usr/bin/env python3
import json
import os
import requests
import argparse
PRAGMA_ONCE = '''#pragma once
'''
WARNING = '''/****************************************************************
* READ THIS WARNING FIRST
* This is an auto-generated header which contains definitions
* for Redfish DMTF defined messages.
* DO NOT modify this registry outside of running the
* parse_registries.py script. The definitions contained within
* this file are owned by DMTF. Any modifications to these files
* should be first pushed to the relevant registry in the DMTF
* github organization.
***************************************************************/'''
REGISTRY_HEADER = PRAGMA_ONCE + WARNING + '''
#include "registries.hpp"
#include <array>
// clang-format off
namespace redfish::registries::{}
{{
'''
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
include_path = os.path.realpath(
os.path.join(
SCRIPT_DIR,
"..",
"redfish-core",
"include",
"registries"))
proxies = {
'https': os.environ.get("https_proxy", None)
}
def make_getter(dmtf_name, header_name, type_name):
url = 'https://redfish.dmtf.org/registries/{}'.format(dmtf_name)
dmtf = requests.get(url, proxies=proxies)
dmtf.raise_for_status()
json_file = json.loads(dmtf.text)
path = os.path.join(include_path, header_name)
return (path, json_file, type_name, url)
def update_registries(files):
# Remove the old files
for file, json_dict, namespace, url in files:
try:
os.remove(file)
except BaseException:
print("{} not found".format(file))
with open(file, 'w') as registry:
registry.write(REGISTRY_HEADER.format(namespace))
# Parse the Registry header info
registry.write(
"const Header header = {{\n"
" \"{json_dict[@Redfish.Copyright]}\",\n"
" \"{json_dict[@odata.type]}\",\n"
" \"{json_dict[Id]}\",\n"
" \"{json_dict[Name]}\",\n"
" \"{json_dict[Language]}\",\n"
" \"{json_dict[Description]}\",\n"
" \"{json_dict[RegistryPrefix]}\",\n"
" \"{json_dict[RegistryVersion]}\",\n"
" \"{json_dict[OwningEntity]}\",\n"
"}};\n"
"constexpr const char* url =\n"
" \"{url}\";\n"
"\n"
"constexpr std::array registry =\n"
"{{\n".format(
json_dict=json_dict,
url=url,
))
messages_sorted = sorted(json_dict["Messages"].items())
for messageId, message in messages_sorted:
registry.write(
" MessageEntry{{\n"
" \"{messageId}\",\n"
" {{\n"
" \"{message[Description]}\",\n"
" \"{message[Message]}\",\n"
" \"{message[MessageSeverity]}\",\n"
" {message[NumberOfArgs]},\n"
" {{".format(
messageId=messageId,
message=message
))
paramTypes = message.get("ParamTypes")
if paramTypes:
for paramType in paramTypes:
registry.write(
"\n"
" \"{}\",".format(paramType)
)
registry.write("\n },\n")
else:
registry.write("},\n")
registry.write(
" \"{message[Resolution]}\",\n"
" }}}},\n".format(message=message))
registry.write(
"\n};\n"
"\n"
"enum class Index\n"
"{\n"
)
for index, (messageId, message) in enumerate(messages_sorted):
messageId = messageId[0].lower() + messageId[1:]
registry.write(
" {} = {},\n".format(messageId, index))
registry.write(
"}};\n"
"}} // namespace redfish::registries::{}\n"
.format(namespace))
def get_privilege_string_from_list(privilege_list):
privilege_string = "{{\n"
for privilege_json in privilege_list:
privileges = privilege_json["Privilege"]
privilege_string += " {"
for privilege in privileges:
if privilege == "NoAuth":
continue
privilege_string += "\""
privilege_string += privilege
privilege_string += "\",\n"
if privilege != "NoAuth":
privilege_string = privilege_string[:-2]
privilege_string += "}"
privilege_string += ",\n"
privilege_string = privilege_string[:-2]
privilege_string += "\n}}"
return privilege_string
def get_variable_name_for_privilege_set(privilege_list):
names = []
for privilege_json in privilege_list:
privileges = privilege_json["Privilege"]
names.append("And".join(privileges))
return "Or".join(names)
PRIVILEGE_HEADER = PRAGMA_ONCE + WARNING + '''
#include "privileges.hpp"
#include <array>
// clang-format off
namespace redfish::privileges
{
'''
def make_privilege_registry():
path, json_file, type_name, url = \
make_getter('Redfish_1.3.0_PrivilegeRegistry.json',
'privilege_registry.hpp', 'privilege')
with open(path, 'w') as registry:
registry.write(PRIVILEGE_HEADER)
privilege_dict = {}
for mapping in json_file["Mappings"]:
# first pass, identify all the unique privilege sets
for operation, privilege_list in mapping["OperationMap"].items():
privilege_dict[get_privilege_string_from_list(
privilege_list)] = (privilege_list, )
for index, key in enumerate(privilege_dict):
(privilege_list, ) = privilege_dict[key]
name = get_variable_name_for_privilege_set(privilege_list)
registry.write(
"const std::array<Privileges, {length}> "
"privilegeSet{name} = {key};\n"
.format(length=len(privilege_list), name=name, key=key)
)
privilege_dict[key] = (privilege_list, name)
for mapping in json_file["Mappings"]:
entity = mapping["Entity"]
registry.write("// {}\n".format(entity))
for operation, privilege_list in mapping["OperationMap"].items():
privilege_string = get_privilege_string_from_list(
privilege_list)
operation = operation.lower()
registry.write(
"const static auto& {}{} = privilegeSet{};\n".format(
operation,
entity,
privilege_dict[privilege_string][1]))
registry.write("\n")
registry.write(
"} // namespace redfish::privileges\n"
"// clang-format on\n")
def main():
parser = argparse.ArgumentParser()
parser.add_argument(
'--registries', type=str,
default="base,task_event,resource_event,privilege",
help="Comma delimited list of registries to update")
args = parser.parse_args()
registries = set(args.registries.split(","))
files = []
if "base" in registries:
files.append(make_getter('Base.1.13.0.json',
'base_message_registry.hpp',
'base'))
if "task_event" in registries:
files.append(make_getter('TaskEvent.1.0.3.json',
'task_event_message_registry.hpp',
'task_event'))
if "resource_event" in registries:
files.append(make_getter('ResourceEvent.1.0.3.json',
'resource_event_message_registry.hpp',
'resource_event'))
update_registries(files)
if "privilege" in registries:
make_privilege_registry()
if __name__ == "__main__":
main()
|
