Add '--title' parameter to 'netlab graph' command (#2840)

Also: update test graph topologies and graph generation scripts to
use the new parameter instead of environment variable

Closes #2803

Author: ipspace

docs/netlab/graph.md

@@ -12,8 +12,9 @@ _netlab_ generates the graph description files. You will have to install [Graphv
 ## Usage
 
 ```text
-usage: netlab graph [-h] [-t {topology,bgp,isis}] [-f G_FORMAT] [-e {graphviz,d2}]
-                    [-i INSTANCE] [--snapshot [SNAPSHOT]] [--topology TOPOLOGY]
+usage: netlab graph [-h] [-t {topology,bgp,isis}] [--title G_TITLE] [-f G_FORMAT]
+                    [-e {graphviz,d2}] [-q] [-i INSTANCE] [--snapshot [SNAPSHOT]]
+                    [--topology TOPOLOGY]
                     [output]
 
 Create a graph description in Graphviz or D2 format or draw a graph
@@ -25,10 +26,12 @@ options:
   -h, --help            show this help message and exit
   -t, --type {topology,bgp,isis}
                         Graph type
+  --title G_TITLE       Graph title
   -f, --format G_FORMAT
                         Graph formatting parameters separated by commas
   -e, --engine {graphviz,d2}
                         Graphing engine
+  -q, --quiet           Report only major errors
   -i, --instance INSTANCE
                         Specify lab instance to create a graph from
   --snapshot [SNAPSHOT]
@@ -70,6 +73,8 @@ These formatting parameters can be applied to a **bgp** graph:
 * **ipv4**, **ipv6**, **vpnv4**, **vpnv6**, **6pe**, or **evpn** -- draw the BGP sessions with the specified address families
 * **novrf** -- do not include VRF BGP sessions in the graph
 
+You can also specify/overwrite the graph title with the `--title` argument.
+
 ```{tip}
 * For more graph type- and graph formatting details, read the [GraphViz](outputs-graphviz) and [D2](outputs-d2) output module documentation.
 * When executed with the `--instance` option, **‌netlab graph** creates the graph description file in the lab directory.

netsim/cli/graph.py

@@ -33,6 +33,10 @@ def graph_parse(args: typing.List[str]) -> argparse.Namespace:
     dest='g_type', action='store',
     choices=['topology','bgp','isis'],
     help='Graph type')
+  parser.add_argument(
+    '--title',
+    dest='g_title', action='store',
+    help='Graph title')
   parser.add_argument(
     '-f','--format',
     dest='g_format', action='store',
@@ -91,6 +95,9 @@ def run(cli_args: typing.List[str]) -> None:
   args = graph_parse(cli_args)
   topology = load_data_source(args,ghosts=False)
   _read.include_environment_defaults(topology)
+  if args.g_title:
+    topology.graph.title = args.g_title
+
   o_module = 'graph' if args.engine == 'graphviz' else 'd2'
   o_param  = f'{o_module}:{args.g_type or "topology"}'
   (o_type,o_name) = parse_output(args,topology)

tests/platform-integration/graph/bgp.yml

@@ -1,3 +1,4 @@
+---
 defaults.device: frr
 defaults.provider: clab
 
@@ -48,15 +49,10 @@ links:
 
 files:
   make_dot.sh: |
-    graph() {
-      echo -n "graph $3 from $1 into $2 "
-      netlab graph -t bgp -f $1 $2
-    }
-
-    NETLAB_GRAPH_TITLE="BGP route reflector sessions" graph rr dot-bgp-rr.svg
-    NETLAB_GRAPH_TITLE="Dashed VRF BGP sessions" graph vrf dot-bgp-vrf.svg
-    NETLAB_GRAPH_TITLE="Global BGP sessions (no VRF sessions)" graph novrf dot-bgp-novrf.svg
-    NETLAB_GRAPH_TITLE="EVPN BGP sessions" graph evpn,rr dot-bgp-evpn.svg
+    netlab graph -t bgp -f rr --title "BGP route reflector sessions" dot-bgp-rr.svg
+    netlab graph -t bgp -f vrf --title "Dashed VRF BGP sessions" dot-bgp-vrf.svg
+    netlab graph -t bgp -f novrf --title "Global BGP sessions (no VRF sessions)" dot-bgp-novrf.svg
+    netlab graph -t bgp -f evpn,rr --title "EVPN BGP sessions" dot-bgp-evpn.svg
   make_d2.sh: |
     unset D2_LAYOUT
     unset D2_SKETCH
@@ -69,8 +65,8 @@ files:
       export D2_SKETCH=true
     fi
 
-    NETLAB_GRAPH_TITLE="Default BGP graph" netlab graph -e d2 -t bgp d2-bgp-default.svg
-    NETLAB_GRAPH_TITLE="BGP graph with no arrows on sessions" \
-    NETLAB_OUTPUTS_D2_BGP_RR=False netlab graph -e d2 -t bgp d2-bgp-no-rr.svg
-    NETLAB_GRAPH_TITLE="VRF BGP sessions" netlab graph -e d2 -t bgp -f vrf d2-bgp-vrf.svg
-    NETLAB_GRAPH_TITLE="BGP sessions with EVPN AF" netlab graph -e d2 -t bgp -f evpn d2-bgp-evpn.svg
+    netlab graph -e d2 -t bgp --title "Default BGP graph" d2-bgp-default.svg
+    NETLAB_OUTPUTS_D2_BGP_RR=False \
+      netlab graph -e d2 -t bgp --title "BGP graph with no arrows on sessions" d2-bgp-no-rr.svg
+    netlab graph -e d2 -t bgp --title "VRF BGP sessions" -f vrf d2-bgp-vrf.svg
+    netlab graph -e d2 -t bgp --title "BGP sessions with EVPN AF" -f evpn d2-bgp-evpn.svg

tests/platform-integration/graph/create-d2.sh

@@ -5,21 +5,26 @@ if [[ "$OPTS" == *"elk"* ]]; then
   export D2_LAYOUT=elk
 fi
 if [[ "$OPTS" == *"topo"* ]]; then
-  netlab graph --topology topo.yml d2-topo-default.svg
-  NETLAB_OUTPUTS_D2_NODE__ADDRESS__LABEL=False netlab graph -e d2 --topology topo.yml d2-topo-no-labels.svg
-  NETLAB_OUTPUTS_D2_AS__CLUSTERS=False netlab graph -e d2 --topology topo.yml d2-topo-no-clusters.svg
-  NETLAB_OUTPUTS_D2_INTERFACE__LABELS=True netlab graph -e d2 --topology topo.yml d2-topo-intf-labels.svg
-  NETLAB_OUTPUTS_D2_GROUPS=[fabric,host] netlab graph -e d2 --topology topo.yml d2-topo-groups.svg
+  netlab graph --title "Default topology graph" -e d2 --topology topo.yml d2-topo-default.svg
+  NETLAB_OUTPUTS_D2_NODE__ADDRESS__LABEL=False \
+    netlab graph --title "No node loopback labels" -e d2 --topology topo.yml d2-topo-no-labels.svg
+  NETLAB_OUTPUTS_D2_AS__CLUSTERS=False \
+    netlab graph --title "No clusters" -e d2 --topology topo.yml d2-topo-no-clusters.svg
+  NETLAB_OUTPUTS_D2_INTERFACE__LABELS=True \
+    netlab graph --title "Interface labels" -e d2 --topology topo.yml d2-topo-intf-labels.svg
+  NETLAB_OUTPUTS_D2_GROUPS=[fabric,host] \
+    netlab graph --title "Custom groups" -e d2 --topology topo.yml d2-topo-groups.svg
 fi
 if [[ "$OPTS" == *"bgp"* ]]; then
-  NETLAB_GRAPH_TITLE="Default BGP graph" netlab graph -e d2 --topology bgp.yml -t bgp d2-bgp-default.svg
-  NETLAB_OUTPUTS_D2_BGP_RR=False netlab graph -e d2 --topology bgp.yml -t bgp d2-bgp-no-rr.svg
-  NETLAB_GRAPH_TITLE="VRF BGP sessions" netlab graph -e d2 --topology bgp.yml -t bgp -f vrf d2-bgp-vrf.svg
-  NETLAB_GRAPH_TITLE="BGP sessions with EVPN AF" netlab graph -e d2 --topology bgp.yml -t bgp -f evpn d2-bgp-evpn.svg
+  netlab graph --title "Default BGP graph" -e d2 --topology bgp.yml -t bgp d2-bgp-default.svg
+  NETLAB_OUTPUTS_D2_BGP_RR=False \
+    netlab graph --title "No RR sessions" -e d2 --topology bgp.yml -t bgp d2-bgp-no-rr.svg
+  netlab graph --title "VRF BGP sessions" -e d2 --topology bgp.yml -t bgp -f vrf d2-bgp-vrf.svg
+  netlab graph --title "BGP sessions with EVPN AF" -e d2 --topology bgp.yml -t bgp -f evpn d2-bgp-evpn.svg
 fi
 if [[ "$OPTS" == *"isis"* ]]; then
-  NETLAB_GRAPH_TITLE="IS-IS routing" netlab graph -e d2 --topology isis.yml -t isis d2-isis.svg
+  netlab graph --title "IS-IS routing" -e d2 --topology isis.yml -t isis d2-isis.svg
 fi
 if [[ "$OPTS" == *"vlan"* ]]; then
-  NETLAB_GRAPH_TITLE="VLAN Access and Trunk Links" netlab graph -e d2 -f vlan --topology vlan.yml d2-vlan.svg
+  netlab graph --title "VLAN Access and Trunk Links" -e d2 -f vlan --topology vlan.yml d2-vlan.svg
 fi

tests/platform-integration/graph/create-graphviz.sh

@@ -2,34 +2,27 @@
 OPTS=${*:-bgp topo isis}
 rm *svg
 if [[ "$OPTS" == *"topo"* ]]; then
-  netlab graph --topology topo.yml dot-topo-default.svg
-  NETLAB_GRAPH_TITLE="Topology graph, no labels" \
-  NETLAB_OUTPUTS_GRAPH_NODE__ADDRESS__LABEL=False netlab graph --topology topo.yml dot-topo-no-labels.svg
-  NETLAB_GRAPH_TITLE="Topology graph, no AS clusters" \
-  NETLAB_OUTPUTS_GRAPH_AS__CLUSTERS=False netlab graph --topology topo.yml dot-topo-no-clusters.svg
-  NETLAB_GRAPH_TITLE="Topology graph, interface labels" \
-  NETLAB_OUTPUTS_GRAPH_INTERFACE__LABELS=True netlab graph --topology topo.yml dot-topo-intf-labels.svg
-  NETLAB_GRAPH_TITLE="Topology graph, custom groups" \
-  NETLAB_OUTPUTS_GRAPH_GROUPS=[fabric,host] netlab graph --topology topo.yml dot-topo-groups.svg
+  netlab graph --title "Default topology graph" --topology topo.yml dot-topo-default.svg
+  NETLAB_OUTPUTS_GRAPH_NODE__ADDRESS__LABEL=False \
+    netlab graph --title "Topology graph, no labels" --topology topo.yml dot-topo-no-labels.svg
+  NETLAB_OUTPUTS_GRAPH_AS__CLUSTERS=False \
+    netlab graph --title "Topology graph, no AS clusters" --topology topo.yml dot-topo-no-clusters.svg
+  NETLAB_OUTPUTS_GRAPH_INTERFACE__LABELS=True \
+    netlab graph --title "Topology graph, interface labels" --topology topo.yml dot-topo-intf-labels.svg
+  NETLAB_OUTPUTS_GRAPH_GROUPS=[fabric,host] \
+    netlab graph --title "Topology graph, custom groups" --topology topo.yml dot-topo-groups.svg
 fi
 if [[ "$OPTS" == *"bgp"* ]]; then
-  NETLAB_GRAPH_TITLE="Default BGP graph" \
   NETLAB_GROUPS_CORE_GRAPH_RANK=1 \
-  netlab graph --topology bgp.yml -t bgp dot-bgp-default.svg
-  NETLAB_GRAPH_TITLE="BGP graph with RR sessions" \
-  netlab graph --topology bgp.yml -t bgp -f rr dot-bgp-rr.svg
-  NETLAB_GRAPH_TITLE="BGP graph with VRF sessions" \
-  netlab graph --topology bgp.yml -t bgp -f vrf dot-bgp-vrf.svg
-  NETLAB_GRAPH_TITLE="No VRF sessions in the BGP graph" \
-  netlab graph --topology bgp.yml -t bgp -f novrf dot-bgp-novrf.svg
-  NETLAB_GRAPH_TITLE="EVPN BGP sessions" \
-  netlab graph --topology bgp.yml -t bgp -f evpn,rr dot-bgp-evpn.svg
+    netlab graph --title "Default BGP graph" --topology bgp.yml -t bgp dot-bgp-default.svg
+  netlab graph --title "BGP graph with RR sessions" --topology bgp.yml -t bgp -f rr dot-bgp-rr.svg
+  netlab graph --title "BGP graph with VRF sessions" --topology bgp.yml -t bgp -f vrf dot-bgp-vrf.svg
+  netlab graph --title "No VRF sessions in the BGP graph" --topology bgp.yml -t bgp -f novrf dot-bgp-novrf.svg
+  netlab graph --title "EVPN BGP sessions" --topology bgp.yml -t bgp -f evpn,rr dot-bgp-evpn.svg
 fi
 if [[ "$OPTS" == *"isis"* ]]; then
-  NETLAB_GRAPH_TITLE="IS-IS routing" \
-  netlab graph --topology isis.yml -t isis dot-isis.svg
+  netlab graph --title "IS-IS routing" --topology isis.yml -t isis dot-isis.svg
 fi
 if [[ "$OPTS" == *"vlan"* ]]; then
-  NETLAB_GRAPH_TITLE="VLAN Access and Trunk Links" \
-  netlab graph --topology vlan.yml -f vlan dot-vlan.svg
+  netlab graph --title "VLAN Access and Trunk Links" --topology vlan.yml -f vlan dot-vlan.svg
 fi

tests/platform-integration/graph/topo.yml

@@ -1,3 +1,4 @@
+---
 provider: clab
 plugin: [ files ]
 
@@ -55,20 +56,15 @@ links:
 
 files:
   make_dot.sh: |
-    graph() {
-      echo -n "graph into $1 "
-      NETLAB_GRAPH_TITLE="$2" netlab graph $1
-    }
-
-    NETLAB_OUTPUTS_GRAPH_NODE__ADDRESS__LABEL=False graph dot-topo-no-labels.svg "Topology graph, no labels"
-    NETLAB_OUTPUTS_GRAPH_AS__CLUSTERS=False graph dot-topo-no-clusters.svg "Topology graph, no AS clusters"
-    NETLAB_OUTPUTS_GRAPH_INTERFACE__LABELS=True graph dot-topo-intf-labels.svg "Topology graph, interface labels"
-    NETLAB_OUTPUTS_GRAPH_GROUPS=[fabric,host] graph dot-topo-groups.svg "Topology graph, custom groups"
+    NETLAB_OUTPUTS_GRAPH_NODE__ADDRESS__LABEL=False \
+      netlab graph --title "Topology graph, no labels" dot-topo-no-labels.svg
+    NETLAB_OUTPUTS_GRAPH_AS__CLUSTERS=False \
+      netlab graph --title "Topology graph, no AS clusters" dot-topo-no-clusters.svg
+    NETLAB_OUTPUTS_GRAPH_INTERFACE__LABELS=True \
+      netlab graph --title "Topology graph, interface labels" dot-topo-intf-labels.svg
+    NETLAB_OUTPUTS_GRAPH_GROUPS=[fabric,host] \
+      netlab graph --title "Topology graph, custom groups" dot-topo-groups.svg
   make_d2.sh: |
-    graph() {
-      NETLAB_GRAPH_TITLE="$2" netlab graph -e d2 $1
-    }
-
     unset D2_LAYOUT
     unset D2_SKETCH
     if [[ "$*" == *"elk"* ]]; then
@@ -79,7 +75,11 @@ files:
       echo "Using sketch mode"
       export D2_SKETCH=true
     fi
-    NETLAB_OUTPUTS_D2_NODE__ADDRESS__LABEL=False graph d2-topo-no-labels.svg "Topology graph, no labels"
-    NETLAB_OUTPUTS_D2_AS__CLUSTERS=False graph d2-topo-no-clusters.svg "Topology graph, no AS clusters"
-    NETLAB_OUTPUTS_D2_INTERFACE__LABELS=True graph d2-topo-intf-labels.svg "Topology graph, interface labels"
-    NETLAB_OUTPUTS_D2_GROUPS=[fabric,host] graph d2-topo-groups.svg "Topology graph, custom groups"
+    NETLAB_OUTPUTS_D2_NODE__ADDRESS__LABEL=False \
+      netlab graph -e d2 --title "Topology graph, no labels" d2-topo-no-labels.svg
+    NETLAB_OUTPUTS_D2_AS__CLUSTERS=False \
+      netlab graph -e d2 --title "Topology graph, no AS clusters" d2-topo-no-clusters.svg
+    NETLAB_OUTPUTS_D2_INTERFACE__LABELS=True \
+      netlab graph -e d2 --title "Topology graph, interface labels" d2-topo-intf-labels.svg
+    NETLAB_OUTPUTS_D2_GROUPS=[fabric,host] \
+      netlab graph -e d2 --title "Topology graph, custom groups" d2-topo-groups.svg