aprsd 3.4.3__py3-none-any.whl → 4.0.0__py3-none-any.whl

aprsd/cmds/completion.py

@@ -3,12 +3,13 @@ import click.shell_completion
 
 from aprsd.main import cli
 
-
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
 
 @cli.command()
-@click.argument("shell", type=click.Choice(list(click.shell_completion._available_shells)))
+@click.argument(
+    "shell", type=click.Choice(list(click.shell_completion._available_shells))
+)
 def completion(shell):
     """Show the shell completion code"""
     from click.utils import _detect_program_name
@@ -17,6 +18,8 @@ def completion(shell):
     prog_name = _detect_program_name()
     complete_var = f"_{prog_name}_COMPLETE".replace("-", "_").upper()
     print(cls(cli, {}, prog_name, complete_var).source())
-    print("# Add the following line to your shell configuration file to have aprsd command line completion")
+    print(
+        "# Add the following line to your shell configuration file to have aprsd command line completion"
+    )
     print("# but remove the leading '#' character.")
-    print(f"# eval \"$(aprsd completion {shell})\"")
+    print(f'# eval "$(aprsd completion {shell})"')

aprsd/cmds/dev.py

@@ -9,18 +9,18 @@ import click
 from oslo_config import cfg
 
 from aprsd import cli_helper, conf, packets, plugin
+
 # local imports here
 from aprsd.client import base
 from aprsd.main import cli
 from aprsd.utils import trace
 
-
 CONF = cfg.CONF
-LOG = logging.getLogger("APRSD")
-CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+LOG = logging.getLogger('APRSD')
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
 
-@cli.group(help="Development type subcommands", context_settings=CONTEXT_SETTINGS)
+@cli.group(help='Development type subcommands', context_settings=CONTEXT_SETTINGS)
 @click.pass_context
 def dev(ctx):
     pass
@@ -29,37 +29,37 @@ def dev(ctx):
 @dev.command()
 @cli_helper.add_options(cli_helper.common_options)
 @click.option(
-    "--aprs-login",
-    envvar="APRS_LOGIN",
+    '--aprs-login',
+    envvar='APRS_LOGIN',
     show_envvar=True,
-    help="What callsign to send the message from.",
+    help='What callsign to send the message from.',
 )
 @click.option(
-    "-p",
-    "--plugin",
-    "plugin_path",
+    '-p',
+    '--plugin',
+    'plugin_path',
     show_default=True,
     default=None,
-    help="The plugin to run.  Ex: aprsd.plugins.ping.PingPlugin",
+    help='The plugin to run.  Ex: aprsd.plugins.ping.PingPlugin',
 )
 @click.option(
-    "-a",
-    "--all",
-    "load_all",
+    '-a',
+    '--all',
+    'load_all',
     show_default=True,
     is_flag=True,
     default=False,
-    help="Load all the plugins in config?",
+    help='Load all the plugins in config?',
 )
 @click.option(
-    "-n",
-    "--num",
-    "number",
+    '-n',
+    '--num',
+    'number',
     show_default=True,
     default=1,
-    help="Number of times to call the plugin",
+    help='Number of times to call the plugin',
 )
