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
|
# Copyright 2025 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library. If not, see <http://www.gnu.org/licenses/>.
#
#
import tempfile
import shutil
from functools import wraps
from typing import Type
from vyos.proto import vyconf_client
from vyos.migrate import ConfigMigrate
from vyos.migrate import ConfigMigrateError
from vyos.component_version import append_system_version
def output(o):
out = ''
for res in (o.output, o.error, o.warning):
if res is not None:
out = out + res
return out
class VyconfSession:
def __init__(self, token: str = None, on_error: Type[Exception] = None):
if token is None:
out = vyconf_client.send_request('setup_session')
self.__token = out.output
else:
self.__token = token
self.on_error = on_error
@staticmethod
def raise_exception(f):
@wraps(f)
def wrapped(self, *args, **kwargs):
if self.on_error is None:
return f(self, *args, **kwargs)
o, e = f(self, *args, **kwargs)
if e:
raise self.on_error(o)
return o, e
return wrapped
@raise_exception
def set(self, path: list[str]) -> tuple[str, int]:
out = vyconf_client.send_request('set', token=self.__token, path=path)
return output(out), out.status
@raise_exception
def delete(self, path: list[str]) -> tuple[str, int]:
out = vyconf_client.send_request('delete', token=self.__token, path=path)
return output(out), out.status
@raise_exception
def commit(self) -> tuple[str, int]:
out = vyconf_client.send_request('commit', token=self.__token)
return output(out), out.status
@raise_exception
def discard(self) -> tuple[str, int]:
out = vyconf_client.send_request('discard', token=self.__token)
return output(out), out.status
def session_changed(self) -> bool:
out = vyconf_client.send_request('session_changed', token=self.__token)
return not bool(out.status)
@raise_exception
def load_config(self, file: str, migrate: bool = False) -> tuple[str, int]:
# pylint: disable=consider-using-with
if migrate:
tmp = tempfile.NamedTemporaryFile()
shutil.copy2(file, tmp.name)
config_migrate = ConfigMigrate(tmp.name)
try:
config_migrate.run()
except ConfigMigrateError as e:
tmp.close()
return repr(e), 1
file = tmp.name
else:
tmp = ''
out = vyconf_client.send_request('load', token=self.__token, location=file)
if tmp:
tmp.close()
return output(out), out.status
@raise_exception
def save_config(self, file: str, append_version: bool = False) -> tuple[str, int]:
out = vyconf_client.send_request('save', token=self.__token, location=file)
if append_version:
append_system_version(file)
return output(out), out.status
@raise_exception
def show_config(self, path: list[str] = None) -> tuple[str, int]:
if path is None:
path = []
out = vyconf_client.send_request('show_config', token=self.__token, path=path)
return output(out), out.status
def __del__(self):
out = vyconf_client.send_request('teardown', token=self.__token)
if out.status:
print(f'Could not tear down session {self.__token}: {output(out)}')
|
