hbisect: add functions to return a label for a cset bisection status

Add two new functions that return a string containing the bisection status
of the node passed in parameter:
 - .label(node): return a multi-char string representing the status of node
 - .shortlabel(node): return a single-char string representing the status
   of node, usually the initial of the label

    bisection status    .label()            .shortlabel()
    ----------------------------------------------------------
    good                'good'              'G'
    good (implicit)     'good (implicit)'   'G'
    bad                 'bad'               'B'
    bad (implicit)      'bad (implicit)'    'B'
    skipped             'skip'              'S'
    untested            'untested'          'U'
    ignored             'ignored'           'I'
    (others)            None                None

There is no point in returning 'range' or 'pruned', as these get covered
by another, more meaningful status in the table above.

In case the node is not being bisected, the functions return None to leave
it up to the caller to decide what to print (nothing, an empty space, or
whatever else suits).

Signed-off-by: "Yann E. MORIN" <[e-mail]>

mercurial/hbisect.py

@@ -1,222 +1,251 b''
 # changelog bisection for mercurial
 #
 # Copyright 2007 Matt Mackall
 # Copyright 2005, 2006 Benoit Boissinot <[e-mail]>
 #
 # Inspired by git bisect, extension skeleton taken from mq.py.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import os, error
 from i18n import _
 from node import short, hex
 import util
 
 def bisect(changelog, state):
     """find the next node (if any) for testing during a bisect search.
     returns a (nodes, number, good) tuple.
 
     'nodes' is the final result of the bisect if 'number' is 0.
     Otherwise 'number' indicates the remaining possible candidates for
     the search and 'nodes' contains the next bisect target.
     'good' is True if bisect is searching for a first good changeset, False
     if searching for a first bad one.
     """
 
     clparents = changelog.parentrevs
     skip = set([changelog.rev(n) for n in state['skip']])
 
     def buildancestors(bad, good):
         # only the earliest bad revision matters
         badrev = min([changelog.rev(n) for n in bad])
         goodrevs = [changelog.rev(n) for n in good]
         goodrev = min(goodrevs)
         # build visit array
         ancestors = [None] * (len(changelog) + 1) # an extra for [-1]
 
         # set nodes descended from goodrevs
         for rev in goodrevs:
             ancestors[rev] = []
         for rev in xrange(goodrev + 1, len(changelog)):
             for prev in clparents(rev):
                 if ancestors[prev] == []:
                     ancestors[rev] = []
 
         # clear good revs from array
         for rev in goodrevs:
             ancestors[rev] = None
         for rev in xrange(len(changelog), goodrev, -1):
             if ancestors[rev] is None:
                 for prev in clparents(rev):
                     ancestors[prev] = None
 
         if ancestors[badrev] is None:
             return badrev, None
         return badrev, ancestors
 
     good = False
     badrev, ancestors = buildancestors(state['bad'], state['good'])
     if not ancestors: # looking for bad to good transition?
         good = True
         badrev, ancestors = buildancestors(state['good'], state['bad'])
     bad = changelog.node(badrev)
     if not ancestors: # now we're confused
         if len(state['bad']) == 1 and len(state['good']) == 1:
             raise util.Abort(_("starting revisions are not directly related"))
         raise util.Abort(_("inconsistent state, %s:%s is good and bad")
                          % (badrev, short(bad)))
 
     # build children dict
     children = {}
     visit = [badrev]
     candidates = []
     while visit:
         rev = visit.pop(0)
         if ancestors[rev] == []:
             candidates.append(rev)
             for prev in clparents(rev):
                 if prev != -1:
                     if prev in children:
                         children[prev].append(rev)
                     else:
                         children[prev] = [rev]
                         visit.append(prev)
 
     candidates.sort()
     # have we narrowed it down to one entry?
     # or have all other possible candidates besides 'bad' have been skipped?
     tot = len(candidates)
     unskipped = [c for c in candidates if (c not in skip) and (c != badrev)]
     if tot == 1 or not unskipped:
         return ([changelog.node(rev) for rev in candidates], 0, good)
     perfect = tot // 2
 
     # find the best node to test
     best_rev = None
     best_len = -1
     poison = set()
     for rev in candidates:
         if rev in poison:
             # poison children
             poison.update(children.get(rev, []))
             continue
 
         a = ancestors[rev] or [rev]
         ancestors[rev] = None
 
         x = len(a) # number of ancestors
         y = tot - x # number of non-ancestors
         value = min(x, y) # how good is this test?
         if value > best_len and rev not in skip:
             best_len = value
             best_rev = rev
             if value == perfect: # found a perfect candidate? quit early
                 break
 
         if y < perfect and rev not in skip: # all downhill from here?
             # poison children
             poison.update(children.get(rev, []))
             continue
 
         for c in children.get(rev, []):
             if ancestors[c]:
                 ancestors[c] = list(set(ancestors[c] + a))
             else:
                 ancestors[c] = a + [c]
 
     assert best_rev is not None
     best_node = changelog.node(best_rev)
 
     return ([best_node], tot, good)
 
 
 def load_state(repo):
     state = {'good': [], 'bad': [], 'skip': []}
     if os.path.exists(repo.join("bisect.state")):
         for l in repo.opener("bisect.state"):
             kind, node = l[:-1].split()
             node = repo.lookup(node)
             if kind not in state:
                 raise util.Abort(_("unknown bisect kind %s") % kind)
             state[kind].append(node)
     return state
 
 
 def save_state(repo, state):
     f = repo.opener("bisect.state", "w", atomictemp=True)
     wlock = repo.wlock()
     try:
         for kind in state:
             for node in state[kind]:
                 f.write("%s %s\n" % (kind, hex(node)))
         f.close()
     finally:
         wlock.release()
 
 def get(repo, status):
     """
     Return a list of revision(s) that match the given status:
 
     - ``good``, ``bad``, ``skip``: csets explicitly marked as good/bad/skip
     - ``goods``, ``bads``      : csets topologicaly good/bad
     - ``range``              : csets taking part in the bisection
     - ``pruned``             : csets that are goods, bads or skipped
     - ``untested``           : csets whose fate is yet unknown
     - ``ignored``            : csets ignored due to DAG topology
     """
     state = load_state(repo)
     if status in ('good', 'bad', 'skip'):
         return [repo.changelog.rev(n) for n in state[status]]
     else:
         # In the floowing sets, we do *not* call 'bisect()' with more
         # than one level of recusrsion, because that can be very, very
         # time consuming. Instead, we always develop the expression as
         # much as possible.
 
         # 'range' is all csets that make the bisection:
         #   - have a good ancestor and a bad descendant, or conversely
         # that's because the bisection can go either way
         range = '( bisect(bad)::bisect(good) | bisect(good)::bisect(bad) )'
 
         _t = [c.rev() for c in repo.set('bisect(good)::bisect(bad)')]
         # The sets of topologically good or bad csets
         if len(_t) == 0:
             # Goods are topologically after bads
             goods = 'bisect(good)::'    # Pruned good csets
             bads  = '::bisect(bad)'     # Pruned bad csets
         else:
             # Goods are topologically before bads
             goods = '::bisect(good)'    # Pruned good csets
             bads  = 'bisect(bad)::'     # Pruned bad csets
 
         # 'pruned' is all csets whose fate is already known: good, bad, skip
         skips = 'bisect(skip)'                 # Pruned skipped csets
         pruned = '( (%s) | (%s) | (%s) )' % (goods, bads, skips)
 
         # 'untested' is all cset that are- in 'range', but not in 'pruned'
         untested = '( (%s) - (%s) )' % (range, pruned)
 
         # 'ignored' is all csets that were not used during the bisection
         # due to DAG topology, but may however have had an impact.
         # Eg., a branch merged between bads and goods, but whose branch-
         # point is out-side of the range.
         iba = '::bisect(bad) - ::bisect(good)'  # Ignored bads' ancestors
         iga = '::bisect(good) - ::bisect(bad)'  # Ignored goods' ancestors
         ignored = '( ( (%s) | (%s) ) - (%s) )' % (iba, iga, range)
 
         if status == 'range':
             return [c.rev() for c in repo.set(range)]
         elif status == 'pruned':
             return [c.rev() for c in repo.set(pruned)]
         elif status == 'untested':
             return [c.rev() for c in repo.set(untested)]
         elif status == 'ignored':
             return [c.rev() for c in repo.set(ignored)]
         elif status == "goods":
             return [c.rev() for c in repo.set(goods)]
         elif status == "bads":
             return [c.rev() for c in repo.set(bads)]
 
         else:
             raise error.ParseError(_('invalid bisect state'))
+
+def label(repo, node, short=False):
+    rev = repo.changelog.rev(node)
+
+    # Try explicit sets
+    if rev in get(repo, 'good'):
+        return _('good')
+    if rev in get(repo, 'bad'):
+        return _('bad')
+    if rev in get(repo, 'skip'):
+        return _('skipped')
+    if rev in get(repo, 'untested'):
+        return _('untested')
+    if rev in get(repo, 'ignored'):
+        return _('ignored')
+
+    # Try implicit sets
+    if rev in get(repo, 'goods'):
+        return _('good (implicit)')
+    if rev in get(repo, 'bads'):
+        return _('bad (implicit)')
+
+    return None
+
+def shortlabel(label):
+    if label:
+        return label[0].upper()
+
+    return None