mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-04-23 06:09:38 +08:00
922c8ccbc9
It's not enough (or even nescesary) to mock the (now wrapper) method, since we use the underlaying method in our code now. done as part of CURA-11501
201 lines
11 KiB
Python
201 lines
11 KiB
Python
# Copyright (c) 2019 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
|
|
import collections # For OrderedDict to ensure that the first iteration of preferred material is dependable.
|
|
from unittest.mock import patch, MagicMock
|
|
import pytest
|
|
|
|
from cura.Machines.VariantNode import VariantNode
|
|
import copy
|
|
|
|
instance_container_metadata_dict = {"fdmprinter": {"no_variant": [{"base_file": "material_1", "id": "material_1"}, {"base_file": "material_2", "id": "material_2"}]},
|
|
"machine_1": {"no_variant": [{"base_file": "material_1", "id": "material_1"}, {"base_file": "material_2", "id": "material_2"}],
|
|
"Variant One": [{"base_file": "material_1", "id": "material_1"}, {"base_file": "material_2", "id": "material_2"}]}}
|
|
|
|
|
|
material_node_added_test_data = [({"type": "Not a material"}, ["material_1", "material_2"]), # Wrong type
|
|
({"type": "material", "base_file": "material_3"}, ["material_1", "material_2"]), # material_3 is on the "NOPE" list.
|
|
({"type": "material", "base_file": "material_4", "definition": "machine_3"}, ["material_1", "material_2"]), # Wrong machine
|
|
({"type": "material", "base_file": "material_4", "definition": "machine_1"}, ["material_1", "material_2", "material_4"]), # No variant
|
|
({"type": "material", "base_file": "material_4", "definition": "machine_1", "variant_name": "Variant Three"}, ["material_1", "material_2"]), # Wrong variant
|
|
({"type": "material", "base_file": "material_4", "definition": "machine_1", "variant_name": "Variant One"}, ["material_1", "material_2", "material_4"])
|
|
]
|
|
|
|
material_node_update_test_data = [({"type": "material", "base_file": "material_1", "definition": "machine_1", "variant_name": "Variant One"}, ["material_1"], ["material_2"]),
|
|
({"type": "material", "base_file": "material_1", "definition": "fdmprinter", "variant_name": "Variant One"}, [], ["material_2", "material_1"]), # Too generic
|
|
({"type": "material", "base_file": "material_1", "definition": "machine_2", "variant_name": "Variant One"}, [], ["material_2", "material_1"]) # Wrong definition
|
|
]
|
|
|
|
metadata_dict = {}
|
|
|
|
|
|
def getMetadataEntrySideEffect(*args, **kwargs):
|
|
return metadata_dict.get(args[0])
|
|
|
|
|
|
def getInstanceContainerSideEffect(*args, **kwargs):
|
|
variant = kwargs.get("variant")
|
|
definition = kwargs.get("definition")
|
|
|
|
if variant is not None:
|
|
return instance_container_metadata_dict.get(definition).get(variant)
|
|
return instance_container_metadata_dict.get(definition).get("no_variant")
|
|
|
|
|
|
@pytest.fixture
|
|
def machine_node():
|
|
mocked_machine_node = MagicMock()
|
|
mocked_machine_node.container_id = "machine_1"
|
|
mocked_machine_node.isExcludedMaterial = MagicMock(return_value=False)
|
|
mocked_machine_node.preferred_material = "preferred_material"
|
|
return mocked_machine_node
|
|
|
|
@pytest.fixture
|
|
def empty_variant_node(machine_node):
|
|
"""Constructs a variant node without any subnodes.
|
|
|
|
This is useful for performing tests on VariantNode without being dependent
|
|
on how _loadAll works.
|
|
"""
|
|
|
|
container_registry = MagicMock(
|
|
findContainersMetadata = MagicMock(return_value = [{"name": "test variant name"}])
|
|
)
|
|
with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value = container_registry)):
|
|
with patch("cura.Machines.VariantNode.VariantNode._loadAll", MagicMock()):
|
|
result = VariantNode("test_variant", machine = machine_node)
|
|
return result
|
|
|
|
@pytest.fixture
|
|
def container_registry():
|
|
result = MagicMock()
|
|
result.findInstanceContainersMetadata = MagicMock(side_effect = getInstanceContainerSideEffect)
|
|
result.findContainersMetadata = MagicMock(return_value = [{"name": "Variant One"}])
|
|
return result
|
|
|
|
|
|
def createMockedInstanceContainer():
|
|
result = MagicMock()
|
|
result.getMetaDataEntry = MagicMock(side_effect=getMetadataEntrySideEffect)
|
|
return result
|
|
|
|
|
|
def createVariantNode(container_id, machine_node, container_registry):
|
|
with patch("cura.Machines.VariantNode.MaterialNode"): # We're not testing the material node here, so patch it out.
|
|
with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value=container_registry)):
|
|
return VariantNode(container_id, machine_node)
|
|
|
|
|
|
def test_variantNodeInit(container_registry, machine_node):
|
|
node = createVariantNode("variant_1", machine_node, container_registry)
|
|
|
|
assert "material_1" in node.materials
|
|
assert "material_2" in node.materials
|
|
assert len(node.materials) == 2
|
|
|
|
|
|
def test_variantNodeInit_excludedMaterial(container_registry, machine_node):
|
|
machine_node.exclude_materials = ["material_1"]
|
|
machine_node.isExcludedMaterialBaseFile = MagicMock(side_effect=lambda material: material == "material_1")
|
|
node = createVariantNode("variant_1", machine_node, container_registry)
|
|
|
|
assert "material_1" not in node.materials
|
|
assert "material_2" in node.materials
|
|
assert len(node.materials) == 1
|
|
|
|
|
|
@pytest.mark.parametrize("metadata,material_result_list", material_node_added_test_data)
|
|
def test_materialAdded(container_registry, machine_node, metadata, material_result_list):
|
|
variant_node = createVariantNode("machine_1", machine_node, container_registry)
|
|
machine_node.exclude_materials = ["material_3"]
|
|
with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value = container_registry)):
|
|
with patch("cura.Machines.VariantNode.MaterialNode"): # We're not testing the material node here, so patch it out.
|
|
with patch.dict(metadata_dict, metadata):
|
|
mocked_container = createMockedInstanceContainer()
|
|
variant_node._materialAdded(mocked_container)
|
|
|
|
assert len(material_result_list) == len(variant_node.materials)
|
|
for name in material_result_list:
|
|
assert name in variant_node.materials
|
|
|
|
|
|
@pytest.mark.parametrize("metadata,changed_material_list,unchanged_material_list", material_node_update_test_data)
|
|
def test_materialAdded_update(container_registry, machine_node, metadata, changed_material_list, unchanged_material_list):
|
|
variant_node = createVariantNode("machine_1", machine_node, container_registry)
|
|
original_material_nodes = copy.copy(variant_node.materials)
|
|
|
|
with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance", MagicMock(return_value = container_registry)):
|
|
with patch("cura.Machines.VariantNode.MaterialNode"): # We're not testing the material node here, so patch it out.
|
|
with patch.dict(metadata_dict, metadata):
|
|
mocked_container = createMockedInstanceContainer()
|
|
variant_node._materialAdded(mocked_container)
|
|
|
|
for key in unchanged_material_list:
|
|
assert original_material_nodes[key] == variant_node.materials[key]
|
|
|
|
for key in changed_material_list:
|
|
assert original_material_nodes[key] != variant_node.materials[key]
|
|
|
|
|
|
def test_preferredMaterialExactMatch(empty_variant_node):
|
|
"""Tests the preferred material when the exact base file is available in the
|
|
|
|
materials list for this node.
|
|
"""
|
|
empty_variant_node.materials = {
|
|
"some_different_material": MagicMock(getMetaDataEntry = lambda x: 3),
|
|
"preferred_material": MagicMock(getMetaDataEntry = lambda x: 3) # Exact match.
|
|
}
|
|
empty_variant_node.machine.preferred_material = "preferred_material"
|
|
|
|
assert empty_variant_node.preferredMaterial(approximate_diameter = 3) == empty_variant_node.materials["preferred_material"], "It should match exactly on this one since it's the preferred material."
|
|
|
|
|
|
def test_preferredMaterialSubmaterial(empty_variant_node):
|
|
"""Tests the preferred material when a submaterial is available in the
|
|
|
|
materials list for this node.
|
|
"""
|
|
empty_variant_node.materials = {
|
|
"some_different_material": MagicMock(getMetaDataEntry = lambda x: 3),
|
|
"preferred_material_base_file_aa04": MagicMock(getMetaDataEntry = lambda x: 3) # This is a submaterial of the preferred material.
|
|
}
|
|
empty_variant_node.machine.preferred_material = "preferred_material_base_file_aa04"
|
|
|
|
assert empty_variant_node.preferredMaterial(approximate_diameter = 3) == empty_variant_node.materials["preferred_material_base_file_aa04"], "It should match on the submaterial just as well."
|
|
|
|
|
|
def test_preferredMaterialDiameter(empty_variant_node):
|
|
"""Tests the preferred material matching on the approximate diameter of the filament.
|
|
"""
|
|
empty_variant_node.materials = {
|
|
"some_different_material": MagicMock(getMetaDataEntry = lambda x: 3),
|
|
"preferred_material_wrong_diameter": MagicMock(getMetaDataEntry = lambda x: 2), # Approximate diameter is 2 instead of 3.
|
|
"preferred_material_correct_diameter": MagicMock(getMetaDataEntry = lambda x: 3) # Correct approximate diameter.
|
|
}
|
|
empty_variant_node.machine.preferred_material = "preferred_material_correct_diameter"
|
|
|
|
assert empty_variant_node.preferredMaterial(approximate_diameter = 3) == empty_variant_node.materials["preferred_material_correct_diameter"], "It should match only on the material with correct diameter."
|
|
|
|
|
|
def test_preferredMaterialDiameterNoMatch(empty_variant_node):
|
|
"""Tests the preferred material matching on a different material if the diameter is wrong."""
|
|
|
|
empty_variant_node.materials = collections.OrderedDict()
|
|
empty_variant_node.materials["some_different_material"] = MagicMock(getMetaDataEntry = lambda x: 3) # This one first so that it gets iterated over first.
|
|
empty_variant_node.materials["preferred_material"] = MagicMock(getMetaDataEntry = lambda x: 2) # Wrong diameter.
|
|
|
|
assert empty_variant_node.preferredMaterial(approximate_diameter = 3) == empty_variant_node.materials["some_different_material"], "It should match on another material with the correct diameter if the preferred one is unavailable."
|
|
|
|
|
|
def test_preferredMaterialDiameterPreference(empty_variant_node):
|
|
"""Tests that the material diameter is considered more important to match than
|
|
the preferred diameter.
|
|
"""
|
|
|
|
empty_variant_node.materials = collections.OrderedDict()
|
|
empty_variant_node.materials["some_different_material"] = MagicMock(getMetaDataEntry = lambda x: 2) # This one first so that it gets iterated over first.
|
|
empty_variant_node.materials["preferred_material"] = MagicMock(getMetaDataEntry = lambda x: 2) # Matches on ID but not diameter.
|
|
empty_variant_node.materials["not_preferred_but_correct_diameter"] = MagicMock(getMetaDataEntry = lambda x: 3) # Matches diameter but not ID.
|
|
|
|
assert empty_variant_node.preferredMaterial(approximate_diameter = 3) == empty_variant_node.materials["not_preferred_but_correct_diameter"], "It should match on the correct diameter even if it's not the preferred one." |