samba-mirror/python/samba/kcc/graph_utils.py

# Graph topology utilities, used by KCC
#
# Copyright (C) Andrew Bartlett 2015
#
# Copyright goes to Andrew Bartlett, but the actual work was performed
# by Douglas Bagnall and Garming Sam.
#
# 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
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import os
import itertools

from samba.kcc.debug import null_debug, PURPLE, MAGENTA, DARK_YELLOW, RED
from samba.kcc.debug import DARK_GREEN, C_NORMAL, GREY


def write_dot_file(basename, edge_list, vertices=None, label=None,
                   dot_file_dir=None, reformat_labels=True, directed=False,
                   debug=None, edge_colors=None, edge_labels=None,
                   vertex_colors=None):
    if label:
        # sanitise DN and guid labels
        basename += '_' + label.translate(None, ', ')

    f = open(os.path.join(dot_file_dir, "%s.dot" % basename), 'w')

    if debug is not None:
        debug(f.name)
    graphname = ''.join(x for x in basename if x.isalnum())
    print >>f, '%s %s {' % ('digraph' if directed else 'graph', graphname)
    print >>f, 'label="%s";\nfontsize=20;' % (label or graphname)
    if vertices:
        for i, v in enumerate(vertices):
            if reformat_labels:
                v = v.replace(',', '\\n')
            vc = ('color="%s"' % vertex_colors[i]) if vertex_colors else ''
            print >>f, '"%s" [%s];' % (v, vc)

    for i, edge in enumerate(edge_list):
        a, b = edge
        if reformat_labels:
            a = a.replace(',', '\\n')
            b = b.replace(',', '\\n')
        line = '->' if directed else '--'
        el = ('label="%s"' % edge_labels[i]) if edge_labels else ''
        ec = ('color="%s"' % edge_colors[i]) if edge_colors else ''
        print >>f, '"%s" %s "%s" [%s %s];' % (a, line, b, el, ec)
    print >>f, '}'
    f.close()


class GraphError(Exception):
    pass


def verify_graph_complete(edges, vertices, edge_vertices):
    """The graph is complete, which is to say there is an edge between
    every pair of nodes."""
    for v in vertices:
        remotes = set()
        for a, b in edges:
            if a == v:
                remotes.add(b)
            elif b == v:
                remotes.add(a)
        if len(remotes) + 1 != len(vertices):
            raise GraphError("graph is not fully connected")


def verify_graph_connected(edges, vertices, edge_vertices):
    """There is a path between any two nodes."""
    if not edges:
        if len(vertices) <= 1:
            return
        raise GraphError("disconnected vertices were found:\n"
                         "vertices: %s\n edges: %s" %
                         (sorted(vertices), sorted(edges)))

    remaining_edges = list(edges)
    reached = set(remaining_edges.pop())
    while True:
        doomed = []
        for i, e in enumerate(remaining_edges):
            a, b = e
            if a in reached:
                reached.add(b)
                doomed.append(i)
            elif b in reached:
                reached.add(a)
                doomed.append(i)
        if not doomed:
            break
        for i in reversed(doomed):
            del remaining_edges[i]

    if remaining_edges or reached != set(vertices):
        raise GraphError("graph is not connected:\n vertices: %s\n edges: %s\n"
                         " reached: %s\n remaining edges: %s" %
                         (sorted(vertices), sorted(edges),
                          sorted(reached), sorted(remaining_edges)))


def verify_graph_connected_under_edge_failures(edges, vertices, edge_vertices):
    """The graph stays connected when any single edge is removed."""
    for subset in itertools.combinations(edges, len(edges) - 1):
        verify_graph_connected(subset, vertices, edge_vertices)


def verify_graph_connected_under_vertex_failures(edges, vertices,
                                                 edge_vertices):
    """The graph stays connected when any single vertex is removed."""
    for v in vertices:
        sub_vertices = [x for x in vertices if x is not v]
        sub_edges = [x for x in edges if v not in x]
        verify_graph_connected(sub_edges, sub_vertices, sub_vertices)


