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

Unmerged revisions

=== modified file 'Makefile'
--- Makefile	2015-02-26 16:26:57 +0000
+++ Makefile	2015-03-09 14:34:15 +0000
@@ -7,6 +7,9 @@
 	$(foreach fn, $(ignored), $(shell rm -r $(fn);))
 endif
 
+check:
+	make -C edit-here check
+
 click: html
 	cd app && click build . && mv *.click ..
 
@@ -19,4 +22,4 @@
 update-pot:
 	cd edit-here && ./generate-pot
 
-.PHONY: click html web update-pot clean
+.PHONY: click html web update-pot clean check
 
=== modified file 'edit-here/Makefile'
--- edit-here/Makefile	2015-03-06 10:32:59 +0000
+++ edit-here/Makefile	2015-03-09 14:34:15 +0000
@@ -60,6 +60,9 @@
 	@echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html'
 	@echo '                                                                       '
 
+check:
+	./run-tests
+
 web:
 	./generate-translations
 	$(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR_WEB) -s $(CONFFILE) $(PELICANOPTS) -t $(THEMEDIR_WEB)
 
=== added file 'edit-here/run-tests'
--- edit-here/run-tests	1970-01-01 00:00:00 +0000
+++ edit-here/run-tests	2015-03-09 14:34:15 +0000
@@ -0,0 +1,14 @@
+#!/usr/bin/python3
+
+import sys
+import unittest
+
+test_directory = 'tests/'
+test_filename = 'test_*'
+if len(sys.argv) > 1:
+    test_filename = sys.argv[1]
+
+suite = unittest.TestLoader().discover(test_directory, pattern=test_filename)
+res = unittest.TextTestRunner(verbosity=2).run(suite)
+if res.failures or res.errors:
+    sys.exit(1)
 
=== added directory 'edit-here/tests'
=== added file 'edit-here/tests/test_files.py'
--- edit-here/tests/test_files.py	1970-01-01 00:00:00 +0000
+++ edit-here/tests/test_files.py	2015-03-09 14:34:15 +0000
@@ -0,0 +1,20 @@
+import os
+from unittest import TestCase
+
+import translations
+
+
+class HelpTestCase(TestCase):
+    def __init__(self, *args):
+        self.translations = translations.Translations()
+        TestCase.__init__(self, *args)
+
+    def test_doc_files_size_not_0(self):
+        sizes = [os.stat(fn).st_size
+                 for fn in self.translations.documents.docs]
+        self.assertNotIn(0, sizes)
+
+    def test_po_files_size_not_0(self):
+        sizes = [os.stat(fn).st_size
+                 for fn in self.translations.po.langs]
+        self.assertNotIn(0, sizes)
 
=== 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 14:34:15 +0000
@@ -0,0 +1,75 @@
+import codecs
+from html.parser import HTMLParser
+import os
+import shutil
+import subprocess
+import tempfile
+from unittest import TestCase
+import urllib.parse
+import urllib.request
+from urllib.request import FileHandler
+
+
+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()
+        self.fh = FileHandler()
+        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')
 
=== added file 'edit-here/tests/test_translations.py'
--- edit-here/tests/test_translations.py	1970-01-01 00:00:00 +0000
+++ edit-here/tests/test_translations.py	2015-03-09 14:34:15 +0000
@@ -0,0 +1,30 @@
+from unittest import TestCase
+
+import translations
+
+
+class HelpTestCase(TestCase):
+    def __init__(self, *args):
+        self.translations = translations.Translations()
+        TestCase.__init__(self, *args)
+
+    def test_first_line_of_docs_is_title_line(self):
+        po = self.translations.po
+        self.assertTrue(po.gettextize(self.translations.documents))
+        results = []
+        for entry, first_line in po.pot_file_ob.find_title_lines():
+            results += [entry.msgid == first_line]
+        self.assertNotIn(False, results)
+
+    def test_translated_filenames_in_markdown_links(self):
+        po = self.translations.po
+        for po_fn in po.langs:
+            po.load_pofile(po_fn)
+            pofile = po.langs[po_fn]['pofile']
+            for entry in pofile.find_in_msgid('{filename}'):
+                (link_msgid, link_msgstr) = \
+                    pofile.find_link_in_markdown_message(entry)
+                self.assertNotIn(link_msgid, link_msgstr)
+                self.assertEqual(1, len(link_msgstr))
+                self.assertIn(po.langs[po_fn]['gettext_code'],
+                              link_msgstr[0])
 
=== modified file 'edit-here/translations.py'
--- edit-here/translations.py	2015-03-05 09:32:33 +0000
+++ edit-here/translations.py	2015-03-09 14:34:15 +0000
@@ -106,29 +106,37 @@
                 results += [entry]
         return results
 
-    def replace_title_lines(self):
-        results = {}
+    def find_title_lines(self):
+        results = []
         for entry in self.find_in_msgid('Title: '):
             if entry.msgid.startswith('Title: '):
                 where = entry.occurrences[0][0]
-                first_line = open(where).readline().strip()
-                if entry.msgid != first_line:
-                    print('Title line "%s" found, but not on the first line '
-                          'of "%s".' % (entry.msgid, entry.linenum))
-                    return False
-                entry.msgid = entry.msgid.replace('Title: ', '')
-                fn = entry.occurrences[0][0]
-                results[fn] = entry.msgid
-                if self.po_fn.endswith('.po'):
-                    entry.msgstr = ''
+                first_line = codecs.open(where, encoding='utf-8').readline().strip()
+                results += [(entry, first_line)]
+        return results
+
+    def replace_title_lines(self):
+        for entry, first_line in self.find_title_lines():
+            if entry.msgid != first_line:
+                print('Title line "%s" found, but not on the first line '
+                      'of "%s".' % (entry.msgid, entry.linenum))
+                return False
+            entry.msgid = entry.msgid.replace('Title: ', '')
+            if self.po_fn.endswith('.po'):
+                entry.msgstr = ''
         self.save()
         return True
 
+    def find_link_in_markdown_message(self, entry):
+        link_regex = r'\[.+?\]\(\{filename\}(.+?)\)'
+        link_msgid = re.findall(link_regex, entry.msgid)[0]
+        link_msgstr = list(re.findall(link_regex, entry.msgstr))
+        return (link_msgid, link_msgstr)
+
     def rewrite_links(self, documents, bcp47):
-        link_regex = r'\[.+?\]\(\{filename\}(.+?)\)'
         for entry in self.find_in_msgid('{filename}'):
-            link_msgid = re.findall(link_regex, entry.msgid)[0]
-            link_msgstr = list(re.findall(link_regex, entry.msgstr))
+            (link_msgid, link_msgstr) = \
+                self.find_link_in_markdown_message(entry)
             translated_doc_fn = os.path.basename(
                 documents.translated_doc_fn(link_msgid, bcp47))
             if not link_msgstr:
@@ -178,10 +186,15 @@
         if not self.langs[po_fn]['pofile']:
             self.langs[po_fn]['pofile'] = POFile(po_fn)
 
-    def generate_pot_file(self, documents):
+    def gettextize(self, documents):
         if not self.po4a.gettextize(documents.docs, self.pot_fn):
             return False
         self.pot_file_ob.reread()
+        return True
+
+    def generate_pot_file(self, documents):
+        if not self.gettextize(documents):
+            return False
         if not self.pot_file_ob.replace_title_lines():
             return False
         for po_fn in self.langs: