CoCalc -- test_project

GitHub Repository: godotengine/godot
Path: blob/master/tests/core/config/test_project_settings.cpp
⁴⁵⁹⁹⁷ views
1
/**************************************************************************/
2
/*  test_project_settings.cpp                                             */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#include "tests/test_macros.h"
32

33
TEST_FORCE_LINK(test_project_settings)
34

35
#include "core/config/project_settings.h"
36
#include "core/io/dir_access.h"
37
#include "core/object/message_queue.h"
38
#include "core/variant/variant.h"
39
#include "tests/signal_watcher.h"
40
#include "tests/test_utils.h"
41

42
namespace TestProjectSettings {
43

44
TEST_CASE("[ProjectSettings] Get existing setting") {
45
	CHECK(ProjectSettings::get_singleton()->has_setting("application/run/main_scene"));
46

47
	Variant variant = ProjectSettings::get_singleton()->get_setting("application/run/main_scene");
48
	CHECK_EQ(variant.get_type(), Variant::STRING);
49

50
	String name = variant;
51
	CHECK_EQ(name, String());
52
}
53

54
TEST_CASE("[ProjectSettings] Default value is ignored if setting exists") {
55
	CHECK(ProjectSettings::get_singleton()->has_setting("application/run/main_scene"));
56

57
	Variant variant = ProjectSettings::get_singleton()->get_setting("application/run/main_scene", "SomeDefaultValue");
58
	CHECK_EQ(variant.get_type(), Variant::STRING);
59

60
	String name = variant;
61
	CHECK_EQ(name, String());
62
}
63

64
TEST_CASE("[ProjectSettings] Non existing setting is null") {
65
	CHECK_FALSE(ProjectSettings::get_singleton()->has_setting("not_existing_setting"));
66

67
	Variant variant = ProjectSettings::get_singleton()->get_setting("not_existing_setting");
68
	CHECK_EQ(variant.get_type(), Variant::NIL);
69
}
70

71
TEST_CASE("[ProjectSettings] Non existing setting should return default value") {
72
	CHECK_FALSE(ProjectSettings::get_singleton()->has_setting("not_existing_setting"));
73

74
	Variant variant = ProjectSettings::get_singleton()->get_setting("not_existing_setting");
75
	CHECK_EQ(variant.get_type(), Variant::NIL);
76

77
	variant = ProjectSettings::get_singleton()->get_setting("not_existing_setting", "my_nice_default_value");
78
	CHECK_EQ(variant.get_type(), Variant::STRING);
79

80
	String name = variant;
81
	CHECK_EQ(name, "my_nice_default_value");
82

83
	CHECK_FALSE(ProjectSettings::get_singleton()->has_setting("not_existing_setting"));
84
}
85

86
TEST_CASE("[ProjectSettings] Set value should be returned when retrieved") {
87
	CHECK_FALSE(ProjectSettings::get_singleton()->has_setting("my_custom_setting"));
88

89
	Variant variant = ProjectSettings::get_singleton()->get_setting("my_custom_setting");
90
	CHECK_EQ(variant.get_type(), Variant::NIL);
91

92
	ProjectSettings::get_singleton()->set_setting("my_custom_setting", true);
93
	CHECK(ProjectSettings::get_singleton()->has_setting("my_custom_setting"));
94

95
	variant = ProjectSettings::get_singleton()->get_setting("my_custom_setting");
96
	CHECK_EQ(variant.get_type(), Variant::BOOL);
97

98
	bool value = variant;
99
	CHECK_EQ(true, value);
100

101
	CHECK(ProjectSettings::get_singleton()->has_setting("my_custom_setting"));
102
}
103

104
TEST_CASE("[ProjectSettings] localize_path") {
105
	String old_resource_path = TestProjectSettingsInternalsAccessor::resource_path();
106
	TestProjectSettingsInternalsAccessor::resource_path() = DirAccess::create(DirAccess::ACCESS_FILESYSTEM)->get_current_dir();
107
	String root_path = ProjectSettings::get_singleton()->get_resource_path();
108
#ifdef WINDOWS_ENABLED
109
	String root_path_win = ProjectSettings::get_singleton()->get_resource_path().replace_char('/', '\\');
110
#endif
111

112
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("filename"), "res://filename");
113
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path/filename"), "res://path/filename");
114
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path/something/../filename"), "res://path/filename");
115
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path/./filename"), "res://path/filename");
116
#ifdef WINDOWS_ENABLED
117
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path\\filename"), "res://path/filename");
118
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path\\something\\..\\filename"), "res://path/filename");
119
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("path\\.\\filename"), "res://path/filename");
120
#endif
121

122
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("../filename"), "../filename");
123
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("../path/filename"), "../path/filename");
124
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("..\\path\\filename"), "../path/filename");
125

126
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("/testroot/filename"), "/testroot/filename");
127
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("/testroot/path/filename"), "/testroot/path/filename");
128
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("/testroot/path/something/../filename"), "/testroot/path/filename");
129
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("/testroot/path/./filename"), "/testroot/path/filename");
130
#ifdef WINDOWS_ENABLED
131
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:/testroot/filename"), "C:/testroot/filename");
132
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:/testroot/path/filename"), "C:/testroot/path/filename");
133
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:/testroot/path/something/../filename"), "C:/testroot/path/filename");
134
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:/testroot/path/./filename"), "C:/testroot/path/filename");
135
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:\\testroot\\filename"), "C:/testroot/filename");
136
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:\\testroot\\path\\filename"), "C:/testroot/path/filename");
137
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:\\testroot\\path\\something\\..\\filename"), "C:/testroot/path/filename");
138
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path("C:\\testroot\\path\\.\\filename"), "C:/testroot/path/filename");
139
#endif
140