def verify_graph_forest(edges, vertices, edge_vertices):
    """The graph contains no loops. A forest that is also connected is a
    tree."""
    trees = [set(e) for e in edges]
    while True:
        for a, b in itertools.combinations(trees, 2):
            intersection = a & b
            if intersection:
                if len(intersection) == 1:
                    a |= b
                    trees.remove(b)
                    break
                else:
                    raise GraphError("there is a loop in the graph\n"
                                     " vertices %s\n edges %s\n"
                                     " intersection %s" %
                                     (vertices, edges, intersection))
        else:
            # no break in itertools.combinations loop means no
            # further mergers, so we're done.
            #
            # XXX here we also know whether it is a tree or a
            # forest by len(trees) but the connected test already
            # tells us that.
            return


def verify_graph_multi_edge_forest(edges, vertices, edge_vertices):
    """This allows a forest with duplicate edges. That is if multiple
    edges go between the same two vertices, they are treated as a
    single edge by this test.

    e.g.:
                        o
    pass: o-o=o  o=o   (|)             fail:  o-o
            `o          o                     `o'
    """
    unique_edges = set(edges)
    trees = [set(e) for e in unique_edges]
    while True:
        for a, b in itertools.combinations(trees, 2):
            intersection = a & b
            if intersection:
                if len(intersection) == 1:
                    a |= b
                    trees.remove(b)
                    break
                else:
                    raise GraphError("there is a loop in the graph")
        else:
            return


def verify_graph_no_lonely_vertices(edges, vertices, edge_vertices):
    """There are no vertices without edges."""
    lonely = set(vertices) - set(edge_vertices)
    if lonely:
        raise GraphError("some vertices are not connected:\n%s" %
                         '\n'.join(sorted(lonely)))


def verify_graph_no_unknown_vertices(edges, vertices, edge_vertices):
    """The edge endpoints contain no vertices that are otherwise unknown."""
    unknown = set(edge_vertices) - set(vertices)
    if unknown:
        raise GraphError("some edge vertices are seemingly unknown:\n%s" %
                         '\n'.join(sorted(unknown)))


def verify_graph_directed_double_ring(edges, vertices, edge_vertices):
    """Each node has at least two directed edges leaving it, and two
    arriving. The edges work in pairs that have the same end points
    but point in opposite directions. The pairs form a path that
    touches every vertex and form a loop.

    There might be other connections that *aren't* part of the ring.

    Deciding this for sure is NP-complete (the Hamiltonian path
    problem), but there are some easy failures that can be detected.
    So far we check for:
      - leaf nodes
      - disjoint subgraphs
      - robustness against edge and vertex failure
    """
    # a zero or one node graph is OK with no edges.
    # The two vertex case is special. Use
    # verify_graph_directed_double_ring_or_small() to allow that.
    if not edges and len(vertices) <= 1:
        return
    if len(edges) < 2 * len(vertices):
        raise GraphError("directed double ring requires at least twice "
                         "as many edges as vertices")

    # Reduce the problem space by looking only at bi-directional links.
    half_duplex = set(edges)
    duplex_links = set()
    for edge in edges:
        rev_edge = (edge[1], edge[0])
        if edge in half_duplex and rev_edge in half_duplex:
            duplex_links.add(edge)
            half_duplex.remove(edge)
            half_duplex.remove(rev_edge)

    # the Hamiltonian cycle problem is NP-complete in general, but we
    # can cheat a bit and prove a less strong result.
    #
    # We declutter the graph by replacing nodes with edges connecting
    # their neighbours.
    #
    #       A-B-C --> A-C
    #
    #    -A-B-C-   -->  -A--C-
    #       `D_           `D'_
    #
    # In the end there should be a single 2 vertex graph.

    edge_map = {}
    for a, b in duplex_links:
        edge_map.setdefault(a, set()).add(b)
        edge_map.setdefault(b, set()).add(a)

    # an easy to detect failure is a lonely leaf node
    for vertex, neighbours in edge_map.items():
        if len(neighbours) == 1:
            raise GraphError("wanted double directed ring, found a leaf node"
                             "(%s)" % vertex)

    for vertex in edge_map.keys():
        nset = edge_map[vertex]
        if not nset:
            continue
        for n in nset:
            n_neighbours = edge_map[n]
            n_neighbours.remove(vertex)
            n_neighbours.update(x for x in nset if x != n)
        del edge_map[vertex]

    if len(edge_map) > 1:
        raise GraphError("wanted double directed ring, but "
                         "this looks like a split graph\n"
                         "(%s can't reach each other)" %
                         ', '.join(edge_map.keys()))

    verify_graph_connected_under_edge_failures(duplex_links, vertices,
                                               edge_vertices)
    verify_graph_connected_under_vertex_failures(duplex_links, vertices,
                                                 edge_vertices)


