lockss-debugpanel 0.8.2__tar.gz → 0.9.0.dev2__tar.gz

{lockss_debugpanel-0.8.2 → lockss_debugpanel-0.9.0.dev2}/CHANGELOG.rst

@@ -2,13 +2,19 @@
 Release Notes
 =============
 
+-----
+0.9.0
+-----
+
+Released: NOT YET RELEASED
+
 -----
 0.8.2
 -----
 
 Released: 2026-02-03
 
-   *  Requires Python 3.9-3.13.
+*  Requires Python 3.9-3.13.
 
 -----
 0.8.1
@@ -20,10 +26,6 @@ Released: 2025-08-13
 
    *  Fixed bug in the processing of ``--nodes`` and ``--auids`` options.
 
-*  **Version 0.8.1-post1** (released: 2026-02-03)
-
-   *  Requires Python 3.9-3.13.
-
 -----
 0.8.0
 -----

{lockss_debugpanel-0.8.2 → lockss_debugpanel-0.9.0.dev2}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: lockss-debugpanel
-Version: 0.8.2
-Summary: Library and command line tool to interact with the LOCKSS 1.x DebugPanel servlet
+Version: 0.9.0.dev2
+Summary: Command line tool and Python library to interact with the LOCKSS 1.x DebugPanel servlet
 License: BSD-3-Clause
 License-File: LICENSE
 Author: Thib Guicherd-Callin
 Author-email: thib@cs.stanford.edu
 Maintainer: Thib Guicherd-Callin
 Maintainer-email: thib@cs.stanford.edu
-Requires-Python: >=3.9,<3.14
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pydantic :: 2
@@ -19,10 +19,8 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: System :: Archiving
 Classifier: Topic :: Utilities
-Requires-Dist: lockss-pybasic (>=0.1.0,<0.2.0)
-Requires-Dist: pydantic (>=2.11.0,<3.0.0)
-Requires-Dist: pydantic-argparse (>=0.10.0,<0.11.0)
-Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: click-extra (>=7.5.0,<7.6.0)
+Requires-Dist: lockss-pybasic (==0.2.0-dev11)
 Project-URL: Documentation, https://docs.lockss.org/en/latest/software/debugpanel
 Project-URL: Repository, https://github.com/lockss/lockss-debugpanel
 Project-URL: changelog, https://github.com/lockss/lockss-debugpanel/blob/main/CHANGELOG.rst
@@ -33,8 +31,8 @@ Description-Content-Type: text/x-rst
 Debugpanel
 ==========
 
-.. |RELEASE| replace:: 0.8.2
-.. |RELEASE_DATE| replace:: 2026-02-03
+.. |RELEASE| replace:: 0.9.0-dev2
+.. |RELEASE_DATE| replace:: NOT YET RELEASED
 .. |DEBUGPANEL| replace:: **Debugpanel**
 
 .. image:: https://assets.lockss.org/images/logos/debugpanel/debugpanel_128x128.png
@@ -67,9 +65,14 @@ Quick Start::
    debugpanel reload-config -n lockss1.example.edu:8081
 
    # Crawl AUIDs from list.txt on lockss1.example.edu:8081 and lockss2.example.edu:8081
-   # ...First alternative: each node gets a -n
+
+   # ...First alternative: each node gets a -n option
    debugpanel crawl -A list.txt -n lockss1.example.edu:8081 -n lockss2.example.edu:8081
 
-   # ...Second alternative: each -n can have more than argument
+   # ...Second alternative: each -n option can have arguments
    debugpanel crawl -A list.txt -n lockss1.example.edu:8081 lockss2.example.edu:8081
 
+   # ...Third alternative: list lockss1.example.edu:8081 and lockss2.example.edu:8081 in nodes.txt
+   debugpanel crawl -A list.txt -N nodes.txt
+
+

{lockss_debugpanel-0.8.2 → lockss_debugpanel-0.9.0.dev2}/README.rst

@@ -2,8 +2,8 @@
 Debugpanel
 ==========
 
-.. |RELEASE| replace:: 0.8.2
-.. |RELEASE_DATE| replace:: 2026-02-03
+.. |RELEASE| replace:: 0.9.0-dev2
+.. |RELEASE_DATE| replace:: NOT YET RELEASED
 .. |DEBUGPANEL| replace:: **Debugpanel**
 
 .. image:: https://assets.lockss.org/images/logos/debugpanel/debugpanel_128x128.png
@@ -36,8 +36,13 @@ Quick Start::
    debugpanel reload-config -n lockss1.example.edu:8081
 
    # Crawl AUIDs from list.txt on lockss1.example.edu:8081 and lockss2.example.edu:8081
