Merge lp:~dholbach/arb-lint/1019212 into lp:arb-lint

[Daniel Holbach]

[lp:~dholbach/arb-lint/1019212]

29. By Daniel Holbach on 2012-07-02

correct /opt error message

30. By Daniel Holbach on 2012-07-02

changed file identation

[Andrew Mitchell (ajmitch)]

The checks for /opt mostly look like they'll do the right thing, but you may run into python problems with the default arguments to functions being [], as calling pretty_print without file_list set after having it set, will likely still print out the file list, which isn't really what you want.
I think we just accept a blanket exception for /usr/share/doc/<packagename> which would allow README.Debian, NEWS, etc in that directory.

review: Needs Fixing

[Daniel Holbach (dholbach)]

I'm not sure if I understand "you may run into python problems with the default arguments to functions being [], as calling pretty_print without file_list set after having it set, will likely still print out the file list, which isn't really what you want." correctly, but there is a test for "if file_list:" in line 9 in pretty_print().

I'm happy to relax the checks for files in /usr/share/doc, if that's what we agree on.

[lp:~dholbach/arb-lint/1019212]

31. By Daniel Holbach on 2012-07-03

add missing line break

32. By Daniel Holbach on 2012-07-03

relax checks for files in usr/share/doc

[Daniel Holbach (dholbach)]

<ajmitch> dholbach: merge it

=== modified file 'lint/binarypackages.py'
--- lint/binarypackages.py	2012-06-29 08:53:07 +0000
+++ lint/binarypackages.py	2012-07-03 07:14:23 +0000
@@ -5,6 +5,7 @@
 
 from . depends import provides, requires
 from . output import warning, error
+import checks
 
 class BinaryPackages(object):
     arches = []
@@ -47,6 +48,7 @@
                   "tests.")
 
     @provides('debs')
+    @requires('changes_file')
     def find_debs(self):
         if not self.changes_file:
             return None
@@ -60,8 +62,8 @@
         if not self.debs:
             error("No packages found.")
 
+    @provides('deb_contents')
     @requires('debs')
-    @provides('deb_contents')
     def find_deb_contents(self):
         if not self.debs:
             return None
@@ -99,6 +101,30 @@
                 not os.path.basename(a).startswith("extras-unity-"), self.deb_contents)
         if offending_files:
             error("The following file names should start with "
-                  "'extras-unity-':"
-                  "%s" % ("\n".join(["\t%s" % f for f in offending_files])))
-                
+                  "'extras-unity-':",
+                  offending_files)
+    
+    @requires('deb_contents')
+    def test_files_in_opt(self):
+        if not self.deb_contents:
+            return
+        correct_opt_path = "opt/extras.ubuntu.com/" + self.sp.package_name
+        doc_path = "usr/share/doc/" + self.sp.package_name
+        exceptions = [
+            ".lens", 
+            ".desktop", 
+            ".service",
+            doc_path,
+                     ]
+        files_in_opt = filter(lambda filename: correct_opt_path in filename,
+                              self.deb_contents)
+        files_not_in_opt = filter(lambda filename: correct_opt_path not in filename,
+                                  self.deb_contents)
+        if not files_in_opt:
+            error("The package seems to contain no files in '/%s' which "
+                  "indicates a problem with the installation of files." % \
+                          correct_opt_path)
+        other_std_files = checks.find_offending_items(files_not_in_opt, exceptions)
+        if other_std_files:
+            error("These files are outside %s and shouldn't be: " % correct_opt_path,
+                  other_std_files)

=== modified file 'lint/checks.py'
--- lint/checks.py	2012-06-29 10:26:20 +0000
+++ lint/checks.py	2012-07-03 07:14:23 +0000
@@ -9,3 +9,10 @@
     if len(contents) == 0:
         return True
     return False
+
+def find_offending_items(items, exceptions):
+    offenders = []
+    for item in items:
+        if filter(lambda a: a not in item, exceptions) == exceptions:
+            offenders += [ item ]
+    return offenders

=== modified file 'lint/output.py'
--- lint/output.py	2012-06-29 11:46:49 +0000
+++ lint/output.py	2012-07-03 07:14:23 +0000
@@ -1,18 +1,23 @@
 import textwrap
 
-def pretty_print(message, start):
+def pretty_print(message, start, file_list=[]):
     indent = len(start)
     lines = textwrap.wrap(message, 75-indent)
     message = start + lines[0] + "\n"
     indented_lines = [' '.ljust(indent) + line for line in lines[1:]]
     message += "\n".join(indented_lines)
+    if file_list:
+        if message[-1] != "\n":
+            message += "\n"
+        indented_files = [' '.ljust(indent) + "- " + f for f in file_list]
+        message += "\n".join(indented_files)
     return message
 
-def error(message):
-    print pretty_print(message, "E: ")
-
-def warning(message):
-    print pretty_print(message, "W: ")
-
-def info(message):
-    print pretty_print(message, "I: ")
+def error(message, file_list=[]):
+    print pretty_print(message, "E: ", file_list)
+
+def warning(message, file_list=[]):
+    print pretty_print(message, "W: ", file_list)
+
+def info(message, file_list=[]):
+    print pretty_print(message, "I: ", file_list)