Blender V5.3
blender_project_test.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
6#include "BKE_gtest_base.hh"
7#include "BKE_main.hh"
8
9#include "BLI_path_utils.hh"
10
11#include "testing/testing.h"
12
13namespace blender::bke::tests {
14
16 public:
18
19 void SetUp() override
20 {
22 }
23
24 void TearDown() override
25 {
27 }
28};
29
30TEST_F(BlenderProjectTest, blender_project_init_clear_test)
31{
32 EXPECT_EQ(true, BKE_blender_project_init("My Project", "/path/to/my/project"));
33
35 ASSERT_NE(project, nullptr);
36 EXPECT_EQ(project->get_name(), "My Project");
37 EXPECT_EQ(project->get_root_path(), "/path/to/my/project");
38 });
39
41
43 bmain, [](const BlenderProject *project) { ASSERT_EQ(project, nullptr); });
44}
45
46TEST_F(BlenderProjectTest, blender_project_replace_test)
47{
48 EXPECT_EQ(true, BKE_blender_project_init("My Project", "/path/to/my/project"));
49
51 ASSERT_NE(project, nullptr);
52 EXPECT_EQ(project->get_name(), "My Project");
53 EXPECT_EQ(project->get_root_path(), "/path/to/my/project");
54 });
55
56 /* Invalid: empty root. Should leave existing project in place. */
57 EXPECT_EQ(false, BKE_blender_project_init("My Project", ""));
58
60 ASSERT_NE(project, nullptr);
61 EXPECT_EQ(project->get_name(), "My Project");
62 EXPECT_EQ(project->get_root_path(), "/path/to/my/project");
63 });
64
65 /* Invalid: empty name. Should leave existing project in place. */
66 EXPECT_EQ(false, BKE_blender_project_init("", "/path/to/my/project"));
67
69 ASSERT_NE(project, nullptr);
70 EXPECT_EQ(project->get_name(), "My Project");
71 EXPECT_EQ(project->get_root_path(), "/path/to/my/project");
72 });
73
74 /* Valid. Should clear and replace the existing project. */
75 EXPECT_EQ(true, BKE_blender_project_init("My Next Project", "/path/to/way/cooler/project"));
76
78 ASSERT_NE(project, nullptr);
79 EXPECT_EQ(project->get_name(), "My Next Project");
80 EXPECT_EQ(project->get_root_path(), "/path/to/way/cooler/project");
81 });
82}
83
84/* Test get/set for the project's name and root path. */
85TEST_F(BlenderProjectTest, blender_project_name_and_path_test)
86{
87 BKE_blender_project_init("My Project", "/path/to/my/project");
88
90 ASSERT_NE(project, nullptr);
91 EXPECT_EQ(project->get_name(), "My Project");
92 EXPECT_EQ(project->get_root_path(), "/path/to/my/project");
93
94 project->set_name("My Next Project");
95 EXPECT_EQ(project->get_name(), "My Next Project");
96
97 project->set_root_path("/path/to/way/cooler/project");
98 EXPECT_EQ(project->get_root_path(), "/path/to/way/cooler/project");
99 });
100}
101
102/* Test making paths inside the project relative, in path template form. */
103TEST_F(BlenderProjectTest, blender_project_path_make_relative_test)
104{
105#ifdef WIN32
106 const std::string root = "C:\\path\\to\\my\\project";
107#else
108 const std::string root = "/path/to/my/project";
109#endif
110
111 /* Trailing separator on the root path should make no difference. */
112 for (const char *root_suffix : {"", SEP_STR}) {
113 BKE_blender_project_init("My Project", root + root_suffix);
114
116 ASSERT_NE(project, nullptr);
117
118 EXPECT_EQ(BKE_blender_project_path_make_relative(root, false, *project), "{project_root}");
120 "{project_root}");
121
123 "{project_root}/assets");
125 root + SEP_STR "as{s}ets" SEP_STR, false, *project),
126 "{project_root}/as{{s}}ets/");
127
128 /* Unchanged: different project, blend relative, regular relative, already templated. */
129 EXPECT_EQ(BKE_blender_project_path_make_relative(root + "_final_final", false, *project),
130 root + "_final_final");
132 "//as{{s}}ets");
133 EXPECT_EQ(BKE_blender_project_path_make_relative("as{s}ets", true, *project), "as{s}ets");
134 EXPECT_EQ(BKE_blender_project_path_make_relative("{project_root}/assets", true, *project),
135 "{project_root}/assets");
136 });
137 }
138
140}
141
142/* Check the basics of creating new variables. */
143TEST_F(BlenderProjectTest, blender_project_variable_new_test)
144{
145 BKE_blender_project_init("My Project", "/path/to/my/project");
146
148 ASSERT_NE(project, nullptr);
149
150 ProjectVariable *var_str = project->new_variable("MyStringVar", ProjectVariableType::STRING);
151 ASSERT_NE(var_str, nullptr);
152 EXPECT_EQ(var_str->name_get(), "MyStringVar");
155 EXPECT_EQ(var_str->value_string_get(), "");
156 EXPECT_EQ(var_str->description_get(), "");
157
158 ProjectVariable *var_int = project->new_variable("MyIntVar", ProjectVariableType::INT);
159 ASSERT_NE(var_int, nullptr);
160 EXPECT_EQ(var_int->name_get(), "MyIntVar");
162 EXPECT_EQ(var_int->value_int_get(), 0);
163 EXPECT_EQ(var_int->description_get(), "");
164
165 ProjectVariable *var_float = project->new_variable("MyFloatVar", ProjectVariableType::FLOAT);
166 ASSERT_NE(var_float, nullptr);
167 EXPECT_EQ(var_float->name_get(), "MyFloatVar");
169 EXPECT_EQ(var_float->value_float_get(), 0.0);
170 EXPECT_EQ(var_float->description_get(), "");
171 });
172}
173
174/* Test how variable names are handled when creating new variables.
175 *
176 * - Duplicate names should be suffixed with `_001`, etc.
177 * - Invalid names should be modified to become valid. */
178TEST_F(BlenderProjectTest, blender_project_variable_new_names_test)
179{
180 BKE_blender_project_init("My Project", "/path/to/my/project");
181
183 ASSERT_NE(project, nullptr);
184
185 ProjectVariable *var0 = project->new_variable("MyVar", ProjectVariableType::STRING);
186 ProjectVariable *var1 = project->new_variable("MyVar", ProjectVariableType::STRING);
187 ProjectVariable *var2 = project->new_variable("MyVar_001", ProjectVariableType::STRING);
188 ProjectVariable *var3 = project->new_variable("MyVar_003", ProjectVariableType::STRING);
189 ProjectVariable *var4 = project->new_variable("MyOtherVar", ProjectVariableType::STRING);
190 ProjectVariable *var5 = project->new_variable("MyOtherVar", ProjectVariableType::STRING);
191 ProjectVariable *var6 = project->new_variable("MyOtherVar_001", ProjectVariableType::STRING);
192 ProjectVariable *var7 = project->new_variable("MyOtherVar_003", ProjectVariableType::STRING);
193 ProjectVariable *var8 = project->new_variable("Invalid name.with-punctuation_and@ユニコード",
195 ASSERT_NE(var0, nullptr);
196 ASSERT_NE(var1, nullptr);
197 ASSERT_NE(var2, nullptr);
198 ASSERT_NE(var3, nullptr);
199 ASSERT_NE(var4, nullptr);
200 ASSERT_NE(var5, nullptr);
201 ASSERT_NE(var6, nullptr);
202 ASSERT_NE(var7, nullptr);
203 ASSERT_NE(var8, nullptr);
204
205 EXPECT_EQ(var0->name_get(), "MyVar");
206 EXPECT_EQ(var1->name_get(), "MyVar_001");
207 EXPECT_EQ(var2->name_get(), "MyVar_002");
208 EXPECT_EQ(var3->name_get(), "MyVar_003");
209 EXPECT_EQ(var4->name_get(), "MyOtherVar");
210 EXPECT_EQ(var5->name_get(), "MyOtherVar_001");
211 EXPECT_EQ(var6->name_get(), "MyOtherVar_002");
212 EXPECT_EQ(var7->name_get(), "MyOtherVar_003");
213 EXPECT_EQ(var8->name_get(), "Invalid_name_with_punctuation_and________________");
214 });
215}
216
217/* Test how variable names are handled when renaming.
218 *
219 * - Duplicate names should be suffixed with `_001`, etc.
220 * - Invalid names should be modified to become valid. */
221TEST_F(BlenderProjectTest, blender_project_variable_rename_test)
222{
223 BKE_blender_project_init("My Project", "/path/to/my/project");
224
226 ASSERT_NE(project, nullptr);
227
228 ProjectVariable *var0 = project->new_variable("MyVar0", ProjectVariableType::STRING);
229 ProjectVariable *var1 = project->new_variable("MyVar1", ProjectVariableType::STRING);
230 ProjectVariable *var2 = project->new_variable("MyVar2", ProjectVariableType::STRING);
231 ASSERT_NE(var0, nullptr);
232 ASSERT_NE(var1, nullptr);
233 ASSERT_NE(var2, nullptr);
234
235 ASSERT_EQ(project->find_variable_index(var0), 0);
236 ASSERT_EQ(project->find_variable_index(var1), 1);
237 ASSERT_EQ(project->find_variable_index(var2), 2);
238
239 /* Rename to a duplicate name. */
240 project->rename_variable(1, "MyVar0");
241 EXPECT_EQ(var1->name_get(), "MyVar0_001");
242 project->rename_variable(2, "MyVar0");
243 EXPECT_EQ(var2->name_get(), "MyVar0_002");
244
245 /* Rename to same as current name. */
246 project->rename_variable(0, "MyVar0");
247 EXPECT_EQ(var0->name_get(), "MyVar0");
248 project->rename_variable(1, "MyVar0_001");
249 EXPECT_EQ(var1->name_get(), "MyVar0_001");
250 project->rename_variable(2, "MyVar0_002");
251 EXPECT_EQ(var2->name_get(), "MyVar0_002");
252
253 /* Rename to invalid name. */
254 project->rename_variable(0, "Invalid name.with-punctuation_and@ユニコード");
255 EXPECT_EQ(var0->name_get(), "Invalid_name_with_punctuation_and________________");
256
257 /* Rename to duplicate invalid name. */
258 project->rename_variable(1, "Invalid name.with-punctuation_and@ユニコード");
259 EXPECT_EQ(var1->name_get(), "Invalid_name_with_punctuation_and_________________001");
260
261 /* Rename to empty (invalid) name. */
262 project->rename_variable(0, "");
263 EXPECT_EQ(var0->name_get(), "_");
264
265 /* Rename to duplicate empty (invalid) name. */
266 project->rename_variable(1, "");
267 EXPECT_EQ(var1->name_get(), "__001");
268 });
269}
270
271/* Test sub-type get/set on project variables. */
272TEST_F(BlenderProjectTest, blender_project_variable_subtype_test)
273{
274 BKE_blender_project_init("My Project", "/path/to/my/project");
275
277 ASSERT_NE(project, nullptr);
278
279 ProjectVariable *var = project->new_variable("MyVar", ProjectVariableType::STRING);
280 ASSERT_NE(var, nullptr);
281
286 });
287}
288
289/* Test value get/set on project variables. */
290TEST_F(BlenderProjectTest, blender_project_variable_value_test)
291{
292 BKE_blender_project_init("My Project", "/path/to/my/project");
293
295 ASSERT_NE(project, nullptr);
296
297 ProjectVariable *var_str = project->new_variable("MyStringVar", ProjectVariableType::STRING);
298 ProjectVariable *var_int = project->new_variable("MyIntVar", ProjectVariableType::INT);
299 ProjectVariable *var_float = project->new_variable("MyFloatVar", ProjectVariableType::FLOAT);
300 ASSERT_NE(var_str, nullptr);
301 ASSERT_NE(var_int, nullptr);
302 ASSERT_NE(var_float, nullptr);
303
304 var_str->value_set("Hello Suzanne!");
305 EXPECT_EQ(var_str->value_string_get(), "Hello Suzanne!");
306 var_str->value_set("Hello Suzaaaaaaaaaaaaan!");
307 EXPECT_EQ(var_str->value_string_get(), "Hello Suzaaaaaaaaaaaaan!");
308 var_str->value_set("Hello!");
309 EXPECT_EQ(var_str->value_string_get(), "Hello!");
310 var_str->value_set("");
311 EXPECT_EQ(var_str->value_string_get(), "");
312
313 var_int->value_set(42);
314 EXPECT_EQ(var_int->value_int_get(), 42);
315 var_int->value_set(7);
316 EXPECT_EQ(var_int->value_int_get(), 7);
317
318 var_float->value_set(3.5f);
319 EXPECT_EQ(var_float->value_float_get(), 3.5f);
320 var_float->value_set(-1.5f);
321 EXPECT_EQ(var_float->value_float_get(), -1.5f);
322 });
323}
324
325/* Test description get/set on project variables. */
326TEST_F(BlenderProjectTest, blender_project_variable_description_test)
327{
328 BKE_blender_project_init("My Project", "/path/to/my/project");
329
331 ASSERT_NE(project, nullptr);
332
333 ProjectVariable *var = project->new_variable("MyVar", ProjectVariableType::STRING);
334 ASSERT_NE(var, nullptr);
335
336 var->description_set("I'm a variable!");
337 EXPECT_EQ(var->description_get(), "I'm a variable!");
338 var->description_set("No I'm not! I'm a *project* variable!");
339 EXPECT_EQ(var->description_get(), "No I'm not! I'm a *project* variable!");
340 var->description_set("");
341 EXPECT_EQ(var->description_get(), "");
342 });
343}
344
345/* Test moving project variables. */
346TEST_F(BlenderProjectTest, blender_project_variable_move_test)
347{
348 BKE_blender_project_init("My Project", "/path/to/my/project");
349
351 ASSERT_NE(project, nullptr);
352
353 ProjectVariable *var_a = project->new_variable("MyVarA", ProjectVariableType::STRING);
354 ProjectVariable *var_b = project->new_variable("MyVarB", ProjectVariableType::STRING);
355 ProjectVariable *var_c = project->new_variable("MyVarC", ProjectVariableType::STRING);
356 ProjectVariable *var_d = project->new_variable("MyVarD", ProjectVariableType::STRING);
357 ASSERT_NE(var_a, nullptr);
358 ASSERT_NE(var_b, nullptr);
359 ASSERT_NE(var_c, nullptr);
360 ASSERT_NE(var_d, nullptr);
361
362 EXPECT_EQ(project->find_variable_index(var_a), 0);
363 EXPECT_EQ(project->find_variable_index(var_b), 1);
364 EXPECT_EQ(project->find_variable_index(var_c), 2);
365 EXPECT_EQ(project->find_variable_index(var_d), 3);
366
367 project->move_variable(0, 1);
368 EXPECT_EQ(project->find_variable_index(var_b), 0);
369 EXPECT_EQ(project->find_variable_index(var_a), 1);
370 EXPECT_EQ(project->find_variable_index(var_c), 2);
371 EXPECT_EQ(project->find_variable_index(var_d), 3);
372
373 project->move_variable(2, 3);
374 EXPECT_EQ(project->find_variable_index(var_b), 0);
375 EXPECT_EQ(project->find_variable_index(var_a), 1);
376 EXPECT_EQ(project->find_variable_index(var_d), 2);
377 EXPECT_EQ(project->find_variable_index(var_c), 3);
378
379 project->move_variable(0, 3);
380 EXPECT_EQ(project->find_variable_index(var_a), 0);
381 EXPECT_EQ(project->find_variable_index(var_d), 1);
382 EXPECT_EQ(project->find_variable_index(var_c), 2);
383 EXPECT_EQ(project->find_variable_index(var_b), 3);
384
385 project->move_variable(2, 0);
386 EXPECT_EQ(project->find_variable_index(var_c), 0);
387 EXPECT_EQ(project->find_variable_index(var_a), 1);
388 EXPECT_EQ(project->find_variable_index(var_d), 2);
389 EXPECT_EQ(project->find_variable_index(var_b), 3);
390 });
391}
392
393/* Test removing project variables. */
394TEST_F(BlenderProjectTest, blender_project_variable_remove_test)
395{
396 BKE_blender_project_init("My Project", "/path/to/my/project");
397
399 ASSERT_NE(project, nullptr);
400
401 ProjectVariable *var_a = project->new_variable("MyVarA", ProjectVariableType::STRING);
402 ProjectVariable *var_b = project->new_variable("MyVarB", ProjectVariableType::STRING);
403 ProjectVariable *var_c = project->new_variable("MyVarC", ProjectVariableType::STRING);
404 ProjectVariable *var_d = project->new_variable("MyVarD", ProjectVariableType::STRING);
405 ASSERT_NE(var_a, nullptr);
406 ASSERT_NE(var_b, nullptr);
407 ASSERT_NE(var_c, nullptr);
408 ASSERT_NE(var_d, nullptr);
409
410 EXPECT_EQ(project->variables.size(), 4);
411 EXPECT_EQ(project->find_variable_index(var_a), 0);
412 EXPECT_EQ(project->find_variable_index(var_b), 1);
413 EXPECT_EQ(project->find_variable_index(var_c), 2);
414 EXPECT_EQ(project->find_variable_index(var_d), 3);
415
416 project->remove_variable(var_c);
417 EXPECT_EQ(project->variables.size(), 3);
418 EXPECT_EQ(project->find_variable_index(var_a), 0);
419 EXPECT_EQ(project->find_variable_index(var_b), 1);
420 EXPECT_EQ(project->find_variable_index(var_d), 2);
421
422 project->remove_variable(var_a);
423 EXPECT_EQ(project->variables.size(), 2);
424 EXPECT_EQ(project->find_variable_index(var_b), 0);
425 EXPECT_EQ(project->find_variable_index(var_d), 1);
426
427 project->remove_variable(var_d);
428 EXPECT_EQ(project->variables.size(), 1);
429 EXPECT_EQ(project->find_variable_index(var_b), 0);
430
431 project->remove_variable(var_b);
432 EXPECT_EQ(project->variables.size(), 0);
433 });
434}
435
436} // namespace blender::bke::tests
void string_subtype_set(ProjectVariableStringSubtype type)
void description_set(StringRef description)
StringRefNull description_get() const
void value_set(StringRefNull value)
StringRefNull value_string_get() const
ProjectVariableStringSubtype string_subtype_get() const
ProjectVariableType type_get() const
StringRefNull name_get() const
TEST_F(AnimDataTest, BKE_fcurves_id_cb_test)
Main * BKE_main_new()
Definition main.cc:93
auto BKE_blender_project_read_callback(const Main *bmain, Fn lambda)
void BKE_blender_project_clear()
void BKE_main_free(Main *bmain)
Definition main.cc:202
EXPECT_EQ(BLI_expr_pylike_eval(expr, nullptr, 0, &result), EXPR_PYLIKE_INVALID)
bool BKE_blender_project_init(blender::StringRef name, blender::StringRef root_path)
auto BKE_blender_project_write_callback(const Main *bmain, Fn lambda)
std::string BKE_blender_project_path_make_relative(StringRef path, bool path_is_template, const bke::BlenderProject &project)
#define SEP_STR
Definition unit.cc:41