add excluded changes to YANG push on-change wrapper

Change-Id: Idb7bb48a3c60ff70286441cd4d0a5c1c28acee15

Author: peckato1

include/sysrepo-cpp/Enum.hpp

@@ -209,6 +209,18 @@ constexpr GetOptions operator|(const GetOptions a, const GetOptions b)
     return implEnumBitOr(a, b);
 }
 
+/**
+ * @brief Wraps `srsn_yang_push_change_t`
+ */
+enum class YangPushChange : uint32_t {
+    Create = 0, /**< SRSN_YP_CHANGE_CREATE */
+    Delete = 1, /**< SRSN_YP_CHANGE_DELETE */
+    Insert = 2, /**< SRSN_YP_CHANGE_INSERT */
+    Move = 3, /**< SRSN_YP_CHANGE_MOVE */
+    Replace = 4, /**< SRSN_YP_CHANGE_REPLACE */
+    EnumCount = 5, /**< SRSN_COUNT_YP_CHANGE */
+};
+
 std::ostream& operator<<(std::ostream& os, const NotificationType& type);
 std::ostream& operator<<(std::ostream& os, const Event& event);
 std::ostream& operator<<(std::ostream& os, const ChangeOperation& changeOp);

include/sysrepo-cpp/Session.hpp

@@ -145,6 +145,7 @@ class Session {
         const std::optional<std::variant<std::string, libyang::DataNodeAny>>& filter,
         const std::optional<std::chrono::milliseconds>& dampeningPeriod = std::nullopt,
         SyncOnStart syncOnStart = SyncOnStart::No,
+        const std::set<YangPushChange>& excludedChanges = {},
         const std::optional<NotificationTimeStamp>& stopTime = std::nullopt);
     [[nodiscard]] DynamicSubscription subscribeNotifications(
         const std::optional<std::variant<std::string, libyang::DataNodeAny>>& filter,

src/Session.cpp

@@ -607,19 +607,29 @@ DynamicSubscription Session::yangPushOnChange(
     const std::optional<std::variant<std::string, libyang::DataNodeAny>>& filter,
     const std::optional<std::chrono::milliseconds>& dampeningPeriod,
     SyncOnStart syncOnStart,
+    const std::set<YangPushChange>& excludedChanges,
     const std::optional<NotificationTimeStamp>& stopTime)
 {
     int fd;
     uint32_t subId;
     auto stopSpec = stopTime ? std::optional{toTimespec(*stopTime)} : std::nullopt;
     auto xpathFilter = constructXPathFilter(filter);
 
+    /* The enum values are not used as the other enum flags in sysrepo-cpp.
+     * srsn_yang_push_on_change expects an integer array of size EnumCount with 0 or 1 values.
+     */
+    using YangPushChangeUnderlying = std::underlying_type_t<YangPushChange>;
+    std::array<int, static_cast<YangPushChangeUnderlying>(YangPushChange::EnumCount)> excludedChangesArray{};
+    for (const auto& change: excludedChanges) {
+        excludedChangesArray[static_cast<YangPushChangeUnderlying>(change)] = 1;
+    }
+
     auto res = srsn_yang_push_on_change(m_sess.get(),
                                         toDatastore(activeDatastore()),
                                         xpathFilter ? xpathFilter->c_str() : nullptr,
                                         dampeningPeriod ? dampeningPeriod->count() : 0,
                                         syncOnStart == SyncOnStart::Yes,
-                                        nullptr,
+                                        excludedChangesArray.data(),
                                         stopSpec ? &stopSpec.value() : nullptr,
                                         0,
                                         nullptr,

src/utils/enum.hpp

@@ -9,6 +9,7 @@
 #include <type_traits>
 extern "C" {
 #include <sysrepo.h>
+#include <sysrepo/subscribed_notifications.h>
 }
 #include <sysrepo-cpp/Enum.hpp>
 
@@ -171,4 +172,11 @@ constexpr sr_get_options_t toGetOptions(const GetOptions opts)
 {
     return static_cast<sr_get_options_t>(opts);
 }
+
+static_assert(static_cast<YangPushChange>(SRSN_YP_CHANGE_CREATE) == YangPushChange::Create);
+static_assert(static_cast<YangPushChange>(SRSN_YP_CHANGE_DELETE) == YangPushChange::Delete);
+static_assert(static_cast<YangPushChange>(SRSN_YP_CHANGE_INSERT) == YangPushChange::Insert);
+static_assert(static_cast<YangPushChange>(SRSN_YP_CHANGE_MOVE) == YangPushChange::Move);
+static_assert(static_cast<YangPushChange>(SRSN_YP_CHANGE_REPLACE) == YangPushChange::Replace);
+static_assert(static_cast<YangPushChange>(SRSN_COUNT_YP_CHANGE) == YangPushChange::EnumCount);
 }

tests/subscriptions-dynamic.cpp

@@ -497,6 +497,66 @@ TEST_CASE("Dynamic subscriptions")
             sub.terminate();
             REQUIRE_PIPE_HANGUP(sub);
         }
+
+        DOCTEST_SUBCASE("Excluded changes")
+        {
+            auto sub = sess.yangPushOnChange(std::nullopt, std::nullopt, sysrepo::SyncOnStart::No, {sysrepo::YangPushChange::Create});
+
+            client.setItem("/test_module:leafInt32", "123");
+            client.applyChanges(); // excluded (create)
+            client.setItem("/test_module:leafInt32", "124");
+            client.applyChanges();
+            client.setItem("/test_module:leafInt32", "125");
+            client.applyChanges();
+
+            REQUIRE_YANG_PUSH_UPDATE(sub, R"({
+  "ietf-yang-push:push-change-update": {
+    "datastore-changes": {
+      "yang-patch": {
+        "patch-id": "patch-1",
+        "edit": [
+          {
+            "edit-id": "edit-1",
+            "operation": "replace",
+            "target": "/test_module:leafInt32",
+            "value": {
+              "test_module:leafInt32": 124
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+)");
+
+            READ_YANG_PUSH_UPDATE(sub);
+
+            REQUIRE_YANG_PUSH_UPDATE(sub, R"({
+  "ietf-yang-push:push-change-update": {
+    "datastore-changes": {
+      "yang-patch": {
+        "patch-id": "patch-2",
+        "edit": [
+          {
+            "edit-id": "edit-1",
+            "operation": "replace",
+            "target": "/test_module:leafInt32",
+            "value": {
+              "test_module:leafInt32": 125
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+)");
+            READ_YANG_PUSH_UPDATE(sub);
+
+            sub.terminate();
+            REQUIRE_PIPE_HANGUP(sub);
+        }
     }
 
     DOCTEST_SUBCASE("YANG Push periodic")