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

[Daniel Holbach]

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

82. By Daniel Holbach on 2015-03-06

make pep8 happy, export to check (internal) links in translated markdown docs

83. By Daniel Holbach on 2015-03-09

error out if test suite fails

84. By Daniel Holbach on 2015-03-09

fix opening of markdown documents, uncovered in testsuite run in pbuilder

[Nicholas Skaggs (nskaggs)]

Some comments. Personally this also seems to fail for me. It fails in various manners on each run in test_translated_filenames_in_markdown_links.

make check
make -C edit-here check
make[1]: Entering directory '/home/nskaggs/projects/ubuntutouch/merges/help-app/edit-here'
./run-tests && echo true
test_doc_files_size_not_0 (test_files.HelpTestCase) ... ok
test_po_files_size_not_0 (test_files.HelpTestCase) ... ok
test_first_line_of_docs_is_title_line (test_translations.HelpTestCase) ... ok
test_translated_filenames_in_markdown_links (test_translations.HelpTestCase) ... FAIL

======================================================================
FAIL: test_translated_filenames_in_markdown_links (test_translations.HelpTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/nskaggs/projects/ubuntutouch/merges/help-app/edit-here/tests/test_translations.py", line 27, in test_translated_filenames_in_markdown_links
    self.assertNotIn(link_msgid, link_msgstr)
AssertionError: 'basic.md' unexpectedly found in ['basic.md']

----------------------------------------------------------------------
Ran 4 tests in 0.140s

FAILED (failures=1)
Exception ignored in: <bound method PO.__del__ of <translations.PO object at 0x7fb4bbf047b8>>
Traceback (most recent call last):
  File "/home/nskaggs/projects/ubuntutouch/merges/help-app/edit-here/translations.py", line 183, in __del__
  File "/home/nskaggs/projects/ubuntutouch/merges/help-app/edit-here/translations.py", line 179, in _remove_fake_po_file
AttributeError: 'NoneType' object has no attribute 'path'
Makefile:64: recipe for target 'check' failed
make[1]: *** [check] Error 1
make[1]: Leaving directory '/home/nskaggs/projects/ubuntutouch/merges/help-app/edit-here'
Makefile:11: recipe for target 'check' failed
make: *** [check] Error 2

[Nicholas Skaggs (nskaggs)]

Just noting it all works when I merge https://code.launchpad.net/~dholbach/help-app/1428677/+merge/252302 on top.

=== modified file 'edit-here/Makefile'
--- edit-here/Makefile	2015-03-09 10:19:29 +0000
+++ edit-here/Makefile	2015-03-09 10:19:29 +0000
@@ -61,7 +61,7 @@
 	@echo '                                                                       '
 
 check:
-	./run-tests
+	./run-tests && echo true
 
 web:
 	./generate-translations
 
=== modified file 'edit-here/run-tests'
--- edit-here/run-tests	2015-03-09 10:19:29 +0000
+++ edit-here/run-tests	2015-03-09 10:19:29 +0000
@@ -9,4 +9,6 @@
     test_filename = sys.argv[1]
 
 suite = unittest.TestLoader().discover(test_directory, pattern=test_filename)
-unittest.TextTestRunner(verbosity=2).run(suite)
+res = unittest.TextTestRunner(verbosity=2).run(suite)
+if res.failures or res.errors:
+    sys.exit(1)
 
=== modified file 'edit-here/tests/test_files.py'
--- edit-here/tests/test_files.py	2015-03-09 10:19:29 +0000
+++ edit-here/tests/test_files.py	2015-03-09 10:19:29 +0000
@@ -3,6 +3,7 @@
 
 import translations
 
+
 class HelpTestCase(TestCase):
     def __init__(self, *args):
         self.translations = translations.Translations()
@@ -12,3 +13,8 @@
         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_translations.py'
--- edit-here/tests/test_translations.py	1970-01-01 00:00:00 +0000
+++ edit-here/tests/test_translations.py	2015-03-09 10:19:29 +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 10:19:29 +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: