X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=dak%2Ftransitions.py;h=9c4e7d8bc7e97010b23d0dc1b21f349e723f2c93;hb=1c35448b880358d020e81339657e3435fdda9434;hp=7a0da2e11dd5cc50cada96b75ba83e9898045aaa;hpb=020f423243aaeab5ede2313b274131067386213f;p=dak.git diff --git a/dak/transitions.py b/dak/transitions.py index 7a0da2e1..9c4e7d8b 100755 --- a/dak/transitions.py +++ b/dak/transitions.py @@ -1,7 +1,12 @@ #!/usr/bin/env python -# Display, edit and check the release manager's transition file. -# Copyright (C) 2008 Joerg Jaspert +""" +Display, edit and check the release manager's transition file. + +@contact: Debian FTP Master +@copyright: 2008 Joerg Jaspert +@license: GNU General Public License version 2 or later +""" # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -23,18 +28,24 @@ ################################################################################ -import os, pg, sys, time, errno, fcntl, tempfile, pwd, re +import os +import sys +import time +import errno +import fcntl +import tempfile +import pwd import apt_pkg -import daklib.database as database -import daklib.utils as utils -import syck -# Globals -Cnf = None -Options = None -projectB = None +from daklib.dbconn import * +from daklib import utils +from daklib.dak_exceptions import TransitionsError +from daklib.regexes import re_broken_package +import yaml -re_broken_package = re.compile(r"[a-zA-Z]\w+\s+\-.*") +# Globals +Cnf = None #: Configuration, apt_pkg.Configuration +Options = None #: Parsed CommandLine arguments ################################################################################ @@ -42,20 +53,27 @@ re_broken_package = re.compile(r"[a-zA-Z]\w+\s+\-.*") #### This may run within sudo !! #### ##################################### def init(): - global Cnf, Options, projectB + """ + Initialize. Sets up database connection, parses commandline arguments. + + @attention: This function may run B{within sudo} + + """ + global Cnf, Options apt_pkg.init() Cnf = utils.get_conf() - Arguments = [('h',"help","Edit-Transitions::Options::Help"), + Arguments = [('a',"automatic","Edit-Transitions::Options::Automatic"), + ('h',"help","Edit-Transitions::Options::Help"), ('e',"edit","Edit-Transitions::Options::Edit"), ('i',"import","Edit-Transitions::Options::Import", "HasArg"), ('c',"check","Edit-Transitions::Options::Check"), ('s',"sudo","Edit-Transitions::Options::Sudo"), ('n',"no-action","Edit-Transitions::Options::No-Action")] - for i in ["help", "no-action", "edit", "import", "check", "sudo"]: + for i in ["automatic", "help", "no-action", "edit", "import", "check", "sudo"]: if not Cnf.has_key("Edit-Transitions::Options::%s" % (i)): Cnf["Edit-Transitions::Options::%s" % (i)] = "" @@ -66,15 +84,13 @@ def init(): if Options["help"]: usage() - whoami = os.getuid() - whoamifull = pwd.getpwuid(whoami) - username = whoamifull[0] + username = utils.getusername() if username != "dak": print "Non-dak user: %s" % username Options["sudo"] = "y" - projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"])) - database.init(Cnf, projectB) + # Initialise DB connection + DBConn() ################################################################################ @@ -89,6 +105,7 @@ Options: -i, --import check and import transitions from file -c, --check check the transitions file, remove outdated entries -S, --sudo use sudo to update transitions file + -a, --automatic don't prompt (only affects check). -n, --no-action don't do anything (only affects check)""" sys.exit(exit_code) @@ -99,15 +116,29 @@ Options: #### This may run within sudo !! #### ##################################### def load_transitions(trans_file): + """ + Parse a transition yaml file and check it for validity. + + @attention: This function may run B{within sudo} + + @type trans_file: string + @param trans_file: filename to parse + + @rtype: dict or None + @return: validated dictionary of transition entries or None + if validation fails, empty string if reading C{trans_file} + returned something else than a dict + + """ # Parse the yaml file sourcefile = file(trans_file, 'r') sourcecontent = sourcefile.read() failure = False try: - trans = syck.load(sourcecontent) - except syck.error, msg: + trans = yaml.load(sourcecontent) + except yaml.YAMLError, exc: # Someone fucked it up - print "ERROR: %s" % (msg) + print "ERROR: %s" % (exc) return None # lets do further validation here @@ -184,6 +215,12 @@ def load_transitions(trans_file): #### This may run within sudo !! #### ##################################### def lock_file(f): + """ + Lock a file + + @attention: This function may run B{within sudo} + + """ for retry in range(10): lock_fd = os.open(f, os.O_RDWR | os.O_CREAT) try: @@ -205,11 +242,19 @@ def lock_file(f): #### This may run within sudo !! #### ##################################### def write_transitions(from_trans): - """Update the active transitions file safely. - This function takes a parsed input file (which avoids invalid - files or files that may be be modified while the function is - active), and ensure the transitions file is updated atomically - to avoid locks.""" + """ + Update the active transitions file safely. + This function takes a parsed input file (which avoids invalid + files or files that may be be modified while the function is + active) and ensure the transitions file is updated atomically + to avoid locks. + + @attention: This function may run B{within sudo} + + @type from_trans: dict + @param from_trans: transitions dictionary, as returned by L{load_transitions} + + """ trans_file = Cnf["Dinstall::Reject::ReleaseTransitions"] trans_temp = trans_file + ".tmp" @@ -218,7 +263,7 @@ def write_transitions(from_trans): temp_lock = lock_file(trans_temp) destfile = file(trans_temp, 'w') - syck.dump(from_trans, destfile) + yaml.dump(from_trans, destfile, default_flow_style=False) destfile.close() os.rename(trans_temp, trans_file) @@ -227,15 +272,20 @@ def write_transitions(from_trans): ################################################################################ -class ParseException(Exception): - pass - ########################################## #### This usually runs within sudo !! #### ########################################## def write_transitions_from_file(from_file): - """We have a file we think is valid; if we're using sudo, we invoke it - here, otherwise we just parse the file and call write_transitions""" + """ + We have a file we think is valid; if we're using sudo, we invoke it + here, otherwise we just parse the file and call write_transitions + + @attention: This function usually runs B{within sudo} + + @type from_file: filename + @param from_file: filename of a transitions file + + """ # Lets check if from_file is in the directory we expect it to be in if not os.path.abspath(from_file).startswith(Cnf["Transitions::TempPath"]): @@ -248,25 +298,37 @@ def write_transitions_from_file(from_file): else: trans = load_transitions(from_file) if trans is None: - raise ParseException, "Unparsable transitions file %s" % (file) + raise TransitionsError, "Unparsable transitions file %s" % (file) write_transitions(trans) ################################################################################ def temp_transitions_file(transitions): - # NB: file is unlinked by caller, but fd is never actually closed. - # We need the chmod, as the file is (most possibly) copied from a - # sudo-ed script and would be unreadable if it has default mkstemp mode + """ + Open a temporary file and dump the current transitions into it, so users + can edit them. + + @type transitions: dict + @param transitions: current defined transitions + + @rtype: string + @return: path of newly created tempfile + + @note: NB: file is unlinked by caller, but fd is never actually closed. + We need the chmod, as the file is (most possibly) copied from a + sudo-ed script and would be unreadable if it has default mkstemp mode + """ (fd, path) = tempfile.mkstemp("", "transitions", Cnf["Transitions::TempPath"]) os.chmod(path, 0644) f = open(path, "w") - syck.dump(transitions, f) + yaml.dump(transitions, f, default_flow_style=False) return path ################################################################################ def edit_transitions(): + """ Edit the defined transitions. """ trans_file = Cnf["Dinstall::Reject::ReleaseTransitions"] edit_file = temp_transitions_file(load_transitions(trans_file)) @@ -324,23 +386,36 @@ def edit_transitions(): ################################################################################ def check_transitions(transitions): + """ + Check if the defined transitions still apply and remove those that no longer do. + @note: Asks the user for confirmation first unless -a has been set. + + """ + global Cnf + to_dump = 0 to_remove = [] + info = {} + + session = DBConn().session() + # Now look through all defined transitions for trans in transitions: t = transitions[trans] source = t["source"] expected = t["new"] - # Will be None if nothing is in testing. - current = database.get_suite_version(source, "testing") + # Will be an empty list if nothing is in testing. + sources = get_source_in_suite(source, "testing", session) - print_info(trans, source, expected, t["rm"], t["reason"], t["packages"]) + info[trans] = get_info(trans, source, expected, t["rm"], t["reason"], t["packages"]) + print info[trans] - if current == None: + if len(sources) < 1: # No package in testing print "Transition source %s not in testing, transition still ongoing." % (source) else: + current = sources[0].version compare = apt_pkg.VersionCompare(current, expected) if compare < 0: # This is still valid, the current version in database is older than @@ -364,6 +439,8 @@ def check_transitions(transitions): if Options["no-action"]: answer="n" + elif Options["automatic"]: + answer="y" else: answer = utils.our_raw_input(prompt).lower() @@ -375,9 +452,26 @@ def check_transitions(transitions): sys.exit(0) elif answer == 'y': print "Committing" - for remove in to_remove: + subst = {} + subst['__SUBJECT__'] = "Transitions completed: " + ", ".join(sorted(to_remove)) + subst['__TRANSITION_MESSAGE__'] = "The following transitions were removed:\n" + for remove in sorted(to_remove): + subst['__TRANSITION_MESSAGE__'] += info[remove] + '\n' del transitions[remove] + # If we have a mail address configured for transitions, + # send a notification + subst['__TRANSITION_EMAIL__'] = Cnf.get("Transitions::Notifications", "") + if subst['__TRANSITION_EMAIL__'] != "": + print "Sending notification to %s" % subst['__TRANSITION_EMAIL__'] + subst['__DAK_ADDRESS__'] = Cnf["Dinstall::MyEmailAddress"] + subst['__BCC__'] = 'X-DAK: dak transitions' + if Cnf.has_key("Dinstall::Bcc"): + subst["__BCC__"] += '\nBcc: %s' % Cnf["Dinstall::Bcc"] + message = utils.TemplateSubst(subst, + os.path.join(Cnf["Dir::Templates"], 'transition.removed')) + utils.send_mail(message) + edit_file = temp_transitions_file(transitions) write_transitions_from_file(edit_file) @@ -388,33 +482,63 @@ def check_transitions(transitions): ################################################################################ -def print_info(trans, source, expected, rm, reason, packages): - print """Looking at transition: %s +def get_info(trans, source, expected, rm, reason, packages): + """ + Print information about a single transition. + + @type trans: string + @param trans: Transition name + + @type source: string + @param source: Source package + + @type expected: string + @param expected: Expected version in testing + + @type rm: string + @param rm: Responsible RM + + @type reason: string + @param reason: Reason + + @type packages: list + @param packages: list of blocked packages + + """ + return """Looking at transition: %s Source: %s New Version: %s Responsible: %s Description: %s Blocked Packages (total: %d): %s """ % (trans, source, expected, rm, reason, len(packages), ", ".join(packages)) - return ################################################################################ def transition_info(transitions): + """ + Print information about all defined transitions. + Calls L{get_info} for every transition and then tells user if the transition is + still ongoing or if the expected version already hit testing. + + @type transitions: dict + @param transitions: defined transitions + """ for trans in transitions: t = transitions[trans] source = t["source"] expected = t["new"] - # Will be None if nothing is in testing. - current = database.get_suite_version(source, "testing") + # Will be empty list if nothing is in testing. + sources = get_suite_version(source, "testing") - print_info(trans, source, expected, t["rm"], t["reason"], t["packages"]) + print get_info(trans, source, expected, t["rm"], t["reason"], t["packages"]) - if current == None: + if len(sources) < 1: # No package in testing print "Transition source %s not in testing, transition still ongoing." % (source) else: + current = sources[0].version compare = apt_pkg.VersionCompare(current, expected) print "Apt compare says: %s" % (compare) if compare < 0: @@ -429,6 +553,12 @@ def transition_info(transitions): ################################################################################ def main(): + """ + Prepare the work to be done, do basic checks. + + @attention: This function may run B{within sudo} + + """ global Cnf ##################################### @@ -458,7 +588,7 @@ def main(): if Options["import"]: try: write_transitions_from_file(Options["import"]) - except ParseException, m: + except TransitionsError, m: print m sys.exit(2) sys.exit(0)