Merge branch 'master' into blender2.8
[blender.git] / tests / python / bl_load_addons.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_addons.py
25 """
26
27 import bpy
28 import addon_utils
29
30 import os
31 import sys
32 import imp
33
34 BLACKLIST_DIRS = (
35     os.path.join(bpy.utils.resource_path('USER'), "scripts"),
36 ) + tuple(addon_utils.paths()[1:])
37 BLACKLIST_ADDONS = set()
38
39
40 def _init_addon_blacklist():
41
42     # in case we built without cycles
43     if not bpy.app.build_options.cycles:
44         BLACKLIST_ADDONS.add("cycles")
45
46     # in case we built without freestyle
47     if not bpy.app.build_options.freestyle:
48         BLACKLIST_ADDONS.add("render_freestyle_svg")
49
50     # netrender has known problems re-registering
51     BLACKLIST_ADDONS.add("netrender")
52
53
54 def addon_modules_sorted():
55     modules = addon_utils.modules({})
56     modules[:] = [
57         mod for mod in modules
58         if not (mod.__file__.startswith(BLACKLIST_DIRS))
59         if not (mod.__name__ in BLACKLIST_ADDONS)
60     ]
61     modules.sort(key=lambda mod: mod.__name__)
62     return modules
63
64
65 def disable_addons():
66     # first disable all
67     addons = bpy.context.user_preferences.addons
68     for mod_name in list(addons.keys()):
69         addon_utils.disable(mod_name, default_set=True)
70     assert(bool(addons) is False)
71
72
73 def test_load_addons():
74     modules = addon_modules_sorted()
75
76     disable_addons()
77
78     addons = bpy.context.user_preferences.addons
79
80     addons_fail = []
81
82     for mod in modules:
83         mod_name = mod.__name__
84         print("\tenabling:", mod_name)
85         addon_utils.enable(mod_name, default_set=True)
86         if (mod_name not in addons) and (mod_name not in BLACKLIST_ADDONS):
87             addons_fail.append(mod_name)
88
89     if addons_fail:
90         print("addons failed to load (%d):" % len(addons_fail))
91         for mod_name in addons_fail:
92             print("    %s" % mod_name)
93     else:
94         print("addons all loaded without errors!")
95     print("")
96
97
98 def reload_addons(do_reload=True, do_reverse=True):
99     modules = addon_modules_sorted()
100     addons = bpy.context.user_preferences.addons
101
102     disable_addons()
103
104     # Run twice each time.
105     for _ in (0, 1):
106         for mod in modules:
107             mod_name = mod.__name__
108             print("\tenabling:", mod_name)
109             addon_utils.enable(mod_name, default_set=True)
110             assert(mod_name in addons)
111
112         for mod in modules:
113             mod_name = mod.__name__
114             print("\tdisabling:", mod_name)
115             addon_utils.disable(mod_name, default_set=True)
116             assert(not (mod_name in addons))
117
118             # now test reloading
119             if do_reload:
120                 imp.reload(sys.modules[mod_name])
121
122         if do_reverse:
123             # in case order matters when it shouldn't
124             modules.reverse()
125
126
127 def main():
128
129     _init_addon_blacklist()
130
131     # first load addons, print a list of all addons that fail
132     test_load_addons()
133
134     reload_addons(do_reload=False, do_reverse=False)
135     reload_addons(do_reload=False, do_reverse=True)
136     reload_addons(do_reload=True, do_reverse=True)
137
138
139 if __name__ == "__main__":
140
141     # So a python error exits(1)
142     try:
143         main()
144     except:
145         import traceback
146         traceback.print_exc()
147         sys.exit(1)