Compare output (#41)

* Do a test which compares the output with a file.

* Always order the methods in the same order.

* Don't need debug set on this app.

* whitespace.

* Add the task to run check_example.

* Refactor this test class for generalization.

* Import the app which depends on modules correctly.

* Check examples for factory and custom examples.

* Add more __init__.py

* Use a safe tag for the docstring in template.

* Check the private group of the simple example

This includes endpoints with multiline docstrings.

* Use Markup in the <br> replacement string.

Author: jwg4

.travis.yml

@@ -26,6 +26,7 @@ install:
 script: 
   - python -m unittest discover
   - flake8 --exclude=examples --max-line-length=100
+  - python -m tests.check_example
 notifications:
   email: false
 

examples/__init__.py

@@ -63,7 +63,6 @@ <h1>
         {% for doc in autodoc %}
         <div class="mapping">
             <a id="rule-{{doc.rule|urlencode}}" class="rule"><h2>{{doc.rule|escape}}</h2></a>
-            <p class="location">{{doc.location.filename}}:{{doc.location.line}}</p>
             <ul class="methods">
                 {% for method in doc.methods -%}
                 <li class="method">{{method}}</li>

examples/custom/__init__.py

@@ -5,7 +5,6 @@
 
 
 app = Flask(__name__)
-app.debug = True
 auto = Autodoc(app)
 
 users = []

examples/custom/templates/autodoc_custom.html

@@ -6,7 +6,7 @@
 import inspect
 
 from flask import current_app, render_template, render_template_string, jsonify
-from jinja2 import evalcontextfilter
+from jinja2 import evalcontextfilter, Markup
 from jinja2.exceptions import TemplateAssertionError
 
 
@@ -59,7 +59,7 @@ def add_custom_nl2br_filters(self, app):
         @app.template_filter()
         @evalcontextfilter
         def nl2br(eval_ctx, value):
-            result = '\n\n'.join('%s' % p.replace('\n', '<br>\n')
+            result = '\n\n'.join('%s' % p.replace('\n', Markup('<br>\n'))
                                  for p in _paragraph_re.split(value))
             return result
 
@@ -150,7 +150,7 @@ def generate(self, groups='all', sort=None):
 
             if func_groups.intersection(groups_to_generate):
                 props = dict(
-                    methods=rule.methods,
+                    methods=sorted(list(rule.methods)),
                     rule="%s" % rule,
                     endpoint=rule.endpoint,
                     docstring=func.__doc__,
@@ -215,7 +215,7 @@ def endpoint_info(doc):
             return {
                 "args": [(arg, doc['defaults'][arg]) for arg in args],
                 "docstring": doc['docstring'],
-                "methods": sorted(list(doc['methods'])),
+                "methods": doc['methods'],
                 "rule": doc['rule']
             }
         data = {

examples/factory/__init__.py

@@ -75,7 +75,7 @@ <h1>
                 </li>
                 {% endfor %}
             </ul>
-            <p class="docstring">{{doc.docstring|urlize|nl2br}}</p>
+            <p class="docstring">{{doc.docstring|urlize|nl2br|safe}}</p>
         </div>
         {% endfor %}
     </body>

examples/simple/__init__.py

@@ -0,0 +1,54 @@
+import sys
+import unittest
+
+from examples.custom.blog import app as custom_app
+from examples.simple.blog import app as simple_app
+
+
+class TestApp(object):
+    maxDiff = None
+
+    def setUp(self):
+        self.client = self.app.test_client()
+
+    def test_output(self):
+        r = self.client.get(self.path)
+        self.assertEqual(r.status_code, 200)
+        data = r.data.decode('utf-8')
+        with open(self.filename) as f:
+            expected = f.read()
+
+        self.assertEqual(data, expected)
+
+
+class TestSimpleApp(TestApp, unittest.TestCase):
+    app = simple_app
+    filename = "tests/files/simple.html"
+    path = "/doc"
+
+
+class TestSimpleAppPrivateGroup(TestApp, unittest.TestCase):
+    app = simple_app
+    filename = "tests/files/simple_private.html"
+    path = "/doc/private"
+
+
+class TestFactoryApp(TestApp, unittest.TestCase):
+    filename = "tests/files/factory.html"
+    path = "/doc/"
+
+    @classmethod
+    def setUpClass(cls):
+        sys.path.append('examples/factory')
+        from app import create_app as factory_create_app
+        cls.app = factory_create_app()
+
+
+class TestCustomApp(TestApp, unittest.TestCase):
+    app = custom_app
+    filename = "tests/files/custom.html"
+    path = "/doc/"
+
+
+if __name__ == "__main__":
+    unittest.main()