catalystwan 0.40.1.dev6__py3-none-any.whl → 2.0.0a0__py3-none-any.whl

catalystwan/tests/test_tenant_migration_api.py

@@ -1,102 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-import tempfile
-import unittest
-from pathlib import Path
-from unittest.mock import MagicMock, patch
-from uuid import uuid4
-
-from packaging.version import Version  # type: ignore
-
-from catalystwan.api.task_status_api import Task
-from catalystwan.api.tenant_migration_api import ImportTask, TenantMigrationAPI
-from catalystwan.endpoints.tenant_migration import ImportInfo, MigrationInfo
-from catalystwan.models.tenant import Tenant, TenantExport
-
-
-class TestTenantMigrationAPI(unittest.TestCase):
-    @patch("catalystwan.session.ManagerSession")
-    def setUp(self, session_mock):
-        self.session = session_mock
-        self.api = TenantMigrationAPI(self.session)
-
-    def test_export_tenant(self):
-        tenant = Tenant(desc="Test Tenant", name="test_tenant", subdomain="test_subdomain", org_name="test_org")
-        task = self.api.export_tenant(tenant=tenant)
-        self.assertIsInstance(task, Task)
-
-    def test_export_migration_tenant(self):
-        tenant = TenantExport(
-            name="test_tenant",
-            desc="Test Tenant Description",
-            subdomain="test_subdomain",
-            org_name="test_org",
-            is_destination_overlay_mt=False,
-            migration_key="Cisco12345",
-        )
-        task = self.api.export_tenant(tenant=tenant)
-        self.assertIsInstance(task, Task)
-
-    def test_download(self):
-        content = b"\xFFtest_data"
-        with tempfile.TemporaryDirectory() as tmpdir:
-            download_path = Path(tmpdir) / "test.tar.gz"
-            self.session.endpoints.tenant_migration.download_tenant_data = MagicMock(return_value=content)
-            self.api.download(download_path)
-            assert open(download_path, "rb").read() == content
-
-    def test_import_tenant(self):
-        self.session.api_version = Version("20.12")
-        migration_key = "mkey1"
-        migration_id = str(uuid4())
-        with tempfile.TemporaryDirectory() as tmpdir:
-            import_file = Path(tmpdir) / "tenant.tar.gz"
-            with open(import_file, "wb") as f:
-                f.write(b"\xFEtest_data")
-            self.session.endpoints.tenant_migration.import_tenant_data = MagicMock(
-                return_value=ImportInfo(
-                    process_id="123",
-                    migration_token_url=("/dataservice/tenantmigration/migrationToken?" f"migrationId={migration_id}"),
-                )
-            )
-            task = self.api.import_tenant(import_file, migration_key)
-            self.assertIsInstance(task, ImportTask)
-            assert task.import_info.migration_token_query_params.migration_id == migration_id
-
-    def test_import_tenant_with_key(self):
-        self.session.api_version = Version("20.13")
-        migration_key = "mkey2"
-        migration_id = str(uuid4())
-        with tempfile.TemporaryDirectory() as tmpdir:
-            import_file = Path(tmpdir) / "tenant.tar.gz"
-            with open(import_file, "wb") as f:
-                f.write(b"\xFEtest_data")
-            self.session.endpoints.tenant_migration.import_tenant_data_with_key = MagicMock(
-                return_value=ImportInfo(
-                    process_id="123",
-                    migration_token_url=("/dataservice/tenantmigration/migrationToken?" f"migrationId={migration_id}"),
-                )
-            )
-            task = self.api.import_tenant(import_file, migration_key)
-            self.assertIsInstance(task, ImportTask)
-            assert task.import_info.migration_token_query_params.migration_id == migration_id
-
-    def test_store_token(self):
-        token_data = "test_token1987"
-        with tempfile.TemporaryDirectory() as tmpdir:
-            download_path = Path(tmpdir) / "token.txt"
-            migration_id = "123"
-            self.session.endpoints.tenant_migration.get_migration_token = MagicMock(return_value=token_data)
-            self.api.store_token(migration_id, download_path)
-            assert open(download_path, "r").read() == token_data
-
-    def test_migrate_network(self):
-        with tempfile.TemporaryDirectory() as tmpdir:
-            token_file = Path(tmpdir) / "token_file.txt"
-            with open(token_file, "wb") as f:
-                f.write(b"token_text")
-            self.api.session.endpoints.tenant_migration.migrate_network = MagicMock(
-                return_value=MigrationInfo(processId="123")
-            )
-            task = self.api.migrate_network(token_file)
-            self.assertIsInstance(task, Task)

