Cura/tests/Machines/TestMaterialNode.py

from unittest.mock import patch, MagicMock
import pytest

from cura.Machines.MaterialNode import MaterialNode

instance_container_metadata_dict = {"fdmprinter": {"no_variant": [{"id": "quality_1"}]},
                                    "machine_1": {"variant_1": {"material_1": [{"id": "quality_2"}, {"id": "quality_3"}]}}}


quality_metadata_machine_quality_test_data = [({"type": "Not a quality"}, ["quality_2", "quality_3"]),  # Wrong type
                              ({"type": "quality", "definition": "machine_2"}, ["quality_2", "quality_3"]),  # Wrong defintion
                              ({"type": "quality", "definition": "machine_1", "variant": "variant_2"}, ["quality_2", "quality_3"]), # Wrong variant
                              ({"type": "quality", "definition": "machine_1", "variant": "variant_1", "material": "material_2"}, ["quality_2", "quality_3"]),  # wrong material
                              ({"type": "quality", "definition": "machine_1", "variant": "variant_1", "material": "material_1"}, ["quality_2", "quality_3", "quality_4"]),
                             ]

quality_metadata_no_machine_quality =[({"type": "Not a quality"}, ["quality_1"]),  # Wrong type
                                ({"type": "quality", "definition": "machine_1"}, ["quality_1"]),  # Wrong defintion (it needs fdmprinter)
                              ({"type": "quality", "definition": "fdmprinter", "variant": "variant_2"}, ["quality_1", "quality_4"]), # Wrong variant, but should be added (as we ignore the variant)
                              ({"type": "quality", "definition": "fdmprinter", "variant": "variant_1", "material": "material_2"}, ["quality_1", "quality_4"]),  # wrong material,  but should be added (as we ignore the material)
                              ({"type": "quality", "definition": "fdmprinter", "variant": "variant_1", "material": "material_1"}, ["quality_1", "quality_4"]),
                             ]

metadata_dict = {}


def getMetadataEntrySideEffect(*args, **kwargs):
    return metadata_dict.get(args[0])

def createMockedInstanceContainer(container_id):
    result = MagicMock()
    result.getId = MagicMock(return_value=container_id)
    result.getMetaDataEntry = MagicMock(side_effect=getMetadataEntrySideEffect)
    return result


def getInstanceContainerSideEffect(*args, **kwargs):
    variant = kwargs.get("variant")
    definition = kwargs.get("definition")
    if variant is not None:
        definition_dict = instance_container_metadata_dict.get(definition)
        variant_dict = definition_dict.get(variant)
        material_dict = variant_dict.get(kwargs.get("material"))
        return material_dict
    return instance_container_metadata_dict.get(definition).get("no_variant")


@pytest.fixture
def container_registry():
    result = MagicMock()
    result.findInstanceContainersMetadata = MagicMock(side_effect=getInstanceContainerSideEffect)
    result.findContainersMetadata = MagicMock(return_value = [{"base_file": "material_1"}])
    return result


def test_materialNodeInit_noMachineQuality(container_registry):
    variant_node = MagicMock()
    variant_node.variant_name = "variant_1"
    variant_node.machine.has_machine_quality = False
    with patch("cura.Machines.MaterialNode.QualityNode"):
        with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value=container_registry)):
            node = MaterialNode("material_1", variant_node)

    assert len(node.qualities) == 1
    assert "quality_1" in node.qualities


def test_materialNodeInit_MachineQuality(container_registry):
    variant_node = MagicMock()
    variant_node.variant_name = "variant_1"
    variant_node.machine.has_machine_quality = True
    variant_node.machine.quality_definition = "machine_1"
    with patch("cura.Machines.MaterialNode.QualityNode"):
        with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value=container_registry)):
            node = MaterialNode("material_1", variant_node)

    assert len(node.qualities) == 2
    assert "quality_2" in node.qualities
    assert "quality_3" in node.qualities


@pytest.mark.parametrize("metadata,qualities_result_list", quality_metadata_machine_quality_test_data)
def test_qualityAdded_hasMachineQuality(container_registry, metadata, qualities_result_list):
    variant_node = MagicMock()
    variant_node.variant_name = "variant_1"
    variant_node.machine.has_machine_quality = True
    variant_node.machine.quality_definition = "machine_1"

    container = createMockedInstanceContainer("quality_4")

    with patch("cura.Machines.MaterialNode.QualityNode"):
        with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value=container_registry)):
            node = MaterialNode("material_1", variant_node)

            with patch.dict(metadata_dict, metadata):
                node._qualityAdded(container)

    assert len(qualities_result_list) == len(node.qualities)
    for name in qualities_result_list:
        assert name in node.qualities



@pytest.mark.parametrize("metadata,qualities_result_list", quality_metadata_no_machine_quality)
def test_qualityAdded_noMachineQuality(container_registry, metadata, qualities_result_list):
    variant_node = MagicMock()
    variant_node.variant_name = "variant_1"
    variant_node.machine.has_machine_quality = False

    container = createMockedInstanceContainer("quality_4")

    with patch("cura.Machines.MaterialNode.QualityNode"):
        with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value=container_registry)):
            node = MaterialNode("material_1", variant_node)

            with patch.dict(metadata_dict, metadata):
                node._qualityAdded(container)

    assert len(qualities_result_list) == len(node.qualities)
    for name in qualities_result_list:
        assert name in node.qualities