aboutsummaryrefslogtreecommitdiff
path: root/tests/mlia/test_cli_logging.py
blob: 7c5f299df2fac316289421c04c2f5abef257634b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Tests for the module cli.logging."""
import logging
from pathlib import Path
from typing import Optional

import pytest

from mlia.cli.logging import setup_logging
from tests.mlia.utils.logging import clear_loggers


def teardown_function() -> None:
    """Perform action after test completion.

    This function is launched automatically by pytest after each test
    in this module.
    """
    clear_loggers()


@pytest.mark.parametrize(
    "logs_dir, verbose, expected_output, expected_log_file_content",
    [
        (
            None,
            None,
            "cli info\n",
            None,
        ),
        (
            None,
            True,
            """mlia.tools.aiet_wrapper - aiet debug
cli info
mlia.cli - cli debug
""",
            None,
        ),
        (
            "logs",
            True,
            """mlia.tools.aiet_wrapper - aiet debug
cli info
mlia.cli - cli debug
""",
            """mlia.tools.aiet_wrapper - DEBUG - aiet debug
mlia.cli - DEBUG - cli debug
""",
        ),
    ],
)
def test_setup_logging(
    tmp_path: Path,
    capfd: pytest.CaptureFixture,
    logs_dir: str,
    verbose: bool,
    expected_output: str,
    expected_log_file_content: str,
) -> None:
    """Test function setup_logging."""
    logs_dir_path = tmp_path / logs_dir if logs_dir else None

    setup_logging(logs_dir_path, verbose)

    aiet_logger = logging.getLogger("mlia.tools.aiet_wrapper")
    aiet_logger.debug("aiet debug")

    cli_logger = logging.getLogger("mlia.cli")
    cli_logger.info("cli info")
    cli_logger.debug("cli debug")

    stdout, _ = capfd.readouterr()
    assert stdout == expected_output

    check_log_assertions(logs_dir_path, expected_log_file_content)


def check_log_assertions(
    logs_dir_path: Optional[Path], expected_log_file_content: str
) -> None:
    """Test assertions for log file."""
    if logs_dir_path is not None:
        assert logs_dir_path.is_dir()

        items = list(logs_dir_path.iterdir())
        assert len(items) == 1

        log_file_path = items[0]
        assert log_file_path.is_file()

        log_file_name = log_file_path.name
        assert log_file_name == "mlia.log"

        with open(log_file_path, encoding="utf-8") as log_file:
            log_content = log_file.read()

        expected_lines = expected_log_file_content.split("\n")
        produced_lines = log_content.split("\n")

        assert len(expected_lines) == len(produced_lines)
        for expected, produced in zip(expected_lines, produced_lines):
            assert expected in produced