Merge lp:~danilo/linaro-license-protection/bug-1084013 into lp:~linaro-automation/linaro-license-protection/trunk

[Данило Шеган]

This ensures files like MD5SUM (all uppercase) are still recognized in BUILD-INFO patterns: problem was that we used to lowercase the key, but then didn't match against it.

I don't see any reason to try to match the globs in a case-sensitive manner, so I am instead keeping the file patterns as they are.

This branch introduces tests on both the level of BUILD-INFO parsing, and an integration test to ensure we can access a file with all uppercase filename.

Some minor cleanups are done along the way:
 - temporary_directory helper has been moved into tests/helpers.py since it's used by both test_buildinfo.py and test_views.py now
 - a few imports have been reordered, and I extract the shared test-case setup in test_views.py

[Данило Шеган (danilo)]

pep8 is even stricter in quantal, I'll work on fixing that in the follow-up branch.

[James Tunnicliffe (dooferlad)]

Looks good to me.

review: Approve

=== modified file 'license_protected_downloads/buildinfo.py'
--- license_protected_downloads/buildinfo.py	2012-07-11 11:56:10 +0000
+++ license_protected_downloads/buildinfo.py	2012-11-28 12:32:21 +0000
@@ -40,7 +40,6 @@
                 os.path.join(cls.get_search_path(path), "BUILD-INFO.txt"))
 
     def _set(self, key, value):
-        key = key.lower()
         if key in self.build_info_array[self.index]:
             # A repeated key indicates we have found another chunk of
             # build-info
@@ -175,9 +174,7 @@
                 self.file_info_array.pop(index)
 
 if __name__ == "__main__":
-    bi = BuildInfo("/var/www/build-info/origen-blob.txt")
-#   print bi.build_info_array
-#    print "file_info_array: %s" % bi.file_info_array
-#    print bi.getFormatVersion()
+    import sys
+    bi = BuildInfo(sys.argv[1])
     for field in bi.fields_defined:
         print field + " = " + str(bi.get(field))

=== modified file 'license_protected_downloads/tests/__init__.py'
--- license_protected_downloads/tests/__init__.py	2012-11-07 18:13:07 +0000
+++ license_protected_downloads/tests/__init__.py	2012-11-28 12:32:21 +0000
@@ -1,8 +1,12 @@
-from license_protected_downloads.tests.test_buildinfo import BuildInfoTests
+from license_protected_downloads.tests.test_buildinfo import (
+    BuildInfoTests,
+    FileNameMatchingTests,
+    )
 from license_protected_downloads.tests.test_models import LicenseTestCase
 from license_protected_downloads.tests.test_pep8 import TestPep8
 from license_protected_downloads.tests.test_pyflakes import TestPyflakes
 from license_protected_downloads.tests.test_views import (
+    FileViewTests,
     HowtoViewTests,
     ViewTests,
     )
@@ -14,13 +18,15 @@
 
 #starts the test suite
 __test__ = {
+    'BuildInfoTests': BuildInfoTests,
+    'FileNameMatchingTests': FileNameMatchingTests,
+    'FileViewTests': FileViewTests,
+    'HowtoViewTests': HowtoViewTests,
     'LicenseTestCase': LicenseTestCase,
-    'ViewTests': ViewTests,
-    'HowtoViewTests': HowtoViewTests,
-    'BuildInfoTests': BuildInfoTests,
+    'RenderTextFilesTests': RenderTextFilesTests,
+    'SetsuperuserCommandTest': SetsuperuserCommandTest,
+    'TestOpenIDAuth': TestOpenIDAuth,
     'TestPep8': TestPep8,
     'TestPyflakes': TestPyflakes,
-    'TestOpenIDAuth': TestOpenIDAuth,
-    'SetsuperuserCommandTest': SetsuperuserCommandTest,
-    'RenderTextFilesTests': RenderTextFilesTests,
+    'ViewTests': ViewTests,
 }

=== added file 'license_protected_downloads/tests/helpers.py'
--- license_protected_downloads/tests/helpers.py	1970-01-01 00:00:00 +0000
+++ license_protected_downloads/tests/helpers.py	2012-11-28 12:32:21 +0000
@@ -0,0 +1,42 @@
+# Copyright (c)2012 Linaro.
+# Test helpers.
+
+import os
+import shutil
+import tempfile
+
+
+class temporary_directory(object):
+    """Creates a context manager for a temporary directory."""
+
+    def __enter__(self):
+        self.root = tempfile.mkdtemp()
+        return self
+
+    def __exit__(self, *args):
+        shutil.rmtree(self.root)
+
+    def make_file(self, name, data=None, with_buildinfo=False):
+        """Creates a file in this temporary directory."""
+        full_path = os.path.join(self.root, name)
+        dir_name = os.path.dirname(full_path)
+        try:
+            os.makedirs(dir_name)
+        except os.error:
+            pass
+        if with_buildinfo:
+            buildinfo_name = os.path.join(dir_name, 'BUILD-INFO.txt')
+            base_name = os.path.basename(full_path)
+            with open(buildinfo_name, 'w') as buildinfo_file:
+                buildinfo_file.write(
+                    'Format-Version: 0.1\n\n'
+                    'Files-Pattern: %s\n'
+                    'License-Type: open\n' % base_name)
+        target = open(full_path, "w")
+        if data is None:
+            return target
+        else:
+            target.write(data)
+            target.close()
+            return full_path
+