catalystwan/tests/test_typed_list.py

@@ -1,426 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# type: ignore
-import copy
-import unittest
-from unittest import TestCase
-
-from attr import define  # type: ignore
-from parameterized import parameterized
-
-from catalystwan.dataclasses import DataclassBase, Device, User
-from catalystwan.exceptions import InvalidOperationError
-from catalystwan.typed_list import DataSequence, TypedList
-
-
-@define
-class FakeUser(DataclassBase):
-    name: str
-    weight: float
-
-
-class TestTypedList(TestCase):
-    def setUp(self):
-        self.u = User(username="User1")
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-        self.users = [u1, u2, u3]
-        self.typed_list = TypedList(User, self.users)
-
-    @parameterized.expand([(str, []), (int, [1, 2, 3]), (User, [User("User1")])])
-    def test_init(self, _type, iterable):
-        # Arrange, Act
-        TypedList(_type, iterable)
-
-    @parameterized.expand([(str, [1]), (int, [1, 2, "3"]), (User, [User(username="User1"), 1])])  # type: ignore
-    def test_init_type_error(self, _type, iterable):
-        # Arrange, Act, Assert
-        with self.assertRaises(TypeError):
-            TypedList(_type, iterable)
-
-    def test_init_no_args(self):
-        # Arrange, Act, Assert
-        with self.assertRaises(TypeError):
-            TypedList()
-
-    def test_init_only_type(self):
-        # Arrange, Act, Assert
-        TypedList(str)
-
-    @parameterized.expand([(str, [], "TypedList(str, [])"), (int, [1, 2, 3], "TypedList(int, [1, 2, 3])")])
-    def test_repr_trival(self, _type, iterable, output):
-        # Arrange, Act
-        representation = repr(TypedList(_type, iterable))
-
-        # Assert
-        self.assertEqual(representation, output)
-
-    # Integration
-    def test_repr(self):
-        # Arrange
-        typed_list = TypedList(User, self.users)
-        output = (
-            "TypedList(User, ["
-            "User(username='User1', password=None, group=[], locale=None, description=None, resource_group=None), "
-            "User(username='User2', password=None, group=[], locale=None, description=None, resource_group=None), "
-            "User(username='User3', password=None, group=[], locale=None, description=None, resource_group=None)])"
-        )
-        # Act
-        representation = repr(typed_list)
-
-        # Assert
-        self.assertEqual(representation, output)
-
-    @parameterized.expand(
-        [
-            (str, ["1"], 1),
-            (int, [1, 2, 3], 3),
-            (User, None, 0),
-            (User, [User(username="User1")], 1),
-            (User, [User(username="User1"), User(username="User2")], 2),
-        ]
-    )
-    def test_len(self, _type, iterable, length):
-        # Arrange, Act
-        output_length = len(TypedList(_type, iterable))
-
-        # Assert
-        self.assertEqual(output_length, length)
-
-    @parameterized.expand(
-        [
-            (str, ["1"], "1"),
-            (int, [1, 2, 3], 3),
-            (User, [User(username="User1")], User(username="User1")),
-            (User, [User(username="User1"), User(username="User2")], User(username="User1")),
-        ]
-    )
-    def test_contains_positive(self, _type, iterable, other):
-        # Arrange, Act
-        typed_list = TypedList(_type, iterable)
-
-        # Assert
-        self.assertTrue(other in typed_list)
-
-    @parameterized.expand(
-        [
-            (str, ["1"], "2"),
-            (int, [1, 2, 3], 4),
-            (User, [User(username="User1")], User(username="User2")),
-            (User, [User(username="User1"), User(username="User2")], User(username="User3")),
-        ]
-    )
-    def test_negative(self, _type, iterable, other):
-        # Arrange, Act
-        typed_list = TypedList(_type, iterable)
-
-        # Assert
-        self.assertFalse(other in typed_list)
-
-    @parameterized.expand(
-        [
-            (1, User(username="User2")),
-            (slice(1, 3, 1), TypedList(User, [User(username="User2"), User(username="User3")])),
-        ]
-    )
-    def test_get_item(self, index, output):
-        self.assertEqual(self.typed_list[index], output)
-
-    @parameterized.expand([(User(username="User1"),), (TypedList(User, [User("User3")]),)])
-    def test_eq_negative(self, other):
-        self.assertFalse(self.users == other)
-
-    def test_eq_false_sort(self):
-        # Arrange
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-
-        # Act, Assert
-        self.assertFalse(self.users == [u1, u3, u2])
-
-    def test_eq(self):
-        # Arrange
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-
-        # Act, Assert
-        self.assertTrue(self.users == [u1, u2, u3])
-
-    def test_set_item(self):
-        # Arrange
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-
-        users = TypedList(User, [u1, u2])
-
-        # Act
-        users[1] = u3
-
-        # Assert
-        self.assertEqual(users[1], u3)
-        self.assertEqual(users[0], u1)
-        with self.assertRaises(IndexError):
-            users[2]
-        self.assertNotEqual(users[1], u2)
-        with self.assertRaises(TypeError):
-            users[1] = 2
-
-    def test_insert(self):
-        # Arrange
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-
-        users = TypedList(User, [u1, u2])
-
-        # Act
-        users.insert(1, u3)
-
-        # Assert
-        self.assertEqual(users[0], u1)
-        self.assertEqual(users[1], u3)
-        self.assertEqual(users[2], u2)
-        with self.assertRaises(IndexError):
-            users[3]
-        self.assertNotEqual(users[1], u2)
-        with self.assertRaises(TypeError):
-            users.insert(1, "2")
-
-    @parameterized.expand(
-        [
-            (TypedList(str, ["A", "B"]), TypedList(str, ["C"]), False, TypedList(str, ["A", "B", "C"])),
-            (TypedList(int, [1, 2]), TypedList(int, [5]), False, TypedList(int, [1, 2, 5])),
-            (TypedList(str, ["Z"]), TypedList(int, [9]), True, None),
-        ]
-    )
-    def test_add(self, term1, term2, raises, expected_result):
-        if raises:
-            with self.assertRaises(TypeError):
-                observed_result = term1 + term2
-        else:
-            observed_result = term1 + term2
-            assert observed_result == expected_result
-
-    @parameterized.expand(
-        [
-            (TypedList(str, ["A", "B"]), TypedList(str, ["C"]), False, TypedList(str, ["A", "B", "C"])),
-            (TypedList(int, [1, 2]), TypedList(int, [5]), False, TypedList(int, [1, 2, 5])),
-            (TypedList(str, ["Z"]), TypedList(int, [9]), True, None),
-        ]
-    )
-    def test_iadd(self, term1, term2, raises, expected_result):
-        if raises:
-            with self.assertRaises(TypeError):
-                term1 += term2
-        else:
-            term1 += term2
-            assert term1 == expected_result
-
-
-class TestDataSequence(TestCase):
-    def setUp(self):
-        self.u = User(username="User1")
-        u1 = User(username="User1")
-        u2 = User(username="User2")
-        u3 = User(username="User3")
-        self.users = [u1, u2, u3]
-        self.data_sequence = DataSequence(User, self.users)
-
-    @parameterized.expand(
-        [
-            (User, [], []),
-            (User, None, []),
-            (User, [User(username="User1")], [User(username="User1")]),
-            (Device, [], []),
-        ]
-    )
-    def test_init(self, _type, items, data):
-        # Arrange, Act
-        data_seq = DataSequence(_type, items)
-
-        # Assert
-        self.assertEqual(data_seq.data, data)
-
-    def test_init_exception(self):
-        # Arrage, Act, Assert
-        with self.assertRaises(TypeError):
-            DataSequence(str, ["1, 2"])
-
-    @parameterized.expand(
-        [
-            (
-                DataSequence(User, [User(username="A")]),
-                DataSequence(User, [User(username="B")]),
-                False,
-                DataSequence(User, [User(username="A"), User(username="B")]),
-            ),
-            (
-                DataSequence(User, [User(username="A")]),
-                DataSequence(FakeUser, [FakeUser(name="B", weight=99.9)]),
-                True,
-                None,
-            ),
-        ]
-    )
-    def test_add(self, term1, term2, raises, expected_result):
-        if raises:
-            with self.assertRaises(TypeError):
-                observed_result = term1 + term2
-        else:
-            observed_result = term1 + term2
-            assert observed_result == expected_result
-
-    @parameterized.expand(
-        [
-            (
-                DataSequence(User, [User(username="A")]),
-                DataSequence(User, [User(username="B")]),
-                False,
-                DataSequence(User, [User(username="A"), User(username="B")]),
-            ),
-            (
-                DataSequence(User, [User(username="A")]),
-                DataSequence(FakeUser, [FakeUser(name="B", weight=99.9)]),
-                True,
-                None,
-            ),
-        ]
-    )
-    def test_iadd(self, term1, term2, raises, expected_result):
-        if raises:
-            with self.assertRaises(TypeError):
-                term1 += term2
-        else:
-            term1 += term2
-            assert term1 == expected_result
-
-    def test_single_or_default(self):
-        # Arrange, Act
-        output = DataSequence(User, [self.u]).single_or_default(default="x")
-
-        # Assert
-        self.assertEqual(output, self.u)
-
-    @parameterized.expand(
-        [
-            (User, [], None),
-            (User, [], "Test"),
-        ]
-    )
-    def test_single_or_default_empty(self, _type, items, default_value):
-        # Arrange
-        data_seq = DataSequence(_type, items)
-
-        # Act
-        output = data_seq.single_or_default(default=default_value)
-
-        # Assert
-        self.assertEqual(output, default_value)
-
-    def test_single_or_default_big_array(self):
-        # Arrange
-        data_seq = DataSequence(User, self.users)
-
-        # Act, Assert
-        with self.assertRaises(InvalidOperationError):
-            data_seq.single_or_default()
-
-    @parameterized.expand(
-        [
-            (None, []),
-            ("DoesNotExists", []),
-            ("User1", [User("User1")]),
-        ]
-    )
-    def test_filter_single_attribute(self, attribute, users):
-        # Arrange
-        correct_seq = DataSequence(User, users)
-
-        # Act
-        output = self.data_sequence.filter(username=attribute)
-
-        # Assert
-        self.assertEqual(output, correct_seq)
-        self.assertTrue(isinstance(output, DataSequence))
-
-    def test_filter_two_attributes(self):
-        # Arrange
-        additional_user = User(username="User1", description="ThisOne")
-        users = copy.deepcopy(self.data_sequence)
-        users.append(additional_user)
-        correct_output = DataSequence(User, [additional_user])
-
-        # Act
-        output = users.filter(username="User1", description="ThisOne")
-
-        # Assert
-        self.assertEqual(output, correct_output)
-
-    def test_filter_exception(self):
-        # Arrange, Act, Assert
-        with self.assertRaises(AttributeError):
-            self.data_sequence.filter(does_not="exists")
-
-    def test_find(self):
-        # Arrange
-        expected = self.data_sequence.filter(username="User3").single_or_default()
-        # Act
-        observed = self.data_sequence.find(username="User3")
-
-        # Assert
-        self.assertEqual(observed, expected)
-
-    def test_find_two_attributes(self):
-        # Arrange
-        additional_user = User(username="User1", description="ThisOne")
-        users = copy.deepcopy(self.data_sequence)
-        users.append(additional_user)
-        correct_output = additional_user
-
-        # Act
-        output = users.find(username="User1", description="ThisOne")
-
-        # Assert
-        self.assertEqual(output, correct_output)
-
-    def test_find_wrong_arg(self):
-        # Arrange, Act, Assert
-        with self.assertRaises(AttributeError):
-            self.data_sequence.find(does_not="exists")
-
-    def test_find_no_match(self):
-        # Arrange, Act, Assert
-        with self.assertRaises(InvalidOperationError):
-            self.data_sequence.find(username="NonExistingUser")
-
-    def test_deepcopy_basemodel(self):
-        # Arrange
-        user = User(username="admin")
-        ds = DataSequence(User, [user])
-        # Act
-        ds_deepcopy = copy.deepcopy(ds)
-        user_deepcopied = ds_deepcopy[0]
-        # Assert
-        self.assertIsNot(ds, ds_deepcopy)
-        self.assertIsNot(user, user_deepcopied)
-        self.assertEqual(user.username, user_deepcopied.username)
-
-    def test_deepcopy_dataclass(self):
-        # Arrange
-        fu = FakeUser(name="admin", weight=87.5)
-        ds = DataSequence(FakeUser, [fu])
-        # Act
-        ds_deepcopy = copy.deepcopy(ds)
-        fd_deepcopied = ds_deepcopy[0]
-        # Assert
-        self.assertIsNot(ds, ds_deepcopy)
-        self.assertIsNot(fu, fd_deepcopied)
-        self.assertEqual(fu.name, fd_deepcopied.name)
-
-
-if __name__ == "__main__":
-    unittest.main()

