]> git.decadent.org.uk Git - dak.git/blobdiff - dak/examine_package.py
examine_package: make most functions functional
[dak.git] / dak / examine_package.py
index f7fadf2a4dc3777ef910262fc3df5778b43f8fc3..2b92ca7816593a87753ca97ee3cf4f11045cc385 100755 (executable)
@@ -3,6 +3,10 @@
 """
 Script to automate some parts of checking NEW packages
 
+Most functions are written in a functional programming style. They
+return a string avoiding the side effect of directly printing the string
+to stdout. Those functions can be used in multithreaded parts of dak.
+
 @contact: Debian FTP Master <ftpmaster@debian.org>
 @copyright: 2000, 2001, 2002, 2003, 2006  James Troup <james@nocrew.org>
 @copyright: 2009  Joerg Jaspert <joerg@debian.org>
@@ -93,11 +97,11 @@ def headline(s, level=2, bodyelement=None):
         if bodyelement:
             return """<thead>
                 <tr><th colspan="2" class="title" onclick="toggle('%(bodyelement)s', 'table-row-group', 'table-row-group')">%(title)s <span class="toggle-msg">(click to toggle)</span></th></tr>
-              </thead>"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
+              </thead>\n"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
         else:
-            return "<h%d>%s</h%d>" % (level, utils.html_escape(s), level)
+            return "<h%d>%s</h%d>\n" % (level, utils.html_escape(s), level)
     else:
-        return "---- %s ----" % (s)
+        return "---- %s ----\n" % (s)
 
 # Colour definitions, 'end' isn't really for use
 
@@ -154,18 +158,20 @@ def format_field(k,v):
 
 def foldable_output(title, elementnameprefix, content, norow=False):
     d = {'elementnameprefix':elementnameprefix}
+    result = ''
     if use_html:
-        print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
-                   <table class="infobox rfc822">"""%d
-    print headline(title, bodyelement="%(elementnameprefix)s-body"%d)
+        result += """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
+                   <table class="infobox rfc822">\n"""%d
+    result += headline(title, bodyelement="%(elementnameprefix)s-body"%d)
     if use_html:
-        print """    <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
+        result += """    <tbody id="%(elementnameprefix)s-body" class="infobody">\n"""%d
     if norow:
-        print content
+        result += content + "\n"
     else:
-        print output_row(content)
+        result += output_row(content) + "\n"
     if use_html:
-        print """</tbody></table></div>"""
+        result += """</tbody></table></div>"""
+    return result
 
 ################################################################################
 
@@ -360,7 +366,7 @@ def output_package_relations ():
             to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
 
     package_relations.clear()
-    foldable_output("Package relations", "relations", to_print)
+    return foldable_output("Package relations", "relations", to_print)
 
 def output_deb_info(suite, filename, packagename):
     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
@@ -462,9 +468,13 @@ def get_readme_source (dsc_filename):
 
 def check_dsc (suite, dsc_filename):
     (dsc) = read_changes_or_dsc(suite, dsc_filename)
-    foldable_output(dsc_filename, "dsc", dsc, norow=True)
-    foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
-    foldable_output("README.source for %s" % dsc_filename, "source-readmesource", get_readme_source(dsc_filename))
+    return foldable_output(dsc_filename, "dsc", dsc, norow=True) + \
+           "\n" + \
+           foldable_output("lintian check for %s" % dsc_filename,
+              "source-lintian", do_lintian(dsc_filename)) + \
+           "\n" + \
+           foldable_output("README.source for %s" % dsc_filename,
+               "source-readmesource", get_readme_source(dsc_filename))
 
 def check_deb (suite, deb_filename):
     filename = os.path.basename(deb_filename)
@@ -475,29 +485,30 @@ def check_deb (suite, deb_filename):
     else:
         is_a_udeb = 0
 
-
-    foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
-                    output_deb_info(suite, deb_filename, packagename), norow=True)
+    result = foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
+        output_deb_info(suite, deb_filename, packagename), norow=True) + "\n"
 
     if is_a_udeb:
-        foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
-                        "")
+        result += foldable_output("skipping lintian check for udeb",
+           "binary-%s-lintian"%packagename, "") + "\n"
     else:
-        foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
-                        do_lintian(deb_filename))
+        result += foldable_output("lintian check for %s" % (filename),
+           "binary-%s-lintian"%packagename, do_lintian(deb_filename)) + "\n"
 
-    foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
-                    do_command("dpkg -c", deb_filename))
+    result += foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
+        do_command("dpkg -c", deb_filename)) + "\n"
 
     if is_a_udeb:
-        foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
-                        "")
+        result += foldable_output("skipping copyright for udeb",
+           "binary-%s-copyright"%packagename, "") + "\n"
     else:
-        foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
-                        get_copyright(deb_filename))
+        result += foldable_output("copyright of %s" % (filename),
+           "binary-%s-copyright"%packagename, get_copyright(deb_filename)) + "\n"
 
-    foldable_output("file listing of %s" % (filename),  "binary-%s-file-listing"%packagename,
-                    do_command("ls -l", deb_filename))
+    result += foldable_output("file listing of %s" % (filename),
+       "binary-%s-file-listing"%packagename, do_command("ls -l", deb_filename))
+
+    return result
 
 # Read a file, strip the signature and return the modified contents as
 # a string.
@@ -529,21 +540,21 @@ def strip_pgp_signature (filename):
 
 def display_changes(suite, changes_filename):
     changes = read_changes_or_dsc(suite, changes_filename)
-    foldable_output(changes_filename, "changes", changes, norow=True)
+    return foldable_output(changes_filename, "changes", changes, norow=True)
 
 def check_changes (changes_filename):
     try:
         changes = utils.parse_changes (changes_filename)
     except ChangesUnicodeError:
         utils.warn("Encoding problem with changes file %s" % (changes_filename))
-    display_changes(changes['distribution'], changes_filename)
+    print display_changes(changes['distribution'], changes_filename)
 
     files = utils.build_file_list(changes)
     for f in files.keys():
         if f.endswith(".deb") or f.endswith(".udeb"):
-            check_deb(changes['distribution'], f)
+            print check_deb(changes['distribution'], f)
         if f.endswith(".dsc"):
-            check_dsc(changes['distribution'], f)
+            print check_dsc(changes['distribution'], f)
         # else: => byhand
 
 def main ():
@@ -564,6 +575,10 @@ def main ():
     if Options["Help"]:
         usage()
 
+    if Options["Html-Output"]:
+        global use_html
+        use_html = 1
+
     stdout_fd = sys.stdout
 
     for f in args:
@@ -579,13 +594,13 @@ def main ():
                 elif f.endswith(".deb") or f.endswith(".udeb"):
                     # default to unstable when we don't have a .changes file
                     # perhaps this should be a command line option?
-                    check_deb('unstable', f)
+                    print check_deb('unstable', f)
                 elif f.endswith(".dsc"):
-                    check_dsc('unstable', f)
+                    print check_dsc('unstable', f)
                 else:
                     utils.fubar("Unrecognised file type: '%s'." % (f))
             finally:
-                output_package_relations()
+                print output_package_relations()
                 if not Options["Html-Output"]:
                     # Reset stdout here so future less invocations aren't FUBAR
                     less_fd.close()