addon_utils default mismatch /w enable/disable
[blender.git] / tests / python / bl_load_py_modules.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 # simple script to enable all addons, and disable
22
23 """
24 ./blender.bin --background -noaudio --factory-startup --python tests/python/bl_load_py_modules.py
25 """
26
27 import bpy
28 import addon_utils
29
30 import sys
31 import os
32
33 BLACKLIST = {
34     "bl_i18n_utils",
35     "cycles",
36     "io_export_dxf",  # TODO, check on why this fails
37     'io_import_dxf',  # Because of cydxfentity.so dependency
38     }
39
40 BLACKLIST_DIRS = (
41     os.path.join(bpy.utils.resource_path('USER'), "scripts"),
42     ) + tuple(addon_utils.paths()[1:])
43
44
45 def addon_modules_sorted():
46     modules = addon_utils.modules({})
47     modules[:] = [mod for mod in modules if not mod.__file__.startswith(BLACKLIST_DIRS)]
48     modules.sort(key=lambda mod: mod.__name__)
49     return modules
50
51
52 def source_list(path, filename_check=None):
53     from os.path import join
54     for dirpath, dirnames, filenames in os.walk(path):
55         # skip '.svn'
56         if dirpath.startswith("."):
57             continue
58
59         for filename in filenames:
60             filepath = join(dirpath, filename)
61             if filename_check is None or filename_check(filepath):
62                 yield filepath
63
64
65 def load_addons():
66     modules = addon_modules_sorted()
67     addons = bpy.context.user_preferences.addons
68
69     # first disable all
70     for mod_name in list(addons.keys()):
71         addon_utils.disable(mod_name, default_set=True)
72
73     assert(bool(addons) is False)
74
75     for mod in modules:
76         mod_name = mod.__name__
77         addon_utils.enable(mod_name, default_set=True)
78         assert(mod_name in addons)
79
80
81 def load_modules():
82     modules = []
83     module_paths = []
84
85     # paths blender stores scripts in.
86     paths = bpy.utils.script_paths()
87
88     print("Paths:")
89     for script_path in paths:
90         print("\t'%s'" % script_path)
91
92     #
93     # find all sys.path we added
94     for script_path in paths:
95         for mod_dir in sys.path:
96             if mod_dir.startswith(script_path):
97                 if not mod_dir.startswith(BLACKLIST_DIRS):
98                     if mod_dir not in module_paths:
99                         if os.path.exists(mod_dir):
100                             module_paths.append(mod_dir)
101
102     #
103     # collect modules from our paths.
104     module_names = {}
105     for mod_dir in module_paths:
106         # print("mod_dir", mod_dir)
107         for mod, mod_full in bpy.path.module_names(mod_dir):
108             if mod in BLACKLIST:
109                 continue
110             if mod in module_names:
111                 mod_dir_prev, mod_full_prev = module_names[mod]
112                 raise Exception("Module found twice %r.\n    (%r -> %r, %r -> %r)" %
113                                 (mod, mod_dir, mod_full, mod_dir_prev, mod_full_prev))
114
115             modules.append(__import__(mod))
116
117             module_names[mod] = mod_dir, mod_full
118     del module_names
119
120     #
121     # now submodules
122     for m in modules:
123         filepath = m.__file__
124         if os.path.basename(filepath).startswith("__init__."):
125             mod_dir = os.path.dirname(filepath)
126             for submod, submod_full in bpy.path.module_names(mod_dir):
127                 # fromlist is ignored, ugh.
128                 mod_name_full = m.__name__ + "." + submod
129                 __import__(mod_name_full)
130                 mod_imp = sys.modules[mod_name_full]
131
132                 # check we load what we ask for.
133                 assert(os.path.samefile(mod_imp.__file__, submod_full))
134
135                 modules.append(mod_imp)
136
137     #
138     # check which filepaths we didn't load
139     source_files = []
140     for mod_dir in module_paths:
141         source_files.extend(source_list(mod_dir, filename_check=lambda f: f.endswith(".py")))
142
143     source_files = list(set(source_files))
144     source_files.sort()
145
146     #
147     # remove loaded files
148     loaded_files = list({m.__file__ for m in modules})
149     loaded_files.sort()
150
151     for f in loaded_files:
152         source_files.remove(f)
153
154     #
155     # test we tested all files except for presets and templates
156     ignore_paths = [
157         os.sep + "presets" + os.sep,
158         os.sep + "templates" + os.sep,
159     ] + [(os.sep + f + os.sep) for f in BLACKLIST]
160
161     for f in source_files:
162         ok = False
163         for ignore in ignore_paths:
164             if ignore in f:
165                 ok = True
166         if not ok:
167             raise Exception("Source file %r not loaded in test" % f)
168
169     print("loaded %d modules" % len(loaded_files))
170
171
172 def main():
173     load_addons()
174     load_modules()
175
176 if __name__ == "__main__":
177     # So a python error exits(1)
178     try:
179         main()
180     except:
181         import traceback
182         traceback.print_exc()
183         sys.exit(1)