gw-tests/genhtml/genhtml.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 import os;
   4 import dircache;
   5 import sys;
   6 import urllib
   7 import traceback
   8 import glob
   9
  10 class DimValue(object):
  11     def __new__(cls, dim, value):
  12         if value in dim:
  13             return dim[value]
  14         else:
  15             return super(DimValue, cls).__new__(cls)
  16     def __init__(self, dim, value):
  17         self.dim = dim
  18         self.value = value
  19         self.dim.addValue(self)
  20     def __str__(self):
  21         return self.dim.val2str(self.value)
  22     def __repr__(self):
  23         return "DimValue(%s, %s)" % (repr(self.dim), repr(self.value))
  24     def htmlTableHeading(self):
  25         return self.dim.htmlTableHeading(self.value)
  26
  27 class DimValues(list):
  28     def replace(self, val):
  29         for i in xrange(len(self)):
  30             if self[i].dim == val.dim:
  31                 self[i] = val
  32     def __add__(self, val):
  33         ret = DimValues(self)
  34         ret.append(val)
  35         return ret
  36     def __sub__(self, dim):
  37         result = DimValues(self)
  38         for v in self:
  39             if v.dim == dim:
  40                 result.remove(v)
  41         return result
  42     def key(self):
  43         return tuple([v.value for v in self])
  44
  45 class Dimension(dict):
  46     def __init__(self, atype, name=None):
  47         self.type = atype
  48         if (name):
  49             self.name = name
  50         else:
  51             self.name = atype
  52         self.sortedKeys = []
  53
  54     def __iter__(self):
  55         for i in xrange(len(self)):
  56             yield self.getValue(i)
  57     def getValue(self, index):
  58         return self[self.sortedKeys[index]]
  59
  60     def addValue(self, value):
  61         if value not in self:
  62             if isinstance(value, DimValue):
  63                 self[value.value] = value
  64             else:
  65                 raise Exception("Unsupported usage of addValue")
  66                 #self[value] = DimValue(self, value)
  67             self.sortedKeys = self.keys()
  68             self.sortedKeys.sort()
  69     def val2str(self, v):
  70         return str(v)
  71     def htmlTableHeading(self, v):
  72         return self.val2str(v)
  73     def __str__(self):
  74         return self.name
  75     def __repr__(self):
  76         return "Dimension(%s)"%self.type
  77
  78 class DimensionKern(Dimension):
  79     def __init__(self):
  80         Dimension.__init__(self, 'gwkern', 'GW kernel')
  81     def htmlTableHeading(self, v):
  82         i=v.find(":")
  83         if i>0: kver=v[:i]
  84         else: kver=v
  85         return v+"<br><a href='config-%s'>config</a>"%(urllib.quote(kver))
  86     def versions(self):
  87         for v in self.values:
  88             i=v.find(":")
  89             if i>0: kver=v[:i]
  90             else: kver=v
  91             yield kver
  92
  93 class DimensionHostKern(Dimension):
  94     def __init__(self):
  95         Dimension.__init__(self, 'hostkern', 'Host kernel')
  96     def val2str(self, v):
  97         if v.find("host-") == 0:
  98             v = v[5:]
  99         return v
 100     def htmlTableHeading(self, v):
 101         v = self.val2str(v)
 102         i = v.find(":")
 103         if i>0: kver = v[:i]
 104         else: kver = v
 105         return v+"<br><a href='config-%s'>config</a>"%(urllib.quote(kver))
 106     def versions(self):
 107         for v in self.values:
 108             i=v.find(":")
 109             if i>0: kver=v[:i]
 110             else: kver=v
 111             yield kver
 112
 113 class DimensionTest(Dimension):
 114     def __init__(self):
 115         Dimension.__init__(self, 'test', 'Test')
 116     def htmlTableHeading(self, v):
 117         return v+"<br><a href='%s.sh.html'>source</a>"%(urllib.quote(v))
 118
 119 class DimensionLoad(Dimension):
 120     def __init__(self):
 121         Dimension.__init__(self, 'load', 'Load')
 122
 123 class DimensionTraffic(Dimension):
 124     def __init__(self):
 125         Dimension.__init__(self, 'traf', 'Traffic')
 126     def val2str(self, v):
 127         if v == "50":
 128             return "50%"
 129         elif v == "oneatatime":
 130             return "one message at a time"
 131         else:
 132             return v
 133     def htmlTableHeading(self, v):
 134         return self.val2str(v)
 135 class Test(object):
 136     @classmethod
 137     def isOnPath(cls, path):
 138         f = os.path.join(path, 'plot.sh')
 139         return os.path.isfile(f)
 140     def __init__(self, path, values, tests=None):
 141         self.path = path
 142         self.name = os.path.basename(path)
 143         self.values = values
 144         self.tests = tests
 145     def printThumbLink(self, file):
 146 #         try:
 147 #             imgs = [img for img in dircache.listdir(thumb)]
 148 #         except OSError:
 149 #             imgs = [ self.name + ".png" ]
 150         imgs = [ 'tgraph.png' ]
 151         for img in imgs:
 152             print >>file, "<a href='%s/results.html'><img src='%s/%s'></a>" % \
 153                   (urllib.quote(self.path), urllib.quote(self.path), img)
 154     def fullImgLink(self, pngName):
 155         return "<div><a href='%s'><img src='%s' /></a></div>" % \
 156                (pngName[:-4]+".pdf", pngName)
 157
 158     def htmlPrintStats(self, html):
 159         cwd = os.getcwd()
 160         os.chdir(self.path)
 161         stats = glob.glob("*-stat.txt")
 162         print >>html, "<h3>Statistics</h3>"
 163         print >>html, "<table><tr>"
 164         stats.sort()
 165         for i in stats:
 166             lines = open(i).readlines()
 167             def fixupLine(l):
 168                 comment = l.find("#")
 169                 if comment >= 0:
 170                     l = l[:comment-1]
 171                 if l.find("cmdline=") == 0:
 172                     l = "<abbr title=%s>cmdline=...</abbr>" % str(l[8:])
 173                 return l
 174             lines = [fixupLine(l) for l in lines]
 175             print >>html, "<td><h4>%s</h4>%s</td>" % (i, "<br />".join(lines))
 176         print >>html, "</tr></table>"
 177         os.chdir(cwd)
 178
 179     def generateHtml(self):
 180         html = open(os.path.join(self.path, 'results.html'), "w")
 181         title = "CAN gateway timing analysis"
 182         cdup = "../"*len(self.values)
 183         print >> html, """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 184 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 185 <head>
 186 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
 187 <title>%s</title>
 188 <link rel="stylesheet" href="%sstyle.css" type="text/css" />
 189 </head>
 190 <body>
 191 <h1>%s</h1>"""  % (title, cdup, title)
 192         params = ["%s %s" % (v.dim, v) for v in self.values]
 193         print >>html, "Results for:", ", ".join(params)
 194         print >>html, "<div class='otherview'><h4>Other results</h4><table>"
 195         for d in self.tests.space:
 196             links = []
 197             for v in d:
 198                 if v in self.values:
 199                     links.append("<span class='value current'>%s</span>"%str(v))
 200                 else:
 201                     vv = DimValues(self.values)
 202                     vv.replace(v)
 203                     try:
 204                         href = cdup + urllib.quote(self.tests[vv.key()].path+"/results.html")
 205                         links.append("<span class='value other'><a href='%s'>%s</a></span>"%(href, str(v)))
 206                     except KeyError:
 207                         links.append("<span class='value missing'>%s</span>"%str(v))
 208             print >>html, "<tr><th>%s</th><td>" % d, " ".join(links), "</td></tr>"
 209
 210         print >>html, "</table></div>"
 211         print >>html, self.fullImgLink("graph.png")
 212         self.htmlPrintStats(html)
 213         cwd = os.getcwd()
 214         os.chdir(self.path)
 215         additionalImgs = glob.glob("graph?*.png")
 216         if additionalImgs: print >>html, "<h3>Additional graphs</h3>"
 217         for i in additionalImgs:
 218             print >>html, "<h4>%s</h4>" % i[5:-4]
 219             print >>html, self.fullImgLink(i)
 220         os.chdir(cwd)
 221
 222         print >>html, "<hr />"
 223         print >>html, "<a href='./'>Raw data</a><br />"
 224         print >>html, "<a href='%s'>Script source</a><br />" % (cdup+self.name+".sh.html")
 225         print >>html, "<a href='%s'>Back to top</a><br />" % cdup
 226
 227         html.close()
 228
 229 class Space(list):
 230     """List of Dimensions()s (order matters)"""
 231     def __init__(self, *dimensions):
 232         self.extend(list(dimensions))
 233     def path2dimValues(self, path):
 234         coordinates = path.split("/")
 235         if len(coordinates) != len(self):
 236             raise KeyError("The number coordinates do not match the number of dimensions: " + str(coordinates))
 237
 238         dv = DimValues([DimValue(self[i], coordinates[i]) \
 239                             for i in xrange(len(coordinates))])
 240         return dv
 241
 242     def iterValues(self):
 243         idx = [0 for i in xrange(len(self))]
 244         done=False
 245         while not done:
 246             values=DimValues()
 247             for i in xrange(len(self)):
 248                 values.append(self[i].values()[idx[i]])
 249             yield values
 250             done=True
 251             for i in xrange(len(self)):
 252                 idx[i] += 1
 253                 if idx[i] < len(self[i]):
 254                     done=False
 255                     break
 256                 idx[i] = 0
 257     def reorder(self, dimValues):
 258         reordered = DimValues()
 259         for d in self:
 260             for v in dimValues:
 261                 if v.dim == d:
 262                     reordered.append(v)
 263         return reordered
 264     def iterDimensionPairs(self):
 265         for i in xrange(len(self)):
 266             for j in xrange(i+1, len(self)):
 267                 yield (self[i], self[j])
 268                 yield (self[j], self[i])
 269     def iterRemainingDimensions(self, dimensionPair):
 270         for d in self:
 271             if d not in dimensionPair:
 272                 yield d
 273
 274
 275 class Tests(dict):
 276     """Represents all tests organized along several dimensions"""
 277     def __init__(self, rootpath, space):
 278         dict.__init__(self)
 279         self.space = space
 280         if (rootpath):
 281             self.populate(rootpath)
 282     def getTest(self, key):
 283         if len(key) != len(self.space):
 284             raise KeyError("The coordinates in key do not match the dimension of the space")
 285         realkey = self.space.reorder(key)
 286         return self[realkey.key()]
 287
 288     def addTest(self, test):
 289         self[test.values.key()] = test
 290
 291     def populate(self, rootpath):
 292         for root, dirs, files in os.walk(rootpath):
 293             if (root.find(rootpath) == 0):
 294                 path = root[len(rootpath):]
 295             else:
 296                 path = rootpath
 297             if Test.isOnPath(root):
 298                 dv = self.space.path2dimValues(path)
 299                 self.addTest(Test(root, dv, self))
 300     def generateHtml(self):
 301         for pair in self.space.iterDimensionPairs():
 302             remDims = Space(*tuple([d for d in self.space.iterRemainingDimensions(pair)]))
 303             for vals in remDims.iterValues():
 304                 page = Page(pair, vals, self)
 305                 print page.getName()
 306                 page.generate()
 307         try:
 308             os.remove("index.html")
 309         except OSError: pass
 310         os.symlink(page.getName(), "index.html")
 311         css = open("style.css", "w")
 312         print >>css, """img { border: 0; }
 313 table { border-collapse: collapse; }
 314 th, td { border: 1px solid lightgray; padding: 4px;}
 315 h4 { margin: 0; }
 316 .otherview { margin: 1ex 0}
 317 .otherview .value { color: black; padding: 0ex 1ex; -moz-border-radius: 1ex; border-radius: 1ex;}
 318 .otherview .value a { color: inherit; text-decoration: none; }
 319 .otherview .other:hover { background: #eee; }
 320 .otherview .missing { color: gray; }
 321 .otherview .current { background: #ccc; }
 322 """
 323         css.close()
 324         for test in self.values():
 325             print test.path
 326             test.generateHtml()
 327
 328         os.system("source-highlight -d --output-dir=. ../*.sh > /dev/null")
 329
 330 class Page(object):
 331     def __init__(self, dimPair, valsOther, tests):
 332         self.dimy, self.dimx = dimPair
 333         self.dimOther = [v.dim for v in valsOther]
 334         self.valsOther = tests.space.reorder(valsOther)
 335         self.tests = tests
 336     def getName(self):
 337         return "%s-vs-%s-for-%s.html"%(self.dimy.type, self.dimx.type,
 338                                        "-".join([v.value for v in self.valsOther]))
 339     def generate(self):
 340         html = open(self.getName(), "w")
 341         title = "CAN gateway timing analysis"
 342         print >> html, """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 343 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 344 <head>
 345 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
 346 <title>%s</title>
 347 <link rel="stylesheet" href="style.css" type="text/css" />
 348 </head>
 349 <body>
 350 <h1>%s</h1>"""  % (title, title)
 351         params = ["%s %s" % (v.dim, v) for v in self.valsOther]
 352         print >>html, "<h3>Results for ", ", ".join(params), "</h3>"
 353         print >>html, "<div class='otherview'><h4>Other views</h4>"
 354         print >>html, "<table><tr>"
 355         for d in self.dimOther:
 356             print >>html, "<th>%s</th>" % d
 357             print >>html, "<td><a href='%s'>&rarr;</a> " % \
 358                 Page((self.dimy, d), self.valsOther - d + self.dimx.getValue(0), self.tests).getName()
 359             print >>html, "<a href='%s'>&darr;</a></td>" % \
 360                 Page((d, self.dimx), self.valsOther - d + self.dimy.getValue(0), self.tests).getName()
 361             links = []
 362             print >>html, "<td>"
 363             for v in d:
 364                 if v in self.valsOther:
 365                     links.append("<span class='value current'>%s</span>"%str(v))
 366                 else:
 367                     vv = DimValues(self.valsOther)
 368                     vv.replace(v)
 369                     links.append("<span class='value other'><a href='%s'>%s</a></span>"%(urllib.quote(Page((self.dimy, self.dimx), vv, self.tests).getName()), str(v)))
 370             print >>html, " ".join(links)
 371             print >>html, "</td></tr>"
 372         print >>html, "</table></div>"
 373
 374         print >>html, "<table><thead><tr><td>%s &rarr; <br />%s &darr;</td>" % (self.dimx.name, self.dimy.name)
 375         for x in self.dimx:
 376             print >>html, "<th>%s</th>" % x.htmlTableHeading()
 377         print >>html, "</tr></thead>"
 378         for y in self.dimy:
 379             print >>html, "<tr><th>%s</th>" % y.htmlTableHeading()
 380
 381             for x in self.dimx:
 382                 print >>html, "<td>"
 383                 idx = [x,y]
 384                 idx.extend(self.valsOther)
 385                 try:
 386                     test = tests.getTest(idx)
 387                     test.printThumbLink(html)
 388                 except KeyError:
 389                     print >>html, "N/A"
 390                 print >>html, "</td>"
 391             print >>html, "</tr>"
 392         print >> html, """
 393 </table>
 394 <div style="font-size: small; color: gray; margin-top: 1em;">Authors: Michal Sojka, Pavel Píša, Copyright © 2010 Czech Technical University in Prague</div>
 395 </body>
 396 """
 397
 398
 399 if __name__ == "__main__":
 400     os.chdir(sys.argv[1])
 401     os.system("rm *.html")
 402     tests = Tests("./", Space(DimensionHostKern(), DimensionKern(), DimensionTraffic(), DimensionLoad(), DimensionTest()))
 403     tests.generateHtml()
 404     sys.exit(0)