wireshark/tools/ftsanity.py
Peter Wu cc4bce537b ftsanity.py: make it work with modern tshark
Broken since 4ac2441d7c ("Coalesce "-G
fields2" and "-G fields3" into "-G fields").

This patch fixes Python3 compatibility, fixes handling of the changed
output and option and prints the faulting line on assertion error. It
also updates two dissectors which had tabs in their description,
breaking the output.

Tested with Python 2.5.6, 2.6.6, 2.7.9, 3.2.6, 3.4.3.

Change-Id: Ifcd0d0eb092b357eca357cd53f2e1348ebf8885c
Reviewed-on: https://code.wireshark.org/review/7791
Reviewed-by: Gilbert Ramirez <gram@alumni.rice.edu>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-03-24 05:13:46 +00:00

115 lines
3.1 KiB
Python
Executable file

#!/usr/bin/env python
"""
Check the sanity of field definitions in Wireshark.
"""
#
# Gilbert Ramirez <gram [AT] alumni.rice.edu>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import sys
from optparse import OptionParser
import subprocess
errors = 0
class Proto:
"""Data for a protocol."""
def __init__(self, line):
data = line.split("\t")
assert len(data) == 3, "expected 3 columns in %s" % data
assert data[0] == "P"
self.name = data[1]
self.abbrev = data[2]
class Field:
"""Data for a field."""
def __init__(self, line):
data = line.split("\t")
assert len(data) == 8, "expected 8 columns in %s" % data
assert data[0] == "F"
self.name = data[1]
self.abbrev = data[2]
self.ftype = data[3]
self.parent = data[4]
self.base = data[5]
self.bitmask = int(data[6],0)
self.blurb = data[7]
def gather_data(tshark):
"""Calls tshark and gathers data."""
proc = subprocess.Popen([tshark, "-G", "fields"],
stdout=subprocess.PIPE)
output, error = proc.communicate()
if proc.returncode != 0:
sys.exit("Failed: " + cmd)
if sys.version_info[0] >= 3:
output = output.decode('utf-8')
lines = output.splitlines()
protos = [Proto(x) for x in lines if x[0] == "P"]
fields = [Field(x) for x in lines if x[0] == "F"]
return protos, fields
def check_fields(fields):
"""Looks for problems in field definitions."""
global errors
for field in fields:
if field.bitmask != 0:
if field.ftype.find("FT_UINT") != 0 and \
field.ftype.find("FT_INT") != 0 and \
field.ftype != "FT_BOOLEAN":
print("%s has a bitmask 0x%x but is type %s" % \
(field.abbrev, field.bitmask, field.ftype))
errors += 1
def run(tshark):
"""Run the tests."""
global errors
protos, fields = gather_data(tshark)
check_fields(fields)
if errors > 0:
sys.exit("%d errors found" % (errors,))
else:
print("Success.")
def main():
"""Parse the command-line."""
usage = "%prog tshark"
parser = OptionParser(usage=usage)
(options, args) = parser.parse_args()
if len(args) != 1:
parser.error("Need location of tshark.")
run(args[0])
if __name__ == "__main__":
main()