Merge lp:~stevanr/linaro-license-protection/bug-1069814 into lp:~linaro-automation/linaro-license-protection/trunk

[Stevan Radaković]

Move textile constants to settings so we can change them for releases.*.

[Georgy Redkozubov (gesha)]

Stevan, thanks for taking bug.
Looks good.

review: Approve

[Fathi Boudra (fboudra)]

For LP: #1069814, we need to append .textile extension.
Also, please rename UBUNTU_FILES to a generic term like LINUX_FILES. The pattern applies to Ubuntu and OpenEmbedded builds.

review: Needs Fixing

[Georgy Redkozubov (gesha)]

> For LP: #1069814, we need to append .textile extension.

Fathi, this file is not used for releases, it's generic. For snapshots/releases we override settings in other branch if needed: https://code.launchpad.net/~linaro-infrastructure/linaro-license-protection/configs

Please comment in https://code.launchpad.net/~stevanr/linaro-license-protection/bug-1069814-configs/+merge/130884 what files should have .textile extension.

> Also, please rename UBUNTU_FILES to a generic term like LINUX_FILES. The
> pattern applies to Ubuntu and OpenEmbedded builds.

Fathi, you rule there :)

Stevan, also please update STAGING_ACCEPTED_FILES in scripts/publish_to_snapshots.py as appropriate.

Thanks.

[Fathi Boudra (fboudra)]

On 23 October 2012 09:06, Georgy Redkozubov wrote:
>> For LP: #1069814, we need to append .textile extension.
>
> Fathi, this file is not used for releases, it's generic. For snapshots/releases we override settings in other branch if needed: https://code.launchpad.net/~linaro-infrastructure/linaro-license-protection/configs
> Please comment in https://code.launchpad.net/~stevanr/linaro-license-protection/bug-1069814-configs/+merge/130884 what files should have .textile extension.

IMO, the markup language extension is generic. According to your
comment, it should be in both branches.

[lp:~stevanr/linaro-license-protection/bug-1069814]

141. By Stevan Radaković on 2012-10-23

Apply changes from code review fixes.

[Georgy Redkozubov (gesha)]

Changes look good.

=== modified file 'license_protected_downloads/render_text_files.py'
--- license_protected_downloads/render_text_files.py	2012-10-22 17:00:23 +0000
+++ license_protected_downloads/render_text_files.py	2012-10-23 09:39:09 +0000
@@ -4,38 +4,6 @@
 from collections import OrderedDict
 from django.conf import settings
 
-UBUNTU_FILES = ('README',
-                'INSTALL',
-                'HACKING',
-                'FIRMWARE',
-                'RTSM')
-ANDROID_FILES = ('HOWTO_releasenotes.txt',
-                 'HOWTO_install.txt',
-                 'HOWTO_getsourceandbuild.txt',
-                 'HOWTO_flashfirmware.txt',
-                 'HOWTO_rtsm.txt')
-
-MANDATORY_ANDROID_FILES = ('HOWTO_install.txt',
-                           'HOWTO_getsourceandbuild.txt',
-                           'HOWTO_flashfirmware.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'}
-
-TAB_PRIORITY = ['Release Notes',
-                'Binary Image Installation',
-                'Building From Source',
-                'Firmware Update',
-                'RTSM']
-
 
 class MultipleFilesException(Exception):
     pass
@@ -48,7 +16,7 @@
 
     @classmethod
     def sort_tabs_by_priority(cls, a, b):
-        base_list = TAB_PRIORITY
+        base_list = settings.TAB_PRIORITY
         return base_list.index(a[0]) - base_list.index(b[0])
 
     @classmethod
@@ -64,16 +32,16 @@
 
         if filepaths:
             for filepath in filepaths:
-                title = FILES_MAP[os.path.basename(filepath)]
+                title = settings.FILES_MAP[os.path.basename(filepath)]
                 result[title] = cls.render_file(filepath)
 
         # Switch to fallback data for mandatory files.
         if cls.check_for_manifest_or_tarballs(path):
-            for filename in MANDATORY_ANDROID_FILES:
-                if FILES_MAP[filename] not in result:
+            for filename in settings.MANDATORY_ANDROID_FILES:
+                if settings.FILES_MAP[filename] not in result:
                     filepath = os.path.join(settings.TEXTILE_FALLBACK_PATH,
                                             filename)
-                    title = FILES_MAP[filename]
+                    title = settings.FILES_MAP[filename]
                     result[title] = cls.render_file(filepath)
 
         if not filepaths and len(result) == 0:
@@ -100,9 +68,9 @@
         # If there are more of the same type then one, throw custom error as
         # written above.
         multiple = 0
-        filepaths = cls.dirEntries(path, True, FILES_MAP.keys())
+        filepaths = cls.dirEntries(path, True, settings.FILES_MAP.keys())
         if len(filepaths) > 0:
-            for filepath in FILES_MAP.keys():
+            for filepath in settings.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-22 17:00:23 +0000
+++ license_protected_downloads/tests/test_render_text_files.py	2012-10-23 09:39:09 +0000
@@ -3,11 +3,10 @@
 import tempfile
 import shutil
 import re
+from django.conf import settings
 from license_protected_downloads.render_text_files import RenderTextFiles
 from license_protected_downloads.render_text_files \
  import MultipleFilesException
-from license_protected_downloads.render_text_files import ANDROID_FILES
-from license_protected_downloads.render_text_files import UBUNTU_FILES
 
 
 THIS_DIRECTORY = os.path.dirname(os.path.abspath(__file__))
@@ -55,19 +54,21 @@
             RenderTextFiles.find_relevant_files(path)
 
     def test_find_relevant_files_android(self):
-        path = self.make_temp_dir(empty=False, file_list=ANDROID_FILES)
+        path = self.make_temp_dir(empty=False,
+                                  file_list=settings.ANDROID_FILES)
         full_android_files = []
-        for file in ANDROID_FILES:
+        for file in settings.ANDROID_FILES:
             full_android_files.append(os.path.join(path, file))
         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()
-        full_path = self.make_temp_dir(empty=False, file_list=ANDROID_FILES,
+        full_path = self.make_temp_dir(empty=False,
+                                       file_list=settings.ANDROID_FILES,
                                        dir=path)
         full_android_files = []
-        for file in ANDROID_FILES:
+        for file in settings.ANDROID_FILES:
             full_android_files.append(os.path.join(full_path, file))
         self.assertEqual(sorted(full_android_files),
             sorted(RenderTextFiles.find_relevant_files(path)))
@@ -76,13 +77,15 @@
 
     def test_find_relevant_files_android_several_subdirs(self):
         path = self.make_temp_dir()
-        full_path1 = self.make_temp_dir(empty=False, file_list=ANDROID_FILES,
-            dir=path)
-        full_path2 = self.make_temp_dir(empty=False, file_list=ANDROID_FILES,
-            dir=path)
+        full_path1 = self.make_temp_dir(empty=False,
+                                        file_list=settings.ANDROID_FILES,
+                                        dir=path)
+        full_path2 = self.make_temp_dir(empty=False,
+                                        file_list=settings.ANDROID_FILES,
+                                        dir=path)
         full_android_files1 = []
         full_android_files2 = []
-        for file in ANDROID_FILES:
+        for file in settings.ANDROID_FILES:
             full_android_files1.append(os.path.join(full_path1, file))
             full_android_files2.append(os.path.join(full_path2, file))
         with self.assertRaises(MultipleFilesException):
@@ -93,7 +96,7 @@
             sorted(RenderTextFiles.find_relevant_files(full_path2)))
 
     def test_find_relevant_files_android_and_ubuntu_samedir(self):
-        flist = ANDROID_FILES + UBUNTU_FILES
+        flist = settings.ANDROID_FILES + settings.LINUX_FILES
         path = self.make_temp_dir(empty=False, file_list=flist)
         full_files = []
         for file in flist:
@@ -103,19 +106,21 @@
 
     def test_find_relevant_files_android_and_ubuntu_different_subdirs(self):
         path = self.make_temp_dir()
-        android_path = self.make_temp_dir(empty=False, file_list=ANDROID_FILES,
+        android_path = self.make_temp_dir(empty=False,
+                                          file_list=settings.ANDROID_FILES,
                                           dir=path)
-        ubuntu_path = self.make_temp_dir(empty=False, file_list=UBUNTU_FILES,
+        ubuntu_path = self.make_temp_dir(empty=False,
+                                         file_list=settings.LINUX_FILES,
                                          dir=path)
         full_android_files = []
-        full_ubuntu_files = []
-        for file in ANDROID_FILES:
+        full_linux_files = []
+        for file in settings.ANDROID_FILES:
             full_android_files.append(os.path.join(android_path, file))
-        for file in UBUNTU_FILES:
-            full_ubuntu_files.append(os.path.join(ubuntu_path, file))
-        self.assertEqual(sorted(full_android_files + full_ubuntu_files),
+        for file in settings.LINUX_FILES:
+            full_linux_files.append(os.path.join(ubuntu_path, file))
+        self.assertEqual(sorted(full_android_files + full_linux_files),
             sorted(RenderTextFiles.find_relevant_files(path)))
         self.assertEqual(sorted(full_android_files),
             sorted(RenderTextFiles.find_relevant_files(android_path)))
-        self.assertEqual(sorted(full_ubuntu_files),
+        self.assertEqual(sorted(full_linux_files),
             sorted(RenderTextFiles.find_relevant_files(ubuntu_path)))

=== modified file 'scripts/publish_to_snapshots.py'
--- scripts/publish_to_snapshots.py	2012-10-17 10:52:29 +0000
+++ scripts/publish_to_snapshots.py	2012-10-23 09:39:09 +0000
@@ -69,6 +69,7 @@
         'OPEN-EULA.txt',
         '*.EULA.txt.*',
         'README',
+        'README.textile',
         'INSTALL',
         'HACKING',
         '*HOWTO_*.txt',

=== modified file 'settings.py'
--- settings.py	2012-10-19 11:06:33 +0000
+++ settings.py	2012-10-23 09:39:09 +0000
@@ -161,3 +161,36 @@
     'django.contrib.messages.context_processors.messages',
     'django.contrib.auth.context_processors.auth',
 )
+
+# Render TEXTILE files settings.
+LINUX_FILES = ('README',
+               'INSTALL',
+               'HACKING',
+               'FIRMWARE',
+               'RTSM')
+ANDROID_FILES = ('HOWTO_releasenotes.txt',
+                 'HOWTO_install.txt',
+                 'HOWTO_getsourceandbuild.txt',
+                 'HOWTO_flashfirmware.txt',
+                 'HOWTO_rtsm.txt')
+
+MANDATORY_ANDROID_FILES = ('HOWTO_install.txt',
+                           'HOWTO_getsourceandbuild.txt',
+                           'HOWTO_flashfirmware.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'}
+
+TAB_PRIORITY = ['Release Notes',
+                'Binary Image Installation',
+                'Building From Source',
+                'Firmware Update',
+                'RTSM']