Merge lp:~gesha/linaro-license-protection/change-tabs-names into lp:~linaro-automation/linaro-license-protection/trunk

[Georgy Redkozubov]

This branch adds new files to render, adds tab names mapping.

[Stevan Radaković (stevanr)]

Looking good. Great work gesha!

One thing only

+ file_obj.readline()

should be removed. What Fathi meant was to remove this line from the source files themself because it was used as a workaround. So we don't have to strap the line out.
Approving.

review: Approve

=== modified file 'license_protected_downloads/render_text_files.py'
--- license_protected_downloads/render_text_files.py	2012-10-16 14:26:32 +0000
+++ license_protected_downloads/render_text_files.py	2012-10-18 19:24:18 +0000
@@ -1,14 +1,30 @@
 import os
 import re
 from textile.textilefactory import TextileFactory
+from collections import OrderedDict
 
 
 UBUNTU_FILES = ('README',
                 'INSTALL',
-                'HACKING')
-ANDROID_FILES = ('HOWTO_install.txt',
+                'HACKING',
+                'FIRMWARE',
+                'RTSM')
+ANDROID_FILES = ('HOWTO_releasenotes.txt',
+                 'HOWTO_install.txt',
                  'HOWTO_getsourceandbuild.txt',
-                 'HOWTO_flashfirmware.txt')
+                 'HOWTO_flashfirmware.txt',
+                 'HOWTO_rtsm.txt')
+
+FILES_MAP = {'HOWTO_releasenotes.txt': 'Release Notes',
+             'HOWTO_install.txt': 'Binary Image Installation',
+             'HOWTO_getsourceandbuild.txt': 'Building From Source',
+             'HOWTO_flashfirmware.txt': 'Firmware Update',
+             'HOWTO_rtsm.txt': 'RTSM',
+             'README': 'Release Notes',
+             'INSTALL': 'Binary Image Installation',
+             'HACKING': 'Building From Source',
+             'FIRMWARE': 'Firmware Update',
+             'RTSM': 'RTSM'}
 
 
 class MultipleFilesException(Exception):
@@ -33,7 +49,7 @@
     @classmethod
     def find_and_render(cls, path):
 
-        result = {}
+        result = OrderedDict()
 
         try:
             filepaths = sorted(cls.find_relevant_files(path),
@@ -46,7 +62,8 @@
             for filepath in filepaths:
                 try:
                     file_obj = open(filepath, 'r')
-                    title, formatted = cls.render_file(file_obj)
+                    formatted = cls.render_file(file_obj)
+                    title = FILES_MAP[os.path.basename(filepath)]
                     result[title] = formatted
                 except:
                     # TODO: log error or something.
@@ -60,9 +77,8 @@
     def render_file(cls, file_obj):
         # TODO: introduce special options to textile factory if necessary.
         textile_factory = TextileFactory()
-        title = file_obj.readline()
-        file_obj.seek(0)
-        return title, textile_factory.process(file_obj.read())
+        file_obj.readline()
+        return textile_factory.process(file_obj.read())
 
     @classmethod
     def find_relevant_files(cls, path):
@@ -70,13 +86,9 @@
         # If there are more of the same type then one, throw custom error as
         # written above.
         multiple = 0
-        filepaths = cls.dirEntries(path, True, UBUNTU_FILES, ANDROID_FILES)
+        filepaths = cls.dirEntries(path, True, FILES_MAP.keys())
         if len(filepaths) > 0:
-            for filepath in UBUNTU_FILES:
-                if len(cls.findall(filepaths,
-                                   lambda x: re.search(filepath, x))) > 1:
-                    multiple += 1
-            for filepath in ANDROID_FILES:
+            for filepath in FILES_MAP.keys():
                 if len(cls.findall(filepaths,
                                    lambda x: re.search(filepath, x))) > 1:
                     multiple += 1

=== modified file 'license_protected_downloads/tests/test_render_text_files.py'
--- license_protected_downloads/tests/test_render_text_files.py	2012-10-16 12:00:29 +0000
+++ license_protected_downloads/tests/test_render_text_files.py	2012-10-18 19:24:18 +0000
@@ -65,8 +65,8 @@
         full_android_files = []
         for file in ANDROID_FILES:
             full_android_files.append(os.path.join(path, file))
-        self.assertEqual(full_android_files,
-            RenderTextFiles.find_relevant_files(path))
+        self.assertEqual(sorted(full_android_files),
+            sorted(RenderTextFiles.find_relevant_files(path)))
 
     def test_find_relevant_files_android_subdir(self):
         path = self.make_temp_dir()
@@ -75,10 +75,10 @@
         full_android_files = []
         for file in ANDROID_FILES:
             full_android_files.append(os.path.join(full_path, file))
-        self.assertEqual(full_android_files,
-            RenderTextFiles.find_relevant_files(path))
-        self.assertEqual(full_android_files,
-            RenderTextFiles.find_relevant_files(full_path))
+        self.assertEqual(sorted(full_android_files),
+            sorted(RenderTextFiles.find_relevant_files(path)))
+        self.assertEqual(sorted(full_android_files),
+            sorted(RenderTextFiles.find_relevant_files(full_path)))
 
     def test_find_relevant_files_android_several_subdirs(self):
         path = self.make_temp_dir()
@@ -93,10 +93,10 @@
             full_android_files2.append(os.path.join(full_path2, file))
         with self.assertRaises(MultipleFilesException):
             RenderTextFiles.find_relevant_files(path)
-        self.assertEqual(full_android_files1,
-            RenderTextFiles.find_relevant_files(full_path1))
-        self.assertEqual(full_android_files2,
-            RenderTextFiles.find_relevant_files(full_path2))
+        self.assertEqual(sorted(full_android_files1),
+            sorted(RenderTextFiles.find_relevant_files(full_path1)))
+        self.assertEqual(sorted(full_android_files2),
+            sorted(RenderTextFiles.find_relevant_files(full_path2)))
 
     def test_find_relevant_files_android_and_ubuntu_samedir(self):
         flist = ANDROID_FILES + UBUNTU_FILES