python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00
Code Issues Releases Activity

update docs

Browse Source
This commit is contained in:
Kelly Brazil
2021-04-08 15:52:49 -07:00
parent 4290a3cbd1
commit b8b8dfead4
61 changed files with 1500 additions and 1847 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
jc/parsers/traceroute.py
View File

@ -19,6 +19,27 @@ Usage (module):
import jc.parsers.traceroute
result = jc.parsers.traceroute.parse(traceroute_command_output)
Schema:
{
"destination_ip": string,
"destination_name": string,
"hops": [
{
"hop": integer,
"probes": [
{
"annotation": string,
"asn": integer,
"ip": string,
"name": string,
"rtt": float
}
]
}
]
}
Compatibility:
'linux', 'darwin', 'freebsd'
@ -101,7 +122,8 @@ import jc.utils
class info():
version = '1.1'
"""Provides parser metadata (version, author, etc.)"""
version = '1.2'
description = '`traceroute` and `traceroute6` command parser'
author = 'Kelly Brazil'
author_email = 'kellyjonbrazil@gmail.com'
@ -151,7 +173,7 @@ RE_PROBE_ASN = re.compile(r'\[AS(\d+)\]')
RE_PROBE_RTT_ANNOTATION = re.compile(r'(?:(\d+(?:\.?\d+)?)\s+ms|(\s+\*\s+))\s*(!\S*)?')
class Traceroute(object):
class _Traceroute(object):
def __init__(self, dest_name, dest_ip):
self.dest_name = dest_name
self.dest_ip = dest_ip
@ -167,7 +189,7 @@ class Traceroute(object):
return text
class Hop(object):
class _Hop(object):
def __init__(self, idx):
self.idx = idx # Hop count, starting at 1 (usually)
self.probes = [] # Series of Probe instances
@ -194,7 +216,7 @@ class Hop(object):
return text
class Probe(object):
class _Probe(object):
def __init__(self, name=None, ip=None, asn=None, rtt=None, annotation=None):
self.name = name
self.ip = ip
@ -216,7 +238,7 @@ class Probe(object):
return text
def loads(data):
def _loads(data):
lines = data.splitlines()
# Get headers
@ -227,7 +249,7 @@ def loads(data):
dest_ip = match_dest.group(2)
# The Traceroute node is the root of the tree
traceroute = Traceroute(dest_name, dest_ip)
traceroute = _Traceroute(dest_name, dest_ip)
# Parse the remaining lines, they should be only hops/probes
for line in lines[1:]:
@ -243,7 +265,7 @@ def loads(data):
hop_index = None
if hop_index is not None:
hop = Hop(hop_index)
hop = _Hop(hop_index)
traceroute.add_hop(hop)
hop_string = hop_match.group(2)
@ -279,7 +301,7 @@ def loads(data):
probe_annotation = probe_rtt_annotation[2] or None
probe = Probe(
probe = _Probe(
name=probe_name,
ip=probe_ip,
asn=probe_asn,
@ -300,7 +322,7 @@ class ParseError(Exception):
########################################################################################
def process(proc_data):
def _process(proc_data):
"""
Final processing to conform to the schema.
@ -310,26 +332,7 @@ def process(proc_data):
Returns:
Dictionary. Structured data with the following schema:
{
"destination_ip": string,
"destination_name": string,
"hops": [
{
"hop": integer,
"probes": [
{
"annotation": string,
"asn": integer,
"ip": string,
"name": string,
"rtt": float
}
]
}
]
}
Dictionary. Structured to conform to the schema.
"""
int_list = ['hop', 'asn']
float_list = ['rtt']
@ -408,7 +411,7 @@ def parse(data, raw=False, quiet=False):
data = '\n'.join(new_data)
tr = loads(data)
tr = _loads(data)
hops = tr.hops
hops_list = []
@ -441,4 +444,4 @@ def parse(data, raw=False, quiet=False):
if raw:
return raw_output
else:
return process(raw_output)
return _process(raw_output)