Merge lp:~gesha/linaro-license-protection/non-recursive-search into lp:~linaro-automation/linaro-license-protection/trunk

[Georgy Redkozubov]

This branch adds non-recursive search for README, INSTALL, etc. and for howto/HOWTO_* These files will be rendered only if found in current dir.
Made flash firmware instructions non-mandatory. Updated tests to reflect current state.

[Stevan Radaković (stevanr)]

Hey gesha, this looks good.

One comment though, I don't think we should make flashfirmware non-mandatory so easy.
It should be put under discussion first in the email thread we had, I already told fabo about this.
This effects only android, and it was determined previously that it should have fallback links.
Let's remove it for now, it doesn't have to do anything with the bug were're fixing here.

review: Needs Fixing

[lp:~gesha/linaro-license-protection/non-recursive-search]

141. By Georgy Redkozubov on 2012-10-23

Revert back HOWTO_flashfirmware.txt

[Stevan Radaković (stevanr)]

Thanks. Approve +1.

review: Approve

=== 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 12:13:28 +0000
@@ -4,6 +4,8 @@
 from collections import OrderedDict
 from django.conf import settings
 
+HOWTO_PATH = 'howto/'
+
 UBUNTU_FILES = ('README',
                 'INSTALL',
                 'HACKING',
@@ -100,18 +102,24 @@
         # 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())
-        if len(filepaths) > 0:
-            for filepath in FILES_MAP.keys():
-                if len(cls.findall(filepaths,
+        howtopath = os.path.join(path, HOWTO_PATH)
+        androidpaths = cls.dirEntries(howtopath, False, ANDROID_FILES)
+        ubuntupaths = cls.dirEntries(path, False, UBUNTU_FILES)
+        if len(androidpaths) > 0 and len(ubuntupaths) > 0:
+            raise MultipleFilesException
+        if len(androidpaths) > 0:
+            for filepath in ANDROID_FILES:
+                if len(cls.findall(androidpaths,
                                    lambda x: re.search(filepath, x))) > 1:
                     multiple += 1
             if multiple == 0:
-                return filepaths
+                return androidpaths
             else:
                 raise MultipleFilesException
+        elif len(ubuntupaths) > 0:
+            return ubuntupaths
         else:
-            return filepaths
+            return []
 
     @classmethod
     def flatten(cls, l, ltypes=(list, tuple)):
@@ -140,6 +148,8 @@
             directory are added to the list.
         '''
         fileList = []
+        if not os.path.exists(path):
+            return fileList
         for file in os.listdir(path):
             dirfile = os.path.join(path, file)
             if os.path.isfile(dirfile):

=== 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 12:13:28 +0000
@@ -8,7 +8,7 @@
  import MultipleFilesException
 from license_protected_downloads.render_text_files import ANDROID_FILES
 from license_protected_downloads.render_text_files import UBUNTU_FILES
-
+from license_protected_downloads.render_text_files import HOWTO_PATH
 
 THIS_DIRECTORY = os.path.dirname(os.path.abspath(__file__))
 
@@ -35,87 +35,50 @@
         self.assertEqual([],
             RenderTextFiles.findall(l, lambda x: re.search(r'1', x)))
 
-    def make_temp_dir(self, empty=True, file_list=None, dir=None):
+    def make_temp_dir(self, empty=True, file_list=None, dir=None, subdir=None):
         path = tempfile.mkdtemp(dir=dir)
         if not empty:
             if file_list:
+                if subdir:
+                    movepath = os.path.join(path, HOWTO_PATH)
+                    os.makedirs(movepath)
+                else:
+                    movepath = path
                 for file in file_list:
-                    handle, fname = tempfile.mkstemp(dir=path)
-                    shutil.move(fname, os.path.join(path, file))
+                    handle, fname = tempfile.mkstemp(dir=movepath)
+                    shutil.move(fname, os.path.join(movepath, file))
         return path
 
-    def test_find_relevant_files_multiple_files(self):
-        path = tempfile.mkdtemp()
-        handle, fname = tempfile.mkstemp(dir=path)
-        shutil.move(fname, os.path.join(path, 'README'))
-        path1 = tempfile.mkdtemp(dir=path)
-        handle, fname = tempfile.mkstemp(dir=path1)
-        shutil.move(fname, os.path.join(path1, 'README'))
-        with self.assertRaises(MultipleFilesException):
-            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=ANDROID_FILES,
+                                  subdir=HOWTO_PATH)
         full_android_files = []
         for file in ANDROID_FILES:
-            full_android_files.append(os.path.join(path, file))
+            full_android_files.append(os.path.join(path, HOWTO_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,
-                                       dir=path)
+                                       dir=path, subdir=HOWTO_PATH)
         full_android_files = []
         for file in ANDROID_FILES:
-            full_android_files.append(os.path.join(full_path, file))
-        self.assertEqual(sorted(full_android_files),
+            full_android_files.append(os.path.join(full_path, HOWTO_PATH,
+                                                   file))
+        self.assertEqual([],
             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()
-        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_android_files1 = []
-        full_android_files2 = []
-        for file in 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):
-            RenderTextFiles.find_relevant_files(path)
-        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
-        path = self.make_temp_dir(empty=False, file_list=flist)
+        path = self.make_temp_dir(empty=False, file_list=UBUNTU_FILES)
+        os.makedirs(os.path.join(path, HOWTO_PATH))
         full_files = []
-        for file in flist:
+        for file in ANDROID_FILES:
+            full_files.append(os.path.join(path, HOWTO_PATH, file))
+            open(os.path.join(path, HOWTO_PATH, file), 'w').close()
+        for file in UBUNTU_FILES:
             full_files.append(os.path.join(path, file))
-        self.assertListEqual(sorted(full_files),
-            sorted(RenderTextFiles.find_relevant_files(path)))
-
-    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,
-                                          dir=path)
-        ubuntu_path = self.make_temp_dir(empty=False, file_list=UBUNTU_FILES,
-                                         dir=path)
-        full_android_files = []
-        full_ubuntu_files = []
-        for file in 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),
-            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),
-            sorted(RenderTextFiles.find_relevant_files(ubuntu_path)))
+        with self.assertRaises(MultipleFilesException):
+            RenderTextFiles.find_relevant_files(path)