Merge lp:~dholbach/help-app/1428677 into lp:~ubuntu-touch-coreapps-drivers/help-app/trunk

[Daniel Holbach]

[lp:~dholbach/help-app/1428677]

87. By Daniel Holbach on 2015-03-09

remove unused code

88. By Daniel Holbach on 2015-03-09

explain what we do in terms of testing

[Nicholas Skaggs (nskaggs)]

+1, Just a small comment.

=== modified file 'HACKING'
--- HACKING	2015-03-09 12:01:16 +0000
+++ HACKING	2015-03-09 16:09:32 +0000
@@ -57,6 +57,7 @@
     ├── content
     │   └── pages       ← Here is the place to edit the content.
     ├── po              ← Translations.
+    ├── tests           ← Code for automated testing goes here.
     └── themes          ← Themes files, both templates and css/js.
         ├── phone       ← Phone/device app theme.
         └── web         ← Online build (.ubuntu.com) theme.
@@ -131,6 +132,19 @@
 http://www.w3.org/International/questions/qa-apache-lang-neg for publishing
 this on the web.
 
+Testing
+-------
+
+We love automated testing! We added a couple of test cases to 
+
+	./edit-here/tests/
+
+and it would be great if you added more. We want to run these tests 
+whenever we build the package or publish the docs or whatever else. Just
+to make sure that everything works fine. To run the test suite, run:
+
+	make check
+
 
 Code, bugs, etc.
 ----------------

=== modified file 'edit-here/Makefile'
--- edit-here/Makefile	2015-03-09 16:09:32 +0000
+++ edit-here/Makefile	2015-03-06 14:32:59 +0000
@@ -61,7 +61,7 @@
 	@echo '                                                                       '
 
 check:
-	./run-tests && echo true
+	./run-tests
 
 web:
 	./generate-translations

=== added file 'edit-here/tests/test_links.py'
--- edit-here/tests/test_links.py	1970-01-01 00:00:00 +0000
+++ edit-here/tests/test_links.py	2015-03-09 16:09:32 +0000
@@ -0,0 +1,72 @@
+import codecs
+from html.parser import HTMLParser
+import os
+import shutil
+import subprocess
+import tempfile
+from unittest import TestCase
+import urllib.parse
+
+
+def require_build(build):
+    tempdir = tempfile.mkdtemp()
+    ret = subprocess.call(['make', '-es', build],
+                          env={'OUTPUTDIR': tempdir})
+    return (ret, tempdir)
+
+
+def clean_tempdir(tempdir):
+    if os.path.exists(tempdir):
+        shutil.rmtree(tempdir)
+
+
+class MyHTMLParser(HTMLParser):
+    links = []
+
+    def handle_starttag(self, tag, attrs):
+        if tag == "a":
+            for name, value in attrs:
+                if name == "href":
+                    url = urllib.parse.urlparse(value)
+                    if not url.netloc or url.netloc == 'localhost':
+                        self.links += [value]
+
+    def reload(self):
+        links = self.links
+        self.links = []
+        return links
+
+
+class HelpTestCase(TestCase):
+    def __init__(self, *args):
+        self.pwd = os.getcwd()
+        self.htmlparser = MyHTMLParser()
+        TestCase.__init__(self, *args)
+
+    def __del__(self):
+        os.chdir(self.pwd)
+
+    def _test_local_links(self, build):
+        (ret, tempdir) = require_build(build)
+        if ret:
+            return False
+        for dirpath, dirnames, filenames in os.walk(tempdir):
+            for fn in filenames:
+                full_fn = os.path.join(dirpath, fn)
+                os.chdir(dirpath)
+                if full_fn.endswith('.html'):
+                    html = codecs.open(full_fn, encoding='utf-8').read()
+                    self.htmlparser.feed(html)
+                links = self.htmlparser.reload()
+                for link in links:
+                    rel_path = os.path.relpath(link, full_fn)
+                    path = os.path.normpath(os.path.join(full_fn, rel_path))
+                    self.assertTrue(os.path.exists(path))
+        clean_tempdir(tempdir)
+        return True
+
+    def test_local_phone_links(self):
+        return self._test_local_links('html')
+
+    def test_local_web_links(self):
+        return self._test_local_links('web')