test_m8.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
Tests for the 'Feature congestion' metric (m8).
"""


# ----------------------------------------------------------------------------
# Imports
# ----------------------------------------------------------------------------

# Standard library modules
import pathlib
from typing import Any, List, Optional, Union

# Third-party modules
import pytest

# First-party modules
from aim.common import image_utils
from aim.metrics.m8.m8_feature_congestion import Metric
from tests.common.constants import DATA_TESTS_INPUT_VALUES_DIR, IDIFF_TOLERANCE
from tests.common.utils import load_expected_result

# ----------------------------------------------------------------------------
# Metadata
# ----------------------------------------------------------------------------

__author__ = "Amir Hossein Kargaran, Markku Laine"
__date__ = "2021-12-11"
__email__ = "markku.laine@aalto.fi"
__version__ = "1.1"


# ----------------------------------------------------------------------------
# Tests
# ----------------------------------------------------------------------------


@pytest.mark.parametrize(
    ["input_value", "expected_results"],
    [
        ("aalto.fi_website.png", [3.826612]),
        ("myhelsinki.fi_website.png", [4.667929]),
        ("wikipedia.org_website.png", [6.741694]),
        ("black.png", [1.248283]),
        ("white_50_transparent_50.png", [1.248283]),
        ("red.png", [1.248283]),
        ("green.png", [1.248283]),
        ("blue.png", [1.248283]),
        ("transparent.png", [1.248283]),
        ("white.png", [1.248283]),
        (
            "map.png",
            [
                3.282042,
                load_expected_result("m8_1_map.png"),
            ],
        ),
    ],
)
def test_feature_congestion_desktop(
    input_value: str, expected_results: List[Any]
) -> None:
    """
    Test feature congestion (desktop GUIs).

    Args:
        input_value: GUI image file name
        expected_results: Expected results (list of measures)
    """
    # Build GUI image file path
    gui_image_filepath: pathlib.Path = (
        pathlib.Path(DATA_TESTS_INPUT_VALUES_DIR) / input_value
    )

    # Read GUI image (PNG)
    gui_image_png_base64: str = image_utils.read_image(gui_image_filepath)

    # Execute metric
    result: Optional[List[Union[int, float, str]]] = Metric.execute_metric(
        gui_image_png_base64
    )

    # Test result
    if (
        result is not None
        and isinstance(result[0], float)
        and isinstance(result[1], str)
    ):
        assert round(result[0], 6) == expected_results[0]
        if len(expected_results) == 2:
            assert (
                image_utils.idiff(result[1], expected_results[1])
                <= IDIFF_TOLERANCE
            )