connection: add install, update and remove in batch

Sysrepo implemented nex function allowing to install, update and remove
modules in batch. It allows to spend less time installinf lot of
modules. This patch allows to call theses function with the Python
wrapper.

Author: jeanseb6wind

README.rst

@@ -49,11 +49,11 @@ On a Debian/Ubuntu system:
 Compatibility
 -------------
 
-The current version requires at least C `sysrepo 2.1.66`__.
+The current version requires at least C `sysrepo 2.2.0`__.
 
 The last version of the bindings that works with C `sysrepo 1.x`__ is v0.7.0__.
 
-__ https://github.com/sysrepo/sysrepo/commit/a2a45fb32542
+__ https://github.com/sysrepo/sysrepo/commit/8c48a7a50eb2
 __ https://github.com/sysrepo/sysrepo/tree/libyang1
 __ https://pypi.org/project/sysrepo/0.7.0/
 

cffi/cdefs.h

@@ -81,8 +81,11 @@ int sr_disconnect(sr_conn_ctx_t *);
 const struct ly_ctx *sr_acquire_context(sr_conn_ctx_t *);
 void sr_release_context(sr_conn_ctx_t *);
 int sr_install_module(sr_conn_ctx_t *, const char *, const char *, const char **);
+int sr_install_modules(sr_conn_ctx_t *conn, const char **, const char *, const char ***);
 int sr_remove_module(sr_conn_ctx_t *, const char *, int);
+int sr_remove_modules(sr_conn_ctx_t *conn, const char **, int);
 int sr_update_module(sr_conn_ctx_t *, const char *, const char *);
+int sr_update_modules(sr_conn_ctx_t *, const char **, const char *);
 int sr_enable_module_feature(sr_conn_ctx_t *, const char *, const char *);
 int sr_disable_module_feature(sr_conn_ctx_t *, const char *, const char *);
 

cffi/source.c

@@ -9,6 +9,6 @@
 #if (SR_VERSION_MAJOR != 7)
 #error "This version of sysrepo bindings only works with libsysrepo.so.7"
 #endif
-#if (SR_VERSION_MINOR < 7)
-#error "Need at least libsysrepo.so.7.7"
+#if (SR_VERSION_MINOR < 10)
+#error "Need at least libsysrepo.so.7.10"
 #endif

examples/sysrepo-example2.yang

@@ -0,0 +1,7 @@
+module sysrepo-example2 {
+  yang-version 1.1;
+  namespace a;
+  prefix aug;
+
+  feature turbo2;
+}

sysrepo/connection.py

@@ -4,7 +4,7 @@
 from contextlib import contextmanager
 import logging
 import signal
-from typing import Optional, Sequence
+from typing import Dict, Optional, Sequence
 
 import libyang
 
@@ -166,6 +166,87 @@ def install_module(
             valid_codes=valid_codes,
         )
 