-@click.argument("message", nargs=-1, required=True)
+@click.argument('message', nargs=-1, required=True)
 @click.pass_context
 @cli_helper.process_standard_options
 def test_plugin(
@@ -76,7 +76,7 @@ def test_plugin(
 
     if not aprs_login:
         if CONF.aprs_network.login == conf.client.DEFAULT_LOGIN:
-            click.echo("Must set --aprs_login or APRS_LOGIN")
+            click.echo('Must set --aprs_login or APRS_LOGIN')
             ctx.exit(-1)
             return
         else:
@@ -86,33 +86,34 @@ def test_plugin(
 
     if not plugin_path:
         click.echo(ctx.get_help())
-        click.echo("")
-        click.echo("Failed to provide -p option to test a plugin")
+        click.echo('')
+        click.echo('Failed to provide -p option to test a plugin')
         ctx.exit(-1)
         return
 
     if type(message) is tuple:
-        message = " ".join(message)
+        message = ' '.join(message)
 
     if CONF.trace_enabled:
-        trace.setup_tracing(["method", "api"])
+        trace.setup_tracing(['method', 'api'])
 
     base.APRSClient()
 
     pm = plugin.PluginManager()
     if load_all:
-        pm.setup_plugins()
+        pm.setup_plugins(load_help_plugin=CONF.load_help_plugin)
     obj = pm._create_class(plugin_path, plugin.APRSDPluginBase)
     if not obj:
         click.echo(ctx.get_help())
-        click.echo("")
+        click.echo('')
         ctx.fail(f"Failed to create object from plugin path '{plugin_path}'")
         ctx.exit()
 
     # Register the plugin they wanted tested.
     LOG.info(
-        "Testing plugin {} Version {}".format(
-            obj.__class__, obj.version,
+        'Testing plugin {} Version {}'.format(
+            obj.__class__,
+            obj.version,
         ),
     )
     pm.register_msg(obj)
@@ -125,7 +126,7 @@ def test_plugin(
     )
     LOG.info(f"P'{plugin_path}'  F'{fromcall}'   C'{message}'")
 
-    for x in range(number):
+    for _ in range(number):
         replies = pm.run(packet)
         # Plugin might have threads, so lets stop them so we can exit.
         # obj.stop_threads()
@@ -146,17 +147,12 @@ def test_plugin(
             elif isinstance(reply, packets.Packet):
                 # We have a message based object.
                 LOG.info(reply)
-            else:
-                # A plugin can return a null message flag which signals
-                # us that they processed the message correctly, but have
-                # nothing to reply with, so we avoid replying with a
-                # usage string
-                if reply is not packets.NULL_MESSAGE:
-                    LOG.info(
-                        packets.MessagePacket(
-                            from_call=CONF.callsign,
-                            to_call=fromcall,
-                            message_text=reply,
-                        ),
-                    )
+            elif reply is not packets.NULL_MESSAGE:
+                LOG.info(
+                    packets.MessagePacket(
+                        from_call=CONF.callsign,
+                        to_call=fromcall,
+                        message_text=reply,
+                    ),
+                )
     pm.stop()

aprsd/cmds/fetch_stats.py

@@ -2,8 +2,8 @@
 import logging
 
 import click
-from oslo_config import cfg
 import requests
+from oslo_config import cfg
 from rich.console import Console
 from rich.table import Table
 
@@ -11,32 +11,34 @@ from rich.table import Table
 import aprsd
 from aprsd import cli_helper
 from aprsd.main import cli
-
+from aprsd.threads.stats import StatsStore
 
 # setup the global logger
 # log.basicConfig(level=log.DEBUG) # level=10
-LOG = logging.getLogger("APRSD")
+LOG = logging.getLogger('APRSD')
 CONF = cfg.CONF
 
 
 @cli.command()
 @cli_helper.add_options(cli_helper.common_options)
 @click.option(
-    "--host", type=str,
+    '--host',
+    type=str,
     default=None,
-    help="IP address of the remote aprsd admin web ui fetch stats from.",
+    help='IP address of the remote aprsd admin web ui fetch stats from.',
 )
 @click.option(
-    "--port", type=int,
+    '--port',
+    type=int,
     default=None,
-    help="Port of the remote aprsd web admin interface to fetch stats from.",
+    help='Port of the remote aprsd web admin interface to fetch stats from.',
 )
 @click.pass_context
 @cli_helper.process_standard_options
 def fetch_stats(ctx, host, port):
     """Fetch stats from a APRSD admin web interface."""
     console = Console()
-    console.print(f"APRSD Fetch-Stats started version: {aprsd.__version__}")
+    console.print(f'APRSD Fetch-Stats started version: {aprsd.__version__}')
 
     CONF.log_opt_values(LOG, logging.DEBUG)
     if not host:
@@ -44,113 +46,263 @@ def fetch_stats(ctx, host, port):
     if not port:
         port = CONF.admin.web_port
 
-    msg = f"Fetching stats from {host}:{port}"
+    msg = f'Fetching stats from {host}:{port}'
     console.print(msg)
     with console.status(msg):
-        response = requests.get(f"http://{host}:{port}/stats", timeout=120)
+        response = requests.get(f'http://{host}:{port}/stats', timeout=120)
         if not response:
             console.print(
-                f"Failed to fetch stats from {host}:{port}?",
-                style="bold red",
+                f'Failed to fetch stats from {host}:{port}?',
+                style='bold red',
             )
             return
 
         stats = response.json()
         if not stats:
             console.print(
-                f"Failed to fetch stats from aprsd admin ui at {host}:{port}",
-                style="bold red",
+                f'Failed to fetch stats from aprsd admin ui at {host}:{port}',
+                style='bold red',
             )
             return
 
     aprsd_title = (
-        "APRSD "
-        f"[bold cyan]v{stats['APRSDStats']['version']}[/] "
-        f"Callsign [bold green]{stats['APRSDStats']['callsign']}[/] "
-        f"Uptime [bold yellow]{stats['APRSDStats']['uptime']}[/]"
+        'APRSD '
+        f'[bold cyan]v{stats["APRSDStats"]["version"]}[/] '
+        f'Callsign [bold green]{stats["APRSDStats"]["callsign"]}[/] '
+        f'Uptime [bold yellow]{stats["APRSDStats"]["uptime"]}[/]'
     )
 
-    console.rule(f"Stats from {host}:{port}")
-    console.print("\n\n")
+    console.rule(f'Stats from {host}:{port}')
+    console.print('\n\n')
     console.rule(aprsd_title)
 
     # Show the connection to APRS
     # It can be a connection to an APRS-IS server or a local TNC via KISS or KISSTCP
-    if "aprs-is" in stats:
-        title = f"APRS-IS Connection {stats['APRSClientStats']['server_string']}"
+    if 'aprs-is' in stats:
+        title = f'APRS-IS Connection {stats["APRSClientStats"]["server_string"]}'
         table = Table(title=title)
-        table.add_column("Key")
-        table.add_column("Value")
-        for key, value in stats["APRSClientStats"].items():
+        table.add_column('Key')
+        table.add_column('Value')
+        for key, value in stats['APRSClientStats'].items():
             table.add_row(key, value)
         console.print(table)
 
-    threads_table = Table(title="Threads")
-    threads_table.add_column("Name")
-    threads_table.add_column("Alive?")
-    for name, alive in stats["APRSDThreadList"].items():
+    threads_table = Table(title='Threads')
+    threads_table.add_column('Name')
+    threads_table.add_column('Alive?')
+    for name, alive in stats['APRSDThreadList'].items():
         threads_table.add_row(name, str(alive))
 
     console.print(threads_table)
 
-    packet_totals = Table(title="Packet Totals")
-    packet_totals.add_column("Key")
-    packet_totals.add_column("Value")
-    packet_totals.add_row("Total Received", str(stats["PacketList"]["rx"]))
-    packet_totals.add_row("Total Sent", str(stats["PacketList"]["tx"]))
+    packet_totals = Table(title='Packet Totals')
+    packet_totals.add_column('Key')
+    packet_totals.add_column('Value')
+    packet_totals.add_row('Total Received', str(stats['PacketList']['rx']))
+    packet_totals.add_row('Total Sent', str(stats['PacketList']['tx']))
     console.print(packet_totals)
 
     # Show each of the packet types
-    packets_table = Table(title="Packets By Type")
-    packets_table.add_column("Packet Type")
-    packets_table.add_column("TX")
-    packets_table.add_column("RX")
-    for key, value in stats["PacketList"]["packets"].items():
-        packets_table.add_row(key, str(value["tx"]), str(value["rx"]))
+    packets_table = Table(title='Packets By Type')
+    packets_table.add_column('Packet Type')
+    packets_table.add_column('TX')
+    packets_table.add_column('RX')
+    for key, value in stats['PacketList']['packets'].items():
+        packets_table.add_row(key, str(value['tx']), str(value['rx']))
 
     console.print(packets_table)
 
-    if "plugins" in stats:
-        count = len(stats["PluginManager"])
-        plugins_table = Table(title=f"Plugins ({count})")
-        plugins_table.add_column("Plugin")
-        plugins_table.add_column("Enabled")
-        plugins_table.add_column("Version")
-        plugins_table.add_column("TX")
-        plugins_table.add_column("RX")
-        plugins = stats["PluginManager"]
-        for key, value in plugins.items():
+    if 'plugins' in stats:
+        count = len(stats['PluginManager'])
+        plugins_table = Table(title=f'Plugins ({count})')
+        plugins_table.add_column('Plugin')
+        plugins_table.add_column('Enabled')
+        plugins_table.add_column('Version')
+        plugins_table.add_column('TX')
+        plugins_table.add_column('RX')
+        plugins = stats['PluginManager']
+        for key, _ in plugins.items():
             plugins_table.add_row(
                 key,
-                str(plugins[key]["enabled"]),
-                plugins[key]["version"],
-                str(plugins[key]["tx"]),
-                str(plugins[key]["rx"]),
+                str(plugins[key]['enabled']),
+                plugins[key]['version'],
+                str(plugins[key]['tx']),
+                str(plugins[key]['rx']),
             )
 
         console.print(plugins_table)
 
-    seen_list = stats.get("SeenList")
-
-    if seen_list:
+    if seen_list := stats.get('SeenList'):
         count = len(seen_list)
-        seen_table = Table(title=f"Seen List ({count})")
-        seen_table.add_column("Callsign")
-        seen_table.add_column("Message Count")
-        seen_table.add_column("Last Heard")
+        seen_table = Table(title=f'Seen List ({count})')
+        seen_table.add_column('Callsign')
+        seen_table.add_column('Message Count')
+        seen_table.add_column('Last Heard')
         for key, value in seen_list.items():
-            seen_table.add_row(key, str(value["count"]), value["last"])
+            seen_table.add_row(key, str(value['count']), value['last'])
 
         console.print(seen_table)
 
-    watch_list = stats.get("WatchList")
-
-    if watch_list:
+    if watch_list := stats.get('WatchList'):
         count = len(watch_list)
-        watch_table = Table(title=f"Watch List ({count})")
-        watch_table.add_column("Callsign")
-        watch_table.add_column("Last Heard")
+        watch_table = Table(title=f'Watch List ({count})')
+        watch_table.add_column('Callsign')
+        watch_table.add_column('Last Heard')
         for key, value in watch_list.items():
-            watch_table.add_row(key, value["last"])
+            watch_table.add_row(key, value['last'])
 
         console.print(watch_table)
+
+
+@cli.command()
+@cli_helper.add_options(cli_helper.common_options)
+@click.option(
+    '--raw',
+    is_flag=True,
+    default=False,
+    help='Dump raw stats instead of formatted output.',
+)
+@click.option(
+    '--show-section',
+    default=['All'],
+    help='Show specific sections of the stats. '
+    ' Choices: All, APRSDStats, APRSDThreadList, APRSClientStats,'
+    ' PacketList, SeenList, WatchList',
+    multiple=True,
+    type=click.Choice(
+        [
+            'All',
+            'APRSDStats',
+            'APRSDThreadList',
+            'APRSClientStats',
+            'PacketList',
+            'SeenList',
+            'WatchList',
+        ],
+        case_sensitive=False,
+    ),
+)
+@click.pass_context
+@cli_helper.process_standard_options
+def dump_stats(ctx, raw, show_section):
+    """Dump the current stats from the running APRSD instance."""
+    console = Console()
+    console.print(f'APRSD Dump-Stats started version: {aprsd.__version__}')
+
+    with console.status('Dumping stats'):
+        ss = StatsStore()
+        ss.load()
+        stats = ss.data
+        if raw:
+            if 'All' in show_section:
+                console.print(stats)
+                return
+            else:
+                for section in show_section:
+                    console.print(f'Dumping {section} section:')
+                    console.print(stats[section])
+                return
+
+        t = Table(title='APRSD Stats')
+        t.add_column('Key')
+        t.add_column('Value')
+        for key, value in stats['APRSDStats'].items():
+            t.add_row(key, str(value))
+
+        if 'All' in show_section or 'APRSDStats' in show_section:
+            console.print(t)
+
+        # Show the thread list
+        t = Table(title='Thread List')
+        t.add_column('Name')
+        t.add_column('Class')
+        t.add_column('Alive?')
+        t.add_column('Loop Count')
+        t.add_column('Age')
+        for name, value in stats['APRSDThreadList'].items():
+            t.add_row(
+                name,
+                value['class'],
+                str(value['alive']),
+                str(value['loop_count']),
+                str(value['age']),
+            )
+
+        if 'All' in show_section or 'APRSDThreadList' in show_section:
+            console.print(t)
+
+        # Show the plugins
+        t = Table(title='Plugin List')
+        t.add_column('Name')
+        t.add_column('Enabled')
+        t.add_column('Version')
+        t.add_column('TX')
+        t.add_column('RX')
+        for name, value in stats['PluginManager'].items():
+            t.add_row(
+                name,
+                str(value['enabled']),
+                value['version'],
+                str(value['tx']),
+                str(value['rx']),
+            )
+
+        if 'All' in show_section or 'PluginManager' in show_section:
+            console.print(t)
+
+        # Now show the client stats
+        t = Table(title='Client Stats')
+        t.add_column('Key')
+        t.add_column('Value')
+        for key, value in stats['APRSClientStats'].items():
+            t.add_row(key, str(value))
+
+        if 'All' in show_section or 'APRSClientStats' in show_section:
+            console.print(t)
+
+        # now show the packet list
+        packet_list = stats.get('PacketList')
+        t = Table(title='Packet List')
+        t.add_column('Key')
+        t.add_column('Value')
+        t.add_row('Total Received', str(packet_list['rx']))
+        t.add_row('Total Sent', str(packet_list['tx']))
+
+        if 'All' in show_section or 'PacketList' in show_section:
+            console.print(t)
+
+        # now show the seen list
+        seen_list = stats.get('SeenList')
+        sorted_seen_list = sorted(
+            seen_list.items(),
+        )
+        t = Table(title='Seen List')
+        t.add_column('Callsign')
+        t.add_column('Message Count')
+        t.add_column('Last Heard')
+        for key, value in sorted_seen_list:
+            t.add_row(
+                key,
+                str(value['count']),
+                str(value['last']),
+            )
+
+        if 'All' in show_section or 'SeenList' in show_section:
+            console.print(t)
+
+        # now show the watch list
+        watch_list = stats.get('WatchList')
+        sorted_watch_list = sorted(
+            watch_list.items(),
+        )
+        t = Table(title='Watch List')
+        t.add_column('Callsign')
+        t.add_column('Last Heard')
+        for key, value in sorted_watch_list:
+            t.add_row(
+                key,
+                str(value['last']),
+            )
+
+        if 'All' in show_section or 'WatchList' in show_section:
+            console.print(t)

aprsd/cmds/healthcheck.py

@@ -13,13 +13,15 @@ from oslo_config import cfg
 from rich.console import Console
 
 import aprsd
-from aprsd import cli_helper
-from aprsd import conf  # noqa
+from aprsd import (  # noqa: F401
+    cli_helper,
+    conf,
+)
+
 # local imports here
 from aprsd.main import cli
 from aprsd.threads import stats as stats_threads
 
-
 # setup the global logger
 # log.basicConfig(level=log.DEBUG) # level=10
 CONF = cfg.CONF
@@ -63,7 +65,7 @@ def healthcheck(ctx, timeout):
 
                 if email_thread_last_update != "never":
                     d = now - email_thread_last_update
-                    max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 0}
+                    max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 30}
                     max_delta = datetime.timedelta(**max_timeout)
                     if d > max_delta:
                         console.log(f"Email thread is very old! {d}")
@@ -74,7 +76,7 @@ def healthcheck(ctx, timeout):
                 console.log("No APRSClientStats")
                 sys.exit(-1)
             else:
-                aprsis_last_update = client_stats["server_keepalive"]
+                aprsis_last_update = client_stats["connection_keepalive"]
                 d = now - aprsis_last_update
                 max_timeout = {"hours": 0.0, "minutes": 5, "seconds": 0}
                 max_delta = datetime.timedelta(**max_timeout)