TestCuraContainerRegistry.py 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. # Copyright (c) 2017 Ultimaker B.V.
  2. # Cura is released under the terms of the AGPLv3 or higher.
  3. import os #To find the directory with test files and find the test files.
  4. import pytest #This module contains unit tests.
  5. import shutil #To copy files to make a temporary file.
  6. import unittest.mock #To mock and monkeypatch stuff.
  7. import urllib.parse
  8. from cura.Settings.CuraContainerRegistry import CuraContainerRegistry #The class we're testing.
  9. from cura.Settings.ExtruderStack import ExtruderStack #Testing for returning the correct types of stacks.
  10. from cura.Settings.GlobalStack import GlobalStack #Testing for returning the correct types of stacks.
  11. from UM.Resources import Resources #Mocking some functions of this.
  12. import UM.Settings.InstanceContainer #Creating instance containers to register.
  13. import UM.Settings.ContainerRegistry #Making empty container stacks.
  14. import UM.Settings.ContainerStack #Setting the container registry here properly.
  15. from UM.Settings.DefinitionContainer import DefinitionContainer
  16. ## Gives a fresh CuraContainerRegistry instance.
  17. @pytest.fixture()
  18. def container_registry():
  19. registry = CuraContainerRegistry()
  20. UM.Settings.InstanceContainer.setContainerRegistry(registry)
  21. UM.Settings.ContainerStack.setContainerRegistry(registry)
  22. return registry
  23. ## Gives an arbitrary definition container.
  24. @pytest.fixture()
  25. def definition_container():
  26. return DefinitionContainer(container_id = "Test Definition")
  27. def teardown():
  28. #If the temporary file for the legacy file rename test still exists, remove it.
  29. temporary_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks", "temporary.stack.cfg")
  30. if os.path.isfile(temporary_file):
  31. os.remove(temporary_file)
  32. ## Tests whether addContainer properly converts to ExtruderStack.
  33. def test_addContainerExtruderStack(container_registry, definition_container):
  34. container_registry.addContainer(definition_container)
  35. container_stack = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Container Stack") #A container we're going to convert.
  36. container_stack.addMetaDataEntry("type", "extruder_train") #This is now an extruder train.
  37. container_stack.insertContainer(0, definition_container) #Add a definition to it so it doesn't complain.
  38. mock_super_add_container = unittest.mock.MagicMock() #Takes the role of the Uranium-ContainerRegistry where the resulting containers get registered.
  39. with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
  40. container_registry.addContainer(container_stack)
  41. assert len(mock_super_add_container.call_args_list) == 1 #Called only once.
  42. assert len(mock_super_add_container.call_args_list[0][0]) == 1 #Called with one parameter.
  43. assert type(mock_super_add_container.call_args_list[0][0][0]) == ExtruderStack
  44. ## Tests whether addContainer properly converts to GlobalStack.
  45. def test_addContainerGlobalStack(container_registry, definition_container):
  46. container_registry.addContainer(definition_container)
  47. container_stack = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Container Stack") #A container we're going to convert.
  48. container_stack.addMetaDataEntry("type", "machine") #This is now a global stack.
  49. container_stack.insertContainer(0, definition_container) #Must have a definition.
  50. mock_super_add_container = unittest.mock.MagicMock() #Takes the role of the Uranium-ContainerRegistry where the resulting containers get registered.
  51. with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
  52. container_registry.addContainer(container_stack)
  53. assert len(mock_super_add_container.call_args_list) == 1 #Called only once.
  54. assert len(mock_super_add_container.call_args_list[0][0]) == 1 #Called with one parameter.
  55. assert type(mock_super_add_container.call_args_list[0][0][0]) == GlobalStack
  56. def test_addContainerGoodSettingVersion(container_registry, definition_container):
  57. definition_container.getMetaData()["setting_version"] = 3
  58. container_registry.addContainer(definition_container)
  59. instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
  60. instance.addMetaDataEntry("setting_version", 3)
  61. instance.setDefinition(definition_container)
  62. mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting containers get registered.
  63. with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
  64. container_registry.addContainer(instance)
  65. mock_super_add_container.assert_called_once_with(instance) #The instance must have been registered now.
  66. def test_addContainerNoSettingVersion(container_registry, definition_container):
  67. definition_container.getMetaData()["setting_version"] = 3
  68. container_registry.addContainer(definition_container)
  69. instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
  70. #Don't add setting_version metadata.
  71. instance.setDefinition(definition_container)
  72. mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting container should not get registered.
  73. with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
  74. container_registry.addContainer(instance)
  75. 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!
  76. def test_addContainerBadSettingVersion(container_registry, definition_container):
  77. definition_container.getMetaData()["setting_version"] = 3
  78. container_registry.addContainer(definition_container)
  79. instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
  80. instance.addMetaDataEntry("setting_version", 9001) #Wrong version!
  81. instance.setDefinition(definition_container)
  82. mock_super_add_container = unittest.mock.MagicMock() #Take the role of the Uranium-ContainerRegistry where the resulting container should not get registered.
  83. with unittest.mock.patch("UM.Settings.ContainerRegistry.ContainerRegistry.addContainer", mock_super_add_container):
  84. container_registry.addContainer(instance)
  85. 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!
  86. ## Tests whether loading gives objects of the correct type.
  87. @pytest.mark.parametrize("filename, output_class", [
  88. ("ExtruderLegacy.stack.cfg", ExtruderStack),
  89. ("MachineLegacy.stack.cfg", GlobalStack),
  90. ("Left.extruder.cfg", ExtruderStack),
  91. ("Global.global.cfg", GlobalStack),
  92. ("Global.stack.cfg", GlobalStack)
  93. ])
  94. def test_loadTypes(filename, output_class, container_registry):
  95. #Mock some dependencies.
  96. Resources.getAllResourcesOfType = unittest.mock.MagicMock(return_value = [os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks", filename)]) #Return just this tested file.
  97. def findContainers(container_type = 0, id = None):
  98. if id == "some_instance":
  99. return [UM.Settings.ContainerRegistry._EmptyInstanceContainer(id)]
  100. elif id == "some_definition":
  101. return [DefinitionContainer(container_id = id)]
  102. else:
  103. return []
  104. container_registry.findContainers = findContainers
  105. with unittest.mock.patch("cura.Settings.GlobalStack.GlobalStack.findContainer"):
  106. with unittest.mock.patch("os.remove"):
  107. container_registry.load()
  108. #Check whether the resulting type was correct.
  109. stack_id = filename.split(".")[0]
  110. for container in container_registry._containers: #Stupid ContainerRegistry class doesn't expose any way of getting at this except by prodding the privates.
  111. if container.getId() == stack_id: #This is the one we're testing.
  112. assert type(container) == output_class
  113. break
  114. else:
  115. assert False #Container stack with specified ID was not loaded.
  116. ## Tests whether loading a legacy file moves the upgraded file properly.
  117. def test_loadLegacyFileRenamed(container_registry):
  118. #Create a temporary file for the registry to load.
  119. stacks_folder = os.path.join(os.path.dirname(os.path.abspath(__file__)), "stacks")
  120. temp_file = os.path.join(stacks_folder, "temporary.stack.cfg")
  121. temp_file_source = os.path.join(stacks_folder, "MachineLegacy.stack.cfg")
  122. shutil.copyfile(temp_file_source, temp_file)
  123. #Mock some dependencies.
  124. UM.Settings.ContainerStack.setContainerRegistry(container_registry)
  125. Resources.getAllResourcesOfType = unittest.mock.MagicMock(return_value = [temp_file]) #Return a temporary file that we'll make for this test.
  126. def findContainers(container_type = 0, id = None):
  127. if id == "MachineLegacy":
  128. return None
  129. container = UM.Settings.ContainerRegistry._EmptyInstanceContainer(id)
  130. container.getNextStack = unittest.mock.MagicMock()
  131. return [container]
  132. old_find_containers = container_registry.findContainers
  133. container_registry.findContainers = findContainers
  134. with unittest.mock.patch("cura.Settings.GlobalStack.GlobalStack.findContainer"):
  135. container_registry.load()
  136. container_registry.findContainers = old_find_containers
  137. container_registry.saveAll()
  138. print("all containers in registry", container_registry._containers)
  139. assert not os.path.isfile(temp_file)
  140. mime_type = container_registry.getMimeTypeForContainer(GlobalStack)
  141. file_name = urllib.parse.quote_plus("MachineLegacy") + "." + mime_type.preferredSuffix
  142. path = Resources.getStoragePath(Resources.ContainerStacks, file_name)
  143. assert os.path.isfile(path)