From 0172314122fb3858cf1f29617b41466f7897ffe9 Mon Sep 17 00:00:00 2001
From: Satellite QE <115476073+Satellite-QE@users.noreply.github.com>
Date: Tue, 9 Apr 2024 03:49:11 -0400
Subject: [PATCH] new entity for NotificationRecipients (#1125)

Added new entity `NotificationRecipients` for `/notification_recipients` endpoint.

(cherry picked from commit e6e6ec6dcfcd5d258e32587eda95683c4554a049)

Co-authored-by: Pavel Novotny <pnovotny@redhat.com>
---
 nailgun/entities.py    | 14 ++++++++++++++
 tests/test_entities.py | 31 +++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)

diff --git a/nailgun/entities.py b/nailgun/entities.py
index 2f9d59de..8d9a36e6 100644
--- a/nailgun/entities.py
+++ b/nailgun/entities.py
@@ -8916,3 +8916,17 @@ def search(self, fields=None, query=None, filters=None):
         return super().search(
             fields=fields, query=query, filters=filters, path_fields={'user': self.user}
         )
+
+
+class NotificationRecipients(Entity, EntityReadMixin):
+    """A representation of /notification_recipients endpoint."""
+
+    def __init__(self, server_config=None, **kwargs):
+        self._fields = {
+            'notifications': entity_fields.ListField(),
+        }
+        self._meta = {
+            'api_path': '/notification_recipients',
+            'read_type': 'base',
+        }
+        super().__init__(server_config, **kwargs)
diff --git a/tests/test_entities.py b/tests/test_entities.py
index dd22fada..a20fb636 100644
--- a/tests/test_entities.py
+++ b/tests/test_entities.py
@@ -3999,3 +3999,34 @@ def test_scap_tailoring_file(self):
             _get_required_field_names(entity),
             set(entity.get_values().keys()),
         )
+
+
+class NotificationRecipientsTestCase(TestCase):
+    """Tests for :class:`nailgun.entities.NotificationRecipients`."""
+
+    def test_to_json(self):
+        """Check json serialisation on nested entities."""
+        notifications_kwargs = {
+            "notifications": [
+                {
+                    "id": 28,
+                    "seen": False,
+                    "level": "info",
+                    "text": "The fastest guide to configuring Red Hat Satellite ever",
+                    "created_at": "2024-03-20T17:24:33.596Z",
+                    "group": "Community",
+                    "actions": {
+                        "links": [
+                            {
+                                "href": "https://www.redhat.com/en/blog/fastest-guide-configuring-red-hat-satellite-ever",
+                                "title": "Open",
+                                "external": True,
+                            }
+                        ]
+                    },
+                }
+            ]
+        }
+        cfg = config.ServerConfig(url='https://foo.bar', verify=False, auth=('foo', 'bar'))
+        notifications = entities.NotificationRecipients(cfg, **notifications_kwargs)
+        self.assertDictEqual(notifications_kwargs, json.loads(notifications.to_json()))