Merge pull request #4151 from natali-rs1985/T6695

T6695: Machine-readable operational mode support for traceroute

2 files changed, 255 insertions, 38 deletions

diff --git a/src/op_mode/mtr.py b/src/op_mode/mtr.py
index baf9672a1..522cbe008 100644
--- a/src/op_mode/mtr.py
+++ b/src/op_mode/mtr.py
@@ -23,155 +23,155 @@ from vyos.utils.network import vrf_list
 from vyos.utils.process import call
 
 options = {
-    'report': {
+    'report-mode': {
         'mtr': '{command} --report',
         'type': 'noarg',
-        'help': 'This option puts mtr into report mode. When in this mode, mtr will run for the number of cycles specified by the -c option, and then print statistics and exit.'
+        'help': 'This option puts mtr into report mode. When in this mode, mtr will run for the number of cycles specified by the -c option, and then print statistics and exit.',
     },
     'report-wide': {
         'mtr': '{command} --report-wide',
         'type': 'noarg',
-        'help': 'This option puts mtr into wide report mode. When in this mode, mtr will not cut hostnames in the report.'
+        'help': 'This option puts mtr into wide report mode. When in this mode, mtr will not cut hostnames in the report.',
     },
     'raw': {
         'mtr': '{command} --raw',
         'type': 'noarg',
-        'help': 'Use the raw output format. This format is better suited for archival of the measurement results.'
+        'help': 'Use the raw output format. This format is better suited for archival of the measurement results.',
     },
     'json': {
         'mtr': '{command} --json',
         'type': 'noarg',
-        'help': 'Use this option to tell mtr to use the JSON output format.'
+        'help': 'Use this option to tell mtr to use the JSON output format.',
     },
     'split': {
         'mtr': '{command} --split',
         'type': 'noarg',
-        'help': 'Use this option to set mtr to spit out a format that is suitable for a split-user interface.'
+        'help': 'Use this option to set mtr to spit out a format that is suitable for a split-user interface.',
     },
     'no-dns': {
         'mtr': '{command} --no-dns',
         'type': 'noarg',
-        'help': 'Use this option to force mtr to display numeric IP numbers and not try to resolve the host names.'
+        'help': 'Use this option to force mtr to display numeric IP numbers and not try to resolve the host names.',
     },
     'show-ips': {
         'mtr': '{command} --show-ips {value}',
         'type': '<num>',
-        'help': 'Use this option to tell mtr to display both the host names and numeric IP numbers.'
+        'help': 'Use this option to tell mtr to display both the host names and numeric IP numbers.',
     },
     'ipinfo': {
         'mtr': '{command} --ipinfo {value}',
         'type': '<num>',
-        'help': 'Displays information about each IP hop.'
+        'help': 'Displays information about each IP hop.',
     },
     'aslookup': {
         'mtr': '{command} --aslookup',
         'type': 'noarg',
-        'help': 'Displays the Autonomous System (AS) number alongside each hop. Equivalent to --ipinfo 0.'
+        'help': 'Displays the Autonomous System (AS) number alongside each hop. Equivalent to --ipinfo 0.',
     },
     'interval': {
         'mtr': '{command} --interval {value}',
         'type': '<num>',
-        'help': 'Use this option to specify the positive number of seconds between ICMP ECHO requests. The default value for this parameter is one second. The root user may choose values between zero and one.'
+        'help': 'Use this option to specify the positive number of seconds between ICMP ECHO requests. The default value for this parameter is one second. The root user may choose values between zero and one.',
     },
     'report-cycles': {
         'mtr': '{command} --report-cycles {value}',
         'type': '<num>',
-        'help': 'Use this option to set the number of pings sent to determine both the machines on the network and the reliability of those machines.  Each cycle lasts one second.'
+        'help': 'Use this option to set the number of pings sent to determine both the machines on the network and the reliability of those machines.  Each cycle lasts one second.',
     },
     'psize': {
         'mtr': '{command} --psize {value}',
         'type': '<num>',
-        'help': 'This option sets the packet size used for probing. It is in bytes, inclusive IP and ICMP headers. If set to a negative number, every iteration will use a different, random packet size up to that number.'
+        'help': 'This option sets the packet size used for probing. It is in bytes, inclusive IP and ICMP headers. If set to a negative number, every iteration will use a different, random packet size up to that number.',
     },
     'bitpattern': {
         'mtr': '{command} --bitpattern {value}',
         'type': '<num>',
-        'help': 'Specifies bit pattern to use in payload. Should be within range 0 - 255. If NUM is greater than 255, a random pattern is used.'
+        'help': 'Specifies bit pattern to use in payload. Should be within range 0 - 255. If NUM is greater than 255, a random pattern is used.',
     },
     'gracetime': {
         'mtr': '{command} --gracetime {value}',
         'type': '<num>',
-        'help': 'Use this option to specify the positive number of seconds to wait for responses after the final request. The default value is five seconds.'
+        'help': 'Use this option to specify the positive number of seconds to wait for responses after the final request. The default value is five seconds.',
     },
     'tos': {
         'mtr': '{command} --tos {value}',
         'type': '<tos>',
-        'help': 'Specifies value for type of service field in IP header. Should be within range 0 - 255.'
+        'help': 'Specifies value for type of service field in IP header. Should be within range 0 - 255.',
     },
     'mpls': {
         'mtr': '{command} --mpls {value}',
         'type': 'noarg',
-        'help': 'Use this option to tell mtr to display information from ICMP extensions for MPLS (RFC 4950) that are encoded in the response packets.'
+        'help': 'Use this option to tell mtr to display information from ICMP extensions for MPLS (RFC 4950) that are encoded in the response packets.',
     },
     'interface': {
         'mtr': '{command} --interface {value}',
         'type': '<interface>',
         'helpfunction': interface_list,
-        'help': 'Use the network interface with a specific name for sending network probes. This can be useful when you have multiple network interfaces with routes to your destination, for example both wired Ethernet and WiFi, and wish to test a particular interface.'
+        'help': 'Use the network interface with a specific name for sending network probes. This can be useful when you have multiple network interfaces with routes to your destination, for example both wired Ethernet and WiFi, and wish to test a particular interface.',
     },
     'address': {
         'mtr': '{command} --address {value}',
         'type': '<x.x.x.x> <h:h:h:h:h:h:h:h>',
-        'help': 'Use this option to bind the outgoing socket to ADDRESS, so that all packets will be sent with ADDRESS as source address.'
+        'help': 'Use this option to bind the outgoing socket to ADDRESS, so that all packets will be sent with ADDRESS as source address.',
     },
     'first-ttl': {
         'mtr': '{command} --first-ttl {value}',
         'type': '<num>',
-        'help': 'Specifies with what TTL to start. Defaults to 1.'
+        'help': 'Specifies with what TTL to start. Defaults to 1.',
     },
     'max-ttl': {
         'mtr': '{command} --max-ttl {value}',
         'type': '<num>',
-        'help': 'Specifies the maximum number of hops or max time-to-live value mtr will probe. Default is 30.'
+        'help': 'Specifies the maximum number of hops or max time-to-live value mtr will probe. Default is 30.',
     },
     'max-unknown': {
         'mtr': '{command} --max-unknown {value}',
         'type': '<num>',
-        'help': 'Specifies the maximum unknown host. Default is 5.'
+        'help': 'Specifies the maximum unknown host. Default is 5.',
     },
     'udp': {
         'mtr': '{command} --udp',
         'type': 'noarg',
-        'help': 'Use UDP datagrams instead of ICMP ECHO.'
+        'help': 'Use UDP datagrams instead of ICMP ECHO.',
     },
     'tcp': {
         'mtr': '{command} --tcp',
         'type': 'noarg',
-        'help': ' Use TCP SYN packets instead of ICMP ECHO. PACKETSIZE is ignored, since SYN packets can not contain data.'
+        'help': ' Use TCP SYN packets instead of ICMP ECHO. PACKETSIZE is ignored, since SYN packets can not contain data.',
     },
     'sctp': {
         'mtr': '{command} --sctp',
         'type': 'noarg',
-        'help': 'Use Stream Control Transmission Protocol packets instead of ICMP ECHO.'
+        'help': 'Use Stream Control Transmission Protocol packets instead of ICMP ECHO.',
     },
     'port': {
         'mtr': '{command} --port {value}',
         'type': '<port>',
-        'help': 'The target port number for TCP/SCTP/UDP traces.'
+        'help': 'The target port number for TCP/SCTP/UDP traces.',
     },
     'localport': {
         'mtr': '{command} --localport {value}',
         'type': '<port>',
-        'help': 'The source port number for UDP traces.'
+        'help': 'The source port number for UDP traces.',
     },
     'timeout': {
         'mtr': '{command} --timeout {value}',
         'type': '<num>',
-        'help': ' The number of seconds to keep probe sockets open before giving up on the connection.'
+        'help': ' The number of seconds to keep probe sockets open before giving up on the connection.',
     },
     'mark': {
         'mtr': '{command} --mark {value}',
         'type': '<num>',
-        'help': ' Set the mark for each packet sent through this socket similar to the netfilter MARK target but socket-based. MARK is 32 unsigned integer.'
+        'help': ' Set the mark for each packet sent through this socket similar to the netfilter MARK target but socket-based. MARK is 32 unsigned integer.',
     },
     'vrf': {
         'mtr': 'sudo ip vrf exec {value} {command}',
         'type': '<vrf>',
         'help': 'Use specified VRF table',
         'helpfunction': vrf_list,
-        'dflt': 'default'
-        }
-    }
+        'dflt': 'default',
+    },
+}
 
 mtr = {
     4: '/bin/mtr -4',
@@ -204,8 +204,8 @@ def completion_failure(option: str) -> None:
 def expension_failure(option, completions):
     reason = 'Ambiguous' if completions else 'Invalid'
     sys.stderr.write(
-        '\n\n  {} command: {} [{}]\n\n'.format(reason, ' '.join(sys.argv),
-                                               option))
+        '\n\n  {} command: {} [{}]\n\n'.format(reason, ' '.join(sys.argv), option)
+    )
     if completions:
         sys.stderr.write('  Possible completions:\n   ')
         sys.stderr.write('\n   '.join(completions))
