Initial step for IDTypeInfo refactor 'cleanup' project.
[blender.git] / tests / gtests / blenloader / blendfile_loading_base_test.cc
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2019 by Blender Foundation.
17  */
18 #include "blendfile_loading_base_test.h"
19
20 #include "MEM_guardedalloc.h"
21
22 extern "C" {
23 #include "BKE_appdir.h"
24 #include "BKE_blender.h"
25 #include "BKE_context.h"
26 #include "BKE_global.h"
27 #include "BKE_idtype.h"
28 #include "BKE_image.h"
29 #include "BKE_main.h"
30 #include "BKE_modifier.h"
31 #include "BKE_node.h"
32 #include "BKE_scene.h"
33
34 #include "BLI_threads.h"
35 #include "BLI_path_util.h"
36
37 #include "BLO_readfile.h"
38
39 #include "DEG_depsgraph_build.h"
40 #include "DEG_depsgraph.h"
41
42 #include "DNA_genfile.h" /* for DNA_sdna_current_init() */
43 #include "DNA_windowmanager_types.h"
44
45 #include "IMB_imbuf.h"
46
47 #include "RNA_define.h"
48
49 #include "WM_api.h"
50 #include "wm.h"
51 }
52
53 DEFINE_string(test_assets_dir, "", "lib/tests directory from SVN containing the test assets.");
54
55 BlendfileLoadingBaseTest::~BlendfileLoadingBaseTest()
56 {
57 }
58
59 void BlendfileLoadingBaseTest::SetUpTestCase()
60 {
61   testing::Test::SetUpTestCase();
62
63   /* Minimal code to make loading a blendfile and constructing a depsgraph not crash, copied from
64    * main() in creator.c. */
65   BLI_threadapi_init();
66
67   DNA_sdna_current_init();
68   BKE_blender_globals_init();
69
70   BKE_idtype_init();
71   IMB_init();
72   BKE_images_init();
73   BKE_modifier_init();
74   DEG_register_node_types();
75   RNA_init();
76   init_nodesystem();
77
78   G.background = true;
79   G.factory_startup = true;
80
81   /* Allocate a dummy window manager. The real window manager will try and load Python scripts from
82    * the release directory, which it won't be able to find. */
83   ASSERT_EQ(G.main->wm.first, nullptr);
84   G.main->wm.first = MEM_callocN(sizeof(wmWindowManager), __func__);
85 }
86
87 void BlendfileLoadingBaseTest::TearDownTestCase()
88 {
89   if (G.main->wm.first != nullptr) {
90     MEM_freeN(G.main->wm.first);
91     G.main->wm.first = nullptr;
92   }
93
94   /* Copied from WM_exit_ex() in wm_init_exit.c, and cherry-picked those lines that match the
95    * allocation/initialization done in SetUpTestCase(). */
96   BKE_blender_free();
97   RNA_exit();
98
99   DEG_free_node_types();
100   DNA_sdna_current_free();
101   BLI_threadapi_exit();
102
103   BKE_blender_atexit();
104
105   if (MEM_get_memory_blocks_in_use() != 0) {
106     size_t mem_in_use = MEM_get_memory_in_use() + MEM_get_memory_in_use();
107     printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
108            MEM_get_memory_blocks_in_use(),
109            (double)mem_in_use / 1024 / 1024);
110     MEM_printmemlist();
111   }
112
113   BKE_tempdir_session_purge();
114
115   testing::Test::TearDownTestCase();
116 }
117
118 void BlendfileLoadingBaseTest::TearDown()
119 {
120   depsgraph_free();
121   blendfile_free();
122
123   testing::Test::TearDown();
124 }
125
126 bool BlendfileLoadingBaseTest::blendfile_load(const char *filepath)
127 {
128   if (FLAGS_test_assets_dir.empty()) {
129     ADD_FAILURE()
130         << "Pass the flag --test-assets-dir and point to the lib/tests directory from SVN.";
131     return false;
132   }
133
134   char abspath[FILENAME_MAX];
135   BLI_path_join(abspath, sizeof(abspath), FLAGS_test_assets_dir.c_str(), filepath, NULL);
136
137   bfile = BLO_read_from_file(abspath, BLO_READ_SKIP_NONE, NULL /* reports */);
138   if (bfile == nullptr) {
139     ADD_FAILURE() << "Unable to load file '" << filepath << "' from test assets dir '"
140                   << FLAGS_test_assets_dir << "'";
141     return false;
142   }
143   return true;
144 }
145
146 void BlendfileLoadingBaseTest::blendfile_free()
147 {
148   if (bfile == nullptr) {
149     return;
150   }
151
152   wmWindowManager *wm = static_cast<wmWindowManager *>(bfile->main->wm.first);
153   if (wm != nullptr) {
154     wm_close_and_free(NULL, wm);
155   }
156   BLO_blendfiledata_free(bfile);
157   bfile = nullptr;
158 }
159
160 void BlendfileLoadingBaseTest::depsgraph_create(eEvaluationMode depsgraph_evaluation_mode)
161 {
162   depsgraph = DEG_graph_new(
163       bfile->main, bfile->curscene, bfile->cur_view_layer, depsgraph_evaluation_mode);
164   DEG_graph_build_from_view_layer(depsgraph, bfile->main, bfile->curscene, bfile->cur_view_layer);
165   BKE_scene_graph_update_tagged(depsgraph, bfile->main);
166 }
167
168 void BlendfileLoadingBaseTest::depsgraph_free()
169 {
170   if (depsgraph == nullptr) {
171     return;
172   }
173   DEG_graph_free(depsgraph);
174   depsgraph = nullptr;
175 }