catalystwan 0.40.2.dev1__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

catalystwan/tests/test_templates.py

@@ -1,405 +0,0 @@
-# Copyright 2022 Cisco Systems, Inc. and its affiliates
-
-import unittest
-from unittest.mock import patch
-
-from parameterized import parameterized  # type: ignore
-
-from catalystwan.api.task_status_api import SubTaskData, TaskResult
-from catalystwan.api.template_api import TemplatesAPI
-from catalystwan.api.templates.cli_template import CLITemplate
-from catalystwan.api.templates.device_template.device_template import DeviceTemplate
-from catalystwan.api.templates.feature_template import FeatureTemplate
-from catalystwan.api.templates.models.cisco_aaa_model import CiscoAAAModel
-from catalystwan.api.templates.payloads.aaa.aaa_model import AAAModel, AuthenticationOrder
-from catalystwan.dataclasses import Device
-from catalystwan.endpoints.configuration_template_master import DeviceTemplateInformation
-from catalystwan.typed_list import DataSequence
-from catalystwan.utils.personality import Personality
-from catalystwan.utils.reachability import Reachability
-
-
-class TestTemplatesAPI(unittest.TestCase):
-    def setUp(self):
-        self.data_template = [
-            {
-                "deviceType": "vedge-C8000V",
-                "lastUpdatedBy": "user",
-                "resourceGroup": "global",
-                "templateClass": "cedge",
-                "configType": "file",
-                "templateId": "dummy_id_1",
-                "factoryDefault": False,
-                "templateName": "template_1",
-                "devicesAttached": 0,
-                "templateDescription": "dummy template 1",
-                "draftMode": "Disabled",
-                "lastUpdatedOn": 0,
-                "templateAttached": 0,
-            },
-            {
-                "deviceType": "vedge-cloud",
-                "lastUpdatedBy": "admin",
-                "resourceGroup": "global",
-                "templateClass": "vedge",
-                "configType": "file",
-                "templateId": "dummy_id_2",
-                "factoryDefault": False,
-                "templateName": "template_2",
-                "devicesAttached": 1,
-                "templateDescription": "dummy template 2",
-                "draftMode": "Disabled",
-                "lastUpdatedOn": 0,
-                "templateAttached": 0,
-            },
-        ]
-        self.templates = DataSequence(
-            DeviceTemplateInformation,
-            [DeviceTemplateInformation(**template) for template in self.data_template],
-        )
-        self.device_info = Device(
-            personality=Personality.EDGE,
-            uuid="dummy_uuid",
-            id="162.168.0.1",
-            hostname="dummy_host",
-            reachability=Reachability.REACHABLE,
-            local_system_ip="192.168.0.1",
-            memUsage=1.0,
-            connected_vManages=["192.168.0.1"],
-            model="vedge-cloud",
-            status="normal",
-        )
-        sub_tasks_data = SubTaskData.model_validate(
-            {
-                "status": "Success",
-                "statusId": "success",
-                "action": "",
-                "activity": [],
-                "currentActivity": "",
-                "actionConfig": "",
-                "order": 1,
-                "uuid": "",
-                "host-name": "",
-                "site-id": "",
-            }
-        )
-        self.task = TaskResult(result=True, sub_tasks_data=[sub_tasks_data])
-
-    @patch("catalystwan.session.ManagerSession")
-    def test_templates_success(self, mock_session):
-        # Arrange
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.return_value = self.templates
-
-        # Act
-        answer = TemplatesAPI(mock_session).get(FeatureTemplate)
-
-        # Assert
-        self.assertEqual(answer, self.templates)
-
-    @patch("catalystwan.session.ManagerSession")
-    def test_templates_get(self, mock_session):
-        # Arrange
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.return_value = self.templates
-
-        # Act
-        TemplatesAPI(mock_session).get(FeatureTemplate)
-
-        # Assert
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.assert_called_once_with(
-            params={"summary": True}
-        )
-
-    @parameterized.expand(
-        [
-            (
-                AAAModel(
-                    template_name="test_template",
-                    template_description="test_description",
-                    auth_order=[AuthenticationOrder.LOCAL],
-                    auth_fallback=False,
-                    auth_disable_audit_logs=True,
-                    auth_admin_order=True,
-                    auth_disable_netconf_logs=False,
-                ),
-                "aaa_id",
-            ),
-            (
-                DeviceTemplate(  # type: ignore
-                    template_name="test_device_template",
-                    template_description="test_device_template_description",
-                    device_type="vedge-2000",
-                    general_templates=[],
-                ),
-                "device_template_id",
-            ),
-            (
-                CLITemplate(  # type: ignore
-                    template_name="test", template_description="test", device_model="vedge-100"
-                ),
-                "cli_id",
-            ),
-            (
-                CiscoAAAModel(  # type: ignore
-                    template_name="test_aaa_model",
-                    template_description="test_aaa_description",
-                ),
-                "generator_id",
-            ),
-        ]
-    )
-    @patch("catalystwan.session.ManagerSession")
-    @patch("catalystwan.api.template_api.TemplatesAPI.create_by_generator")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_feature_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_device_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_cli_template")
-    def test_templates_create_success(
-        self,
-        template,
-        template_id,
-        mock_create_cli_template,
-        mock_create_device_template,
-        mock_create_feature_template,
-        mock_create_by_generator,
-        mock_session,
-    ):
-        # Arrange
-        mock_create_by_generator.return_value = "generator_id"
-        mock_create_feature_template.return_value = "aaa_id"
-        mock_create_device_template.return_value = "device_template_id"
-        mock_create_cli_template.return_value = "cli_id"
-
-        # Act
-        templates_api = TemplatesAPI(mock_session)
-
-        # Assert
-        self.assertEqual(templates_api.create(template), template_id)
-
-    @parameterized.expand(
-        [
-            (
-                [
-                    AAAModel(
-                        template_name="test_template",
-                        template_description="test_description",
-                        auth_order=[AuthenticationOrder.LOCAL],
-                        auth_fallback=False,
-                        auth_disable_audit_logs=True,
-                        auth_admin_order=True,
-                        auth_disable_netconf_logs=False,
-                    ),
-                    DeviceTemplate(  # type: ignore
-                        template_name="test_device_template",
-                        template_description="test_device_template_description",
-                        device_type="vedge-2000",
-                        general_templates=[],
-                    ),
-                    CLITemplate(  # type: ignore
-                        template_name="test_cli_template",
-                        template_description="test_cli_description",
-                        device_model="vedge-cloud",
-                    ),
-                    CiscoAAAModel(  # type: ignore
-                        template_name="test_aaa_model",
-                        template_description="test_aaa_description",
-                    ),
-                ],
-                ["aaa_id", "device_template_id", "cli_id", "generator_id"],
-            ),
-        ]
-    )
-    @patch("catalystwan.session.ManagerSession")
-    @patch("catalystwan.api.template_api.TemplatesAPI.create_by_generator")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_feature_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_device_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_cli_template")
-    def test_templates_create_list_success(
-        self,
-        templates,
-        template_ids,
-        mock_create_cli_template,
-        mock_create_device_template,
-        mock_create_feature_template,
-        mock_create_by_generator,
-        mock_session,
-    ):
-        # Arrange
-        mock_create_by_generator.return_value = "generator_id"
-        mock_create_feature_template.return_value = "aaa_id"
-        mock_create_device_template.return_value = "device_template_id"
-        mock_create_cli_template.return_value = "cli_id"
-
-        # Act
-        templates_api = TemplatesAPI(mock_session)
-
-        # Assert
-        self.assertEqual(templates_api.create(templates), template_ids)
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("catalystwan.api.template_api.TemplatesAPI.create_by_generator")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_feature_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_device_template")
-    @patch("catalystwan.api.template_api.TemplatesAPI._create_cli_template")
-    def test_templates_create_failure(
-        self,
-        mock_create_cli_template,
-        mock_create_device_template,
-        mock_create_feature_template,
-        mock_create_by_generator,
-        mock_session,
-    ):
-        # Act
-        templates_api = TemplatesAPI(mock_session)
-
-        # Assert
-        with self.assertRaises(NotImplementedError):
-            templates_api.create(None)
-        assert not mock_create_cli_template.called
-        assert not mock_create_device_template.called
-        assert not mock_create_feature_template.called
-        assert not mock_create_by_generator.called
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.api.template_api.wait_for_completed")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_attach_exist_template(self, mock_session, mock_wait_for_completed, mock_templates):
-
-    #     # Arrage
-    #     mock_session.post_json.return_value = {"id": "operation_id"}
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-
-    #     # mock wait complete
-    #     mock_wait_for_completed.return_value = self.task
-
-    #     # Act
-    #     answer = test_object.attach("template_1", self.device_info)
-
-    #     # Assert
-    #     self.assertTrue(answer)
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.api.template_api.wait_for_completed")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_attach_no_exist_template(self, mock_session, mock_wait_for_completed, mock_templates):
-
-    #     # Arrage
-    #     mock_session.post_json.return_value = {"id": "operation_id"}
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-
-    #     # mock wait complete
-    #     mock_wait_for_completed.return_value = self.task
-
-    #     # Act
-    #     answer = test_object.attach("no_exist_template", self.device_info)
-
-    #     # Assert
-    #     self.assertFalse(answer)
-
-    # @patch("catalystwan.api.template_api.wait_for_completed")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_device_to_cli_true(self, mock_session, mock_wait_for_completed):
-
-    #     # Arrage
-    #     mock_session.post_json.return_value = {"id": "operation_id"}
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock wait complete
-    #     mock_wait_for_completed.return_value = self.task
-
-    #     # Act
-    #     answer = test_object.device_to_cli(self.device_info)
-
-    #     # Assert
-    #     self.assertTrue(answer)
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_delete_success(self, mock_session, mock_templates):
-
-    #     # Arrage
-    #     MockResponse = MagicMock()
-    #     MockResponse.status_code = 200
-    #     mock_session.delete.return_value = MockResponse
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-
-    #     # Act
-    #     answer = test_object.delete("template_1")
-    #     # Assert
-    #     self.assertTrue(answer)
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_delete_wrong_status(self, mock_session, mock_templates):
-
-    #     # Arrage
-    #     MockResponse = MagicMock()
-    #     MockResponse.ok = False
-    #     mock_session.delete.return_value = MockResponse
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-
-    #     # Act
-    #     answer = test_object.delete("template_1")
-
-    #     # Assert
-    #     self.assertFalse(answer)
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_delete_exception(self, mock_session, mock_templates):
-
-    #     # Arrage
-    #     MockResponse = MagicMock()
-    #     MockResponse.status = 404
-    #     mock_session.delete.return_value = MockResponse
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-
-    #     # Act
-    #     def answer():
-    #         return test_object.delete("template_2")
-
-    #     # Assert
-    #     self.assertRaises(AttachedError, answer)
-
-    # @patch.object(TemplatesAPI, "templates")
-    # @patch("catalystwan.session.ManagerSession")
-    # def test_create_exception(self, mock_session, mock_templates):
-
-    #     # Arrage
-    #     test_object = TemplatesAPI(mock_session)
-
-    #     # mock templates
-    #     MockTemplates = Mock()
-    #     mock_templates.return_value = MockTemplates
-    #     test_object.templates = self.templates
-    #     config = CiscoConfParse([])
-
-    #     # Act
-    #     def answer():
-    #         return test_object.create(self.device_info, "template_1", "new_description", config)
-
-    #     # Assert
-    #     self.assertRaises(AlreadyExistsError, answer)

