dak/cruft_report.py

   1 #!/usr/bin/env python
   2
   3 """ Check for obsolete binary packages """
   4 # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006  James Troup <james@nocrew.org>
   5
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20 ################################################################################
  21
  22 # ``If you're claiming that's a "problem" that needs to be "fixed",
  23 #   you might as well write some letters to God about how unfair entropy
  24 #   is while you're at it.'' -- 20020802143104.GA5628@azure.humbug.org.au
  25
  26 ## TODO:  fix NBS looping for version, implement Dubious NBS, fix up output of
  27 ##        duplicate source package stuff, improve experimental ?, add overrides,
  28 ##        avoid ANAIS for duplicated packages
  29
  30 ################################################################################
  31
  32 import commands, os, sys, re
  33 import apt_pkg
  34
  35 from daklib.config import Config
  36 from daklib.dbconn import *
  37 from daklib import utils
  38 from daklib.regexes import re_extract_src_version
  39
  40 ################################################################################
  41
  42 no_longer_in_suite = {}; # Really should be static to add_nbs, but I'm lazy
  43
  44 source_binaries = {}
  45 source_versions = {}
  46
  47 ################################################################################
  48
  49 def usage(exit_code=0):
  50     print """Usage: dak cruft-report
  51 Check for obsolete or duplicated packages.
  52
  53   -h, --help                show this help and exit.
  54   -m, --mode=MODE           chose the MODE to run in (full or daily).
  55   -s, --suite=SUITE         check suite SUITE.
  56   -w, --wanna-build-dump    where to find the copies of http://buildd.debian.org/stats/*.txt"""
  57     sys.exit(exit_code)
  58
  59 ################################################################################
  60
  61 def add_nbs(nbs_d, source, version, package, suite_id, session):
  62     # Ensure the package is still in the suite (someone may have already removed it)
  63     if no_longer_in_suite.has_key(package):
  64         return
  65     else:
  66         q = session.execute("""SELECT b.id FROM binaries b, bin_associations ba
  67                                 WHERE ba.bin = b.id AND ba.suite = :suite_id
  68                                   AND b.package = :package LIMIT 1""", {'suite_id': suite_id,
  69                                                                          'package': package})
  70         if not q.fetchall():
  71             no_longer_in_suite[package] = ""
  72             return
  73
  74     nbs_d.setdefault(source, {})
  75     nbs_d[source].setdefault(version, {})
  76     nbs_d[source][version][package] = ""
  77
  78 ################################################################################
  79
  80 # Check for packages built on architectures they shouldn't be.
  81 def do_anais(architecture, binaries_list, source, session):
  82     if architecture == "any" or architecture == "all":
  83         return ""
  84
  85     anais_output = ""
  86     architectures = {}
  87     for arch in architecture.split():
  88         architectures[arch.strip()] = ""
  89     for binary in binaries_list:
  90         q = session.execute("""SELECT a.arch_string, b.version
  91                                 FROM binaries b, bin_associations ba, architecture a
  92                                WHERE ba.suite = :suiteid AND ba.bin = b.id
  93                                  AND b.architecture = a.id AND b.package = :package""",
  94                              {'suiteid': suite_id, 'package': binary})
  95         ql = q.fetchall()
  96         versions = []
  97         for i in ql:
  98             arch = i[0]
  99             version = i[1]
 100             if architectures.has_key(arch):
 101                 versions.append(version)
 102         versions.sort(apt_pkg.VersionCompare)
 103         if versions:
 104             latest_version = versions.pop()
 105         else:
 106             latest_version = None
 107         # Check for 'invalid' architectures
 108         versions_d = {}
 109         for i in ql:
 110             arch = i[0]
 111             version = i[1]
 112             if not architectures.has_key(arch):
 113                 versions_d.setdefault(version, [])
 114                 versions_d[version].append(arch)
 115
 116         if versions_d != {}:
 117             anais_output += "\n (*) %s_%s [%s]: %s\n" % (binary, latest_version, source, architecture)
 118             versions = versions_d.keys()
 119             versions.sort(apt_pkg.VersionCompare)
 120             for version in versions:
 121                 arches = versions_d[version]
 122                 arches.sort()
 123                 anais_output += "    o %s: %s\n" % (version, ", ".join(arches))
 124     return anais_output
 125
 126
 127 ################################################################################
 128
 129 # Check for out-of-date binaries on architectures that do not want to build that
 130 # package any more, and have them listed as Not-For-Us
 131 def do_nfu(nfu_packages):
 132     output = ""
 133
 134     a2p = {}
 135
 136     for architecture in nfu_packages:
 137         a2p[architecture] = []
 138         for (package,bver,sver) in nfu_packages[architecture]:
 139             output += "  * [%s] does not want %s (binary %s, source %s)\n" % (architecture, package, bver, sver)
 140             a2p[architecture].append(package)
 141
 142
 143     if output:
 144         print "Obsolete by Not-For-Us"
 145         print "----------------------"
 146         print
 147         print output
 148
 149         print "Suggested commands:"
 150         for architecture in a2p:
 151             if a2p[architecture]:
 152                 print (" dak rm -m \"[auto-cruft] NFU\" -s %s -a %s -b %s" %
 153                     (suite, architecture, " ".join(a2p[architecture])))
 154         print
 155
 156 def parse_nfu(architecture):
 157     cnf = Config()
 158     # utils/hpodder_1.1.5.0: Not-For-Us [optional:out-of-date]
 159     r = re.compile("^\w+/([^_]+)_.*: Not-For-Us")
 160
 161     ret = set()
 162
 163     filename = "%s/%s-all.txt" % (cnf["Cruft-Report::Options::Wanna-Build-Dump"], architecture)
 164
 165     # Not all architectures may have a wanna-build dump, so we want to ignore missin
 166     # files
 167     if os.path.exists(filename):
 168         f = utils.open_file(filename)
 169         for line in f:
 170             if line[0] == ' ':
 171                 continue
 172
 173             m = r.match(line)
 174             if m:
 175                 ret.add(m.group(1))
 176
 177         f.close()
 178     else:
 179         utils.warn("No wanna-build dump file for architecture %s" % architecture)
 180     return ret
 181
 182 ################################################################################
 183
 184 def do_newer_version(lowersuite_name, highersuite_name, code, session):
 185     lowersuite = get_suite(lowersuite_name, session)
 186     if not lowersuite:
 187         return
 188
 189     highersuite = get_suite(highersuite_name, session)
 190     if not highersuite:
 191         return
 192
 193     # Check for packages in $highersuite obsoleted by versions in $lowersuite
 194     q = session.execute("""
 195 SELECT s.source, s.version AS lower, s2.version AS higher
 196   FROM src_associations sa, source s, source s2, src_associations sa2
 197   WHERE sa.suite = :highersuite_id AND sa2.suite = :lowersuite_id AND sa.source = s.id
 198    AND sa2.source = s2.id AND s.source = s2.source
 199    AND s.version < s2.version""", {'lowersuite_id': lowersuite.suite_id,
 200                                     'highersuite_id': highersuite.suite_id})
 201     ql = q.fetchall()
 202     if ql:
 203         nv_to_remove = []
 204         print "Newer version in %s" % lowersuite.suite_name
 205         print "-----------------" + "-" * len(lowersuite.suite_name)
 206         print
 207         for i in ql:
 208             (source, higher_version, lower_version) = i
 209             print " o %s (%s, %s)" % (source, higher_version, lower_version)
 210             nv_to_remove.append(source)
 211         print
 212         print "Suggested command:"
 213         print " dak rm -m \"[auto-cruft] %s\" -s %s %s" % (code, highersuite.suite_name,
 214                                                            " ".join(nv_to_remove))
 215         print
 216
 217 ################################################################################
 218
 219 def do_nbs(real_nbs):
 220     output = "Not Built from Source\n"
 221     output += "---------------------\n\n"
 222
 223     cmd_output = ""
 224     nbs_keys = real_nbs.keys()
 225     nbs_keys.sort()
 226     for source in nbs_keys:
 227         output += " * %s_%s builds: %s\n" % (source,
 228                                        source_versions.get(source, "??"),
 229                                        source_binaries.get(source, "(source does not exist)"))
 230         output += "      but no longer builds:\n"
 231         versions = real_nbs[source].keys()
 232         versions.sort(apt_pkg.VersionCompare)
 233         all_packages = []
 234         for version in versions:
 235             packages = real_nbs[source][version].keys()
 236             packages.sort()
 237             all_packages.extend(packages)
 238             output += "        o %s: %s\n" % (version, ", ".join(packages))
 239         if all_packages:
 240             all_packages.sort()
 241             cmd_output += " dak rm -m \"[auto-cruft] NBS (was built by %s)\" -s %s -b %s -R\n\n" % (source, suite.suite_name, " ".join(all_packages))
 242
 243         output += "\n"
 244
 245     if len(cmd_output):
 246         print output
 247         print "Suggested commands:\n"
 248         print cmd_output
 249
 250 ################################################################################
 251
 252 def do_dubious_nbs(dubious_nbs):
 253     print "Dubious NBS"
 254     print "-----------"
 255     print
 256
 257     dubious_nbs_keys = dubious_nbs.keys()
 258     dubious_nbs_keys.sort()
 259     for source in dubious_nbs_keys:
 260         print " * %s_%s builds: %s" % (source,
 261                                        source_versions.get(source, "??"),
 262                                        source_binaries.get(source, "(source does not exist)"))
 263         print "      won't admit to building:"
 264         versions = dubious_nbs[source].keys()
 265         versions.sort(apt_pkg.VersionCompare)
 266         for version in versions:
 267             packages = dubious_nbs[source][version].keys()
 268             packages.sort()
 269             print "        o %s: %s" % (version, ", ".join(packages))
 270
 271         print
 272
 273 ################################################################################
 274
 275 def obsolete_source(suite_name, session):
 276     """returns obsolete source packages for suite_name without binaries
 277     in the same suite sorted by install_date; install_date should help
 278     detecting source only (or binary throw away) uploads; duplicates in
 279     the suite are skipped
 280
 281     subquery 'source_suite_unique' returns source package names from
 282     suite without duplicates; the rationale behind is that neither
 283     cruft-report nor rm cannot handle duplicates (yet)"""
 284
 285     query = """
 286 WITH source_suite_unique AS
 287     (SELECT source, suite
 288         FROM source_suite GROUP BY source, suite HAVING count(*) = 1)
 289 SELECT ss.src, ss.source, ss.version,
 290     to_char(ss.install_date, 'YYYY-MM-DD') AS install_date
 291     FROM source_suite ss
 292     JOIN source_suite_unique ssu
 293         ON ss.source = ssu.source AND ss.suite = ssu.suite
 294     JOIN suite s ON s.id = ss.suite
 295     LEFT JOIN bin_associations_binaries bab
 296         ON ss.src = bab.source AND ss.suite = bab.suite
 297     WHERE s.suite_name = :suite_name AND bab.id IS NULL
 298     ORDER BY install_date"""
 299     args = { 'suite_name': suite_name }
 300     return session.execute(query, args)
 301
 302 def source_bin(source, session):
 303     """returns binaries built by source for all or no suite grouped and
 304     ordered by package name"""
 305
 306     query = """
 307 SELECT b.package
 308     FROM binaries b
 309     JOIN src_associations_src sas ON b.source = sas.src
 310     WHERE sas.source = :source
 311     GROUP BY b.package
 312     ORDER BY b.package"""
 313     args = { 'source': source }
 314     return session.execute(query, args)
 315
 316 def newest_source_bab(suite_name, package, session):
 317     """returns newest source that builds binary package in suite grouped
 318     and sorted by source and package name"""
 319
 320     query = """
 321 SELECT sas.source, MAX(sas.version) AS srcver
 322     FROM src_associations_src sas
 323     JOIN bin_associations_binaries bab ON sas.src = bab.source
 324     JOIN suite s on s.id = bab.suite
 325     WHERE s.suite_name = :suite_name AND bab.package = :package
 326         GROUP BY sas.source, bab.package
 327         ORDER BY sas.source, bab.package"""
 328     args = { 'suite_name': suite_name, 'package': package }
 329     return session.execute(query, args)
 330
 331 def report_obsolete_source(suite_name, session):
 332     rows = obsolete_source(suite_name, session)
 333     if rows.rowcount == 0:
 334         return
 335     print \
 336 """Obsolete source packages in suite %s
 337 ----------------------------------%s\n""" % \
 338         (suite_name, '-' * len(suite_name))
 339     for os_row in rows.fetchall():
 340         (src, old_source, version, install_date) = os_row
 341         print " * obsolete source %s version %s installed at %s" % \
 342             (old_source, version, install_date)
 343         for sb_row in source_bin(old_source, session):
 344             (package, ) = sb_row
 345             print "   - has built binary %s" % package
 346             for nsb_row in newest_source_bab(suite_name, package, session):
 347                 (new_source, srcver) = nsb_row
 348                 print "     currently built by source %s version %s" % \
 349                     (new_source, srcver)
 350         print "   - suggested command:"
 351         rm_opts = "-S -p -m \"[auto-cruft] obsolete source package\""
 352         print "     dak rm -s %s %s %s\n" % (suite_name, rm_opts, old_source)
 353
 354 def get_suite_binaries(suite, session):
 355     # Initalize a large hash table of all binary packages
 356     binaries = {}
 357
 358     print "Getting a list of binary packages in %s..." % suite.suite_name
 359     q = session.execute("""SELECT distinct b.package
 360                              FROM binaries b, bin_associations ba
 361                             WHERE ba.suite = :suiteid AND ba.bin = b.id""",
 362                            {'suiteid': suite.suite_id})
 363     for i in q.fetchall():
 364         binaries[i[0]] = ""
 365
 366     return binaries
 367
 368 ################################################################################
 369
 370 def main ():
 371     global suite, suite_id, source_binaries, source_versions
 372
 373     cnf = Config()
 374
 375     Arguments = [('h',"help","Cruft-Report::Options::Help"),
 376                  ('m',"mode","Cruft-Report::Options::Mode", "HasArg"),
 377                  ('s',"suite","Cruft-Report::Options::Suite","HasArg"),
 378                  ('w',"wanna-build-dump","Cruft-Report::Options::Wanna-Build-Dump","HasArg")]
 379     for i in [ "help" ]:
 380         if not cnf.has_key("Cruft-Report::Options::%s" % (i)):
 381             cnf["Cruft-Report::Options::%s" % (i)] = ""
 382     cnf["Cruft-Report::Options::Suite"] = cnf["Dinstall::DefaultSuite"]
 383
 384     if not cnf.has_key("Cruft-Report::Options::Mode"):
 385         cnf["Cruft-Report::Options::Mode"] = "daily"
 386
 387     if not cnf.has_key("Cruft-Report::Options::Wanna-Build-Dump"):
 388         cnf["Cruft-Report::Options::Wanna-Build-Dump"] = "/srv/ftp.debian.org/scripts/nfu"
 389
 390     apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
 391
 392     Options = cnf.SubTree("Cruft-Report::Options")
 393     if Options["Help"]:
 394         usage()
 395
 396     # Set up checks based on mode
 397     if Options["Mode"] == "daily":
 398         checks = [ "nbs", "nviu", "nvit", "obsolete source" ]
 399     elif Options["Mode"] == "full":
 400         checks = [ "nbs", "nviu", "nvit", "obsolete source", "nfu", "dubious nbs", "bnb", "bms", "anais" ]
 401     else:
 402         utils.warn("%s is not a recognised mode - only 'full' or 'daily' are understood." % (Options["Mode"]))
 403         usage(1)
 404
 405     session = DBConn().session()
 406
 407     bin_pkgs = {}
 408     src_pkgs = {}
 409     bin2source = {}
 410     bins_in_suite = {}
 411     nbs = {}
 412     source_versions = {}
 413
 414     anais_output = ""
 415     duplicate_bins = {}
 416
 417     nfu_packages = {}
 418
 419     suite = get_suite(Options["Suite"].lower(), session)
 420     suite_id = suite.suite_id
 421     suite_name = suite.suite_name.lower()
 422
 423     if "obsolete source" in checks:
 424         report_obsolete_source(suite_name, session)
 425
 426     bin_not_built = {}
 427
 428     if "bnb" in checks:
 429         bins_in_suite = get_suite_binaries(suite, session)
 430
 431     # Checks based on the Sources files
 432     components = cnf.ValueList("Suite::%s::Components" % (suite_name))
 433     for component in components:
 434         filename = "%s/dists/%s/%s/source/Sources.gz" % (cnf["Dir::Root"], suite_name, component)
 435         # apt_pkg.ParseTagFile needs a real file handle and can't handle a GzipFile instance...
 436         (fd, temp_filename) = utils.temp_filename()
 437         (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
 438         if (result != 0):
 439             sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
 440             sys.exit(result)
 441         sources = utils.open_file(temp_filename)
 442         Sources = apt_pkg.ParseTagFile(sources)
 443         while Sources.Step():
 444             source = Sources.Section.Find('Package')
 445             source_version = Sources.Section.Find('Version')
 446             architecture = Sources.Section.Find('Architecture')
 447             binaries = Sources.Section.Find('Binary')
 448             binaries_list = [ i.strip() for i in  binaries.split(',') ]
 449
 450             if "bnb" in checks:
 451                 # Check for binaries not built on any architecture.
 452                 for binary in binaries_list:
 453                     if not bins_in_suite.has_key(binary):
 454                         bin_not_built.setdefault(source, {})
 455                         bin_not_built[source][binary] = ""
 456
 457             if "anais" in checks:
 458                 anais_output += do_anais(architecture, binaries_list, source, session)
 459
 460             # Check for duplicated packages and build indices for checking "no source" later
 461             source_index = component + '/' + source
 462             #if src_pkgs.has_key(source):
 463             #    print " %s is a duplicated source package (%s and %s)" % (source, source_index, src_pkgs[source])
 464             src_pkgs[source] = source_index
 465             for binary in binaries_list:
 466                 if bin_pkgs.has_key(binary):
 467                     key_list = [ source, bin_pkgs[binary] ]
 468                     key_list.sort()
 469                     key = '_'.join(key_list)
 470                     duplicate_bins.setdefault(key, [])
 471                     duplicate_bins[key].append(binary)
 472                 bin_pkgs[binary] = source
 473             source_binaries[source] = binaries
 474             source_versions[source] = source_version
 475
 476         sources.close()
 477         os.unlink(temp_filename)
 478
 479     # Checks based on the Packages files
 480     check_components = components[:]
 481     if suite_name != "experimental":
 482         check_components.append('main/debian-installer');
 483
 484     for component in check_components:
 485         architectures = [ a.arch_string for a in get_suite_architectures(suite_name,
 486                                                                          skipsrc=True, skipall=True,
 487                                                                          session=session) ]
 488         for architecture in architectures:
 489             if component == 'main/debian-installer' and re.match("kfreebsd", architecture):
 490                 continue
 491             filename = "%s/dists/%s/%s/binary-%s/Packages.gz" % (cnf["Dir::Root"], suite_name, component, architecture)
 492             # apt_pkg.ParseTagFile needs a real file handle
 493             (fd, temp_filename) = utils.temp_filename()
 494             (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
 495             if (result != 0):
 496                 sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
 497                 sys.exit(result)
 498
 499             if "nfu" in checks:
 500                 nfu_packages.setdefault(architecture,[])
 501                 nfu_entries = parse_nfu(architecture)
 502
 503             packages = utils.open_file(temp_filename)
 504             Packages = apt_pkg.ParseTagFile(packages)
 505             while Packages.Step():
 506                 package = Packages.Section.Find('Package')
 507                 source = Packages.Section.Find('Source', "")
 508                 version = Packages.Section.Find('Version')
 509                 if source == "":
 510                     source = package
 511                 if bin2source.has_key(package) and \
 512                        apt_pkg.VersionCompare(version, bin2source[package]["version"]) > 0:
 513                     bin2source[package]["version"] = version
 514                     bin2source[package]["source"] = source
 515                 else:
 516                     bin2source[package] = {}
 517                     bin2source[package]["version"] = version
 518                     bin2source[package]["source"] = source
 519                 if source.find("(") != -1:
 520                     m = re_extract_src_version.match(source)
 521                     source = m.group(1)
 522                     version = m.group(2)
 523                 if not bin_pkgs.has_key(package):
 524                     nbs.setdefault(source,{})
 525                     nbs[source].setdefault(package, {})
 526                     nbs[source][package][version] = ""
 527                 else:
 528                     previous_source = bin_pkgs[package]
 529                     if previous_source != source:
 530                         key_list = [ source, previous_source ]
 531                         key_list.sort()
 532                         key = '_'.join(key_list)
 533                         duplicate_bins.setdefault(key, [])
 534                         if package not in duplicate_bins[key]:
 535                             duplicate_bins[key].append(package)
 536                     if "nfu" in checks:
 537                         if package in nfu_entries and \
 538                                version != source_versions[source]: # only suggest to remove out-of-date packages
 539                             nfu_packages[architecture].append((package,version,source_versions[source]))
 540
 541             packages.close()
 542             os.unlink(temp_filename)
 543
 544     # Distinguish dubious (version numbers match) and 'real' NBS (they don't)
 545     dubious_nbs = {}
 546     real_nbs = {}
 547     for source in nbs.keys():
 548         for package in nbs[source].keys():
 549             versions = nbs[source][package].keys()
 550             versions.sort(apt_pkg.VersionCompare)
 551             latest_version = versions.pop()
 552             source_version = source_versions.get(source,"0")
 553             if apt_pkg.VersionCompare(latest_version, source_version) == 0:
 554                 add_nbs(dubious_nbs, source, latest_version, package, suite_id, session)
 555             else:
 556                 add_nbs(real_nbs, source, latest_version, package, suite_id, session)
 557
 558     if "nviu" in checks:
 559         do_newer_version('unstable', 'experimental', 'NVIU', session)
 560
 561     if "nvit" in checks:
 562         do_newer_version('testing', 'testing-proposed-updates', 'NVIT', session)
 563
 564     if "nbs" in checks:
 565         do_nbs(real_nbs)
 566
 567     ###
 568
 569     if Options["Mode"] == "full":
 570         print "="*75
 571         print
 572
 573     if "nfu" in checks:
 574         do_nfu(nfu_packages)
 575
 576     if "bnb" in checks:
 577         print "Unbuilt binary packages"
 578         print "-----------------------"
 579         print
 580         keys = bin_not_built.keys()
 581         keys.sort()
 582         for source in keys:
 583             binaries = bin_not_built[source].keys()
 584             binaries.sort()
 585             print " o %s: %s" % (source, ", ".join(binaries))
 586         print
 587
 588     if "bms" in checks:
 589         print "Built from multiple source packages"
 590         print "-----------------------------------"
 591         print
 592         keys = duplicate_bins.keys()
 593         keys.sort()
 594         for key in keys:
 595             (source_a, source_b) = key.split("_")
 596             print " o %s & %s => %s" % (source_a, source_b, ", ".join(duplicate_bins[key]))
 597         print
 598
 599     if "anais" in checks:
 600         print "Architecture Not Allowed In Source"
 601         print "----------------------------------"
 602         print anais_output
 603         print
 604
 605     if "dubious nbs" in checks:
 606         do_dubious_nbs(dubious_nbs)
 607
 608
 609 ################################################################################
 610
 611 if __name__ == '__main__':
 612     main()