+    def install_modules(
+        self,
+        filepaths: Dict[str, Sequence[str]],
+        searchdirs: Optional[Sequence[str]] = None,
+        ignore_already_exists=False,
+    ) -> None:
+        """
+        Install new schemas (modules) into sysrepo in a batch.
+
+        :arg filepaths:
+            Dict of paths to the new schemas associated with a list of features to enable.
+            Can have either YANG or YIN extension/format.
+        :arg searchdirs:
+            Optional list of search directories for import schemas.
+        :arg ignore_already_exists:
+            Ignore error if module already exists in sysrepo.
+        """
+        schema_paths = tuple([str2c(k) for k in filepaths] + [ffi.NULL])
+
+        # We need to maintain a pointer to extension names in C
+        _ref = []
+        all_features = []
+        has_feature = False
+        for features in filepaths.values():
+            features_cname = []
+            for f in features:
+                cname = str2c(f)
+                _ref.append(cname)
+                features_cname.append(cname)
+                has_feature = True
+
+            all_features.append(ffi.new("char *[]", tuple(features_cname + [ffi.NULL])))
+
+        if has_feature:
+            all_features = tuple(all_features)
+        else:
+            all_features = ffi.NULL
+
+        if ignore_already_exists:
+            valid_codes = (lib.SR_ERR_OK, lib.SR_ERR_EXISTS)
+        else:
+            valid_codes = (lib.SR_ERR_OK,)
+
+        if not searchdirs:
+            searchdirs = []
+
+        check_call(
+            lib.sr_install_modules,
+            self.cdata,
+            schema_paths,
+            str2c(":".join(searchdirs)),
+            all_features,
+            valid_codes=valid_codes,
+        )
+
+    def update_modules(
+        self,
+        filepaths: Sequence[str],
+        searchdirs: Optional[Sequence[str]] = None,
+    ) -> None:
+        """
+        Update schemas (modules) into sysrepo in a batch.
+
+        :arg filepaths:
+            Array of paths to the new schemas.
+            Can have either YANG or YIN extension/format.
+        :arg searchdirs:
+            Optional list of search directories for import schemas.
+        """
+        schema_paths = tuple([str2c(path) for path in filepaths] + [ffi.NULL])
+        if not searchdirs:
+            searchdirs = []
+
+        check_call(
+            lib.sr_update_modules,
+            self.cdata,
+            schema_paths,
+            str2c(":".join(searchdirs)),
+            valid_codes=(lib.SR_ERR_OK,),
+        )
+
     def remove_module(self, name: str, force: bool = False) -> None:
         """
         Remove an installed module from sysrepo. Deferred until there are no
@@ -176,6 +257,16 @@ def remove_module(self, name: str, force: bool = False) -> None:
         """
         check_call(lib.sr_remove_module, self.cdata, str2c(name), force)
 
+    def remove_modules(self, names: Sequence[str], force: bool = False) -> None:
+        """
+        Remove installed modules from sysrepo.
+
+        :arg str names:
+            Array of names of the modules to remove.
+        """
+        names = tuple([str2c(n) for n in names] + [ffi.NULL])
+        check_call(lib.sr_remove_modules, self.cdata, names, force)
+
     def enable_module_feature(self, name: str, feature_name: str) -> None:
         """
         Enable a module feature.

tests/test_connection.py

@@ -42,9 +42,28 @@ def test_conn_start_session_operational(self):
             with conn.start_session("operational") as sess:
                 self.assertEqual(sess.get_datastore(), "operational")
 
-    def test_conn_install_module(self):
+    def test_conn_install_remove_modules(self):
+        YANG_FILE2 = os.path.join(
+            os.path.dirname(os.path.dirname(__file__)), "examples/sysrepo-example2.yang"
+        )
+        with sysrepo.SysrepoConnection() as conn:
+            filepaths = {YANG_FILE: ["turbo"], YANG_FILE2: ["turbo2"]}
+            # filepaths = {YANG_FILE2: ["turbo2"]}
+            conn.install_modules(filepaths)
+
+        with sysrepo.SysrepoConnection() as conn:
+            modules = ["sysrepo-example", "sysrepo-example2"]
+            conn.remove_modules(modules)
+
+    def test_conn_install_remove_module(self):
         with sysrepo.SysrepoConnection() as conn:
             conn.install_module(YANG_FILE, enabled_features=["turbo"])
+        with sysrepo.SysrepoConnection() as conn:
+            conn.remove_module("sysrepo-example")
+        with sysrepo.SysrepoConnection() as conn:
+            with conn.get_ly_ctx() as ctx:
+                with self.assertRaises(libyang.LibyangError):
+                    ctx.get_module("sysrepo-example")
 
     def test_conn_enable_module_feature(self):
         with sysrepo.SysrepoConnection() as conn:
@@ -57,11 +76,4 @@ def test_conn_enable_module_feature(self):
                 data = data["module"]
                 data = [x for x in data if x["name"] == "sysrepo-example"][0]
                 self.assertIn("feature", data)
-
-    def test_conn_remove_module(self):
-        with sysrepo.SysrepoConnection() as conn:
             conn.remove_module("sysrepo-example")
-        with sysrepo.SysrepoConnection() as conn:
-            with conn.get_ly_ctx() as ctx:
-                with self.assertRaises(libyang.LibyangError):
-                    ctx.get_module("sysrepo-example")