catalystwan/tests/test_tenant_backup_restore_api.py

@@ -1,88 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-import tempfile
-import unittest
-from pathlib import Path
-from unittest.mock import patch
-from uuid import uuid4
-
-from catalystwan.api.tenant_backup_restore_api import TenantBackupRestoreAPI
-
-
-class TestTenantBackupRestoreAPI(unittest.TestCase):
-    def setUp(self):
-        self.processId = str(uuid4())
-        self.download_file_content = "Downloaded file content"
-        self.full_name = Path("/dataservice")
-        self.full_name = (
-            self.full_name
-            / "tenantbackup"
-            / "download"
-            / "3cf632d2-5a62-45cb-af50-50c5ef1b1202"
-            / "bkup_3cf632d2-5a62-45cb-af50-50c5ef1b1202_010823-180713_88aba4772eef495ab6857a5076625ba9.tar.gz"
-        )
-        self.downloaded_file = Path("/tmp") / self.full_name.name
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("requests.Response")
-    def test_delete_full_name(self, mock_session, mock_response):
-        # Arrange
-        mock_session.delete.return_value = mock_response
-        mock_response.json.return_value = mock_response
-        expected_api = f"/dataservice/tenantbackup/delete?fileName={self.full_name}"
-        # Act
-        TenantBackupRestoreAPI(mock_session).delete(str(self.full_name))
-        # Assert
-        mock_session.delete.assert_called_once_with(expected_api)
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("requests.Response")
-    def test_delete_name(self, mock_session, mock_response):
-        # Arrange
-        mock_session.delete.return_value = mock_response
-        mock_response.json.return_value = mock_response
-        expected_api = f"/dataservice/tenantbackup/delete?fileName={self.full_name.name}"
-        # Act
-        TenantBackupRestoreAPI(mock_session).delete(str(self.full_name.name))
-        # Assert
-        mock_session.delete.assert_called_once_with(expected_api)
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("requests.Response")
-    def test_delete_all(self, mock_session, mock_response):
-        # Arrange
-        mock_session.delete.return_value = mock_response
-        mock_response.json.return_value = mock_response
-        expected_api = "/dataservice/tenantbackup/delete?fileName=all"
-        # Act
-        TenantBackupRestoreAPI(mock_session).delete_all()
-        # Assert
-        mock_session.delete.assert_called_once_with(expected_api)
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("requests.Response")
-    def test_download_full(self, mock_session, mock_response):
-        # Arrange
-        mock_session.get_file.return_value = mock_response
-        mock_session.get.return_value = mock_response
-        mock_response.status_code = 200
-        mock_response.content = self.download_file_content
-        with tempfile.TemporaryDirectory() as tmpdir:
-            # Act
-            download_path = TenantBackupRestoreAPI(mock_session).download(str(self.full_name), Path(tmpdir))
-            # Assert
-            self.assertEqual(download_path, Path(tmpdir) / self.full_name.name)
-
-    @patch("catalystwan.session.ManagerSession")
-    @patch("requests.Response")
-    def test_download_name(self, mock_session, mock_response):
-        # Arrange
-        mock_session.get_file.return_value = mock_response
-        mock_session.get.return_value = mock_response
-        mock_response.status_code = 200
-        mock_response.content = self.download_file_content
-        with tempfile.TemporaryDirectory() as tmpdir:
-            # Act
-            download_path = TenantBackupRestoreAPI(mock_session).download(self.full_name.name, Path(tmpdir))
-            # Assert
-            self.assertEqual(download_path, Path(tmpdir) / self.full_name.name)

