test_folder.py

from unittest import TestCase
from unittest.mock import MagicMock, Mock, patch

from src.grafana_api.model import APIModel
from src.grafana_api.folder import Folder


class FolderTestCase(TestCase):
    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folders(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=list([{"title": None, "id": 12}]))

        call_the_api_mock.return_value = mock

        self.assertEqual(list([{"title": None, "id": 12}]), folder.get_folders())

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folders_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=list())

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.get_folders()

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": None, "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            dict({"title": None, "id": 12}), folder.get_folder_by_uid("xty13y")
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_uid_no_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(ValueError):
            folder.get_folder_by_uid("")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_uid_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.get_folder_by_uid("xty13y")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_id(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": None, "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(dict({"title": None, "id": 12}), folder.get_folder_by_id(12))

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_id_no_id(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(ValueError):
            folder.get_folder_by_id(0)

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_by_id_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.get_folder_by_id(10)

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_create_folder(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": None, "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(dict({"title": None, "id": 12}), folder.create_folder("test"))

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_create_folder_specified_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": None, "id": 12, "uid": "test"}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            dict({"title": None, "id": 12, "uid": "test"}),
            folder.create_folder("test", "test"),
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_create_folder_no_title(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(ValueError):
            folder.create_folder(MagicMock())

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_create_folder_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.create_folder("test")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": "test1", "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            dict({"title": "test1", "id": 12}),
            folder.update_folder("test", "test1", 10),
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_no_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": "test", "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            dict({"title": "test", "id": 12}),
            folder.update_folder("test", overwrite=True),
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_overwrite_true(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"title": "test", "id": 12}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            dict({"title": "test", "id": 12}),
            folder.update_folder("test", "test", overwrite=True),
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_no_title(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(ValueError):
            folder.update_folder(MagicMock(), MagicMock())

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.update_folder("test", "test", 10)

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_delete_folder(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"message": "Folder deleted"}))

        call_the_api_mock.return_value = mock

        self.assertEqual(None, folder.delete_folder("test"))

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_delete_folder_no_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict())

        call_the_api_mock.return_value = mock

        with self.assertRaises(ValueError):
            folder.delete_folder("")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_delete_folder_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"message": "error"}))

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.delete_folder("test")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_permissions(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=list([{"id": "test"}]))

        call_the_api_mock.return_value = mock

        self.assertEqual(list([{"id": "test"}]), folder.get_folder_permissions("test"))

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_permissions_no_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        call_the_api_mock.return_value = list()
        with self.assertRaises(ValueError):
            folder.get_folder_permissions("")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_folder_permissions_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=list([{"test": "test"}]))

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.get_folder_permissions("test")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_permissions(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"message": "Folder permissions updated"}))

        call_the_api_mock.return_value = mock

        self.assertEqual(
            None, folder.update_folder_permissions("test", dict({"test": "test"}))
        )

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_permissions_no_uid(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        call_the_api_mock.return_value = dict()
        with self.assertRaises(ValueError):
            folder.update_folder_permissions("", dict())

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_update_folder_permissions_error_response(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(return_value=dict({"message": "test"}))

        call_the_api_mock.return_value = mock

        with self.assertRaises(Exception):
            folder.update_folder_permissions("test", dict({"test": "test"}))

    @patch("src.grafana_api.folder.Folder.get_all_folder_ids_and_names")
    def test_get_folder_id_by_dashboard_path(self, all_folder_ids_and_names_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        all_folder_ids_and_names_mock.return_value = list([{"title": "test", "id": 12}])
        self.assertEqual(
            12, folder.get_folder_id_by_dashboard_path(dashboard_path="test")
        )

    def test_get_folder_id_by_dashboard_path_general_path(self):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        self.assertEqual(
            0, folder.get_folder_id_by_dashboard_path(dashboard_path="General")
        )

    def test_get_folder_id_by_dashboard_path_no_dashboard_path_defined(self):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        with self.assertRaises(ValueError):
            folder.get_folder_id_by_dashboard_path(dashboard_path="")

    @patch("src.grafana_api.folder.Folder.get_all_folder_ids_and_names")
    def test_get_folder_id_by_dashboard_path_no_title_match(
        self, all_folder_ids_and_names_mock
    ):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        all_folder_ids_and_names_mock.return_value = list(
            [{"title": None, "id": "xty13y"}]
        )
        with self.assertRaises(Exception):
            folder.get_folder_id_by_dashboard_path(dashboard_path="test")

    @patch("src.grafana_api.api.Api.call_the_api")
    def test_get_all_folder_ids_and_names(self, call_the_api_mock):
        model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
        folder: Folder = Folder(grafana_api_model=model)

        mock: Mock = Mock()
        mock.json = Mock(
            return_value=list([{"title": "test", "id": 12, "test": "test"}])
        )

        call_the_api_mock.return_value = mock

        self.assertEqual(
            list([{"title": "test", "id": 12}]), folder.get_all_folder_ids_and_names()
        )