[ssip]: Add CLI UTs.

nazariig · nazariig · commit 73665b9d2e8c · 2022-05-31T20:59:52.000+03:00
Signed-off-by: Nazarii Hnydyn &lt;nazariig@nvidia.com&gt;
diff --git a/tests/syslog_input/assert_show_output.py b/tests/syslog_input/assert_show_output.py
@@ -0,0 +1,17 @@
+"""
+Module holding the correct values for show CLI command outputs for the syslog_test.py
+"""
+
+show_syslog_empty="""\
+SERVER IP    SOURCE IP    PORT    VRF
+-----------  -----------  ------  -----
+"""
+
+
+show_syslog="""\
+SERVER IP    SOURCE IP    PORT    VRF
+-----------  -----------  ------  --------
+2.2.2.2      1.1.1.1      514     default
+3.3.3.3      1.1.1.1      514     mgmt
+2222::2222   1111::1111   514     Vrf-Data
+"""
diff --git a/tests/syslog_input/syslog_cdb.json b/tests/syslog_input/syslog_cdb.json
@@ -0,0 +1,20 @@
+{
+    "VRF|Vrf-Data": {
+        "NULL": "NULL"
+    },
+    "SYSLOG_SERVER|2.2.2.2": {
+        "source": "1.1.1.1",
+        "port": "514",
+        "vrf": "default"
+    },
+    "SYSLOG_SERVER|3.3.3.3": {
+        "source": "1.1.1.1",
+        "port": "514",
+        "vrf": "mgmt"
+    },
+    "SYSLOG_SERVER|2222::2222": {
+        "source": "1111::1111",
+        "port": "514",
+        "vrf": "Vrf-Data"
+    }
+}
diff --git a/tests/syslog_input/vrf_cdb.json b/tests/syslog_input/vrf_cdb.json
@@ -0,0 +1,8 @@
+{
+    "MGMT_VRF_CONFIG|vrf_global": {
+        "mgmtVrfEnabled": "true"
+    },
+    "VRF|Vrf-Data": {
+        "NULL": "NULL"
+    }
+}
diff --git a/tests/syslog_test.py b/tests/syslog_test.py
@@ -0,0 +1,246 @@
+#!/usr/bin/env python
+
+import pytest
+
+import os
+import mock
+import logging
+
+import show.main as show
+import config.main as config
+
+from click.testing import CliRunner
+from utilities_common.db import Db
+
+from .mock_tables import dbconnector
+from .syslog_input import assert_show_output
+
+
+ERROR_PATTERN_INVALID_IP = "does not appear to be an IPv4 or IPv6 address"
+ERROR_PATTERN_PROHIBITED_IP = "is a loopback/multicast IP address"
+ERROR_PATTERN_IP_FAMILY_MISMATCH = "IP address family mismatch"
+
+ERROR_PATTERN_INVALID_PORT = "is not a valid integer"
+ERROR_PATTERN_INVALID_PORT_RANGE = "is not in the valid range of 0 to 65535"
+
+ERROR_PATTERN_INVALID_VRF = "invalid choice"
+ERROR_PATTERN_NONEXISTENT_VRF = "VRF doesn't exist in Linux"
+
+VRF_LIST = ["mgmt", "Vrf-Data"]
+VRF_MEMBER_DICT = {"mgmt": ["eth0"], "Vrf-Data": ["Ethernet0"]}
+IP_ADDR_DICT = {"Ethernet0": ["1111::1111"], "Loopback0": ["1.1.1.1"], "eth0": ["3.3.3.3"]}
+
+SUCCESS = 0
+ERROR2 = 2
+
+
+test_path = os.path.dirname(os.path.abspath(__file__))
+mock_db_path = os.path.join(test_path, "syslog_input")
+logger = logging.getLogger(__name__)
+
+
+class TestSyslog:
+    @classmethod
+    def setup_class(cls):
+        logger.info("SETUP")
+        os.environ["UTILITIES_UNIT_TESTING"] = "1"
+
+    @classmethod
+    def teardown_class(cls):
+        logger.info("TEARDOWN")
+        os.environ["UTILITIES_UNIT_TESTING"] = "0"
+        os.environ["UTILITIES_UNIT_TESTING_TOPOLOGY"] = ""
+        dbconnector.dedicated_dbs["CONFIG_DB"] = None
+
+    ########## CONFIG SYSLOG ##########
+
+    @mock.patch("utilities_common.cli.run_command", mock.MagicMock(return_value=None))
+    @pytest.mark.parametrize("server_ip", ["2.2.2.2", "2222::2222"])
+    def test_config_syslog_basic(self, server_ip):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"], [server_ip], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["del"], [server_ip], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+
+    @mock.patch("utilities_common.cli.run_command", mock.MagicMock(return_value=None))
+    @mock.patch("config.syslog.get_vrf_list", mock.MagicMock(return_value=VRF_LIST))
+    @mock.patch("config.syslog.get_vrf_member_dict", mock.MagicMock(return_value=VRF_MEMBER_DICT))
+    @mock.patch("config.syslog.get_ip_addr_dict", mock.MagicMock(return_value=IP_ADDR_DICT))
+    @pytest.mark.parametrize("server_ip,source_ip,port,vrf", [
+        ("2.2.2.2", "1.1.1.1", "514", "default"),
+        ("4.4.4.4", "3.3.3.3", "514", "mgmt"),
+        ("2222::2222", "1111::1111", "514", "Vrf-Data")
+    ])
+    def test_config_syslog_extended(self, server_ip, source_ip, port, vrf):
+        dbconnector.dedicated_dbs["CONFIG_DB"] = os.path.join(mock_db_path, "vrf_cdb")
+
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            [server_ip, "--source", source_ip, "--port", port, "--vrf", vrf], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["del"], [server_ip], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+
+    @pytest.mark.parametrize("server_ip,source_ip", [
+        ("2.2.2.2", "1.1.1.1111"),
+        ("4.4.4.4444", "3.3.3.3")
+    ])
+    def test_config_syslog_invalid_ip(self, server_ip, source_ip):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            [server_ip, "--source", source_ip], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_INVALID_IP in result.output
+        assert result.exit_code == ERROR2
+
+    @pytest.mark.parametrize("source_ip", ["127.0.0.1", "224.0.0.1"])
+    def test_config_syslog_prohibited_sip(self, source_ip):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--source", source_ip], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_PROHIBITED_IP in result.output
+        assert result.exit_code == ERROR2
+
+    def test_config_syslog_ip_family_mismatch(self):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--source", "1111::1111"], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_IP_FAMILY_MISMATCH in result.output
+        assert result.exit_code == ERROR2
+
+    def test_config_syslog_invalid_port(self):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--port", "514p"], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_INVALID_PORT in result.output
+        assert result.exit_code == ERROR2
+
+    @pytest.mark.parametrize("port", ["-1", "65536"])
+    def test_config_syslog_invalid_port_range(self, port):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--port", port], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_INVALID_PORT_RANGE in result.output
+        assert result.exit_code == ERROR2
+
+    def test_config_syslog_invalid_vrf(self):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--vrf", "default1"], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_INVALID_VRF in result.output
+        assert result.exit_code == ERROR2
+
+    @pytest.mark.parametrize("vrf", ["mgmt", "Vrf-Data"])
+    def test_config_syslog_nonexistent_vrf(self, vrf):
+        dbconnector.dedicated_dbs["CONFIG_DB"] = os.path.join(mock_db_path, "vrf_cdb")
+
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            config.config.commands["syslog"].commands["add"],
+            ["2.2.2.2", "--vrf", vrf], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert ERROR_PATTERN_NONEXISTENT_VRF in result.output
+        assert result.exit_code == ERROR2
+
+    ########## SHOW SYSLOG ##########
+
+    def test_show_syslog_empty(self):
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            show.cli.commands["syslog"], [], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+        assert result.output == assert_show_output.show_syslog_empty
+
+    def test_show_syslog(self):
+        dbconnector.dedicated_dbs["CONFIG_DB"] = os.path.join(mock_db_path, "syslog_cdb")
+
+        db = Db()
+        runner = CliRunner()
+
+        result = runner.invoke(
+            show.cli.commands["syslog"], [], obj=db
+        )
+
+        logger.debug("\n" + result.output)
+        logger.debug(result.exit_code)
+        assert result.exit_code == SUCCESS
+        assert result.output == assert_show_output.show_syslog