catalystwan/tests/test_tenant_management_api.py

@@ -1,153 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-import unittest
-from unittest.mock import MagicMock, patch
-
-from catalystwan.api.task_status_api import Task
-from catalystwan.api.tenant_management_api import TenantManagementAPI
-from catalystwan.endpoints.tenant_management import (
-    ControlStatus,
-    SiteHealth,
-    TenantStatus,
-    TenantUpdateRequest,
-    vEdgeHealth,
-    vSessionId,
-    vSmartPlacementUpdateRequest,
-    vSmartStatus,
-    vSmartTenantCapacity,
-    vSmartTenantMap,
-)
-from catalystwan.models.tenant import Tenant
-from catalystwan.typed_list import DataSequence
-
-
-class TenantManagementAPITest(unittest.TestCase):
-    @patch("catalystwan.session.ManagerSession")
-    def setUp(self, session_mock):
-        self.session = session_mock
-        self.session.api_version = None
-        self.session.session_type = None
-        self.api = TenantManagementAPI(self.session)
-
-    def test_get(self):
-        expected_tenants = [
-            Tenant(
-                name="tenant1",
-                org_name="CiscoDevNet",
-                subdomain="alpha.bravo.net",
-                desc="This is tenant for unit tests",
-                edge_connector_enable=True,
-                edge_connector_system_ip="172.16.255.81",
-                edge_connector_tunnel_interface_name="GigabitEthernet1",
-                wan_edge_forecast=1,
-            )
-        ]
-        self.api._endpoints.get_all_tenants = MagicMock(return_value=expected_tenants)
-        observed_tenants = self.api.get()
-        assert expected_tenants == observed_tenants
-
-    def test_create(self):
-        tenants = [
-            Tenant(
-                name="tenant1",
-                org_name="CiscoDevNet",
-                subdomain="alpha.bravo.net",
-                desc="This is tenant for unit tests",
-                edge_connector_enable=True,
-                edge_connector_system_ip="172.16.255.81",
-                edge_connector_tunnel_interface_name="GigabitEthernet1",
-                wan_edge_forecast=1,
-            )
-        ]
-        task = self.api.create(tenants)
-        self.assertIsInstance(task, Task)
-
-    def test_update(self):
-        # Arrange
-        tenant_update_request = TenantUpdateRequest(
-            tenant_id="apo605#",
-            subdomain="doamin.tenant.net",
-            desc="Tenant1 description",
-            wan_edge_forecast=1,
-            edge_connector_enable=False,
-        )
-        self.api._endpoints.update_tenant = MagicMock()
-        # Act
-        self.api.update(tenant_update_request=tenant_update_request)
-        # Assert
-        self.api._endpoints.update_tenant.assert_called_once_with(
-            tenant_id=tenant_update_request.tenant_id, payload=tenant_update_request
-        )
-
-    def test_update_vsmart_placement(self):
-        # Arrange
-        src_uuid = "123190GDS*!"
-        dst_uuid = "!_0ac%$asfDS"
-        tenant_id = "apo605#"
-        vsmart_placement_update = vSmartPlacementUpdateRequest(
-            src_vsmart_uuid=src_uuid,
-            dest_vsmart_uuid=dst_uuid,
-        )
-        self.api._endpoints.update_tenant_vsmart_placement = MagicMock()
-        # Act
-        self.api.update_vsmart_placement(tenant_id=tenant_id, src_vsmart_uuid=src_uuid, dst_vsmart_uuid=dst_uuid)
-        # Assert
-        self.api._endpoints.update_tenant_vsmart_placement.assert_called_once_with(
-            tenant_id=tenant_id, payload=vsmart_placement_update
-        )
-
-    def test_delete(self):
-        tenant_id_list = ["1"]
-        password = "password"  # pragma: allowlist secret
-        task = self.api.delete(tenant_id_list, password)
-        self.assertIsInstance(task, Task)
-
-    def test_delete_auto_password(self):
-        tenant_id_list = ["1"]
-        task = self.api.delete(tenant_id_list, password="test")
-        self.assertIsInstance(task, Task)
-
-    def test_get_statuses(self):
-        tenant_status = TenantStatus(
-            tenant_id="tenant2",
-            tenant_name="TeanantTwo",
-            control_status=ControlStatus(control_up=1, control_down=0, partial=1),
-            site_health=SiteHealth(full_connectivity=2, partial_connectivity=1, no_connectivity=0),
-            vedge_health=vEdgeHealth(normal=3, warning=1, error=0),
-            vsmart_status=vSmartStatus(up=1, down=0),
-        )
-        expected_statuses = DataSequence(TenantStatus, [tenant_status])
-        self.api._endpoints.get_all_tenant_statuses = MagicMock(return_value=expected_statuses)
-        observed_statuses = self.api.get_statuses()
-        assert expected_statuses == observed_statuses
-
-    def test_get_hosting_capacity_on_vsmarts(self):
-        capacity = vSmartTenantCapacity(vsmart_uuid="ABCD-1234", total_tenant_capacity=12, current_tenant_count=5)
-        expected_capacities = DataSequence(vSmartTenantCapacity, [capacity])
-        self.api._endpoints.get_tenant_hosting_capacity_on_vsmarts = MagicMock(return_value=expected_capacities)
-        observed_capacities = self.api.get_hosting_capacity_on_vsmarts()
-        assert expected_capacities == observed_capacities
-
-    def test_get_vsmart_mapping(self):
-        expected_mapping = vSmartTenantMap(
-            data={
-                "vsmart1": [
-                    Tenant(
-                        name="tenant1",
-                        org_name="Tenant1-organization",
-                        desc="Tenant1 description",
-                        subdomain="tenant1.organization.org",
-                        flake_id=9987,
-                    )
-                ]
-            }
-        )
-        self.api._endpoints.get_tenant_vsmart_mapping = MagicMock(return_value=expected_mapping)
-        observed_mapping = self.api.get_vsmart_mapping()
-        assert expected_mapping == observed_mapping
-
-    def test_vsession_id(self):
-        expected_vsession_id = "567-DEF"
-        self.api._endpoints.vsession_id = MagicMock(return_value=vSessionId(vsessionid=expected_vsession_id))
-        observed_vsession_id = self.api.vsession_id("1")
-        assert expected_vsession_id == observed_vsession_id