-   # ...First alternative: each node gets a -n
+
+   # ...First alternative: each node gets a -n option
    debugpanel crawl -A list.txt -n lockss1.example.edu:8081 -n lockss2.example.edu:8081
 
-   # ...Second alternative: each -n can have more than argument
+   # ...Second alternative: each -n option can have arguments
    debugpanel crawl -A list.txt -n lockss1.example.edu:8081 lockss2.example.edu:8081
+
+   # ...Third alternative: list lockss1.example.edu:8081 and lockss2.example.edu:8081 in nodes.txt
+   debugpanel crawl -A list.txt -N nodes.txt
+

{lockss_debugpanel-0.8.2 → lockss_debugpanel-0.9.0.dev2}/pyproject.toml

@@ -28,11 +28,11 @@
 
 [project]
 name = "lockss-debugpanel"
-version = "0.8.2" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
-description = "Library and command line tool to interact with the LOCKSS 1.x DebugPanel servlet"
+version = "0.9.0-dev2" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+description = "Command line tool and Python library to interact with the LOCKSS 1.x DebugPanel servlet"
 license = { text = "BSD-3-Clause" }
 readme = "README.rst"
-requires-python = ">=3.9,<3.14"
+requires-python = ">=3.10,<4.0"
 authors = [
     { name = "Thib Guicherd-Callin",  email = "thib@cs.stanford.edu" },
 ]