def verify_graph_directed_double_ring_or_small(edges, vertices, edge_vertices):
    """This performs the directed_double_ring test but makes special
    concessions for small rings where the strict rules don't really
    apply."""
    if len(vertices) < 2:
        return
    if len(vertices) == 2:
        """With 2 nodes there should be a single link in each directions."""
        if (len(edges) == 2 and
            edges[0][0] == edges[1][1] and
            edges[0][1] == edges[1][0]):
            return
        raise GraphError("A two vertex graph should have an edge each way.")

    return verify_graph_directed_double_ring(edges, vertices, edge_vertices)


def verify_graph(title, edges, vertices=None, directed=False, properties=(),
                 fatal=True, debug=null_debug):
    errors = []
    debug("%sStarting verify_graph for %s%s%s" % (PURPLE, MAGENTA, title,
                                                  C_NORMAL))

    properties = [x.replace(' ', '_') for x in properties]

    edge_vertices = set()
    for a, b in edges:
        edge_vertices.add(a)
        edge_vertices.add(b)

    if vertices is None:
        vertices = edge_vertices
    else:
        vertices = set(vertices)
        if vertices != edge_vertices:
            debug("vertices in edges don't match given vertices:\n %s != %s" %
                  (sorted(edge_vertices), sorted(vertices)))

    for p in properties:
        fn = 'verify_graph_%s' % p
        try:
            f = globals()[fn]
        except KeyError:
            errors.append((p, "There is no verification check for '%s'" % p))
        try:
            f(edges, vertices, edge_vertices)
            debug(" %s%18s:%s verified!" % (DARK_GREEN, p, C_NORMAL))
        except GraphError, e:
            errors.append((p, e))

    if errors:
        if fatal:
            raise GraphError("The '%s' graph lacks the following properties:"
                             "\n%s" %
                             (title, '\n'.join('%s: %s' % x for x in errors)))
        debug(("%s%s%s FAILED:" % (MAGENTA, title, RED)))
        for p, e in errors:
            debug(" %18s: %s%s%s" % (p, DARK_YELLOW, e, RED))
        debug(C_NORMAL)


def verify_and_dot(basename, edges, vertices=None, label=None,
                   reformat_labels=True, directed=False,
                   properties=(), fatal=True, debug=None,
                   verify=True, dot_file_dir=None,
                   edge_colors=None, edge_labels=None,
                   vertex_colors=None):

    title = '%s %s' % (basename, label or '')
    if verify:
        verify_graph(title, edges, vertices, properties=properties,
                     fatal=fatal, debug=debug)
    if dot_file_dir is not None:
        write_dot_file(basename, edges, vertices=vertices, label=label,
                       dot_file_dir=dot_file_dir,
                       reformat_labels=reformat_labels, directed=directed,
                       debug=debug, edge_colors=edge_colors,
                       edge_labels=edge_labels, vertex_colors=vertex_colors)


def list_verify_tests():
    for k, v in sorted(globals().items()):
        if k.startswith('verify_graph_'):
            print k.replace('verify_graph_', '')
            if v.__doc__:
                print '    %s%s%s' % (GREY, v.__doc__.rstrip(), C_NORMAL)
            else:
                print