=== modified file 'license_protected_downloads/tests/test_buildinfo.py'
--- license_protected_downloads/tests/test_buildinfo.py	2012-07-20 12:26:22 +0000
+++ license_protected_downloads/tests/test_buildinfo.py	2012-11-28 12:32:21 +0000
@@ -4,6 +4,7 @@
 import unittest
 from license_protected_downloads.buildinfo import BuildInfo
 from license_protected_downloads.buildinfo import IncorrectDataFormatException
+from license_protected_downloads.tests.helpers import temporary_directory
 
 THIS_DIRECTORY = os.path.dirname(os.path.abspath(__file__))
 
@@ -275,5 +276,21 @@
         self.assertEquals(build_info.file_info_array, [{}])
 
 
+class FileNameMatchingTests(unittest.TestCase):
+    def test_buildinfo_simple_filename(self):
+        with temporary_directory() as serve_root:
+            sample_file = serve_root.make_file("MD5SUM", data="blah")
+            serve_root.make_file(
+                "BUILD-INFO.txt",
+                data=(
+                    "Format-Version: 2.0\n\n"
+                    "Files-Pattern: MD5SUM\n"
+                    "License-Type: open\n"
+                    ))
+            build_info = BuildInfo(sample_file)
+            file_info = build_info.getInfoForFile()
+            self.assertEqual('open', file_info[0]['license-type'])
+
+
 if __name__ == '__main__':
     unittest.main()

=== modified file 'license_protected_downloads/tests/test_views.py'
--- license_protected_downloads/tests/test_views.py	2012-11-21 17:57:53 +0000
+++ license_protected_downloads/tests/test_views.py	2012-11-28 12:32:21 +0000
@@ -4,60 +4,25 @@
 from django.test import Client, TestCase
 import hashlib
 import os
+import tempfile
 import unittest
 import urlparse
-import shutil
-import tempfile
 
 from license_protected_downloads import bzr_version
 from license_protected_downloads.buildinfo import BuildInfo
+from license_protected_downloads.config import INTERNAL_HOSTS
+from license_protected_downloads.tests.helpers import temporary_directory
 from license_protected_downloads.views import _insert_license_into_db
+from license_protected_downloads.views import _process_include_tags
 from license_protected_downloads.views import _sizeof_fmt
-from license_protected_downloads.views import _process_include_tags
 from license_protected_downloads.views import is_same_parent_dir
-from license_protected_downloads.config import INTERNAL_HOSTS
 
 
 THIS_DIRECTORY = os.path.dirname(os.path.abspath(__file__))
 TESTSERVER_ROOT = os.path.join(THIS_DIRECTORY, "testserver_root")
 
 
-class temporary_directory(object):
-    """Creates a context manager for a temporary directory."""
-
-    def __enter__(self):
-        self.root = tempfile.mkdtemp()
-        return self
-
-    def __exit__(self, *args):
-        shutil.rmtree(self.root)
-
-    def make_file(self, name, data=None, with_buildinfo=False):
-        """Creates a file in this temporary directory."""
-        full_path = os.path.join(self.root, name)
-        dir_name = os.path.dirname(full_path)
-        try:
-            os.makedirs(dir_name)
-        except os.error:
-            pass
-        if with_buildinfo:
-            buildinfo_name = os.path.join(dir_name, 'BUILD-INFO.txt')
-            base_name = os.path.basename(full_path)
-            with open(buildinfo_name, 'w') as buildinfo_file:
-                buildinfo_file.write(
-                    'Format-Version: 0.1\n\n'
-                    'Files-Pattern: %s\n'
-                    'License-Type: open\n' % base_name)
-        target = open(full_path, "w")
-        if data is None:
-            return target
-        else:
-            target.write(data)
-            target.close()
-            return full_path
-
-
-class ViewTests(TestCase):
+class BaseServeViewTest(TestCase):
     def setUp(self):
         self.client = Client()
         self.old_served_paths = settings.SERVED_PATHS
@@ -67,6 +32,7 @@
     def tearDown(self):
         settings.SERVED_PATHS = self.old_served_paths
 
+class ViewTests(BaseServeViewTest):
     def test_license_directly(self):
         response = self.client.get('/licenses/license.html', follow=True)
         self.assertEqual(response.status_code, 200)
@@ -674,16 +640,7 @@
         self.assertFalse(is_same_parent_dir(TESTSERVER_ROOT, fname))
 
 
-class HowtoViewTests(TestCase):
-    def setUp(self):
-        self.client = Client()
-        self.old_served_paths = settings.SERVED_PATHS
-        settings.SERVED_PATHS = [os.path.join(THIS_DIRECTORY,
-                                             "testserver_root")]
-
-    def tearDown(self):
-        settings.SERVED_PATHS = self.old_served_paths
-
+class HowtoViewTests(BaseServeViewTest):
     def test_no_howtos(self):
         with temporary_directory() as serve_root:
             settings.SERVED_PATHS = [serve_root.root]
@@ -754,5 +711,19 @@
             self.assertContains(response, 'HowTo Test')
 
 
+class FileViewTests(BaseServeViewTest):
+    def test_static_file(self):
+        with temporary_directory() as serve_root:
+            settings.SERVED_PATHS = [serve_root.root]
+            serve_root.make_file("MD5SUM")
+            serve_root.make_file(
+                "BUILD-INFO.txt",
+                data=("Format-Version: 2.0\n\n"
+                      "Files-Pattern: MD5SUM\n"
+                      "License-Type: open\n"))
+            response = self.client.get('/MD5SUM')
+            self.assertEqual(response.status_code, 200)
+
+
 if __name__ == '__main__':
     unittest.main()