extra error check for bl_rna_wiki_reference.py validator, that rna_wiki_reference...
[blender.git] / source / tests / bl_rna_wiki_reference.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 # Use for validating our wiki interlinking.
22 #  ./blender.bin --background -noaudio --python source/tests/bl_rna_wiki_reference.py
23 #
24 # 1) test_data()              -- ensure the data we have is correct format
25 # 2) test_lookup_coverage()   -- ensure that we have lookups for _every_ RNA path
26 # 3) test_urls()              -- ensure all the URL's are correct
27 # 4) test_language_coverage() -- ensure language lookup table is complete
28 #
29
30 import bpy
31
32 def test_data():
33     import rna_wiki_reference
34     
35     assert(isinstance(rna_wiki_reference.url_manual_mapping, tuple))
36     for i, value in enumerate(rna_wiki_reference.url_manual_mapping):
37         try:
38             assert(len(value) == 2)
39             assert(isinstance(value[0], str))
40             assert(isinstance(value[1], str))
41         except:
42             print("Expected a tuple of 2 strings, instead item %d is a %s: %r" % (i, type(value), value))
43             import traceback
44             traceback.print_exc()
45             raise
46
47 # a stripped down version of api_dump() in rna_info_dump.py
48
49 def test_lookup_coverage():
50
51     def rna_ids():
52         
53         import rna_info
54         struct = rna_info.BuildRNAInfo()[0]
55         for struct_id, v in sorted(struct.items()):
56             props = [(prop.identifier, prop) for prop in v.properties]
57             for prop_id, prop in props:
58                 yield "bpy.types.%s.%s" % (struct_id[1], prop_id)
59
60         for submod_id in dir(bpy.ops):
61             for op_id in dir(getattr(bpy.ops, submod_id)):
62                 yield "bpy.ops.%s.%s" % (submod_id, op_id)
63
64     # check coverage
65     from bl_operators import wm
66
67     for rna_id in rna_ids():
68         url = wm.WM_OT_doc_view_manual._lookup_rna_url(rna_id, verbose=False)
69         print(rna_id, "->", url)
70
71
72 def test_urls():
73     pass  # TODO
74
75
76 def test_language_coverage():
77     pass  # TODO
78
79
80 def main():
81     test_data()
82     test_lookup_coverage()
83     test_language_coverage()
84
85 if __name__ == "__main__":
86     main()