test: Add first tests for Anta CLI

anta/cli/__init__.py

@@ -5,6 +5,7 @@
 """
 
 import logging
+import pathlib
 from typing import Any, Callable, Dict, List, Tuple
 
 import click
@@ -15,26 +16,51 @@
 from anta.cli.get import commands as get_commands
 from anta.cli.nrfu import commands as check_commands
 from anta.cli.utils import parse_catalog, parse_inventory, setup_logging
-from anta.inventory import AntaInventory
 from anta.result_manager.models import TestResult
 
 
 @click.group()
 @click.pass_context
 @click.version_option(__version__)
-@click.option("--username", show_envvar=True, help="Username to connect to EOS", required=True, is_eager=True)
-@click.option("--password", show_envvar=True, help="Password to connect to EOS", required=True, is_eager=True)
-@click.option("--timeout", show_envvar=True, default=5, help="Global connection timeout", show_default=True, is_eager=True)
-@click.option("--insecure/--secure", show_envvar=True, default=False, help="Disable SSH Host Key validation", show_default=True, is_eager=True)
-@click.option("--enable-password", show_envvar=True, help="Enable password if required to connect", is_eager=True)
+@click.option(
+    "--username",
+    show_envvar=True,
+    help="Username to connect to EOS",
+    required=True,
+)
+@click.option(
+    "--password",
+    show_envvar=True,
+    help="Password to connect to EOS",
+    required=True,
+)
+@click.option(
+    "--timeout",
+    show_envvar=True,
+    default=5,
+    help="Global connection timeout",
+    show_default=True,
+)
+@click.option(
+    "--insecure/--secure",
+    show_envvar=True,
+    is_flag=True,
+    default=False,
+    help="Disable SSH Host Key validation",
+    show_default=True,
+)
+@click.option(
+    "--enable-password",
+    show_envvar=True,
+    help="Enable password if required to connect",
+)
 @click.option(
     "--inventory",
     "-i",
     show_envvar=True,
     required=True,
     help="Path to the inventory YAML file",
-    type=click.Path(file_okay=True, dir_okay=False, exists=True, readable=True),
-    callback=parse_inventory,
+    type=click.Path(file_okay=True, dir_okay=False, exists=True, readable=True, path_type=pathlib.Path),
 )
 @click.option(
     "--log-level",
@@ -57,11 +83,11 @@
 )
 @click.option("--ignore-status", show_envvar=True, is_flag=True, default=False, help="Always exit with success")
 @click.option("--ignore-error", show_envvar=True, is_flag=True, default=False, help="Only report failures and not errors")
-def anta(ctx: click.Context, inventory: AntaInventory, ignore_status: bool, ignore_error: bool, **kwargs: Dict[str, Any]) -> None:
+def anta(ctx: click.Context, inventory: str, ignore_status: bool, ignore_error: bool, **kwargs: Dict[str, Any]) -> None:
     # pylint: disable=unused-argument
     """Arista Network Test Automation (ANTA) CLI"""
     ctx.ensure_object(dict)
-    ctx.obj["inventory"] = inventory
+    ctx.obj["inventory"] = parse_inventory(ctx, inventory)
     ctx.obj["ignore_status"] = ignore_status
     ctx.obj["ignore_error"] = ignore_error
 

anta/cli/utils.py

@@ -52,8 +52,7 @@ def parse_tags(ctx: click.Context, param: Option, value: str) -> List[str]:
     return None
 
 
-def parse_inventory(ctx: click.Context, param: Option, value: str) -> AntaInventory:
-    # pylint: disable=unused-argument
+def parse_inventory(ctx: click.Context, value: str) -> AntaInventory:
     """
     Click option callback to parse an ANTA inventory YAML file
     """

pylintrc

@@ -27,3 +27,5 @@ signature-mutators=click.decorators.option
 [MAIN]
 load-plugins=pylint_pydantic
 extension-pkg-whitelist=pydantic
+ignore-paths = ^tests/units/anta_tests/.*/data.py$,
+               ^tests/units/anta_tests/routing/.*/data.py$,

tests/lib/fixture.py

@@ -6,6 +6,7 @@
 
 import pytest
 from aioeapi import Device
+from click.testing import CliRunner
 
 from anta.device import AntaDevice
 
@@ -28,3 +29,11 @@ def mocked_device(hw_model: str = "unknown_hw") -> MagicMock:
     mock.hw_model = hw_model
 
     return mock
+
+
+@pytest.fixture
+def click_runner() -> CliRunner:
+    """
+    Convenience fixture to return a click.CliRunner for cli testing
+    """
+    return CliRunner()

tests/units/cli/test__init__.py

@@ -0,0 +1,27 @@
+"""
+Tests for anta.cli.__init__.py
+"""
+
+from __future__ import annotations
+
+from click.testing import CliRunner
+
+from anta.cli import anta
+
+
+def test_anta(click_runner: CliRunner) -> None:
+    """
+    Test anta main entrypoint
+    """
+    result = click_runner.invoke(anta)
+    assert result.exit_code == 0
+    assert "Usage" in result.output
+
+
+def test_anta_help(click_runner: CliRunner) -> None:
+    """
+    Test anta --help
+    """
+    result = click_runner.invoke(anta, ["--help"])
+    assert result.exit_code == 0
+    assert "Usage" in result.output