Fix some unit tests.

Add fixtures to the conftest file and clean-up the code a bit.

Contributes to CURA-5628

tests/Settings/TestCuraContainerRegistry.py

@@ -1,61 +1,14 @@
-# Copyright (c) 2017 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 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
-import copy
 
-import cura.CuraApplication
-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
-from UM.Settings.ContainerRegistry import ContainerRegistry
-
-def creteEmptyContainers():
-    empty_container = ContainerRegistry.getInstance().getEmptyInstanceContainer()
-    empty_variant_container = copy.deepcopy(empty_container)
-    empty_variant_container.setMetaDataEntry("id", "empty_variant")
-    empty_variant_container.setMetaDataEntry("type", "variant")
-    ContainerRegistry.getInstance().addContainer(empty_variant_container)
-
-    empty_material_container = copy.deepcopy(empty_container)
-    empty_material_container.setMetaDataEntry("id", "empty_material")
-    empty_material_container.setMetaDataEntry("type", "material")
-    ContainerRegistry.getInstance().addContainer(empty_material_container)
-
-    empty_quality_container = copy.deepcopy(empty_container)
-    empty_quality_container.setMetaDataEntry("id", "empty_quality")
-    empty_quality_container.setName("Not Supported")
-    empty_quality_container.setMetaDataEntry("quality_type", "not_supported")
-    empty_quality_container.setMetaDataEntry("type", "quality")
-    empty_quality_container.setMetaDataEntry("supported", False)
-    ContainerRegistry.getInstance().addContainer(empty_quality_container)
-
-    empty_quality_changes_container = copy.deepcopy(empty_container)
-    empty_quality_changes_container.setMetaDataEntry("id", "empty_quality_changes")
-    empty_quality_changes_container.setMetaDataEntry("type", "quality_changes")
-    ContainerRegistry.getInstance().addContainer(empty_quality_changes_container)
-
-##  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.
@@ -65,10 +18,9 @@ def teardown():
 
 ##  Tests whether addContainer properly converts to ExtruderStack.
 def test_addContainerExtruderStack(container_registry, definition_container):
