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
|
#!/usr/bin/env python3
#
# Copyright (C) 2022 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
# A utility to generate GraphQL schema defintions from standardized op-mode
# scripts.
import os
import json
import typing
from inspect import signature, getmembers, isfunction, isclass, getmro
from jinja2 import Template
from vyos.defaults import directories
if __package__ is None or __package__ == '':
from util import load_as_module, is_op_mode_function_name, is_show_function_name
else:
from . util import load_as_module, is_op_mode_function_name, is_show_function_name
OP_MODE_PATH = directories['op_mode']
SCHEMA_PATH = directories['api_schema']
DATA_DIR = directories['data']
op_mode_include_file = os.path.join(DATA_DIR, 'op-mode-standardized.json')
op_mode_error_schema = 'op_mode_error.graphql'
schema_data: dict = {'schema_name': '',
'schema_fields': []}
query_template = """
input {{ schema_name }}Input {
key: String!
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
type {{ schema_name }} {
result: Generic
}
type {{ schema_name }}Result {
data: {{ schema_name }}
op_mode_error: OpModeError
success: Boolean!
errors: [String]
}
extend type Query {
{{ schema_name }}(data: {{ schema_name }}Input) : {{ schema_name }}Result @genopquery
}
"""
mutation_template = """
input {{ schema_name }}Input {
key: String!
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
type {{ schema_name }} {
result: Generic
}
type {{ schema_name }}Result {
data: {{ schema_name }}
op_mode_error: OpModeError
success: Boolean!
errors: [String]
}
extend type Mutation {
{{ schema_name }}(data: {{ schema_name }}Input) : {{ schema_name }}Result @genopmutation
}
"""
error_template = """
interface OpModeError {
name: String!
message: String!
vyos_code: Int!
}
{% for name in error_names %}
type {{ name }} implements OpModeError {
name: String!
message: String!
vyos_code: Int!
}
{%- endfor %}
"""
def _snake_to_pascal_case(name: str) -> str:
res = ''.join(map(str.title, name.split('_')))
return res
def _map_type_name(type_name: type, optional: bool = False) -> str:
if type_name == str:
return 'String!' if not optional else 'String = null'
if type_name == int:
return 'Int!' if not optional else 'Int = null'
if type_name == bool:
return 'Boolean!' if not optional else 'Boolean = false'
if typing.get_origin(type_name) == list:
if not optional:
return f'[{_map_type_name(typing.get_args(type_name)[0])}]!'
return f'[{_map_type_name(typing.get_args(type_name)[0])}]'
# typing.Optional is typing.Union[_, NoneType]
if (typing.get_origin(type_name) is typing.Union and
typing.get_args(type_name)[1] == type(None)):
return f'{_map_type_name(typing.get_args(type_name)[0], optional=True)}'
# scalar 'Generic' is defined in schema.graphql
return 'Generic'
def create_schema(func_name: str, base_name: str, func: callable) -> str:
sig = signature(func)
field_dict = {}
for k in sig.parameters:
field_dict[sig.parameters[k].name] = _map_type_name(sig.parameters[k].annotation)
# It is assumed that if one is generating a schema for a 'show_*'
# function, that 'get_raw_data' is present and 'raw' is desired.
if 'raw' in list(field_dict):
del field_dict['raw']
schema_fields = []
for k,v in field_dict.items():
schema_fields.append(k+': '+v)
schema_data['schema_name'] = _snake_to_pascal_case(func_name + '_' + base_name)
schema_data['schema_fields'] = schema_fields
if is_show_function_name(func_name):
j2_template = Template(query_template)
else:
j2_template = Template(mutation_template)
res = j2_template.render(schema_data)
return res
def create_error_schema():
from vyos import opmode
e = Exception
err_types = getmembers(opmode, isclass)
err_types = [k for k in err_types if issubclass(k[1], e)]
# drop base class, to be replaced by interface type. Find the class
# programmatically, in case the base class name changes.
for i in range(len(err_types)):
if err_types[i][1] in getmro(err_types[i-1][1]):
del err_types[i]
break
err_names = [k[0] for k in err_types]
error_data = {'error_names': err_names}
j2_template = Template(error_template)
res = j2_template.render(error_data)
return res
def generate_op_mode_definitions():
out = create_error_schema()
with open(f'{SCHEMA_PATH}/{op_mode_error_schema}', 'w') as f:
f.write(out)
with open(op_mode_include_file) as f:
op_mode_files = json.load(f)
for file in op_mode_files:
basename = os.path.splitext(file)[0].replace('-', '_')
module = load_as_module(basename, os.path.join(OP_MODE_PATH, file))
funcs = getmembers(module, isfunction)
funcs = list(filter(lambda ft: is_op_mode_function_name(ft[0]), funcs))
funcs_dict = {}
for (name, thunk) in funcs:
funcs_dict[name] = thunk
results = []
for name,func in funcs_dict.items():
res = create_schema(name, basename, func)
results.append(res)
out = '\n'.join(results)
with open(f'{SCHEMA_PATH}/{basename}.graphql', 'w') as f:
f.write(out)
if __name__ == '__main__':
generate_op_mode_definitions()
|