@@ -229,13 +229,13 @@ def convert(command, args):
         if longname == 'json':
             to_json = True
         if options[longname]['type'] == 'noarg':
-            command = options[longname]['mtr'].format(
-                command=command, value='')
+            command = options[longname]['mtr'].format(command=command, value='')
         elif not args:
             sys.exit(f'mtr: missing argument for {longname} option')
         else:
             command = options[longname]['mtr'].format(
-                command=command, value=args.first())
+                command=command, value=args.first()
+            )
     return command, to_json
 
 
@@ -244,7 +244,7 @@ if __name__ == '__main__':
     host = args.first()
 
     if not host:
-        sys.exit("mtr: Missing host")
+        sys.exit('mtr: Missing host')
 
     if host == '--get-options' or host == '--get-options-nested':
         if host == '--get-options-nested':
diff --git a/src/op_mode/mtr_execute.py b/src/op_mode/mtr_execute.py
new file mode 100644
index 000000000..2585a7ee4
--- /dev/null
+++ b/src/op_mode/mtr_execute.py
@@ -0,0 +1,217 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2024 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+import ipaddress
+import socket
+import sys
+import typing
+
+from json import loads
+
+from vyos.utils.network import interface_list
+from vyos.utils.network import vrf_list
+from vyos.utils.process import cmd
+from vyos.utils.process import call
+
+import vyos.opmode
+
+ArgProtocol = typing.Literal['tcp', 'udp', 'sctp']
+noargs_list = [
+    'report_mode',
+    'json',
+    'report_wide',
+    'split',
+    'raw',
+    'no_dns',
+    'aslookup',
+]
+
+
+def vrf_list_default():
+    return vrf_list() + ['default']
+
+
+options = {
+    'report_mode': {
+        'mtr': '{command} --report',
+    },
+    'protocol': {
+        'mtr': '{command} --{value}',
+    },
+    'json': {
+        'mtr': '{command} --json',
+    },
+    'report_wide': {
+        'mtr': '{command} --report-wide',
+    },
+    'raw': {
+        'mtr': '{command} --raw',
+    },
+    'split': {
+        'mtr': '{command} --split',
+    },
+    'no_dns': {
+        'mtr': '{command} --no-dns',
+    },
+    'show_ips': {
+        'mtr': '{command} --show-ips {value}',
+    },
+    'ipinfo': {
+        'mtr': '{command} --ipinfo {value}',
+    },
+    'aslookup': {
+        'mtr': '{command} --aslookup',
+    },
+    'interval': {
+        'mtr': '{command} --interval {value}',
+    },
+    'report_cycles': {
+        'mtr': '{command} --report-cycles {value}',
+    },
+    'psize': {
+        'mtr': '{command} --psize {value}',
+    },
+    'bitpattern': {
+        'mtr': '{command} --bitpattern {value}',
+    },
+    'gracetime': {
+        'mtr': '{command} --gracetime {value}',
+    },
+    'tos': {
+        'mtr': '{command} --tos {value}',
+    },
+    'mpls': {
+        'mtr': '{command} --mpls {value}',
+    },
+    'interface': {
+        'mtr': '{command} --interface {value}',
+        'helpfunction': interface_list,
+    },
+    'address': {
+        'mtr': '{command} --address {value}',
+    },
+    'first_ttl': {
+        'mtr': '{command} --first-ttl {value}',
+    },
+    'max_ttl': {
+        'mtr': '{command} --max-ttl {value}',
+    },
+    'max_unknown': {
+        'mtr': '{command} --max-unknown {value}',
+    },
+    'port': {
+        'mtr': '{command} --port {value}',
+    },
+    'localport': {
+        'mtr': '{command} --localport {value}',
+    },
+    'timeout': {
+        'mtr': '{command} --timeout {value}',
+    },
+    'mark': {
+        'mtr': '{command} --mark {value}',
+    },
+    'vrf': {
+        'mtr': 'sudo ip vrf exec {value} {command}',
+        'helpfunction': vrf_list_default,
+        'dflt': 'default',
+    },
+}
+
+mtr_command = {
+    4: '/bin/mtr -4',
+    6: '/bin/mtr -6',
+}
+
+
+def mtr(
+    host: str,
+    for_api: typing.Optional[bool],
+    report_mode: typing.Optional[bool],
+    protocol: typing.Optional[ArgProtocol],
+    report_wide: typing.Optional[bool],
+    raw: typing.Optional[bool],
+    json: typing.Optional[bool],
+    split: typing.Optional[bool],
+    no_dns: typing.Optional[bool],
+    show_ips: typing.Optional[str],
+    ipinfo: typing.Optional[str],
+    aslookup: typing.Optional[bool],
+    interval: typing.Optional[str],
+    report_cycles: typing.Optional[str],
+    psize: typing.Optional[str],
+    bitpattern: typing.Optional[str],
+    gracetime: typing.Optional[str],
+    tos: typing.Optional[str],
+    mpl: typing.Optional[bool],
+    interface: typing.Optional[str],
+    address: typing.Optional[str],
+    first_ttl: typing.Optional[str],
+    max_ttl: typing.Optional[str],
+    max_unknown: typing.Optional[str],
+    port: typing.Optional[str],
+    localport: typing.Optional[str],
+    timeout: typing.Optional[str],
+    mark: typing.Optional[str],
+    vrf: typing.Optional[str],
+):
+    args = locals()
+    for name, option in options.items():
+        if 'dflt' in option and not args[name]:
+            args[name] = option['dflt']
+
+    try:
+        ip = socket.gethostbyname(host)
+    except UnicodeError:
+        raise vyos.opmode.InternalError(f'Unknown host: {host}')
+    except socket.gaierror:
+        ip = host
+
+    try:
+        version = ipaddress.ip_address(ip).version
+    except ValueError:
+        raise vyos.opmode.InternalError(f'Unknown host: {host}')
+
+    command = mtr_command[version]
+
+    for key, val in args.items():
+        if key in options and val:
+            if 'helpfunction' in options[key]:
+                allowed_values = options[key]['helpfunction']()
+                if val not in allowed_values:
+                    raise vyos.opmode.InternalError(
+                        f'Invalid argument for option {key} - {val}'
+                    )
+            value = '' if key in noargs_list else val
+            command = options[key]['mtr'].format(command=command, value=val)
+
+    if json:
+        output = cmd(f'{command} {host}')
+        if for_api:
+            output = loads(output)
+        print(output)
+    else:
+        call(f'{command} --curses --displaymode 0 {host}')
+
+
+if __name__ == '__main__':
+    try:
+        res = vyos.opmode.run(sys.modules[__name__])
+        if res:
+            print(res)
+    except (ValueError, vyos.opmode.Error) as e:
+        print(e)
+        sys.exit(1)