141
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path + "/filename"), "res://filename");
142
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path + "/path/filename"), "res://path/filename");
143
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path + "/path/something/../filename"), "res://path/filename");
144
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path + "/path/./filename"), "res://path/filename");
145
#ifdef WINDOWS_ENABLED
146
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path_win + "\\filename"), "res://filename");
147
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path_win + "\\path\\filename"), "res://path/filename");
148
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path_win + "\\path\\something\\..\\filename"), "res://path/filename");
149
	CHECK_EQ(ProjectSettings::get_singleton()->localize_path(root_path_win + "\\path\\.\\filename"), "res://path/filename");
150
#endif
151

152
	TestProjectSettingsInternalsAccessor::resource_path() = old_resource_path;
153
}
154

155
TEST_CASE("[SceneTree][ProjectSettings] settings_changed signal") {
156
	SIGNAL_WATCH(ProjectSettings::get_singleton(), SNAME("settings_changed"));
157

158
	ProjectSettings::get_singleton()->set_setting("test_signal_setting", "test_value");
159
	MessageQueue::get_singleton()->flush();
160

161
	SIGNAL_CHECK("settings_changed", { {} });
162

163
	SIGNAL_UNWATCH(ProjectSettings::get_singleton(), SNAME("settings_changed"));
164
}
165

166
TEST_CASE("[ProjectSettings] get_changed_settings basic functionality") {
167
	String setting_name = "test_changed_setting";
168
	ProjectSettings::get_singleton()->set_setting(setting_name, "test_value");
169

170
	PackedStringArray changes = ProjectSettings::get_singleton()->get_changed_settings();
171
	CHECK(changes.has(setting_name));
172
}
173

174
TEST_CASE("[ProjectSettings] get_changed_settings multiple settings") {
175
	ProjectSettings::get_singleton()->set_setting("test_setting_1", "value1");
176
	ProjectSettings::get_singleton()->set_setting("test_setting_2", "value2");
177
	ProjectSettings::get_singleton()->set_setting("another_group/setting", "value3");
178

179
	PackedStringArray changes = ProjectSettings::get_singleton()->get_changed_settings();
180
	CHECK(changes.has("test_setting_1"));
181
	CHECK(changes.has("test_setting_2"));
182
	CHECK(changes.has("another_group/setting"));
183
}
184

185
TEST_CASE("[ProjectSettings] check_changed_settings_in_group") {
186
	ProjectSettings::get_singleton()->set_setting("group1/setting1", "value1");
187
	ProjectSettings::get_singleton()->set_setting("group1/setting2", "value2");
188
	ProjectSettings::get_singleton()->set_setting("group2/setting1", "value3");
189
	ProjectSettings::get_singleton()->set_setting("other_setting", "value4");
190

191
	CHECK(ProjectSettings::get_singleton()->check_changed_settings_in_group("group1/"));
192
	CHECK(ProjectSettings::get_singleton()->check_changed_settings_in_group("group2/"));
193
	CHECK_FALSE(ProjectSettings::get_singleton()->check_changed_settings_in_group("nonexistent/"));
194

195
	CHECK(ProjectSettings::get_singleton()->check_changed_settings_in_group("group1"));
196
	CHECK(ProjectSettings::get_singleton()->check_changed_settings_in_group("other_setting"));
197
}
198

199
TEST_CASE("[SceneTree][ProjectSettings] Changes cleared after settings_changed signal") {
200
	SIGNAL_WATCH(ProjectSettings::get_singleton(), SNAME("settings_changed"));
201

202
	ProjectSettings::get_singleton()->set_setting("signal_clear_test", "value");
203

204
	PackedStringArray changes_before = ProjectSettings::get_singleton()->get_changed_settings();
205
	CHECK(changes_before.has("signal_clear_test"));
206

207
	MessageQueue::get_singleton()->flush();
208

209
	SIGNAL_CHECK("settings_changed", { {} });
210

211
	PackedStringArray changes_after = ProjectSettings::get_singleton()->get_changed_settings();
212
	CHECK_FALSE(changes_after.has("signal_clear_test"));
213

214
	SIGNAL_UNWATCH(ProjectSettings::get_singleton(), SNAME("settings_changed"));
215
}
216

217
TEST_CASE("[ProjectSettings] No tracking when setting same value") {
218
	String setting_name = "same_value_test";
219
	String test_value = "same_value";
220

221
	ProjectSettings::get_singleton()->set_setting(setting_name, test_value);
222
	int count_before = ProjectSettings::get_singleton()->get_changed_settings().size();
223

224
	// Setting the same value should not be tracked due to early return.
225
	ProjectSettings::get_singleton()->set_setting(setting_name, test_value);
226
	int count_after = ProjectSettings::get_singleton()->get_changed_settings().size();
227

228
	CHECK_EQ(count_before, count_after);
229
}
230

231
} // namespace TestProjectSettings
232

233
Product

Resources

Company
