Merge lp:~gesha/linaro-license-protection/1146220 into lp:~linaro-automation/linaro-license-protection/trunk

[Georgy Redkozubov]

This branch reinstates BUILD-INFO.txt support for publishing service.
Publishing script checks if BUILD-INFO.txt is present among artifacts being published or among already published artifacts for the same build. Otherwise publishing is aborted with an error.

[Stevan Radaković (stevanr)]

Nice work gesha, thanks!

Only thing I dislike here is having return values(PASS, FAIL) in the method instead of using the exceptions as this is a very good example on when they should be used. That way you don't need to return anything at all, just catch exception if the method throws it. Tests would need to go through a little change as well because of it.

review: Needs Fixing (code)

[lp:~gesha/linaro-license-protection/1146220]

184. By Georgy Redkozubov on 2013-04-24

Rewritten code to use exceptions.

[Stevan Radaković (stevanr)]

46 @@ -387,6 +408,7 @@
47 if build_dir_path is None or target_dir_path is None:
48 print "Problem with build/target path, move failed"
49 return FAIL
50 + publisher.check_buildinfo(build_dir_path, target_dir_path)

Think we should have here something like:

try:
    publisher.check_buildinfo(build_dir_path, target_dir_path)
except as e:
    print e.strerror
    return FAIL

[lp:~gesha/linaro-license-protection/1146220]

185. By Georgy Redkozubov on 2013-04-25

Rewrite exception handling.

186. By Georgy Redkozubov on 2013-04-25

Fix pep8

[Stevan Radaković (stevanr)]

Looks good.
Approve +1

review: Approve

=== modified file 'scripts/publish_to_snapshots.py'
--- scripts/publish_to_snapshots.py	2013-02-26 08:38:32 +0000
+++ scripts/publish_to_snapshots.py	2013-04-25 19:33:24 +0000
@@ -15,6 +15,7 @@
 product_dir_path = 'target/product'
 PASS = 0
 FAIL = 1
+buildinfo = 'BUILD-INFO.txt'
 acceptable_job_types = [
     'android',
     'prebuilt',
@@ -61,6 +62,16 @@
     pass
 
 
+class BuildInfoException(Exception):
+    """BUILD-INFO.txt is absent."""
+
+    def __init__(self, value):
+        self.value = value
+
+    def __str__(self):
+        return repr(self.value)
+
+
 class SnapshotsPublisher(object):
 
     # Files that need no sanitization even when publishing to staging.
@@ -367,6 +378,21 @@
             print "Failed to move files destination path", target_dir_path
             return FAIL
 
+    def check_buildinfo(self, build_dir_path, target_dir_path):
+        bi_dirs = []
+        for path, subdirs, files in os.walk(build_dir_path):
+            for filename in files:
+                if buildinfo in filename:
+                    bi_dirs.append(path)
+        for path, subdirs, files in os.walk(target_dir_path):
+            for filename in files:
+                if buildinfo in filename:
+                    bi_dirs.append(path)
+
+        if not bi_dirs:
+            raise BuildInfoException(
+                    "BUILD-INFO.txt is not present for build being published.")
+
 
 def main():
     global uploads_path
@@ -387,6 +413,11 @@
         if build_dir_path is None or target_dir_path is None:
             print "Problem with build/target path, move failed"
             return FAIL
+        try:
+            publisher.check_buildinfo(build_dir_path, target_dir_path)
+        except BuildInfoException as e:
+            print e.value
+            return FAIL
         ret = publisher.move_artifacts(args, build_dir_path, target_dir_path)
         if ret != PASS:
             print "Move Failed"

=== modified file 'tests/test_publish_to_snapshots.py'
--- tests/test_publish_to_snapshots.py	2013-02-26 08:38:32 +0000
+++ tests/test_publish_to_snapshots.py	2013-04-25 19:33:24 +0000
@@ -11,6 +11,8 @@
     SnapshotsPublisher,
     setup_parser,
     product_dir_path,
+    BuildInfoException,
+    buildinfo
     )
 
 
@@ -726,3 +728,55 @@
         self.assertEqual(content, open(resulting_file).read())
         self.assertEqual(howto_content, open(resulting_howto_file).read())
         shutil.rmtree(source_dir)
+
+    def test_check_buildinfo_upload_dir(self):
+        self.publisher = SnapshotsPublisher()
+        param = self.parser.parse_args(
+            ['-t', 'prebuilt', '-j', 'precise-armhf-ubuntu-desktop',
+             '-n', '1'])
+        self.publisher.validate_args(param)
+        build_dir = '/'.join([param.job_name, str(param.build_num)])
+        build_path = os.path.join(self.uploads_path, build_dir)
+        os.makedirs(build_path)
+        www_path = os.path.join(self.target_path, build_dir)
+        os.makedirs(www_path)
+
+        file_name = os.path.join(build_path, buildinfo)
+        file = open(file_name, "w")
+        file.close()
+
+        self.assertIsNone(self.publisher.check_buildinfo(build_path, www_path))
+
+    def test_check_buildinfo_target_dir(self):
+        self.publisher = SnapshotsPublisher()
+        param = self.parser.parse_args(
+            ['-t', 'prebuilt', '-j', 'precise-armhf-ubuntu-desktop',
+             '-n', '1'])
+        self.publisher.validate_args(param)
+        build_dir = '/'.join([param.job_name, str(param.build_num)])
+        build_path = os.path.join(self.uploads_path, build_dir)
+        os.makedirs(build_path)
+        www_path = os.path.join(self.target_path, build_dir)
+        os.makedirs(www_path)
+
+        file_name = os.path.join(www_path, buildinfo)
+        file = open(file_name, "w")
+        file.close()
+
+        self.assertIsNone(self.publisher.check_buildinfo(build_path, www_path))
+
+    def test_check_buildinfo_no_file(self):
+        self.publisher = SnapshotsPublisher()
+        param = self.parser.parse_args(
+            ['-t', 'prebuilt', '-j', 'precise-armhf-ubuntu-desktop',
+             '-n', '1'])
+        self.publisher.validate_args(param)
+        build_dir = '/'.join([param.job_name, str(param.build_num)])
+        build_path = os.path.join(self.uploads_path, build_dir)
+        os.makedirs(build_path)
+        www_path = os.path.join(self.target_path, build_dir)
+        os.makedirs(www_path)
+
+        self.assertRaises(
+            BuildInfoException,
+            self.publisher.check_buildinfo, build_path, www_path)