Clush.py: display full tree in debug mode only

When tree mode is enabled and in verbose mode, clush will now display
"enabling tree topology" (one line) with the number of gateways
available in the topology (from the current root node).
In debug mode, a dump of the full tree is also printed.

Closes #315.

Change-Id: I6f079c9e5a0ec25d914aae2c22bc36f926cb88c5

Author: thiell

doc/sphinx/tools/clush.rst

@@ -156,7 +156,8 @@ This file defines the following topology graph::
 
 
 At runtime, ClusterShell will pick an initial propagation tree from this
-topology graph definition.
+topology graph definition and the current root node. Multiple admin/root
+nodes may be defined in the file.
 
 .. note:: The algorithm used in Tree mode does not rely on gateway system
    hostnames anymore. In topology.conf, just use the hosts or aliases needed
@@ -173,7 +174,7 @@ file is present. When the configuration file
 target nodes that are defined there. The topology file path can be changed
 using the ``--topology`` command line option.
 
-.. note:: If using ``clush -v`` (verbose option), clush will display an ASCII
+.. note:: If using ``clush -d`` (debug option), clush will display an ASCII
    representation of the initial propagation tree used. This is useful when
    working on Tree mode configuration.
 

lib/ClusterShell/CLI/Clush.py

@@ -974,15 +974,19 @@ def main():
             clush_exit(1, task)
 
     if options.topofile or task._default_tree_is_enabled():
-        if config.verbosity >= VERB_VERB:
-            print Display.COLOR_RESULT_FMT % "TREE MODE enabled"
         if options.topofile:
             task.load_topology(options.topofile)
+        if config.verbosity >= VERB_VERB:
+            roots = len(task.topology.root.nodeset)
+            gws = task.topology.inner_node_count() - roots
+            msg = "enabling tree topology (%d gateways)" % gws
+            print >> sys.stderr, "clush: %s" % msg
 
     if options.grooming_delay:
         if config.verbosity >= VERB_VERB:
-            print Display.COLOR_RESULT_FMT % ("Grooming delay: %f"
-                                              % options.grooming_delay)
+            msg = Display.COLOR_RESULT_FMT % ("Grooming delay: %f" %
+                                              options.grooming_delay)
+            print >> sys.stderr, msg
         task.set_info("grooming_delay", options.grooming_delay)
     elif options.rcopy:
         # By default, --rcopy should inhibit grooming
@@ -1050,7 +1054,7 @@ def main():
                                                 config.command_timeout,
                                                 op))
     if not task.default("USER_interactive"):
-        if display.verbosity >= VERB_VERB and task.topology:
+        if display.verbosity >= VERB_DEBUG and task.topology:
             print Display.COLOR_RESULT_FMT % '-' * 15
             print Display.COLOR_RESULT_FMT % task.topology,
             print Display.COLOR_RESULT_FMT % '-' * 15

lib/ClusterShell/Topology.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright CEA/DAM/DIF (2010-2015)
+# Copyright CEA/DAM/DIF (2010-2016)
 #  Contributor: Henri DOREAU <[email protected]>
 #  Contributor: Stephane THIELL <[email protected]>
 #
@@ -220,6 +220,15 @@ def find_nodegroup(self, node):
                 return group
         raise TopologyError('TopologyNodeGroup not found for node %s' % node)
 
+    def inner_node_count(self):
+        """helper to get inner node count (root and gateway nodes)"""
+        return sum(len(group.nodeset) for group in self.groups
+                                      if group.children_len() > 0)
+
+    def leaf_node_count(self):
+        """helper to get leaf node count"""
+        return sum(len(group.nodeset) for group in self.groups
+                                      if group.children_len() == 0)
 
 class TopologyRoute(object):
     """A single route between two nodesets"""

tests/TreeTopologyTest.py

@@ -190,7 +190,10 @@ def testMultipleAdminGroups(self):
 
         ns_all = NodeSet('admin2,nodes[2-3,20-29]')
         ns_tree = NodeSet()
-        for nodegroup in parser.tree('admin2'):
+        tree = parser.tree('admin2')
+        self.assertEqual(tree.inner_node_count(), 3)
+        self.assertEqual(tree.leaf_node_count(), 10)
+        for nodegroup in tree:
            ns_tree.add(nodegroup.nodeset)
         self.assertEqual(str(ns_all), str(ns_tree))
 
@@ -304,7 +307,10 @@ def testConfigurationLongSyntax(self):
 
         ns_all = NodeSet('admin,proxy,STA[0-1],STB[0-3],nodes[0-10]')
         ns_tree = NodeSet()
-        for nodegroup in parser.tree('admin'):
+        tree = parser.tree('admin')
+        self.assertEqual(tree.inner_node_count(), 8)
+        self.assertEqual(tree.leaf_node_count(), 11)
+        for nodegroup in tree:
            ns_tree.add(nodegroup.nodeset)
         self.assertEqual(str(ns_all), str(ns_tree))
 
@@ -325,7 +331,10 @@ def testConfigurationParserDeepTree(self):
 
         ns_all = NodeSet('admin,nodes[0-159]')
         ns_tree = NodeSet()
-        for nodegroup in parser.tree('admin'):
+        tree = parser.tree('admin')
+        self.assertEqual(tree.inner_node_count(), 151)
+        self.assertEqual(tree.leaf_node_count(), 10)
+        for nodegroup in tree:
            ns_tree.add(nodegroup.nodeset)
         self.assertEqual(str(ns_all), str(ns_tree))
 
@@ -343,7 +352,10 @@ def testConfigurationParserBigTree(self):
 
         ns_all = NodeSet('admin,ST[0-4],STA[0-49],nodes[0-10000]')
         ns_tree = NodeSet()
-        for nodegroup in parser.tree('admin'):
+        tree = parser.tree('admin')
+        self.assertEqual(tree.inner_node_count(), 56)
+        self.assertEqual(tree.leaf_node_count(), 10001)
+        for nodegroup in tree:
            ns_tree.add(nodegroup.nodeset)
         self.assertEqual(str(ns_all), str(ns_tree))