ovsdb/ovsdb-dot.in

   1 #! @PYTHON@
   2
   3 from datetime import date
   4 import ovs.db.error
   5 import ovs.db.schema
   6 import getopt
   7 import os
   8 import re
   9 import sys
  10
  11 argv0 = sys.argv[0]
  12
  13 def printEdge(tableName, type, baseType, label):
  14     if baseType.ref_table_name:
  15         if type.n_min == 0:
  16             if type.n_max == 1:
  17                 arity = "?"
  18             elif type.n_max == sys.maxsize:
  19                 arity = "*"
  20             else:
  21                 arity = "{,%d}" % type.n_max
  22         elif type.n_min == 1:
  23             if type.n_max == 1:
  24                 arity = ""
  25             elif type.n_max == sys.maxsize:
  26                 arity = "+"
  27             else:
  28                 arity = "{1,%d}" % type.n_max
  29
  30         options = {}
  31         options['label'] = '"%s%s"' % (label, arity)
  32         if baseType.ref_type == 'weak':
  33             options['style'] = 'dotted'
  34         print ("\t%s -> %s [%s];" % (
  35             tableName,
  36             baseType.ref_table_name,
  37             ', '.join(['%s=%s' % (k,v) for k,v in options.items()])))
  38
  39 def schemaToDot(schemaFile, arrows):
  40     schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schemaFile))
  41
  42     print ("digraph %s {" % schema.name)
  43     print ('\trankdir=LR;')
  44     print ('\tsize="6.5,4";')
  45     print ('\tmargin="0";')
  46     print ("\tnode [shape=box];")
  47     if not arrows:
  48         print ("\tedge [dir=none, arrowhead=none, arrowtail=none];")
  49     for tableName, table in schema.tables.items():
  50         options = {}
  51         if table.is_root:
  52             options['style'] = 'bold'
  53         print ("\t%s [%s];" % (
  54             tableName,
  55             ', '.join(['%s=%s' % (k,v) for k,v in options.items()])))
  56         for columnName, column in table.columns.items():
  57             if column.type.value:
  58                 printEdge(tableName, column.type, column.type.key, "%s key" % columnName)
  59                 printEdge(tableName, column.type, column.type.value, "%s value" % columnName)
  60             else:
  61                 printEdge(tableName, column.type, column.type.key, columnName)
  62     print ("}");
  63
  64 def usage():
  65     print ("""\
  66 %(argv0)s: compiles ovsdb schemas to graphviz format
  67 Prints a .dot file that "dot" can render to an entity-relationship diagram
  68 usage: %(argv0)s [OPTIONS] SCHEMA
  69 where SCHEMA is an OVSDB schema in JSON format
  70
  71 The following options are also available:
  72   --no-arrows                 omit arrows from diagram
  73   -h, --help                  display this help message
  74   -V, --version               display version information\
  75 """ % {'argv0': argv0})
  76     sys.exit(0)
  77
  78 if __name__ == "__main__":
  79     try:
  80         try:
  81             options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
  82                                               ['no-arrows',
  83                                                'help', 'version',])
  84         except getopt.GetoptError as geo:
  85             sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
  86             sys.exit(1)
  87
  88         arrows = True
  89         for key, value in options:
  90             if key == '--no-arrows':
  91                 arrows = False
  92             elif key in ['-h', '--help']:
  93                 usage()
  94             elif key in ['-V', '--version']:
  95                 print ("ovsdb-dot (Open vSwitch) @VERSION@")
  96             else:
  97                 sys.exit(0)
  98
  99         if len(args) != 1:
 100             sys.stderr.write("%s: exactly 1 non-option argument required "
 101                              "(use --help for help)\n" % argv0)
 102             sys.exit(1)
 103
 104         schemaToDot(args[0], arrows)
 105
 106     except ovs.db.error.Error as e:
 107         sys.stderr.write("%s: %s\n" % (argv0, e.msg))
 108         sys.exit(1)
 109
 110 # Local variables:
 111 # mode: python
 112 # End: