1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
# 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 os.path
import pytest
import unittest.mock #For mocking the container provider priority.
from UM.PluginRegistry import PluginRegistry
from UM.VersionUpgradeManager import VersionUpgradeManager
from UM.Resources import Resources
from UM.MimeTypeDatabase import MimeType, MimeTypeDatabase
from UM.Settings.ContainerProvider import ContainerProvider #To provide the fixtures for container providers.
from UM.Settings.ContainerRegistry import ContainerRegistry
import UM.Settings.ContainerStack
from UM.Settings.DefinitionContainer import DefinitionContainer #To provide definition containers in the registry fixtures.
import UM.Settings.InstanceContainer
## Creates a brand new container registry.
#
# To force a new container registry, the registry is first set to None and
# then re-requested.
#
# \return A brand new container registry.
@pytest.fixture
def container_registry(application, test_containers_provider, plugin_registry: PluginRegistry):
MimeTypeDatabase.addMimeType(
MimeType(
name = "application/x-uranium-definitioncontainer",
comment = "Uranium Definition Container",
suffixes = ["def.json"]
)
)
MimeTypeDatabase.addMimeType(
MimeType(
name = "application/x-uranium-instancecontainer",
comment = "Uranium Instance Container",
suffixes = [ "inst.cfg" ]
)
)
MimeTypeDatabase.addMimeType(
MimeType(
name = "application/x-uranium-containerstack",
comment = "Uranium Container Stack",
suffixes = [ "stack.cfg" ]
)
)
ContainerRegistry._ContainerRegistry__instance = None # Reset the private instance variable every time
registry = ContainerRegistry(application)
#We need to mock the "priority" plug-in metadata field, but preferably without mocking an entire plug-in.
with unittest.mock.patch("UM.PluginRegistry.PluginRegistry.getMetaData", unittest.mock.MagicMock(return_value = {"container_provider": {}})):
registry.addProvider(test_containers_provider)
# Make sure that a new database connection is used.
db_path = os.path.join(Resources.getCacheStoragePath(), "containers.db")
if os.path.exists(db_path):
os.remove(db_path)
container_registry._db_connection = None
UM.Settings.ContainerStack.setContainerRegistry(registry)
UM.Settings.InstanceContainer.setContainerRegistry(registry)
return registry
@pytest.fixture
def loaded_container_registry(container_registry: ContainerRegistry, test_containers_provider: ContainerProvider):
container_registry.addResourceType(Resources.InstanceContainers, "test_type")
container_registry.load()
return container_registry
## Empty container provider which returns nothing.
@pytest.fixture
def container_provider():
return TestContainerProvider()
## Container provider which provides the containers that are in the setting
# test directory.
@pytest.fixture
def test_containers_provider(container_provider: ContainerProvider, upgrade_manager: VersionUpgradeManager) -> ContainerProvider:
my_folder = os.path.dirname(os.path.abspath(__file__))
definition_ids = {"basic_definition", "children", "functions", "inherits", "metadata_definition", "multiple_settings", "single_setting"}
for definition_id in definition_ids:
container = DefinitionContainer(definition_id)
container.deserialize(open(os.path.join(my_folder, "definitions", definition_id + ".def.json"), encoding = "utf-8").read())
container_provider._containers[definition_id] = container
container_provider.addMetadata(container.getMetaData())
instance_ids = {"basic_instance", "metadata_instance", "setting_values"}
for instance_id in instance_ids:
container = UM.Settings.InstanceContainer.InstanceContainer(instance_id)
container.deserialize(open(os.path.join(my_folder, "instances", instance_id + ".inst.cfg"), encoding = "utf-8").read())
container_provider._containers[instance_id] = container
container_provider.addMetadata(container.getMetaData())
return container_provider
## Extremely basic implementation of a container provider.
#
# To add something to this provider, add it to its `_containers` and its
# `_metadata` fields.
class TestContainerProvider(ContainerProvider):
def __init__(self) -> None:
super().__init__()
self._plugin_id = "TestContainerProvider"
self._version = "0.1.0"
def getAllIds(self, *args, **kwargs):
return self._containers.keys()
def isReadOnly(self, *args, **kwargs):
return True
def loadContainer(self, container_id, *args, **kwargs):
return self._containers[container_id]
def loadMetadata(self, container_id, *args, **kwargs):
return self._metadata[container_id]
def saveContainer(self, *args, **kwargs):
return None
def getLastModifiedTime(self, container_id: str):
return 50
|