-    creteEmptyContainers()
     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 = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Extruder Stack") #A container we're going to convert.
     container_stack.setMetaDataEntry("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.
 
@@ -84,7 +36,7 @@ def test_addContainerExtruderStack(container_registry, definition_container):
 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 = UM.Settings.ContainerStack.ContainerStack(stack_id = "Test Global Stack") #A container we're going to convert.
     container_stack.setMetaDataEntry("type", "machine") #This is now a global stack.
     container_stack.insertContainer(0, definition_container) #Must have a definition.
 
@@ -101,7 +53,7 @@ def test_addContainerGoodSettingVersion(container_registry, definition_container
     definition_container.getMetaData()["setting_version"] = CuraApplication.SettingVersion
     container_registry.addContainer(definition_container)
 
-    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
+    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance Right Version")
     instance.setMetaDataEntry("setting_version", CuraApplication.SettingVersion)
     instance.setDefinition(definition_container.getId())
 
@@ -116,7 +68,7 @@ def test_addContainerNoSettingVersion(container_registry, definition_container):
     definition_container.getMetaData()["setting_version"] = CuraApplication.SettingVersion
     container_registry.addContainer(definition_container)
 
-    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
+    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance No Version")
     #Don't add setting_version metadata.
     instance.setDefinition(definition_container.getId())
 
@@ -131,7 +83,7 @@ def test_addContainerBadSettingVersion(container_registry, definition_container)
     definition_container.getMetaData()["setting_version"] = CuraApplication.SettingVersion
     container_registry.addContainer(definition_container)
 
-    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance")
+    instance = UM.Settings.InstanceContainer.InstanceContainer(container_id = "Test Instance Wrong Version")
     instance.setMetaDataEntry("setting_version", 9001) #Wrong version!
     instance.setDefinition(definition_container.getId())
 
@@ -174,4 +126,4 @@ def test_addContainerBadSettingVersion(container_registry, definition_container)
 #             assert type(container) == output_class
 #             break
 #     else:
-#         assert False #Container stack with specified ID was not loaded.
+#         assert False #Container stack with specified ID was not loaded.

tests/Settings/TestExtruderStack.py

@@ -1,9 +1,8 @@
-# Copyright (c) 2017 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
 import pytest #This module contains automated tests.
 import unittest.mock #For the mocking and monkeypatching functionality.
-import copy
 
 import cura.CuraApplication
 import UM.Settings.ContainerRegistry #To create empty instance containers.
@@ -14,29 +13,27 @@ import cura.Settings.ExtruderStack #The module we're testing.
 from cura.Settings.Exceptions import InvalidContainerError, InvalidOperationError #To check whether the correct exceptions are raised.
 
 from cura.Settings.ExtruderManager import ExtruderManager
-from UM.Settings.ContainerRegistry import ContainerRegistry
 from cura.Settings.GlobalStack import GlobalStack
 
 ##  Fake container registry that always provides all containers you ask of.
-@pytest.yield_fixture()
+# @pytest.yield_fixture()
-def container_registry():
+# def container_registry():
-    registry = unittest.mock.MagicMock()
+#     registry = unittest.mock.MagicMock()
-    registry.return_value = unittest.mock.NonCallableMagicMock()
+#     registry.return_value = unittest.mock.NonCallableMagicMock()
-    registry.findInstanceContainers = lambda *args, registry = registry, **kwargs: [registry.return_value]
+#     registry.findInstanceContainers = lambda *args, registry = registry, **kwargs: [registry.return_value]
-    registry.findDefinitionContainers = lambda *args, registry = registry, **kwargs: [registry.return_value]
+#     registry.findDefinitionContainers = lambda *args, registry = registry, **kwargs: [registry.return_value]
-
+#
-    UM.Settings.ContainerRegistry.ContainerRegistry._ContainerRegistry__instance = registry
+#     UM.Settings.ContainerRegistry.ContainerRegistry._ContainerRegistry__instance = registry
-    UM.Settings.ContainerStack._containerRegistry = registry
+#     UM.Settings.ContainerStack._containerRegistry = registry
-
+#
-    yield registry
+#     yield registry
-
+#
-    UM.Settings.ContainerRegistry.ContainerRegistry._ContainerRegistry__instance = None
+#     UM.Settings.ContainerRegistry.ContainerRegistry._ContainerRegistry__instance = None
-    UM.Settings.ContainerStack._containerRegistry = None
+#     UM.Settings.ContainerStack._containerRegistry = None
 
 ##  An empty extruder stack to test with.
 @pytest.fixture()
 def extruder_stack() -> cura.Settings.ExtruderStack.ExtruderStack:
-    creteEmptyContainers()
     return cura.Settings.ExtruderStack.ExtruderStack("TestStack")
 
 ##  Gets an instance container with a specified container type.
@@ -48,31 +45,6 @@ def getInstanceContainer(container_type) -> InstanceContainer:
     container.setMetaDataEntry("type", container_type)
     return container
 
-def creteEmptyContainers():
-    empty_container = ContainerRegistry.getInstance().getEmptyInstanceContainer()
-    empty_variant_container = copy.deepcopy(empty_container)
-    empty_variant_container.setMetaDataEntry("id", "empty_variant")
-    empty_variant_container.setMetaDataEntry("type", "variant")
-    ContainerRegistry.getInstance().addContainer(empty_variant_container)
-
-    empty_material_container = copy.deepcopy(empty_container)
-    empty_material_container.setMetaDataEntry("id", "empty_material")
-    empty_material_container.setMetaDataEntry("type", "material")
-    ContainerRegistry.getInstance().addContainer(empty_material_container)
-
-    empty_quality_container = copy.deepcopy(empty_container)
-    empty_quality_container.setMetaDataEntry("id", "empty_quality")
-    empty_quality_container.setName("Not Supported")
-    empty_quality_container.setMetaDataEntry("quality_type", "not_supported")
-    empty_quality_container.setMetaDataEntry("type", "quality")
-    empty_quality_container.setMetaDataEntry("supported", False)
-    ContainerRegistry.getInstance().addContainer(empty_quality_container)
-
-    empty_quality_changes_container = copy.deepcopy(empty_container)
-    empty_quality_changes_container.setMetaDataEntry("id", "empty_quality_changes")
-    empty_quality_changes_container.setMetaDataEntry("type", "quality_changes")
-    ContainerRegistry.getInstance().addContainer(empty_quality_changes_container)
-
 class DefinitionContainerSubClass(DefinitionContainer):
     def __init__(self):
         super().__init__(container_id = "SubDefinitionContainer")

tests/Settings/TestGlobalStack.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
 import pytest #This module contains unit tests.

tests/Settings/conftest.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2018 Ultimaker B.V.
+# Uranium is released under the terms of the LGPLv3 or higher.
+
+# The purpose of this class is to create fixtures or methods that can be shared among all settings tests.
+
+import pytest
+import copy
+
+from UM.Settings.DefinitionContainer import DefinitionContainer #To provide definition containers in the registry fixtures.
+
+# Returns the CuraContainerRegistry instance with some empty containers.
+@pytest.fixture()
+def container_registry(application):
+    return application.getContainerRegistry()
+
+# Gives an arbitrary definition container.
+@pytest.fixture()
+def definition_container():
+    return DefinitionContainer(container_id = "Test Definition")

tests/TestArrange.py

@@ -1,9 +1,11 @@
+# Copyright (c) 2018 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+
 import numpy
 
 from cura.Arranging.Arrange import Arrange
 from cura.Arranging.ShapeArray import ShapeArray
 
-
 ##  Triangle of area 12
 def gimmeTriangle():
     return numpy.array([[-3, 1], [3, 1], [0, -3]], dtype=numpy.int32)
@@ -102,7 +104,7 @@ def test_centerFirst_rectangular():
 
 
 ##  Test centerFirst
-def test_centerFirst_rectangular():
+def test_centerFirst_rectangular2():
     ar = Arrange(10, 20, 5, 10, scale = 1)
     ar.centerFirst()
     print(ar._priority)

tests/TestMachineAction.py

@@ -1,11 +1,10 @@
-#Todo: Write tests
+# Copyright (c) 2018 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
 
 import pytest
-# QtApplication needs to be imported first to prevent import errors.
-from UM.Qt.QtApplication import QtApplication
 
 from cura.MachineAction import MachineAction
-from cura.MachineActionManager import MachineActionManager, NotUniqueMachineActionError, UnknownMachineActionError
+from cura.MachineActionManager import NotUniqueMachineActionError, UnknownMachineActionError
 
 class Machine:
     def __init__(self, key = ""):
@@ -14,66 +13,64 @@ class Machine:
     def getKey(self):
         return self._key
 
-def test_addMachineAction():
+def test_addMachineAction(machine_action_manager):
-
-    machine_manager = MachineActionManager()
 
     test_action = MachineAction(key = "test_action")
     test_action_2 = MachineAction(key = "test_action_2")
     test_machine = Machine("test_machine")
-    machine_manager.addMachineAction(test_action)
+    machine_action_manager.addMachineAction(test_action)
-    machine_manager.addMachineAction(test_action_2)
+    machine_action_manager.addMachineAction(test_action_2)
 
-    assert machine_manager.getMachineAction("test_action") == test_action
+    assert machine_action_manager.getMachineAction("test_action") == test_action
-    assert machine_manager.getMachineAction("key_that_doesnt_exist") is None
+    assert machine_action_manager.getMachineAction("key_that_doesnt_exist") is None
 
     # Adding the same machine action is not allowed.
     with pytest.raises(NotUniqueMachineActionError):
-        machine_manager.addMachineAction(test_action)
+        machine_action_manager.addMachineAction(test_action)
 
     # Check that the machine has no supported actions yet.
-    assert machine_manager.getSupportedActions(test_machine) == list()
+    assert machine_action_manager.getSupportedActions(test_machine) == list()
 
     # Check if adding a supported action works.
-    machine_manager.addSupportedAction(test_machine, "test_action")
+    machine_action_manager.addSupportedAction(test_machine, "test_action")
-    assert machine_manager.getSupportedActions(test_machine) == [test_action, ]
+    assert machine_action_manager.getSupportedActions(test_machine) == [test_action, ]
 
     # Check that adding a unknown action doesn't change anything.
-    machine_manager.addSupportedAction(test_machine, "key_that_doesnt_exist")
+    machine_action_manager.addSupportedAction(test_machine, "key_that_doesnt_exist")
-    assert machine_manager.getSupportedActions(test_machine) == [test_action, ]
+    assert machine_action_manager.getSupportedActions(test_machine) == [test_action, ]
 
     # Check if adding multiple supported actions works.
-    machine_manager.addSupportedAction(test_machine, "test_action_2")
+    machine_action_manager.addSupportedAction(test_machine, "test_action_2")
-    assert machine_manager.getSupportedActions(test_machine) == [test_action, test_action_2]
+    assert machine_action_manager.getSupportedActions(test_machine) == [test_action, test_action_2]
 
     # Check that the machine has no required actions yet.
-    assert machine_manager.getRequiredActions(test_machine) == set()
+    assert machine_action_manager.getRequiredActions(test_machine) == set()
 
     ## Ensure that only known actions can be added.
     with pytest.raises(UnknownMachineActionError):
-        machine_manager.addRequiredAction(test_machine, "key_that_doesnt_exist")
+        machine_action_manager.addRequiredAction(test_machine, "key_that_doesnt_exist")
 
     ## Check if adding single required action works
-    machine_manager.addRequiredAction(test_machine, "test_action")
+    machine_action_manager.addRequiredAction(test_machine, "test_action")
-    assert machine_manager.getRequiredActions(test_machine) == [test_action, ]
+    assert machine_action_manager.getRequiredActions(test_machine) == [test_action, ]
 
     # Check if adding multiple required actions works.
-    machine_manager.addRequiredAction(test_machine, "test_action_2")
+    machine_action_manager.addRequiredAction(test_machine, "test_action_2")
-    assert machine_manager.getRequiredActions(test_machine) == [test_action, test_action_2]
+    assert machine_action_manager.getRequiredActions(test_machine) == [test_action, test_action_2]
 
     # Ensure that firstStart actions are empty by default.
-    assert machine_manager.getFirstStartActions(test_machine) == []
+    assert machine_action_manager.getFirstStartActions(test_machine) == []
 
     # Check if adding multiple (the same) actions to first start actions work.
-    machine_manager.addFirstStartAction(test_machine, "test_action")
+    machine_action_manager.addFirstStartAction(test_machine, "test_action")
-    machine_manager.addFirstStartAction(test_machine, "test_action")
+    machine_action_manager.addFirstStartAction(test_machine, "test_action")
-    assert machine_manager.getFirstStartActions(test_machine) == [test_action, test_action]
+    assert machine_action_manager.getFirstStartActions(test_machine) == [test_action, test_action]
 
     # Check if inserting an action works
-    machine_manager.addFirstStartAction(test_machine, "test_action_2", index = 1)
+    machine_action_manager.addFirstStartAction(test_machine, "test_action_2", index = 1)
-    assert machine_manager.getFirstStartActions(test_machine) == [test_action, test_action_2, test_action]
+    assert machine_action_manager.getFirstStartActions(test_machine) == [test_action, test_action_2, test_action]
 
     # Check that adding a unknown action doesn't change anything.
-    machine_manager.addFirstStartAction(test_machine, "key_that_doesnt_exist", index = 1)
+    machine_action_manager.addFirstStartAction(test_machine, "key_that_doesnt_exist", index = 1)
-    assert machine_manager.getFirstStartActions(test_machine) == [test_action, test_action_2, test_action]
+    assert machine_action_manager.getFirstStartActions(test_machine) == [test_action, test_action_2, test_action]
 

tests/TestProfileRequirements.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2018 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+
 import configparser #To read the profiles.
 import os #To join paths.
 import pytest
@@ -11,6 +14,7 @@ import pytest
 #   often that we updated the variants for the UM3 but forgot about the UM3E.
 @pytest.mark.parametrize("um3_file, um3e_file", [
     #List the corresponding files below.
+    ("ultimaker3_aa0.25.inst.cfg", "ultimaker3_extended_aa0.25.inst.cfg"),
     ("ultimaker3_aa0.8.inst.cfg", "ultimaker3_extended_aa0.8.inst.cfg"),
     ("ultimaker3_aa04.inst.cfg", "ultimaker3_extended_aa04.inst.cfg"),
     ("ultimaker3_bb0.8.inst.cfg", "ultimaker3_extended_bb0.8.inst.cfg"),

tests/conftest.py

@@ -0,0 +1,38 @@
+# Copyright (c) 2018 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+
+# The purpose of this class is to create fixtures or methods that can be shared among all tests.
+
+import pytest
+from UM.Qt.QtApplication import QtApplication #QTApplication import is required, even though it isn't used.
+from cura.CuraApplication import CuraApplication
+from cura.MachineActionManager import MachineActionManager
+
+# Create a CuraApplication object that will be shared among all tests. It needs to be initialized.
+# Since we need to use it more that once, we create the application the first time and use its instance afterwards.
+@pytest.fixture()
+def application() -> CuraApplication:
+    application = CuraApplication.getInstance()
+    if application is None:
+        application = CuraApplication()
+        application.initialize()
+    return application
+
+# Returns a MachineActionManager instance.
+@pytest.fixture()
+def machine_action_manager(application) -> MachineActionManager:
+    return application.getMachineActionManager()
+
+# @pytest.fixture()
+# def plugin_registry(application):
+#     PluginRegistry._PluginRegistry__instance = None
+#     plugin_registry = PluginRegistry(application)
+#     plugin_registry._plugin_locations = [] # Clear pre-defined plugin locations
+#     return plugin_registry
+#
+# @pytest.fixture()
+# def upgrade_manager(application):
+#     VersionUpgradeManager._VersionUpgradeManager__instance = None
+#     upgrade_manager = VersionUpgradeManager(application)
+#     return upgrade_manager
+