mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-05-30 01:55:55 +08:00
1bac7c2b2a
The fixture does this for us automatically now. It's not entirely neat since this is not cleaned up afterwards, but it does make sense to put it there in the fixture, logically. Contributes to issue CURA-3427.
182 lines
9.9 KiB
Python
182 lines
9.9 KiB
Python
# Copyright (c) 2017 Ultimaker B.V.
|
|
# Cura is released under the terms of the AGPLv3 or higher.
|
|
|
|
import os #To find the directory with test files and find the test files.
|
|
import pytest #This module contains unit tests.
|
|
import shutil #To copy files to make a temporary file.
|
|
import unittest.mock #To mock and monkeypatch stuff.
|
|
import urllib.parse
|
|
|
|
from cura.Settings.CuraContainerRegistry import CuraContainerRegistry #The class we're testing.
|
|
from cura.Settings.ExtruderStack import ExtruderStack #Testing for returning the correct types of stacks.
|
|
from cura.Settings.GlobalStack import GlobalStack #Testing for returning the correct types of stacks.
|
|
from UM.Resources import Resources #Mocking some functions of this.
|
|
import UM.Settings.InstanceContainer #Creating instance containers to register.
|
|
import UM.Settings.ContainerRegistry #Making empty container stacks.
|
|
import UM.Settings.ContainerStack #Setting the container registry here properly.
|
|
from UM.Settings.DefinitionContainer import DefinitionContainer
|
|
|
|
## Gives a fresh CuraContainerRegistry instance.
|
|
@pytest.fixture()
|
|
def container_registry():
|
|
registry = CuraContainerRegistry()
|
|
UM.Settings.InstanceContainer.setContainerRegistry(registry)
|
|
UM.Settings.ContainerStack.setContainerRegistry(registry)
|
|
return registry
|
|
|
|
## Gives an arbitrary definition container.
|
|
@pytest.fixture()
|
|
def definition_container():
|
|
return DefinitionContainer(container_id = "Test Definition")
|
|
|
|
def teardown():
|
|
#If the temporary file for the legacy file rename test still exists, remove it.
|
|
temporary_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks", "temporary.stack.cfg")
|
|
if os.path.isfile(temporary_file):
|
|
os.remove(temporary_file)
|
|
|
|
## Tests whether addContainer properly converts to ExtruderStack.
|
|
def test_addContainerExtruderStack(container_registry, definition_container):
|
|
container_registry.addContainer(definition_container)
|
|
|
|
container_stack = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Container Stack") #A container we're going to convert.
|
|
container_stack.addMetaDataEntry("type", "extruder_train") #This is now an extruder train.
|
|
container_stack.insertContainer(0, definition_container) #Add a definition to it so it doesn't complain.
|
|
|
|
mock_super_add_container = unittest.mock.MagicMock() #Takes the role of the Uranium-ContainerRegistry where the resulting containers get registered.
|
|
with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
|
|
container_registry.addContainer(container_stack)
|
|
|
|
assert len(mock_super_add_container.call_args_list) == 1 #Called only once.
|
|
assert len(mock_super_add_container.call_args_list[0][0]) == 1 #Called with one parameter.
|
|
assert type(mock_super_add_container.call_args_list[0][0][0]) == ExtruderStack
|
|
|
|
## Tests whether addContainer properly converts to GlobalStack.
|
|
def test_addContainerGlobalStack(container_registry, definition_container):
|
|
container_registry.addContainer(definition_container)
|
|
|
|
container_stack = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Container Stack") #A container we're going to convert.
|
|
container_stack.addMetaDataEntry("type", "machine") #This is now a global stack.
|
|
container_stack.insertContainer(0, definition_container) #Must have a definition.
|
|
|
|
mock_super_add_container = unittest.mock.MagicMock() #Takes the role of the Uranium-ContainerRegistry where the resulting containers get registered.
|
|
with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
|
|
container_registry.addContainer(container_stack)
|
|
|
|
assert len(mock_super_add_container.call_args_list) == 1 #Called only once.
|
|
assert len(mock_super_add_container.call_args_list[0][0]) == 1 #Called with one parameter.
|
|
assert type(mock_super_add_container.call_args_list[0][0][0]) == GlobalStack
|
|
|
|
def test_addContainerGoodSettingVersion(container_registry, definition_container):
|
|
definition_container.getMetaData()["setting_version"] = 3
|
|
container_registry.addContainer(definition_container)
|
|
|
|
instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
|
|
instance.addMetaDataEntry("setting_version", 3)
|
|
instance.setDefinition(definition_container)
|
|
|
|
mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting containers get registered.
|
|
with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
|
|
container_registry.addContainer(instance)
|
|
|
|
mock_super_add_container.assert_called_once_with(instance) #The instance must have been registered now.
|
|
|
|
def test_addContainerNoSettingVersion(container_registry, definition_container):
|
|
definition_container.getMetaData()["setting_version"] = 3
|
|
container_registry.addContainer(definition_container)
|
|
|
|
instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
|
|
#Don't add setting_version metadata.
|
|
instance.setDefinition(definition_container)
|
|
|
|
mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting container should not get registered.
|
|
with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
|
|
container_registry.addContainer(instance)
|
|
|
|
mock_super_add_container.assert_not_called() #Should not get passed on to UM.Settings.ContainerRegistry.addContainer, because the setting_version is interpreted as 0!
|
|
|
|
def test_addContainerBadSettingVersion(container_registry, definition_container):
|
|
definition_container.getMetaData()["setting_version"] = 3
|
|
container_registry.addContainer(definition_container)
|
|
|
|
instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
|
|
instance.addMetaDataEntry("setting_version", 9001) #Wrong version!
|
|
instance.setDefinition(definition_container)
|
|
|
|
mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting container should not get registered.
|
|
with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
|
|
container_registry.addContainer(instance)
|
|
|
|
mock_super_add_container.assert_not_called() #Should not get passed on to UM.Settings.ContainerRegistry.addContainer, because the setting_version doesn't match its definition!
|
|
|
|
## Tests whether loading gives objects of the correct type.
|
|
@pytest.mark.parametrize("filename, output_class", [
|
|
("ExtruderLegacy.stack.cfg", ExtruderStack),
|
|
("MachineLegacy.stack.cfg", GlobalStack),
|
|
("Left.extruder.cfg", ExtruderStack),
|
|
("Global.global.cfg", GlobalStack),
|
|
("Global.stack.cfg", GlobalStack)
|
|
])
|
|
def test_loadTypes(filename, output_class, container_registry):
|
|
#Mock some dependencies.
|
|
Resources.getAllResourcesOfType = unittest.mock.MagicMock(return_value = [os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks", filename)]) #Return just this tested file.
|
|
|
|
def findContainers(container_type = 0, id = None):
|
|
if id == "some_instance":
|
|
return [UM.Settings.ContainerRegistry._EmptyInstanceContainer(id)]
|
|
elif id == "some_definition":
|
|
return [DefinitionContainer(container_id = id)]
|
|
else:
|
|
return []
|
|
|
|
container_registry.findContainers = findContainers
|
|
|
|
with unittest.mock.patch("cura.Settings.GlobalStack.GlobalStack.findContainer"):
|
|
with unittest.mock.patch("os.remove"):
|
|
container_registry.load()
|
|
|
|
#Check whether the resulting type was correct.
|
|
stack_id = filename.split(".")[0]
|
|
for container in container_registry._containers: #Stupid ContainerRegistry class doesn't expose any way of getting at this except by prodding the privates.
|
|
if container.getId() == stack_id: #This is the one we're testing.
|
|
assert type(container) == output_class
|
|
break
|
|
else:
|
|
assert False #Container stack with specified ID was not loaded.
|
|
|
|
## Tests whether loading a legacy file moves the upgraded file properly.
|
|
def test_loadLegacyFileRenamed(container_registry):
|
|
#Create a temporary file for the registry to load.
|
|
stacks_folder = os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks")
|
|
temp_file = os.path.join(stacks_folder, "temporary.stack.cfg")
|
|
temp_file_source = os.path.join(stacks_folder, "MachineLegacy.stack.cfg")
|
|
shutil.copyfile(temp_file_source, temp_file)
|
|
|
|
#Mock some dependencies.
|
|
UM.Settings.ContainerStack.setContainerRegistry(container_registry)
|
|
Resources.getAllResourcesOfType = unittest.mock.MagicMock(return_value = [temp_file]) #Return a temporary file that we'll make for this test.
|
|
|
|
def findContainers(container_type = 0, id = None):
|
|
if id == "MachineLegacy":
|
|
return None
|
|
|
|
container = UM.Settings.ContainerRegistry._EmptyInstanceContainer(id)
|
|
container.getNextStack = unittest.mock.MagicMock()
|
|
return [container]
|
|
|
|
old_find_containers = container_registry.findContainers
|
|
container_registry.findContainers = findContainers
|
|
|
|
with unittest.mock.patch("cura.Settings.GlobalStack.GlobalStack.findContainer"):
|
|
container_registry.load()
|
|
|
|
container_registry.findContainers = old_find_containers
|
|
|
|
container_registry.saveAll()
|
|
print("all containers in registry", container_registry._containers)
|
|
assert not os.path.isfile(temp_file)
|
|
mime_type = container_registry.getMimeTypeForContainer(GlobalStack)
|
|
file_name = urllib.parse.quote_plus("MachineLegacy") + "." + mime_type.preferredSuffix
|
|
path = Resources.getStoragePath(Resources.ContainerStacks, file_name)
|
|
assert os.path.isfile(path)
|