@@ -40,10 +40,8 @@ maintainers = [
     { name = "Thib Guicherd-Callin",  email = "thib@cs.stanford.edu" }
 ]
 dependencies = [
-    "lockss-pybasic (>=0.1.0,<0.2.0)",
-    "pydantic (>=2.11.0,<3.0.0)",
-    "pydantic-argparse (>=0.10.0,<0.11.0)",
-    "tabulate (>=0.9.0,<0.10.0)"
+    "click-extra (>=7.5.0,<7.6.0)",
+    "lockss-pybasic (==0.2.0-dev11)",
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",

{lockss_debugpanel-0.8.2 → lockss_debugpanel-0.9.0.dev2}/src/lockss/debugpanel/__init__.py

@@ -1,38 +1,10 @@
 #!/usr/bin/env python3
 
-# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# 1. Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# 3. Neither the name of the copyright holder nor the names of its contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-
 """
 Library and command line tool to interact with the LOCKSS 1.x DebugPanel servlet.
 """
 
-__version__ = '0.8.2'
+__version__ = '0.9.0-dev2'
 
 __copyright__ = '''
 Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
@@ -69,7 +41,7 @@ POSSIBILITY OF SUCH DAMAGE.
 
 from base64 import b64encode
 from urllib.request import Request, urlopen
-from typing import Any, Dict
+from typing import Any
 
 
 type RequestUrlOpenT = Any
@@ -303,7 +275,7 @@ def _auid_action(node: Node, auid: str, action: str, **kwargs) -> RequestUrlOpen
                    ``Force Deep Crawl``.
     :type action: str
     :param kwargs: Key-value pairs of additional query string arguments.
-    :type kwargs: Dict[str, Any]
+    :type kwargs: dict[str, Any]
     :return: The result of calling `urllib.request.urlopen`` on an appropriate
              URL.
     :rtype: RequestUrlOpenT
@@ -326,7 +298,7 @@ def _make_request(node: Node, query: str, **kwargs) -> Request:
     :type query: str
     :param kwargs: Key-value pairs of additional query string arguments, e.g.
                    ``(..., depth=99)`` to add ``"&depth=99"``.
-    :type kwargs: Dict[str, Any]
+    :type kwargs: dict[str, Any]
     :return: An authenticated ``Request`` instance (before
              ``urllib.request.urlopen`` is called).
     :rtype: Request
@@ -350,7 +322,7 @@ def _node_action(node: Node, action: str, **kwargs) -> RequestUrlOpenT:
     :type action: str
     :param kwargs: Key-value pairs of additional query string arguments, e.g.
                    ``(..., depth=99)`` to add ``"&depth=99"``.
-    :type kwargs: Dict[str, Any]
+    :type kwargs: dict[str, Any]
     :return: The result of calling `urllib.request.urlopen`` on an appropriate
              URL.
     :rtype: RequestUrlOpenT

lockss_debugpanel-0.9.0.dev2/src/lockss/debugpanel/cli.py

@@ -0,0 +1,400 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+"""
+Command line tool to interact with the LOCKSS 1.x DebugPanel servlet.
+"""
+
+from collections.abc import Callable
+from concurrent.futures import Executor, Future, ProcessPoolExecutor, ThreadPoolExecutor, as_completed
+from enum import Enum
+from itertools import chain
+from pathlib import Path
+from typing import Any, Optional
+
+from click_extra import ChoiceSource, EnumChoice, ExtraContext, HelpExtraFormatter, IntRange, Style, color_option, group, option, option_group, pass_context, password_option, progressbar, show_params_option, table_format_option
+from click_extra.colorize import default_theme
+from cloup.constraints import mutually_exclusive
+
+from lockss.pybasic.cliutil import click_path
+from lockss.pybasic.errorutil import InternalError
+from lockss.pybasic.fileutil import file_lines, path
+from . import Node, RequestUrlOpenT, check_substance, crawl, crawl_plugins, deep_crawl, disable_indexing, poll, reload_config, reindex_metadata, validate_files, DEFAULT_DEPTH, __copyright__, __license__, __version__
+
+
+class _JobPoolType(Enum):
+    """
+    An enum of job pool types.
+
+    See also ``_DEFAULT_JOB_POOL_TYPE``.
+    """
+    THREAD_POOL = 'thread-pool'
+    PROCESS_POOL = 'process-pool'
+
+    def __str__(self):
+        return self.value
+
+
+_DEFAULT_JOB_POOL_TYPE: _JobPoolType = _JobPoolType.THREAD_POOL
+
+
+class _DebugPanelCli(object):
+
+    def __init__(self):
+        super().__init__()
+        self._auids: Optional[list[str]] = None
+        self._auth: Optional[tuple[str, str]] = None
+        self._ctx: Optional[ExtraContext] = None
+        self._executor: Optional[Executor] = None
+        self._nodes: Optional[list[str]] = None
+
+    def _do_auid_command(self,
+                         node_auid_func: Callable[[Node, str], RequestUrlOpenT],
+                         **kwargs: dict[str, Any]) -> None:
+        """
+        Performs one AUID-centric command.
+
+        :param node_auid_func: A function that applies to a ``Node`` and an AUID
+                               and returns what ``urllib.request.urlopen``
+                               returns.
+        :type node_auid_func: ``RequestUrlOpenT``
+        :param kwargs: Keyword arguments (needed for the ``depth`` command).
+        :type kwargs: Dict[str, Any]
+        """
+        node_objects = [Node(node, *self._auth) for node in self._nodes]
+        futures: dict[Future, tuple[str, str]] = {self._executor.submit(node_auid_func, node_object, auid, **kwargs): (node, auid) for auid in self._auids for node, node_object in zip(self._nodes, node_objects)}
+        results: dict[tuple[str, str], Any] = {}
+        with progressbar(as_completed(futures), length=len(futures), label='Progress') as bar:
+            for future in bar:
+                with future.result() as resp:
+                    node_auid = futures[future]
+                    try:
+                        status: int = resp.status
+                        reason: str = resp.reason
+                        results[node_auid] = 'Requested' if status == 200 else reason
+                    except Exception as exc:
+                        results[node_auid] = exc
+        self._ctx.print_table([[auid, *[results[(node, auid)] for node in self._nodes]] for auid in self._auids],
+                              ['AUID', *self._nodes])
+
+    def _do_node_command(self,
+                         node_func: Callable[[Node], RequestUrlOpenT],
+                         **kwargs: dict[str, Any]) -> None:
+        """
+        Performs one node-centric command.
+
+        :param node_func: A function that applies to a ``Node`` and returns
+                          what ``urllib.request.urlopen`` returns.
+        :type node_auid_func: ``RequestUrlOpenT``
+        :param kwargs: Keyword arguments (not currently needed by any command).
+        :type kwargs: Dict[str, Any]
+        """
+        node_objects = [Node(node, *self._auth) for node in self._nodes]
+        futures: dict[Future, str] = {self._executor.submit(node_func, node_object, **kwargs): node for node, node_object in zip(self._nodes, node_objects)}
+        results: dict[str, Any] = {}
+        with progressbar(as_completed(futures), length=len(futures), label='Progress') as bar:
+            for future in bar:
+                with future.result() as resp:
+                    node = futures[future]
+                    try:
+                        status: int = resp.status
+                        reason: str = resp.reason
+                        results[node] = 'Requested' if status == 200 else reason
+                    except Exception as exc:
+                        results[node] = exc
+        self._ctx.print_table([[node, results[node]] for node in self._nodes],
+                              ['Node', 'Result'])
+
+    def _initialize_auid_operation(self,
+                                   cli_ctx: ExtraContext,
+                                   cli_node: tuple[str, ...],
+                                   cli_nodes: tuple[Path, ...],
+                                   cli_username: str,
+                                   cli_password: str,
+                                   cli_auid: tuple[str, ...],
+                                   cli_auids: tuple[Path, ...],
+                                   cli_pool_size: Optional[int],
+                                   cli_pool_type: _JobPoolType,
+                                   cli_process_pool: bool,
+                                   cli_thread_pool: bool) -> None:
+        self._ctx = self._ctx or cli_ctx
+        self._initialize_node_operation(cli_ctx,
+                                        cli_node,
+                                        cli_nodes,
+                                        cli_username,
+                                        cli_password,
+                                        cli_pool_size,
+                                        cli_pool_type,
+                                        cli_process_pool,
+                                        cli_thread_pool)
+        self._auids = [*cli_auid, *chain.from_iterable(file_lines(file_path) for file_path in cli_auids)]
+        if len(self._auids) == 0:
+            raise ValueError('The list of AUIDs to process is empty')
+
+    def _initialize_node_operation(self,
+                                   cli_ctx: ExtraContext,
+                                   cli_node: tuple[str, ...],
+                                   cli_nodes: tuple[Path, ...],
+                                   cli_username: str,
+                                   cli_password: str,
+                                   cli_pool_size: Optional[int],
+                                   cli_pool_type: _JobPoolType,
+                                   cli_process_pool: bool,
+                                   cli_thread_pool: bool) -> None:
+        self._ctx = self._ctx or cli_ctx
+        self._nodes = [*cli_node, *chain.from_iterable(file_lines(file_path) for file_path in cli_nodes)]
+        if len(self._nodes) == 0:
+            raise ValueError('The list of nodes to process is empty')
+        self._auth = (cli_username, cli_password)
+        if cli_process_pool:
+            cli_pool_type = _JobPoolType.PROCESS_POOL
+        elif cli_thread_pool:
+            cli_pool_type = _JobPoolType.THREAD_POOL
+        match cli_pool_type:
+            case _JobPoolType.PROCESS_POOL:
+                self._executor = ProcessPoolExecutor(max_workers=cli_pool_size)
+            case _JobPoolType.THREAD_POOL:
+                self._executor = ThreadPoolExecutor(max_workers=cli_pool_size)
+            case _:
+                raise InternalError() from ValueError(cli_pool_type)
+
+
+_node_options = option_group(
+    'Node options',
+    option('--node', '-n', metavar='NODE', multiple=True, help='Add NODE to the list of nodes to process.'),
+    option('--nodes', '-N', metavar='FILE', type=click_path('ferz'), multiple=True, help='Add the nodes in FILE to the list of nodes to process.'),
+    option('--username', '-u', metavar='USER', show_default='interactive prompt', help='Set the UI username to USER.', prompt='UI username'),
+    password_option('--password', '-p', metavar='PASS', show_default='interactive prompt', help='Set the UI password to PASS.', prompt='UI password', confirmation_prompt=False)
+)
+
+
+_auid_options = option_group(
+    'AUID options',
+    option('--auid', '-a', metavar='AUID', multiple=True, help='Add AUID to the list of AUIDs to process.'),
+    option('--auids', '-A', metavar='FILE', type=click_path('ferz'), multiple=True, help='Add the AUIDs in FILE to the list of AUIDs to process.')
+)
+
+
+_pool_options = option_group(
+    'Job pool options',
+    option('--pool-size', metavar='SIZE', type=Optional[IntRange(1, None)], default=None, help='Set the job pool size to SIZE.', show_default='CPU-dependent'),
+    mutually_exclusive(
+        option('--pool-type', type=EnumChoice(choices=_JobPoolType, choice_source=ChoiceSource.VALUE), show_choices=True, default=_DEFAULT_JOB_POOL_TYPE, help=f'Set the job pool type to the given type.'),
+        option('--process-pool', is_flag=True, deprecated='Use --pool-type=process-pool instead.'),
+        option('--thread-pool', is_flag=True, deprecated='Use --pool-type=thread-pool instead.')
+    )
+)
+
+
+_table_format_option = table_format_option(help='Set the rendering of tables to the given style.')
+
+@group('debugpanel', params=None,
+       context_settings=ExtraContext.settings(
+           formatter_settings=HelpExtraFormatter.settings(
+               theme=default_theme.with_(
+                   invoked_command=Style(bold=True)
+               )
+           )
+       )
+)
+@color_option
+@show_params_option
+@pass_context
+def _debugpanel(ctx: ExtraContext, **kwargs):
+    ctx.obj = _DebugPanelCli()
+
+
+@_debugpanel.command('check-substance', aliases=['cs'], help='Cause nodes to check the substance of AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@_table_format_option
+@pass_context
+def _check_substance(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(check_substance)
+
+
+@_debugpanel.command('copyright', help='Show the copyright then exit.')
+def _copyright() -> None:
+    print(__copyright__)
+
+
+@_debugpanel.command('crawl', aliases=['cr'], help='Cause nodes to crawl AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@table_format_option
+@pass_context
+def _crawl(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(crawl)
+
+
+@_debugpanel.command('crawl-plugins', aliases=['cp'], help='Cause nodes to crawl plugins.')
+@_node_options
+@_pool_options
+@table_format_option
+@pass_context
+def _crawl_plugins(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_node_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_node_command(crawl_plugins)
+
+
+@_debugpanel.command('deep-crawl', aliases=['dc'], help='Cause nodes to deep-crawl AUs.')
+@_node_options
+@_auid_options
+@option_group(
+    'Depth options',
+    option('--depth', '-d', metavar='DEPTH', type=IntRange(1, None), default=DEFAULT_DEPTH, help='Set the crawl depth to DEPTH.')
+)
+@_pool_options
+@table_format_option
+@pass_context
+def _deep_crawl(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(deep_crawl, depth=kwargs.get('depth'))
+
+
+@_debugpanel.command('disable-indexing', aliases=['di'], help='Cause nodes to disable metadata indexing for AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@table_format_option
+@pass_context
+def _disable_indexing(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(disable_indexing)
+
+
+@_debugpanel.command('license', help='Show the software license then exit.')
+def license() -> None:
+    print(__license__)
+
+
+@_debugpanel.command('poll', aliases=['po'], help='Cause nodes to poll AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@table_format_option
+@pass_context
+def _poll(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(poll)
+
+
+@_debugpanel.command('reindex-metadata', aliases=['ri'], help='Cause nodes to reindex the metadata of AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@table_format_option
+@pass_context
+def _reindex_metadata(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(reindex_metadata)
+
+
+@_debugpanel.command('reload-config', aliases=['rc'], help='Cause nodes to reload their configuration.')
+@_node_options
+@_pool_options
+@table_format_option
+@pass_context
+def _reload_config(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_node_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_node_command(reload_config)
+
+
+@_debugpanel.command('validate-files', aliases=['vf'], help='Cause nodes to validate the files of AUs.')
+@_node_options
+@_auid_options
+@_pool_options
+@table_format_option
+@pass_context
+def _validate_files(ctx: ExtraContext, **kwargs) -> None:
+    cli: _DebugPanelCli = ctx.obj
+    args = [kwargs.get(k) for k in ['node', 'nodes', 'username', 'password', 'auid', 'auids', 'pool_size', 'pool_type', 'process_pool', 'thread_pool']]
+    try:
+        cli._initialize_auid_operation(ctx, *args)
+    except ValueError as ve:
+        ctx.fail(str(ve))
+    cli._do_auid_command(validate_files)
+
+
+@_debugpanel.command('version', help='Show the version number then exit.')
+def version() -> None:
+    print(__version__)
+
+
+def main() -> None:
+    _debugpanel()
+
+
+if __name__ == '__main__':
+    main()

lockss_debugpanel-0.8.2/src/lockss/debugpanel/cli.py

@@ -1,379 +0,0 @@
-#!/usr/bin/env python3
-
-# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# 1. Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# 3. Neither the name of the copyright holder nor the names of its contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-
-"""
-Command line tool to interact with the LOCKSS 1.x DebugPanel servlet.
-"""
-
-from collections.abc import Callable
-from concurrent.futures import Executor, Future, ProcessPoolExecutor, ThreadPoolExecutor, as_completed
-from enum import Enum
-from getpass import getpass
-from itertools import chain
-from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple
-
-from pydantic.v1 import BaseModel, Field, FilePath, root_validator, validator
-from pydantic.v1.types import PositiveInt
-from tabulate import tabulate
-
-from lockss.pybasic.cliutil import BaseCli, StringCommand, at_most_one_from_enum, get_from_enum, COPYRIGHT_DESCRIPTION, LICENSE_DESCRIPTION, VERSION_DESCRIPTION
-from lockss.pybasic.errorutil import InternalError
-from lockss.pybasic.fileutil import file_lines, path
-from lockss.pybasic.outpututil import OutputFormatOptions
-from . import Node, RequestUrlOpenT, check_substance, crawl, crawl_plugins, deep_crawl, disable_indexing, poll, reload_config, reindex_metadata, validate_files, DEFAULT_DEPTH, __copyright__, __license__, __version__
-
-
-class JobPool(Enum):
-    """
-    An enum of job pool types.
-
-    See also ``DEFAULT_POOL_TYPE``.
-    """
-    thread_pool = 'thread-pool'
-    process_pool = 'process-pool'
-
-    @staticmethod
-    def from_option(name: str) -> str:
-        """
-        Given an option name with hyphens, return the enum constant name with
-        underscores.
-
-        :param name: An option name with hyphens.
-        :type name: str
-        :return: The corresponding enum constant name with underscores.
-        :rtype: str
-        """
-        return JobPool(name.replace('-', '_'))
-
-
-DEFAULT_POOL_SIZE: Optional[int] = None
-DEFAULT_POOL_TYPE: JobPool = JobPool.thread_pool
-
-
-class NodesOptions(BaseModel):
-    """
-    The --node/-n, --nodes/-N, --password/-p and --username/-u options.
-    """
-    node: Optional[List[str]] = Field([], aliases=['-n'], description='(nodes) add one or more nodes to the set of nodes to process')
-    nodes: Optional[List[FilePath]] = Field([], aliases=['-N'], description='(nodes) add the nodes listed in one or more files to the set of nodes to process')
-    password: Optional[str] = Field(aliases=['-p'], description='(nodes) UI password; interactive prompt if not specified')
-    username: Optional[str] = Field(aliases=['-u'], description='(nodes) UI username; interactive prompt if not unspecified')
-
-    @validator('nodes', each_item=True, pre=True)
-    def _expand_each_nodes_path(cls, v: Path):
-        return path(v)
-
-    def get_nodes(self):
-        ret = [*self.node, *chain.from_iterable(file_lines(file_path) for file_path in self.nodes)]
-        if len(ret) == 0:
-            raise RuntimeError('empty list of nodes')
-        return ret
-
-
-class AuidsOptions(BaseModel):
-    """
-    The --auid/-a and --auids/-A options.
-    """
-    auid: Optional[List[str]] = Field([], aliases=['-a'], description='(AUIDs) add one or more AUIDs to the set of AUIDs to process')
-    auids: Optional[List[FilePath]] = Field([], aliases=['-A'], description='(AUIDs) add the AUIDs listed in one or more files to the set of AUIDs to process')
-
-    @validator('auids', each_item=True, pre=True)
-    def _expand_each_auids_path(cls, v: Path):
-        return path(v)
-
-    def get_auids(self):
-        ret = [*self.auid, *chain.from_iterable(file_lines(file_path) for file_path in self.auids)]
-        if len(ret) == 0:
-            raise RuntimeError('empty list of AUIDs')
-        return ret
-
-
-class DepthOptions(BaseModel):
-    """
-    The --depth/-d option.
-    """
-    depth: Optional[int] = Field(DEFAULT_DEPTH, aliases=['-d'], description='(deep crawl) set crawl depth')
-
-
-class JobPoolOptions(BaseModel):
-    """
-    The --pool-size, --process-pool and --thread-pool options.
-    """
-    pool_size: Optional[PositiveInt] = Field(description='(job pool) set the job pool size')
-    process_pool: Optional[bool] = Field(False, description='(job pool) use a process pool', enum=JobPool)
-    thread_pool: Optional[bool] = Field(False, description='(job pool) use a thread pool', enum=JobPool)
-
-    @root_validator
-    def _at_most_one_pool_type(cls, values):
-        return at_most_one_from_enum(cls, values, JobPool)
-
-    def get_pool_size(self) -> Optional[int]:
-        return self.pool_size if hasattr(self, 'pool_size') else DEFAULT_POOL_SIZE
-
-    def get_pool_type(self) -> JobPool:
-        return get_from_enum(self, JobPool, DEFAULT_POOL_TYPE)
-
-
-class NodeCommand(OutputFormatOptions, JobPoolOptions, NodesOptions):
-    """
-    A pydantic-argparse command for node commands.
-    """
-    pass
-
-class AuidCommand(NodeCommand, OutputFormatOptions, JobPoolOptions, AuidsOptions, NodesOptions):
-    """
-    A pydantic-argparse command for AUID commands except deep-crawl.
-    """
-    pass
-
-class DeepCrawlCommand(AuidCommand, OutputFormatOptions, JobPoolOptions, DepthOptions, AuidsOptions, NodesOptions):
-    """
-    A pydantic-argparse command for deep-crawl.
-    """
-    pass
-
-
-class DebugPanelCommand(BaseModel):
-    """
-    The pydantic-argparse model for the top-level debugpanel command.
-    """
-    check_substance: Optional[AuidCommand] = Field(description='cause nodes to check the substance of AUs', alias='check-substance')
-    copyright: Optional[StringCommand.type(__copyright__)] = Field(description=COPYRIGHT_DESCRIPTION)
-    cp: Optional[NodeCommand] = Field(description='synonym for: crawl-plugins')
-    cr: Optional[AuidCommand] = Field(description='synonym for: crawl')
-    crawl: Optional[AuidCommand] = Field(description='cause nodes to crawl AUs')
-    crawl_plugins: Optional[NodeCommand] = Field(description='cause nodes to crawl plugins', alias='crawl-plugins')
-    cs: Optional[AuidCommand] = Field(description='synonym for: check-substance')
-    dc: Optional[DeepCrawlCommand] = Field(description='synonym for: deep-crawl')
-    deep_crawl: Optional[DeepCrawlCommand] = Field(description='cause nodes to deeply crawl AUs', alias='deep-crawl')
-    di: Optional[AuidCommand] = Field(description='synonym for: disable-indexing')
-    disable_indexing: Optional[AuidCommand] = Field(description='cause nodes to disable metadata indexing for AUs', alias='disable-indexing')
-    license: Optional[StringCommand.type(__license__)] = Field(description=LICENSE_DESCRIPTION)
-    po: Optional[AuidCommand] = Field(description='synonym for: poll')
-    poll: Optional[AuidCommand] = Field(description='cause nodes to poll AUs')
-    rc: Optional[NodeCommand] = Field(description='synonym for: reload-config')
-    reindex_metadata: Optional[AuidCommand] = Field(description='cause nodes to reindex the metadata of AUs', alias='reindex-metadata')
-    reload_config: Optional[NodeCommand] = Field(description='cause nodes to reload their configuration', alias='reload-config')
-    ri: Optional[AuidCommand] = Field(description='synonym for: reindex-metadata')
-    validate_files: Optional[AuidCommand] = Field(description='cause nodes to validate the files of AUs', alias='validate-files')
-    version: Optional[StringCommand.type(__version__)] = Field(description=VERSION_DESCRIPTION)
-    vf: Optional[AuidCommand] = Field(description='synonym for: validate-files')
-
-
-class DebugPanelCli(BaseCli[DebugPanelCommand]):
-    """
-    The debugpanel command line tool.
-    """
-
-    def __init__(self):
-        """
-        Constructs a new ``DebugPanelCli`` instance.
-        """
-        super().__init__(model=DebugPanelCommand,
-                         prog='debugpanel',
-                         description='Tool to interact with the LOCKSS 1.x DebugPanel servlet')
-        self._auids: Optional[List[str]] = None
-        self._auth: Optional[Any] = None
-        self._executor: Optional[Executor] = None
-        self._nodes: Optional[List[str]] = None
-
-    def _check_substance(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, check_substance)
-
-    def _copyright(self, string_command: StringCommand) -> None:
-        self._do_string_command(string_command)
-
-    def _cp(self, node_command: NodeCommand) -> None:
-        self._crawl_plugins(node_command)
-
-    def _cr(self, auid_command: AuidCommand) -> None:
-        self._crawl(auid_command)
-
-    def _crawl(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, crawl)
-
-    def _crawl_plugins(self, node_command: NodeCommand) -> None:
-        self._do_node_command(node_command, crawl_plugins)
-
-    def _cs(self, auid_command: AuidCommand) -> None:
-        self._check_substance(auid_command)
-
-    def _dc(self, deep_crawl_command: DeepCrawlCommand) -> None:
-        self._deep_crawl(deep_crawl_command)
-
-    def _deep_crawl(self, deep_crawl_command: DeepCrawlCommand) -> None:
-        self._do_auid_command(deep_crawl_command, deep_crawl, depth=deep_crawl_command.depth)
-
-    def _di(self, auid_command: AuidCommand) -> None:
-        self._disable_indexing(auid_command)
-
-    def _disable_indexing(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, disable_indexing)
-
-    def _do_auid_command(self, auid_command: AuidCommand, node_auid_func: Callable[[Node, str], RequestUrlOpenT], **kwargs: Dict[str, Any]) -> None:
-        """
-        Performs one AUID-centric command.
-
-        :param auid_command: An ``AuidCommand`` model.
-        :type auid_command: AuidCommand
-        :param node_auid_func: A function that applies to a ``Node`` and an AUID
-                               and returns what ``urllib.request.urlopen``
-                               returns.
-        :type node_auid_func: ``RequestUrlOpenT``
-        :param kwargs: Keyword arguments (needed for the ``depth`` command).
-        :type kwargs: Dict[str, Any]
-        """
-        self._initialize_auth(auid_command)
-        self._initialize_executor(auid_command)
-        self._nodes = auid_command.get_nodes()
-        self._auids = auid_command.get_auids()
-        node_objects = [Node(node, *self._auth) for node in self._nodes]
-        futures: Dict[Future, Tuple[str, str]] = {self._executor.submit(node_auid_func, node_object, auid, **kwargs): (node, auid) for auid in self._auids for node, node_object in zip(self._nodes, node_objects)}
-        results: Dict[Tuple[str, str], Any] = {}
-        for future in as_completed(futures):
-            node_auid = futures[future]
-            try:
-                resp: RequestUrlOpenT = future.result()
-                status: int = resp.status
-                reason: str = resp.reason
-                results[node_auid] = 'Requested' if status == 200 else reason
-            except Exception as exc:
-                results[node_auid] = exc
-        print(tabulate([[auid, *[results[(node, auid)] for node in self._nodes]] for auid in self._auids],
-                       headers=['AUID', *self._nodes],
-                       tablefmt=auid_command.output_format))
-
-    def _do_node_command(self, node_command: NodeCommand, node_func: Callable[[Node], RequestUrlOpenT], **kwargs: Dict[str, Any]) -> None:
-        """
-        Performs one node-centric command.
-
-        :param node_command: A ``NodeCommand`` model.
-        :type auid_command: NodeCommand
-        :param node_func: A function that applies to a ``Node`` and returns
-                          what ``urllib.request.urlopen`` returns.
-        :type node_auid_func: ``RequestUrlOpenT``
-        :param kwargs: Keyword arguments (not currently needed by any command).
-        :type kwargs: Dict[str, Any]
-        """
-        self._initialize_auth(node_command)
-        self._initialize_executor(node_command)
-        self._nodes = node_command.get_nodes()
-        node_objects = [Node(node, *self._auth) for node in self._nodes]
-        futures: Dict[Future, str] = {self._executor.submit(node_func, node_object, **kwargs): node for node, node_object in zip(self._nodes, node_objects)}
-        results: Dict[str, Any] = {}
-        for future in as_completed(futures):
-            node = futures[future]
-            try:
-                resp: RequestUrlOpenT = future.result()
-                status: int = resp.status
-                reason: str = resp.reason
-                results[node] = 'Requested' if status == 200 else reason
-            except Exception as exc:
-                results[node] = exc
-        print(tabulate([[node, results[node]] for node in self._nodes],
-                       headers=['Node', 'Result'],
-                       tablefmt=node_command.output_format))
-
-    def _do_string_command(self, string_command: StringCommand) -> None:
-        """
-        Performs one string command.
-
-        :param string_command: A ``StringCommand`` model.
-        :type auid_command: StringCommand
-        """
-        string_command()
-
-    def _initialize_auth(self, nodes_options: NodesOptions) -> None:
-        """
-        Computes the ``self._auth`` value, possibly after asking for interactive
-        input.
-
-        :param nodes_options: A ``NodesOptions`` model.
-        :type node_options: ``NodesOptions``
-        """
-        _u = nodes_options.username or input('UI username: ')
-        _p = nodes_options.password or getpass('UI password: ')
-        self._auth = (_u, _p)
-
-    def _initialize_executor(self, job_pool_options: JobPoolOptions) -> None:
-        """
-        Initializes the ``Executor``.
-
-        :param job_pool_options: A ``JobPoolOptions`` model.
-        :type job_pool_options: ``JobPoolOptions``.
-        """
-        if job_pool_options.get_pool_type() == JobPool.thread_pool:
-            self._executor = ThreadPoolExecutor(max_workers=job_pool_options.get_pool_size())
-        elif job_pool_options.get_pool_type() == JobPool.process_pool:
-            self._executor = ProcessPoolExecutor(max_workers=job_pool_options.get_pool_size())
-        else:
-            raise InternalError()
-
-    def _license(self, string_command: StringCommand) -> None:
-        self._do_string_command(string_command)
-
-    def _po(self, auid_command: AuidCommand) -> None:
-        self._poll(auid_command)
-
-    def _poll(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, poll)
-
-    def _rc(self, node_command: NodeCommand):
-        self._reload_config(node_command)
-
-    def _ri(self, auid_command: AuidCommand) -> None:
-        self._reindex_metadata(auid_command)
-
-    def _reindex_metadata(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, reindex_metadata)
-
-    def _reload_config(self, node_command: NodeCommand):
-        self._do_node_command(node_command, reload_config)
-
-    def _validate_files(self, auid_command: AuidCommand) -> None:
-        self._do_auid_command(auid_command, validate_files)
-
-    def _vf(self, auid_command: AuidCommand) -> None:
-        self._validate_files(auid_command)
-
-    def _version(self, string_command: StringCommand) -> None:
-        self._do_string_command(string_command)
-
-
-def main() -> None:
-    """
-    Entry point for the debugpanel command line tool.
-    """
-    DebugPanelCli().run()
-
-
-if __name__ == '__main__':
-    main()