catalystwan/tests/test_url_monitoring.py

@@ -1,80 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-import unittest
-from unittest.mock import MagicMock, patch
-
-from catalystwan.endpoints.url_monitoring import UrlMonitoring
-from catalystwan.models.url_monitoring import DeleteUrlMonitorRequest, UrlMonitoringConfig
-
-
-class TestUrlMonitoring(unittest.TestCase):
-    @patch("catalystwan.session.ManagerSession")
-    def setUp(self, session_mock) -> None:
-        self.session = session_mock
-
-        self.mock_url_monitor_info_data = {"url": "/client/server/ready", "threshold": 98, "alarm_raised": False}
-
-        self.mock_url_monitor_config_add_data = {"url": "/client/server/ready", "threshold": 98}
-        self.mock_url_monitor_config_update_data = {"url": "/client/server/ready", "threshold": 90}
-        self.mock_url_monitor_delete_url = DeleteUrlMonitorRequest(url="/client/server/ready")
-
-    @patch("catalystwan.session.ManagerSession")
-    def test_add_url_monitor(self, mock_session):
-        # Arrange
-        mock_response = MagicMock()
-        mock_session.get_data.return_value = UrlMonitoringConfig(**self.mock_url_monitor_config_add_data)
-        # Mock the request method of the ManagerSession to return the mock response
-        mock_session_instance = mock_session.return_value
-        mock_session_instance.request.return_value = mock_response
-        mock_session.post.return_value = mock_response
-        url_monitor = UrlMonitoring(mock_session_instance)
-
-        # Act
-        response = url_monitor.add_url_monitor(self.mock_url_monitor_config_add_data)
-        # Assert
-        self.assertEqual(response, None)
-        # Ensure the request method was called
-        mock_session_instance.request.assert_called_once()
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("catalystwan.response.ManagerResponse")
-    def test_get_url_monitor(self, mock_session, mock_response):
-        # Arrange
-        mock_response = MagicMock()
-        mock_session_instance = mock_session.return_value
-        mock_session_instance.request.return_value = mock_response
-        url_monitor = UrlMonitoring(mock_session_instance)
-        observed_url_monitor = url_monitor.get_url_monitor()
-        # Assert
-        self.assertIsNotNone(observed_url_monitor)
-
-    @patch("catalystwan.session.ManagerSession")
-    def test_update_url_monitor(self, mock_session):
-        # Arrange
-        mock_response = MagicMock()
-        mock_session.get_data.return_value = UrlMonitoringConfig(**self.mock_url_monitor_config_update_data)
-        # Mock the request method of the ManagerSession to return the mock response
-        mock_session_instance = mock_session.return_value
-        mock_session_instance.request.return_value = mock_response
-        url_monitor = UrlMonitoring(mock_session_instance)
-        # Act
-        response = url_monitor.update_url_monitor(self.mock_url_monitor_config_update_data)
-        # Assert
-        self.assertEqual(response, None)
-        # Ensure the request method was called
-        mock_session_instance.request.assert_called_once()
-
-    @patch("catalystwan.session.ManagerSession")
-    def test_delete_url_monitor(self, mock_session):
-        # Arrange
-        mock_response = MagicMock()
-        mock_session.get_data.return_value = self.mock_url_monitor_delete_url
-        # Mock the request method of the ManagerSession to return the mock response
-        mock_session_instance = mock_session.return_value
-        mock_session_instance.request.return_value = mock_response
-        url_monitor = UrlMonitoring(mock_session_instance)
-        # Act
-        response = url_monitor.delete_url_monitor(self.mock_url_monitor_delete_url)
-        # Assert
-        self.assertEqual(response, None)
-        # Ensure the request method was called
-        mock_session_instance.request.assert_called_once()