feat(anta.tests): Added testcase to verify Login and Motd banner

anta/tests/security.py

@@ -377,3 +377,65 @@ def test(self) -> None:
                 failed_log = f"SSL certificate `{certificate.certificate_name}` is not configured properly:"
                 failed_log += get_failed_logs(expected_certificate_details, actual_certificate_details)
                 self.result.is_failure(f"{failed_log}\n")
+
+
+class VerifyBannerLogin(AntaTest):
+    """
+    This class verifies the login banner of a device.
+    Expected results:
+        * success: The test will pass if the login banner matches the provided input.
+        * failure: The test will fail if the login banner does not match the provided input.
+    """
+
+    name = "VerifyBannerLogin"
+    description = "Verifies the login banner of a device."
+    categories = ["security"]
+    commands = [AntaCommand(command="show banner login")]
+
+    class Input(AntaTest.Input):
+        """Defines the input parameters for this test case."""
+
+        login_banner: str
+        """Expected login banner of the device."""
+
+    @AntaTest.anta_test
+    def test(self) -> None:
+        login_banner = self.instance_commands[0].json_output["loginBanner"]
+
+        # Remove leading and trailing whitespaces from each line
+        cleaned_banner = "\n".join(line.strip() for line in self.inputs.login_banner.split("\n"))
+        if login_banner != cleaned_banner:
+            self.result.is_failure(f"Expected `{cleaned_banner}` as the login banner, but found `{login_banner}` instead.")
+        else:
+            self.result.is_success()
+
+
+class VerifyBannerMotd(AntaTest):
+    """
+    This class verifies the motd banner of a device.
+    Expected results:
+        * success: The test will pass if the motd banner matches the provided input.
+        * failure: The test will fail if the motd banner does not match the provided input.
+    """
+
+    name = "VerifyBannerMotd"
+    description = "Verifies the motd banner of a device."
+    categories = ["security"]
+    commands = [AntaCommand(command="show banner motd")]
+
+    class Input(AntaTest.Input):
+        """Defines the input parameters for this test case."""
+
+        motd_banner: str
+        """Expected motd banner of the device."""
+
+    @AntaTest.anta_test
+    def test(self) -> None:
+        motd_banner = self.instance_commands[0].json_output["motd"]
+
+        # Remove leading and trailing whitespaces from each line
+        cleaned_banner = "\n".join(line.strip() for line in self.inputs.motd_banner.split("\n"))
+        if motd_banner != cleaned_banner:
+            self.result.is_failure(f"Expected `{cleaned_banner}` as the motd banner, but found `{motd_banner}` instead.")
+        else:
+            self.result.is_success()

examples/tests.yaml

@@ -205,6 +205,16 @@ anta.tests.security:
           common_name: Arista Networks Internal IT Root Cert Authority
           encryption_algorithm: RSA
           key_size: 4096
+  - VerifyBannerLogin:
+        login_banner: |
+            # Copyright (c) 2023-2024 Arista Networks, Inc.
+            # Use of this source code is governed by the Apache License 2.0
+            # that can be found in the LICENSE file.
+  - VerifyBannerMotd:
+        motd_banner: |
+            # Copyright (c) 2023-2024 Arista Networks, Inc.
+            # Use of this source code is governed by the Apache License 2.0
+            # that can be found in the LICENSE file.
 
 anta.tests.snmp:
   - VerifySnmpStatus:

tests/units/anta_tests/test_security.py

@@ -14,6 +14,8 @@
     VerifyAPIIPv4Acl,
     VerifyAPIIPv6Acl,
     VerifyAPISSLCertificate,
+    VerifyBannerLogin,
+    VerifyBannerMotd,
     VerifySSHIPv4Acl,
     VerifySSHIPv6Acl,
     VerifySSHStatus,
@@ -569,4 +571,110 @@
             ],
         },
     },
+    {
+        "name": "success",
+        "test": VerifyBannerLogin,
+        "eos_data": [
+            {
+                "loginBanner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "login_banner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+            "that can be found in the LICENSE file."
+        },
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "success-multiline",
+        "test": VerifyBannerLogin,
+        "eos_data": [
+            {
+                "loginBanner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "login_banner": """Copyright (c) 2023-2024 Arista Networks, Inc.
+                            Use of this source code is governed by the Apache License 2.0
+                            that can be found in the LICENSE file."""
+        },
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure-incorrect-login-banner",
+        "test": VerifyBannerLogin,
+        "eos_data": [
+            {
+                "loginBanner": "Copyright (c) 2023 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "login_banner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+            "that can be found in the LICENSE file."
+        },
+        "expected": {
+            "result": "failure",
+            "messages": [
+                "Expected `Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file.` as the login banner, but found `Copyright (c) 2023 Arista Networks, Inc.\nUse of this source code is "
+                "governed by the Apache License 2.0\nthat can be found in the LICENSE file.` instead."
+            ],
+        },
+    },
+    {
+        "name": "success",
+        "test": VerifyBannerMotd,
+        "eos_data": [
+            {
+                "motd": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "motd_banner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+            "that can be found in the LICENSE file."
+        },
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "success-multiline",
+        "test": VerifyBannerMotd,
+        "eos_data": [
+            {
+                "motd": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "motd_banner": """Copyright (c) 2023-2024 Arista Networks, Inc.
+                            Use of this source code is governed by the Apache License 2.0
+                            that can be found in the LICENSE file."""
+        },
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure-incorrect-motd-banner",
+        "test": VerifyBannerMotd,
+        "eos_data": [
+            {
+                "motd": "Copyright (c) 2023 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file."
+            }
+        ],
+        "inputs": {
+            "motd_banner": "Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+            "that can be found in the LICENSE file."
+        },
+        "expected": {
+            "result": "failure",
+            "messages": [
+                "Expected `Copyright (c) 2023-2024 Arista Networks, Inc.\nUse of this source code is governed by the Apache License 2.0\n"
+                "that can be found in the LICENSE file.` as the motd banner, but found `Copyright (c) 2023 Arista Networks, Inc.\nUse of this source code is "
+                "governed by the Apache License 2.0\nthat can be found in the LICENSE file.` instead."
+            ],
+        },
+    },
 ]