Merge 8d3ccc6 into 7f55514

Author: ZPascal

grafana_api/user.py

@@ -26,11 +26,53 @@ def __init__(self, grafana_api_model: APIModel):
         self.grafana_api_model = grafana_api_model
 
     def search_users(
+        self,
+        results_per_page: int = 1000,
+        page: int = 1,
+        sort: str = None,
+    ) -> list:
+        """The method includes a functionality to get all Grafana system users specified by the optional results_per_page, page and sort option
+
+        Required Permissions:
+            Action: users:read
+            Scope: global.users:*
+
+        Args:
+            results_per_page (int): Specify the results_per_page as integer (default 1000)
+            page (int): Specify the page as integer (default 1)
+            sort (str): Specify the sort option. Valid values are login-asc, login-desc, email-asc, email-desc, name-asc, name-desc, lastSeenAtAge-asc and lastSeenAtAge-desc. By default, if sort is not specified, the user list will be ordered by login, email in ascending order (default None)
+
+        Raises:
+            Exception: Unspecified error by executing the API call
+
+        Returns:
+            api_call (list): Returns the list of Grafana users
+        """
+
+        api_request_url: str = (
+            f"{APIEndpoints.USERS.value}?perpage={results_per_page}&page={page}"
+        )
+
+        if sort is not None and len(sort) != 0:
+            api_request_url: str = f"{api_request_url}&sort={sort}"
+
+        api_call: list = Api(self.grafana_api_model).call_the_api(
+            api_request_url,
+        )
+
+        if api_call == list() or api_call[0].get("id") is None:
+            logging.error(f"Check the error: {api_call}.")
+            raise Exception
+        else:
+            return api_call
+
+    def search_users_with_paging(
         self,
         results_per_page: int = 1000,
         pages: int = 1,
         query: str = None,
-    ) -> list:
+        sort: str = None
+    ) -> dict:
         """The method includes a functionality to get all Grafana system users specified by the optional query and paging functionality
 
         Required Permissions:
@@ -41,12 +83,13 @@ def search_users(
             results_per_page (int): Specify the results_per_page as integer (default 1000)
             pages (int): Specify the pages as integer (default 1)
             query (str): Specify the query (default None)
+            sort (str): Specify the sort option. Valid values are login-asc, login-desc, email-asc, email-desc, name-asc, name-desc, lastSeenAtAge-asc and lastSeenAtAge-desc. By default, if sort is not specified, the user list will be ordered by login, email in ascending order (default None)
 
         Raises:
             Exception: Unspecified error by executing the API call
 
         Returns:
-            api_call (list): Returns the list of Grafana users
+            api_call (dict): Returns the Grafana users
         """
 
         api_request_url: str = (
@@ -56,11 +99,14 @@ def search_users(
         if query is not None and len(query) != 0:
             api_request_url: str = f"{api_request_url}&query={query}"
 
-        api_call: list = Api(self.grafana_api_model).call_the_api(
+        if sort is not None and len(sort) != 0:
+            api_request_url: str = f"{api_request_url}&sort={sort}"
+
+        api_call: dict = Api(self.grafana_api_model).call_the_api(
             api_request_url,
         )
 
-        if api_call == list() or api_call[0].get("id") is None:
+        if api_call == dict() or api_call.get("users") is None:
             logging.error(f"Check the error: {api_call}.")
             raise Exception
         else:

tests/unittests/test_user.py

@@ -18,7 +18,7 @@ def test_search_users(self, call_the_api_mock):
         self.assertEqual(list([{"id": 1}]), user.search_users())
 
     @patch("grafana_api.api.Api.call_the_api")
-    def test_search_users_query(self, call_the_api_mock):
+    def test_search_users_sort(self, call_the_api_mock):
         model: APIModel = APIModel(
             host=MagicMock(), username=MagicMock(), password=MagicMock()
         )
@@ -28,7 +28,7 @@ def test_search_users_query(self, call_the_api_mock):
 
         self.assertEqual(
             list([{"id": 1}]),
-            user.search_users(query="Test"),
+            user.search_users(sort="login-asc"),
         )
 
     @patch("grafana_api.api.Api.call_the_api")
@@ -43,6 +43,57 @@ def test_search_users_no_users(self, call_the_api_mock):
         with self.assertRaises(Exception):
             user.search_users()
 
+    @patch("grafana_api.api.Api.call_the_api")
+    def test_search_users_with_paging(self, call_the_api_mock):
+        model: APIModel = APIModel(
+            host=MagicMock(), username=MagicMock(), password=MagicMock()
+        )
+        user: User = User(grafana_api_model=model)
+
+        call_the_api_mock.return_value = dict({"users": []})
+
+        self.assertEqual(dict({"users": []}), user.search_users_with_paging())
+
+    @patch("grafana_api.api.Api.call_the_api")
+    def test_search_users_with_paging_query(self, call_the_api_mock):
+        model: APIModel = APIModel(
+            host=MagicMock(), username=MagicMock(), password=MagicMock()
+        )
+        user: User = User(grafana_api_model=model)
+
+        call_the_api_mock.return_value = dict({"users": []})
+
+        self.assertEqual(
+            dict({"users": []}),
+            user.search_users_with_paging(query="test"),
+        )
+
+    @patch("grafana_api.api.Api.call_the_api")
+    def test_search_users_with_paging_sort(self, call_the_api_mock):
+        model: APIModel = APIModel(
+            host=MagicMock(), username=MagicMock(), password=MagicMock()
+        )
+        user: User = User(grafana_api_model=model)
+
+        call_the_api_mock.return_value = dict({"users": []})
+
+        self.assertEqual(
+            dict({"users": []}),
+            user.search_users_with_paging(sort="login-asc"),
+        )
+
+    @patch("grafana_api.api.Api.call_the_api")
+    def test_search_users_with_paging_no_users(self, call_the_api_mock):
+        model: APIModel = APIModel(
+            host=MagicMock(), username=MagicMock(), password=MagicMock()
+        )
+        user: User = User(grafana_api_model=model)
+
+        call_the_api_mock.return_value = dict()
+
+        with self.assertRaises(Exception):
+            user.search_users_with_paging()
+
     @patch("grafana_api.api.Api.call_the_api")
     def test_get_user_by_id(self, call_the_api_mock):
         model: APIModel = APIModel(