T7292: add Python module client library for vyconfd

.gitignore

@@ -153,6 +153,8 @@ data/configd-include.json
 
 # autogenerated vyos-commitd protobuf files
 python/vyos/proto/*pb2.py
+python/vyos/proto/*.desc
+python/vyos/proto/vyconf_proto.py
 
 # We do not use pip
 Pipfile

python/setup.py

@@ -7,6 +7,9 @@
 sys.path.append('./vyos')
 from defaults import directories
 
+def desc_out(f):
+    return os.path.splitext(f)[0] + '.desc'
+
 def packages(directory):
     return [
         _[0].replace('/','.')
@@ -37,9 +40,17 @@ def run(self):
                     'protoc',
                     '--python_out=vyos/proto',
                     f'--proto_path={self.proto_path}/',
+                    f'--descriptor_set_out=vyos/proto/{desc_out(proto_file)}',
                     proto_file,
                 ]
             )
+        subprocess.check_call(
+            [
+                'vyos/proto/generate_dataclass.py',
+                'vyos/proto/vyconf.desc',
+                '--out-dir=vyos/proto',
+            ]
+        )
 
         build_py.run(self)
 

python/vyos/configtree.py

@@ -523,35 +523,6 @@ def mask_inclusive(left, right, libpath=LIBPATH):
     return tree
 
 
-def show_commit_data(active_tree, proposed_tree, libpath=LIBPATH):
-    if not (
-        isinstance(active_tree, ConfigTree) and isinstance(proposed_tree, ConfigTree)
-    ):
-        raise TypeError('Arguments must be instances of ConfigTree')
-
-    __lib = cdll.LoadLibrary(libpath)
-    __show_commit_data = __lib.show_commit_data
-    __show_commit_data.argtypes = [c_void_p, c_void_p]
-    __show_commit_data.restype = c_char_p
-
-    res = __show_commit_data(active_tree._get_config(), proposed_tree._get_config())
-
-    return res.decode()
-
-
-def test_commit(active_tree, proposed_tree, libpath=LIBPATH):
-    if not (
-        isinstance(active_tree, ConfigTree) and isinstance(proposed_tree, ConfigTree)
-    ):
-        raise TypeError('Arguments must be instances of ConfigTree')
-
-    __lib = cdll.LoadLibrary(libpath)
-    __test_commit = __lib.test_commit
-    __test_commit.argtypes = [c_void_p, c_void_p]
-
-    __test_commit(active_tree._get_config(), proposed_tree._get_config())
-
-
 def reference_tree_to_json(from_dir, to_file, internal_cache='', libpath=LIBPATH):
     try:
         __lib = cdll.LoadLibrary(libpath)

python/vyos/proto/generate_dataclass.py

@@ -0,0 +1,178 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2025 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/>.
+#
+#
+import argparse
+import os
+
+from google.protobuf.descriptor_pb2 import FileDescriptorSet  # pylint: disable=no-name-in-module
+from google.protobuf.descriptor_pb2 import FieldDescriptorProto  # pylint: disable=no-name-in-module
+from humps import decamelize
+
+HEADER = """\
+from enum import IntEnum
+from dataclasses import dataclass
+from dataclasses import field
+"""
+
+
+def normalize(s: str) -> str:
+    """Decamelize and avoid syntactic collision"""
+    t = decamelize(s)
+    return t + '_' if t in ['from'] else t
+
+
+def generate_dataclass(descriptor_proto):
+    class_name = descriptor_proto.name
+    fields = []
+    for field_p in descriptor_proto.field:
+        field_name = field_p.name
+        field_type, field_default = get_type(field_p.type, field_p.type_name)
+        match field_p.label:
+            case FieldDescriptorProto.LABEL_REPEATED:
+                field_type = f'list[{field_type}] = field(default_factory=list)'
+            case FieldDescriptorProto.LABEL_OPTIONAL:
+                field_type = f'{field_type} = None'
+            case _:
+                field_type = f'{field_type} = {field_default}'
+
+        fields.append(f'    {field_name}: {field_type}')
+
+    code = f"""
+@dataclass
+class {class_name}:
+{chr(10).join(fields) if fields else '    pass'}
+"""
+
+    return code
+
+
+def generate_request(descriptor_proto):
+    class_name = descriptor_proto.name
+    fields = []
+    f_vars = []
+    for field_p in descriptor_proto.field:
+        field_name = field_p.name
+        field_type, field_default = get_type(field_p.type, field_p.type_name)
+        match field_p.label:
+            case FieldDescriptorProto.LABEL_REPEATED:
+                field_type = f'list[{field_type}] = []'
+            case FieldDescriptorProto.LABEL_OPTIONAL:
+                field_type = f'{field_type} = None'
+            case _:
+                field_type = f'{field_type} = {field_default}'
+
+        fields.append(f'{normalize(field_name)}: {field_type}')
+        f_vars.append(f'{normalize(field_name)}')
+
+    fields.insert(0, 'token: str = None')
+
+    code = f"""
+def set_request_{decamelize(class_name)}({', '.join(fields)}):
+    reqi = {class_name} ({', '.join(f_vars)})
+    req = Request({decamelize(class_name)}=reqi)
+    req_env = RequestEnvelope(token, req)
+    return req_env
+"""
+
+    return code
+
+
+def generate_nested_dataclass(descriptor_proto):
+    out = ''
+    for nested_p in descriptor_proto.nested_type:
+        out = out + generate_dataclass(nested_p)
+
+    return out
+
+
+def generate_nested_request(descriptor_proto):
+    out = ''
+    for nested_p in descriptor_proto.nested_type:
+        out = out + generate_request(nested_p)
+
+    return out
+
+
+def generate_enum_dataclass(descriptor_proto):
+    code = ''
+    for enum_p in descriptor_proto.enum_type:
+        enums = []
+        enum_name = enum_p.name
+        for enum_val in enum_p.value:
+            enums.append(f'    {enum_val.name} = {enum_val.number}')
+
+        code += f"""
+class {enum_name}(IntEnum):
+{chr(10).join(enums)}
+"""
+
+    return code
+
+
+def get_type(field_type, type_name):
+    res = 'Any', None
+    match field_type:
+        case FieldDescriptorProto.TYPE_STRING:
+            res = 'str', '""'
+        case FieldDescriptorProto.TYPE_INT32 | FieldDescriptorProto.TYPE_INT64:
+            res = 'int', 0
+        case FieldDescriptorProto.TYPE_FLOAT | FieldDescriptorProto.TYPE_DOUBLE:
+            res = 'float', 0.0
+        case FieldDescriptorProto.TYPE_BOOL:
+            res = 'bool', False
+        case FieldDescriptorProto.TYPE_MESSAGE | FieldDescriptorProto.TYPE_ENUM:
+            res = type_name.split('.')[-1], None
+        case _:
+            pass
+
+    return res
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('descriptor_file', help='protobuf .desc file')
+    parser.add_argument('--out-dir', help='directory to write generated file')
+    args = parser.parse_args()
+    desc_file = args.descriptor_file
+    out_dir = args.out_dir
+
+    with open(desc_file, 'rb') as f:
+        descriptor_set_data = f.read()
+
+    descriptor_set = FileDescriptorSet()
+    descriptor_set.ParseFromString(descriptor_set_data)
+
+    for file_proto in descriptor_set.file:
+        f = f'{file_proto.name.replace(".", "_")}.py'
+        f = os.path.join(out_dir, f)
+        dataclass_code = ''
+        nested_code = ''
+        enum_code = ''
+        request_code = ''
+        with open(f, 'w') as f:
+            enum_code += generate_enum_dataclass(file_proto)
+            for message_proto in file_proto.message_type:
+                dataclass_code += generate_dataclass(message_proto)
+                nested_code += generate_nested_dataclass(message_proto)
+                enum_code += generate_enum_dataclass(message_proto)
+                request_code += generate_nested_request(message_proto)
+
+            f.write(HEADER)
+            f.write(enum_code)
+            f.write(nested_code)
+            f.write(dataclass_code)
+            f.write(request_code)

python/vyos/proto/vyconf_client.py

@@ -0,0 +1,87 @@
+# Copyright 2025 VyOS maintainers and contributors <[email protected]>
+#
+# 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 socket
+from dataclasses import asdict
+
+from vyos.proto import vyconf_proto
+from vyos.proto import vyconf_pb2
+
+from google.protobuf.json_format import MessageToDict
+from google.protobuf.json_format import ParseDict
+
+socket_path = '/var/run/vyconfd.sock'
+
+
+def send_socket(msg: bytearray) -> bytes:
+    data = bytes()
+    client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+    client.connect(socket_path)
+    client.sendall(msg)
+
+    data_length = client.recv(4)
+    if data_length:
+        length = int.from_bytes(data_length)
+        data = client.recv(length)
+
+    client.close()
+
+    return data
+
+
+def request_to_msg(req: vyconf_proto.RequestEnvelope) -> vyconf_pb2.RequestEnvelope:
+    # pylint: disable=no-member
+
+    msg = vyconf_pb2.RequestEnvelope()
+    msg = ParseDict(asdict(req), msg, ignore_unknown_fields=True)
+    return msg
+
+
+def msg_to_response(msg: vyconf_pb2.Response) -> vyconf_proto.Response:
+    # pylint: disable=no-member
+
+    d = MessageToDict(msg, preserving_proto_field_name=True)
+
+    response = vyconf_proto.Response(**d)
+    return response
+
+
+def write_request(req: vyconf_proto.RequestEnvelope) -> bytearray:
+    req_msg = request_to_msg(req)
+    encoded_data = req_msg.SerializeToString()
+    byte_size = req_msg.ByteSize()
+    length_bytes = byte_size.to_bytes(4)
+    arr = bytearray(length_bytes)
+    arr.extend(encoded_data)
+
+    return arr
+
+
+def read_response(msg: bytes) -> vyconf_proto.Response:
+    response_msg = vyconf_pb2.Response()  # pylint: disable=no-member
+    response_msg.ParseFromString(msg)
+    response = msg_to_response(response_msg)
+
+    return response
+
+
+def send_request(name, *args, **kwargs):
+    func = getattr(vyconf_proto, f'set_request_{name}')
+    request_env = func(*args, **kwargs)
+    msg = write_request(request_env)
+    response_msg = send_socket(msg)
+    response = read_response(response_msg)
+
+    return response

src/services/vyos-commitd

@@ -72,8 +72,6 @@ class Session:
     # pylint: disable=too-many-instance-attributes
 
     session_id: str = ''
-    named_active: str = None
-    named_proposed: str = None
     dry_run: bool = False
     atomic: bool = False
     background: bool = False