Jsonify show neighbor,adj-rib-in,adj-rib-out cmds output #1240
+210
−177
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,38 +32,28 @@ def _pr(value): | |
| return '%s' % value | ||
|
|
||
|
|
||
| class Neighbor(object): | ||
| extensive_kv = ' %-20s %15s %15s %15s' | ||
| extensive_template = """\ | ||
| Neighbor %(peer-address)s | ||
| Session Local | ||
|
There was a problem hiding this comment. It looks like spaces have been converted to tabs |
||
| %(local-address)s | ||
| %(state)s | ||
| %(duration)s | ||
| Setup Local Remote | ||
| %(as)s | ||
| %(id)s | ||
| %(hold)s | ||
| Capability Local Remote | ||
| %(capabilities)s | ||
| Families Local Remote Add-Path | ||
| %(families)s | ||
| Message Statistic Sent Received | ||
| %(messages)s | ||
| """.replace( | ||
| '\t', ' ' | ||
|
|
@@ -73,99 +63,98 @@ class Neighbor(object): | |
| summary_template = '%-15s %-7s %9s %-12s %10d %10d' | ||
|
|
||
| @classmethod | ||
|
There was a problem hiding this comment. as_dict should not be inlined. It would be better to have as _string added and use two functions for clarity. |
||
| def extensive(cls, answer, output_format='text'): | ||
|
There was a problem hiding this comment. extensive is unlikely to be right as a @classmethod, it is a normal one class function. There was a problem hiding this comment. One for me to look into if the previous code was already a @classmethod There was a problem hiding this comment. However, using an output_format as a string, not a boolean or an "enum", is wrong. String should not be given magical if it is possible to compare them. |
||
| if answer['duration']: | ||
| duration = cls.extensive_kv % ('up for', timedelta(seconds=answer['duration']), '', '') | ||
| else: | ||
| duration = cls.extensive_kv % ('down for', timedelta(seconds=answer['down']), '', '') | ||
|
|
||
| if output_format == 'text': | ||
| formated = { | ||
| 'peer-address': answer['peer-address'], | ||
| 'local-address': cls.extensive_kv % ('local', answer['local-address'], '', ''), | ||
| 'state': cls.extensive_kv % ('state', answer['state'], '', ''), | ||
| 'duration': duration, | ||
| 'as': cls.extensive_kv % ('AS', answer['local-as'], _pr(answer['peer-as']), ''), | ||
| 'id': cls.extensive_kv % ('ID', answer['local-id'], _pr(answer['peer-id']), ''), | ||
| 'hold': cls.extensive_kv % ('hold-time', answer['local-hold'], _pr(answer['peer-hold']), ''), | ||
| 'capabilities': '\n'.join( | ||
| cls.extensive_kv % ('%s:' % k, _en(l), _en(p), '') for k, (l, p) in answer['capabilities'].items() | ||
| ), | ||
| 'families': '\n'.join( | ||
| cls.extensive_kv % ('%s %s:' % (a, s), _en(l), _en(r), _en(p)) | ||
| for (a, s), (l, r, p) in answer['families'].items() | ||
| ), | ||
| 'messages': '\n'.join( | ||
| cls.extensive_kv % ('%s:' % k, str(s), str(r), '') for k, (s, r) in answer['messages'].items() | ||
| ), | ||
| } | ||
| return cls.extensive_template % formated | ||
| else: | ||
| json_output = { | ||
| "Neighbor": answer['peer-address'], | ||
| "Session": { | ||
| "Local": answer['local-address'], | ||
| "State": answer['state'], | ||
| "Up For": str(timedelta(seconds=answer['duration'])) | ||
| }, | ||
| "Setup": { | ||
| "AS": { | ||
| "Local": answer['local-as'], | ||
| "Remote": answer['peer-as'] | ||
| }, | ||
| "ID": { | ||
| "Local": answer['local-id'], | ||
| "Remote": answer['peer-id'] | ||
| }, | ||
| "hold-time": { | ||
| "Local": answer['local-hold'], | ||
| "Remote": answer['peer-hold'] | ||
| } | ||
| }, | ||
| "Capability": { | ||
| k: { | ||
| "Local": _en(l), | ||
| "Remote": _en(p) | ||
| } for k, (l, p) in answer['capabilities'].items() | ||
| }, | ||
| "Families": [ | ||
| { | ||
| "Family": f"{a} {s}", | ||
| "Local": _en(l), | ||
| "Remote": _en(r), | ||
| "Add-Path": _en(p) | ||
| } for (a, s), (l, r, p) in answer['families'].items() | ||
| ], | ||
| "Message Statistic": { | ||
| k: { | ||
| "Sent": s, | ||
| "Received": r | ||
| } for k, (s, r) in answer['messages'].items() | ||
| } | ||
| } | ||
| return json_output | ||
|
|
||
| @classmethod | ||
| def summary(cls, answer, output_format='text'): | ||
| if output_format == 'text': | ||
| return cls.summary_template % ( | ||
| answer['peer-address'], | ||
| _pr(answer['peer-as']), | ||
| timedelta(seconds=answer['duration']) if answer['duration'] else 'down', | ||
| answer['state'].lower(), | ||
| answer['messages']['update'][0], | ||
| answer['messages']['update'][1], | ||
| ) | ||
| else : | ||
| return { | ||
| "Peer": answer['peer-address'], | ||
| "AS": answer['peer-as'], | ||
| "Up/Down": str(timedelta(seconds=answer['duration'])) if answer['duration'] else 'down', | ||
| "State": answer['state'].lower(), | ||
| "Sent": answer['messages']['update'][0], | ||
| "Recvd": answer['messages']['update'][1], | ||
| } | ||
|
|
||
|
|
||
| @Command.register('text', 'teardown', True) | ||
|
|
@@ -194,22 +183,23 @@ def teardown(self, reactor, service, line): | |
| return False | ||
|
|
||
|
|
||
| @Command.register('text', 'show neighbor', False, ['summary', 'extensive', 'configuration']) | ||
| @Command.register('text', 'show neighbor json', False, ['summary', 'extensive']) | ||
|
There was a problem hiding this comment. if we register json, we should also register text and make it work. |
||
| def show_neighbor(self, reactor, service, command): | ||
| words = command.split() | ||
|
|
||
| extensive = 'extensive' in words | ||
| configuration = 'configuration' in words | ||
| summary = 'summary' in words | ||
| json_output = 'json' in words | ||
|
|
||
| if summary: | ||
| words.remove('summary') | ||
| if extensive: | ||
| words.remove('extensive') | ||
| if configuration: | ||
| words.remove('configuration') | ||
| if json_output: | ||
| words.remove('json') | ||
|
|
||
| limit = words[-1] if words[-1] != 'neighbor' else '' | ||
|
|
@@ -226,37 +216,44 @@ def callback_configuration(): | |
| yield True | ||
| reactor.processes.answer_done(service) | ||
|
|
||
| def callback_extensive(): | ||
| peers_extensive_info = [] | ||
| output_format = 'json' if json_output else 'text' | ||
| for peer_name in reactor.peers(): | ||
| if limit and limit not in reactor.neighbor_name(peer_name): | ||
| continue | ||
| extensive_info = Neighbor.extensive(reactor.neighbor_cli_data(peer_name), output_format) | ||
| if output_format == 'text': | ||
| for line in extensive_info.split('\n'): | ||
| reactor.processes.write(service, line) | ||
| else : | ||
| peers_extensive_info.append(extensive_info) | ||
| yield True | ||
| if output_format == 'json': | ||
| reactor.processes.write(service, json.dumps(peers_extensive_info, indent=4) ) | ||
|
|
||
| reactor.processes.answer_done(service) | ||
|
|
||
| def callback_summary(): | ||
| peers_summary = [] | ||
| output_format = 'json' if json_output else 'text' | ||
|
|
||
| if output_format == 'text': | ||
| reactor.processes.write(service, Neighbor.summary_header) | ||
| for peer_name in reactor.established_peers(): | ||
| if limit and limit != reactor.neighbor_ip(peer_name): | ||
| continue | ||
| summary_info = Neighbor.summary(reactor.neighbor_cli_data(peer_name), output_format) | ||
| if output_format == 'text': | ||
| for line in summary_info.split('\n'): | ||
| reactor.processes.write(service, line) | ||
| else : | ||
| peers_summary.append(summary_info) | ||
| yield True | ||
|
|
||
| if output_format == 'json': | ||
| reactor.processes.write(service, json.dumps(peers_summary, indent=4) ) | ||
| reactor.processes.answer_done(service) | ||
|
|
||
| if summary: | ||
| reactor.asynchronous.schedule(service, command, callback_summary()) | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This code seems to return a dict and not a string, it should be a string. While python is dynamic, I attempt to only return one type per function, like in C, to ease debugging.