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
|
#!/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 typing information of
# composite functions comprising several requests.
import os
import sys
import json
from inspect import signature, getmembers, isfunction, isclass, getmro
from jinja2 import Template
from vyos.defaults import directories
if __package__ is None or __package__ == '':
sys.path.append("/usr/libexec/vyos/services/api")
from graphql.libs.op_mode import snake_to_pascal_case, map_type_name
from composite_function import queries, mutations
from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.xml import defaults
else:
from .. libs.op_mode import snake_to_pascal_case, map_type_name
from . composite_function import queries, mutations
from .. import state
SCHEMA_PATH = directories['api_schema']
if __package__ is None or __package__ == '':
# allow running stand-alone
conf = Config()
base = ['service', 'https', 'api']
graphql_dict = conf.get_config_dict(base, key_mangling=('-', '_'),
no_tag_node_value_mangle=True,
get_first_key=True)
if 'graphql' not in graphql_dict:
exit("graphql is not configured")
graphql_dict = dict_merge(defaults(base), graphql_dict)
auth_type = graphql_dict['graphql']['authentication']['type']
else:
auth_type = state.settings['app'].state.vyos_auth_type
schema_data: dict = {'auth_type': auth_type,
'schema_name': '',
'schema_fields': []}
query_template = """
{%- if auth_type == 'key' %}
input {{ schema_name }}Input {
key: String!
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
{%- elif schema_fields %}
input {{ schema_name }}Input {
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
{%- endif %}
type {{ schema_name }} {
result: Generic
}
type {{ schema_name }}Result {
data: {{ schema_name }}
success: Boolean!
errors: [String]
}
extend type Query {
{%- if auth_type == 'key' or schema_fields %}
{{ schema_name }}(data: {{ schema_name }}Input) : {{ schema_name }}Result @compositequery
{%- else %}
{{ schema_name }} : {{ schema_name }}Result @compositequery
{%- endif %}
}
"""
mutation_template = """
{%- if auth_type == 'key' %}
input {{ schema_name }}Input {
key: String!
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
{%- elif schema_fields %}
input {{ schema_name }}Input {
{%- for field_entry in schema_fields %}
{{ field_entry }}
{%- endfor %}
}
{%- endif %}
type {{ schema_name }} {
result: Generic
}
type {{ schema_name }}Result {
data: {{ schema_name }}
success: Boolean!
errors: [String]
}
extend type Mutation {
{%- if auth_type == 'key' or schema_fields %}
{{ schema_name }}(data: {{ schema_name }}Input) : {{ schema_name }}Result @compositemutation
{%- else %}
{{ schema_name }} : {{ schema_name }}Result @compositemutation
{%- endif %}
}
"""
def create_schema(func_name: str, func: callable, template: str) -> str:
sig = signature(func)
field_dict = {}
for k in sig.parameters:
field_dict[sig.parameters[k].name] = map_type_name(sig.parameters[k].annotation)
schema_fields = []
for k,v in field_dict.items():
schema_fields.append(k+': '+v)
schema_data['schema_name'] = snake_to_pascal_case(func_name)
schema_data['schema_fields'] = schema_fields
j2_template = Template(template)
res = j2_template.render(schema_data)
return res
def generate_composite_definitions():
results = []
for name,func in queries.items():
res = create_schema(name, func, query_template)
results.append(res)
for name,func in mutations.items():
res = create_schema(name, func, mutation_template)
results.append(res)
out = '\n'.join(results)
with open(f'{SCHEMA_PATH}/composite.graphql', 'w') as f:
f.write(out)
if __name__ == '__main__':
generate_composite_definitions()
|
