Revive and rewrite docs tests

Author: einarf

.vscode/launch.json

@@ -14,6 +14,17 @@
                 "runeffect",
                 "examples.cubes",
             ],
+        },
+        {
+            "name": "Python: demosys-py test",
+            "type": "python",
+            "request": "launch",
+            "console": "none",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "test",
+                "tests/test_docs.py",
+            ],
         }
     ]
 }

demosys/test/testcase.py

@@ -1,4 +1,6 @@
+import sys
 from unittest import TestCase
+from unittest.mock import MagicMock
 
 from demosys import context, resources
 from demosys import project
@@ -9,6 +11,18 @@
     DataDescription,
 )
 
+MOCK_MODULES = ['glfw', 'pyglet', 'pyglet.window']
+
+
+def apply_mocks():
+    # Mock modules
+    class Mock(MagicMock):
+        @classmethod
+        def __getattr__(cls, name):
+            return MagicMock()
+
+    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
 
 class DemosysTestCase(TestCase):
 
@@ -17,6 +31,8 @@ class DemosysTestCase(TestCase):
     project = project.instance
     timeline = None
 
+    apply_mocks()
+
     def load_program(self, path):
         return resources.programs.load(ProgramDescription(label=path, path=path))
 

tests/test_docs.py

@@ -1,79 +1,51 @@
 """
 Documentation testing
 
-Based on:
+Inspired by:
 https://github.com/cprogrammer1994/ModernGL/blob/master/tests/test_documentation.py
 by Szabolcs Dombi
+
+This version is simplified:
+* Only test if the attribute or method is present in the class. Function parameters are not inspected.
+* Include ignore pattern in the implemented set
 """
-import inspect
 import os
 import re
-import unittest
-
-os.environ['DEMOSYS_SETTINGS_MODULE'] = 'tests.settings'  # noqa
 
-import demosys
-from demosys import effects, opengl
+from demosys.test import DemosysTestCase
+from demosys.utils import module_loading
 
-# Modules we want to remove from types
-MODULES = [
-    'demosys.',
-    'opengl.',
-    'texture.',
-    'shader.',
-    'resources.',
-    'data.',
-    'moderngl.',
-    'buffer.',
-    'rocket.',
-    'tracks.',
-    'scene.',
-    'buffer.',
-    'depth.',
-    'texture_array.',
-    'program.',
-    'vertex_array.',
-    'array.',
-]
+os.environ['DEMOSYS_SETTINGS_MODULE'] = 'tests.settings'  # noqa
 
-class TestCase(unittest.TestCase):
 
+class TestCase(DemosysTestCase):
+    """
+    Test reference docs
+    """
     def validate(self, filename, module, classname, ignore):
-        root = os.path.dirname(os.path.dirname(__file__))
-        with open(os.path.normpath(os.path.join(root, 'docs', 'source', filename))) as f:
+        """
+        Finds all automethod and autoattribute statements in an rst file
+        comparing them to the attributes found in the actual class
+        """
+        with open(os.path.normpath(os.path.join('docs', 'reference', filename))) as f:
             docs = f.read()
-        methods = re.findall(r'^\.\. automethod:: ([^\(\n]+)([^\n]+)', docs, flags=re.M)
-        attributes = re.findall(r'^\.\. autoattribute:: ([^\n]+)', docs, flags=re.M)
-        documented = set(filter(lambda x: x.startswith(classname), [a for a, b in methods] + attributes))
-        implemented = set(classname + '.' + x for x in dir(getattr(module, classname)) if not x.startswith('_'))
-        ignored = set(classname + '.' + x for x in ignore)
-        self.assertSetEqual(implemented - documented - ignored, set(), msg='Implemented but not Documented')
-        self.assertSetEqual(documented - implemented, set(), msg='Documented but not Implemented')
-
-        for method, docsig in methods:
-            classname, methodname = method.split('.')
-            sig = str(inspect.signature(getattr(getattr(module, classname), methodname)))
-            print(sig)
-            sig = sig.replace('self, ', '').replace('typing.', '').replace(' -> None', '')
 
-            for m in MODULES:
-                sig = sig.replace(m, '')
+        module = module_loading.import_module(module)
 
-            sig = sig.replace('(self)', '()').replace(', *,', ',').replace('(*, ', '(')
-            sig = re.sub(r'-> \'(\w+)\'', r'-> \1', sig)
+        methods = re.findall(r'^\.\. automethod:: ([^\(\n]+)', docs, flags=re.M)
+        attributes = re.findall(r'^\.\. autoattribute:: ([^\n]+)', docs, flags=re.M)
 
-            self.assertEqual(docsig, sig, msg=filename + '::' + method)
+        documented = set(filter(lambda x: x.startswith(classname), [a for a in methods] + attributes))
+        implemented = set(classname + '.' + x for x in dir(getattr(module, classname))
+                          if not x.startswith('_') or x == '__init__')
+        print(implemented)
+        ignored = set(classname + '.' + x for x in ignore)
 
-    # def test_effect_docs(self):
-    #     self.validate(
-    #         os.path.join('reference', 'effect.rst'),
-    #         effects, 'Effect', [])
+        self.assertSetEqual(implemented - documented - ignored, set(), msg='Implemented but not Documented')
+        self.assertSetEqual(documented - implemented - ignored, set(), msg='Documented but not Implemented')
 
-    # def test_vao_docs(self):
-    #     self.validate(
-    #         os.path.join('reference', 'vao.rst'),
-    #         opengl, 'VAO', []
-    #     )
+    def test_demosys_contex_base(self):
+        self.validate('demosys.context.base.rst', 'demosys.context.base', 'BaseWindow', [])
 
-if __name__ == '__main__':
-    unittest.main()
+    def test_demosys_context_glfw(self):
+        self.validate('demosys.context.glfw.rst', 'demosys.context.glfw', 'Window', [])