vlog: Output configuration list in alphabetical order.
[openvswitch] / 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:
15         if type.n_min == 0:
16             if type.n_max == 1:
17                 arity = "?"
18             elif type.n_max == sys.maxint:
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.maxint:
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['constraint'] = 'false'
34             options['style'] = 'dotted'
35         print "\t%s -> %s [%s];" % (
36             tableName,
37             baseType.ref_table,
38             ', '.join(['%s=%s' % (k,v) for k,v in options.items()]))
39
40 def schemaToDot(schemaFile):
41     schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schemaFile))
42
43     print "digraph %s {" % schema.name
44     print '\tsize="6.5,4";'
45     print '\tmargin="0";'
46     print "\tnode [shape=box];"
47     print "\tedge [dir=none, arrowhead=none, arrowtail=none];"
48     for tableName, table in schema.tables.iteritems():
49         options = {}
50         if table.is_root:
51             options['style'] = 'bold'
52         print "\t%s [%s];" % (
53             tableName,
54             ', '.join(['%s=%s' % (k,v) for k,v in options.items()]))
55         for columnName, column in table.columns.iteritems():
56             if column.type.value:
57                 printEdge(tableName, column.type, column.type.key, "%s key" % columnName)
58                 printEdge(tableName, column.type, column.type.value, "%s value" % columnName)
59             else:
60                 printEdge(tableName, column.type, column.type.key, columnName)
61     print "}";
62
63 def usage():
64     print """\
65 %(argv0)s: compiles ovsdb schemas to graphviz format
66 Prints a .dot file that "dot" can render to an entity-relationship diagram
67 usage: %(argv0)s [OPTIONS] SCHEMA
68 where SCHEMA is an OVSDB schema in JSON format
69
70 The following options are also available:
71   -h, --help                  display this help message
72   -V, --version               display version information\
73 """ % {'argv0': argv0}
74     sys.exit(0)
75
76 if __name__ == "__main__":
77     try:
78         try:
79             options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
80                                               ['help', 'version'])
81         except getopt.GetoptError, geo:
82             sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
83             sys.exit(1)
84
85         for key, value in options:
86             if key in ['-h', '--help']:
87                 usage()
88             elif key in ['-V', '--version']:
89                 print "ovsdb-dot (Open vSwitch) @VERSION@"
90             else:
91                 sys.exit(0)
92
93         if len(args) != 1:
94             sys.stderr.write("%s: exactly 1 non-option argument required "
95                              "(use --help for help)\n" % argv0)
96             sys.exit(1)
97
98         schemaToDot(args[0])
99
100     except ovs.db.error.Error, e:
101         sys.stderr.write("%s: %s\n" % (argv0, e.msg))
102         sys.exit(1)
103
104 # Local variables:
105 # mode: python
106 # End: