lockss-turtles 0.5.0.dev4__py3-none-any.whl → 0.6.0__py3-none-any.whl

lockss/turtles/plugin_signing_credentials.py

@@ -0,0 +1,84 @@
+#!/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.
+
+"""
+Module to represent plugin signing credentials.
+"""
+
+from pathlib import Path
+from typing import Literal
+
+from pydantic import Field
+
+from .util import BaseModelWithRoot
+
+
+#: A type alias for the plugin signing credentials kind.
+PluginSigningCredentialsKind = Literal['PluginSigningCredentials']
+
+
+class PluginSigningCredentials(BaseModelWithRoot):
+    """
+    A Pydantic model (``lockss.turtles.util.BaseModelWithRoot``) to represent
+    plugin signing credentials.
+    """
+
+    #: This object's kind.
+    kind: PluginSigningCredentialsKind = Field(title='Kind',
+                                               description="This object's kind")
+
+    #: Path to the plugin signing keystore.
+    plugin_signing_keystore: str = Field(alias='plugin-signing-keystore',
+                                         title='Plugin Signing Keystore',
+                                         description='A path to the plugin signing keystore')
+
+    #: Alias to use from the plugin signing keystore.
+    plugin_signing_alias: str = Field(alias='plugin-signing-alias',
+                                      title='Plugin Signing Alias',
+                                      description='The plugin signing alias to use')
+
+    def get_plugin_signing_alias(self) -> str:
+        """
+        Returns the alias to use from the plugin signing keystore.
+
+        :return: The plugin signing alias.
+        :rtype: str
+        """
+        return self.plugin_signing_alias
+
+    def get_plugin_signing_keystore(self) -> Path:
+        """
+        The file path for the plugin signing keystore; a relative path is
+        understood to be relative to the file containing the definition.
+
+        :return: The file path for the plugin signing keystore.
+        :rtype: Path
+        """
+        return self.get_root().joinpath(self.plugin_signing_keystore)

lockss/turtles/util.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University
+# 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:
@@ -28,28 +28,77 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-from pathlib import Path, PurePath
-import json
+"""
+Utility module.
+"""
 
-import jsonschema
-import jsonschema.exceptions
-import yaml
+# Remove in Python 3.14; see https://stackoverflow.com/a/33533514
+from __future__ import annotations
 
+from collections.abc import Iterable
+from pathlib import Path
+from typing import Any, Optional, Union
 
-def _load_and_validate(schema_path, instance_path, multiple=False):
-    with schema_path.open('r') as f:
-        schema = json.load(f)
-    with instance_path.open('r') as f:
-        ret = list(yaml.safe_load_all(f) if multiple else [yaml.safe_load(f)])
-    for instance in ret:
-        try:
-            jsonschema.validate(instance, schema)
-        except jsonschema.exceptions.ValidationError as validation_exception:
-            raise Exception(validation_exception.message) from validation_exception
-    return ret if multiple else ret[0]
+from lockss.pybasic.fileutil import path
+from pydantic import BaseModel
 
 
-def _path(purepath_or_string):
-    if not issubclass(type(purepath_or_string), PurePath):
-        purepath_or_string = Path(purepath_or_string)
-    return purepath_or_string.expanduser().resolve()
+#: Type alias for the union of ``Path`` and ``str``.
+PathOrStr = Union[Path, str]
+
+
+class BaseModelWithRoot(BaseModel):
+    """
+    A Pydantic model with a root path which can be used to resolve relative
+    paths.
+    """
+
+    #: An internal root path.
+    _root: Optional[Path]
+
+    def model_post_init(self, context: Any) -> None:
+        """
+        Pydantic post-initialization method to create the ``_root`` field.
+        """
+        self._root = None
+
+    def get_root(self) -> Path:
+        """
+        Returns this object's root path.
+
+        See ``initialize``.
+
+        :return: This object's root path.
+        :rtype: Path
+        :raises ValueError: If this object's ``initialize`` method was not
+                            called.
+        """
+        if self._root is None:
+            raise ValueError('Uninitialized root')
+        return self._root
+
+    def initialize(self,
+                   root_path_or_str: PathOrStr) -> BaseModelWithRoot:
+        """
+        Mandatory initialization of the root path.
+
+        :param root_path_or_str: This object's root path.
+        :type root_path_or_str: PathOrStr
+        :return: This object, for chaining.
+        :rtype: BaseModelWithRoot
+        """
+        self._root = path(root_path_or_str)
+        return self
+
+
+def file_or(paths: Iterable[Path]) -> str:
+    """
+    Turns an iterable of file paths into a ``" or "``-separated string suitable
+    for CLI messages.
+
+    :param paths: A non-null list of file paths.
+    :type paths: Iterable[Path]
+    :return: A ``" or "``-separated string of the given file paths.
+    :rtype: str
+    """
+    return ' or '.join(map(str, paths))

{lockss_turtles-0.5.0.dev4.dist-info → lockss_turtles-0.6.0.dist-info}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University
+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:

lockss_turtles-0.6.0.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.3
+Name: lockss-turtles
+Version: 0.6.0
+Summary: Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries
+License: BSD-3-Clause
+Author: Thib Guicherd-Callin
+Author-email: thib@cs.stanford.edu
+Maintainer: Thib Guicherd-Callin
+Maintainer-email: thib@cs.stanford.edu
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Archiving
+Classifier: Topic :: Utilities
+Requires-Dist: exceptiongroup (>=1.3.0,<1.4.0)
+Requires-Dist: java-manifest (>=1.1.0,<1.2.0)
+Requires-Dist: lockss-pybasic (>=0.1.1,<0.2.0)
+Requires-Dist: pydantic (>=2.11.0,<2.12.0)
+Requires-Dist: pyyaml (>=6.0.0,<6.1.0)
+Requires-Dist: xdg (>=6.0.0,<6.1.0)
+Project-URL: Documentation, https://docs.lockss.org/en/latest/software/turtles
+Project-URL: Repository, https://github.com/lockss/lockss-turtles
+Project-URL: changelog, https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst
+Project-URL: issues, https://github.com/lockss/lockss-turtles/issues
+Description-Content-Type: text/x-rst
+
+=======
+Turtles
+=======
+
+.. |RELEASE| replace:: 0.6.0
+.. |RELEASE_DATE| replace:: 2025-10-23
+.. |TURTLES| replace:: **Turtles**
+
+.. image:: https://assets.lockss.org/images/logos/turtles/turtles_128x128.png
+   :alt: Turtles logo
+   :align: right
+
+|TURTLES| is a command line tool and Python library to manage LOCKSS plugin sets and LOCKSS plugin registries.
+
+:Latest release: |RELEASE| (|RELEASE_DATE|)
+:Documentation: https://docs.lockss.org/en/latest/software/turtles
+:Release notes: `CHANGELOG.rst <https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst>`_
+:License: `LICENSE <https://github.com/lockss/lockss-turtles/blob/main/LICENSE>`_
+:Repository: https://github.com/lockss/lockss-turtles
+:Issues: https://github.com/lockss/lockss-turtles/issues
+
+----
+
+Quick Start::
+
+   # Install with pipx
+   pipx install lockss-turtles
+
+   # Verify installation and discover all the commands
+   turtles --help
+
+

lockss_turtles-0.6.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+lockss/turtles/__init__.py,sha256=6aGkk-abZwTPYy_tMY72hKjNJjtoDCcQvnBtILsTEsk,1821
+lockss/turtles/__main__.py,sha256=BqRTG3dejCgLh87UJ1Os9DD9unxnQkOdUQM6eqWS3Sg,1680
+lockss/turtles/app.py,sha256=XnBF91r-D3YGSfgIP0v9C064fH8Rc6y4I5y1arEweCQ,30520
+lockss/turtles/cli.py,sha256=x4Ciba5fcDSNeYAhhauOeCP1FcMy5ptOts32CWG3la4,30546
+lockss/turtles/plugin.py,sha256=fxIAaSL06uv9sjYCz2wTQjn_92qPK3EvGNnbkpeSZcA,10972
+lockss/turtles/plugin_registry.py,sha256=8BR6CrqY8hh4zpy13B8gZ9qpCMASlOxvX6g8VmpWeMc,26864
+lockss/turtles/plugin_set.py,sha256=QCUWh56NV5YMQmZIz3-9DYHZI42BC3Aain5mxax7x9o,24668
+lockss/turtles/plugin_signing_credentials.py,sha256=EekUJeXvbfRcrVHCsvvbGBO07bSBzEgVL1Ck4TUbe8k,3415
+lockss/turtles/util.py,sha256=sBvB96BBED_yVZOybcf-sIwldNm9wstgWssnhugpww0,3536
+unittest/lockss/turtles/__init__.py,sha256=ude-nT_uHF0lCD9qKrzedm8QvwqTiNjogpyz8SJudOQ,5598
+unittest/lockss/turtles/test_plugin_registry.py,sha256=NXQyvvV3u1Pk3h5e-W7F93NIL6rYrv3bN_N4TFuZ0_U,18644
+unittest/lockss/turtles/test_plugin_set.py,sha256=SJ2IO3sVOkm1zRr4a9SbyMhKpyKZAzoDV1oVfya3eEU,10949
+unittest/lockss/turtles/test_plugin_signing_credentials.py,sha256=oxAKxeIEATNu3dIajcAFy-gEChMDCHSSDjZotuAB49o,5269
+lockss_turtles-0.6.0.dist-info/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
+lockss_turtles-0.6.0.dist-info/METADATA,sha256=AUSE2g09EKcSqA34-m-TOwdsmjxXuBMesC_sBicF6Lo,2305
+lockss_turtles-0.6.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+lockss_turtles-0.6.0.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
+lockss_turtles-0.6.0.dist-info/RECORD,,

{lockss_turtles-0.5.0.dev4.dist-info → lockss_turtles-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

unittest/lockss/turtles/__init__.py

@@ -0,0 +1,106 @@
+#!/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.
+
+from collections.abc import Callable
+from pathlib import Path
+from pydantic import ValidationError
+from pydantic_core import ErrorDetails
+from typing import Any, Optional, Tuple, Union
+from unittest import TestCase
+
+
+ROOT: Path = Path('.').absolute()
+
+
+Loc = Union[Tuple[str], str]
+
+
+class PydanticTestCase(TestCase):
+
+    def assertPydanticListType(self, func: Callable[[], Any], loc_tuple_or_str: Loc, msg=None) -> None:
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'list_type' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str),
+                                            msg=msg)
+
+    def assertPydanticLiteralError(self, func: Callable[[], Any], loc_tuple_or_str: Loc, expected: Union[Tuple[str], str], msg=None) -> None:
+        if isinstance(expected, str):
+            exp = f"'{expected}'"
+        elif len(expected) == 0:
+            raise RuntimeError(f"'expected' cannot be an empty tuple")
+        elif len(expected) == 1:
+            exp = f"'{expected[0]}'"
+        else:
+            exp = f'''{", ".join(f"'{e}'" for e in expected[:-1])} or '{expected[-1]}\''''
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'literal_error' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str) \
+                                                      and (ctx := e.get('ctx')) \
+                                                      and ctx.get('expected') == exp,
+                                            msg=msg)
+
+    def assertPydanticModelAttributesType(self, func: Callable[[], Any], loc_tuple_or_str: Loc, msg=None) -> None:
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'model_attributes_type' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str),
+                                            msg=msg)
+
+    def assertPydanticMissing(self, func: Callable[[], Any], loc_tuple_or_str: Loc, msg=None) -> None:
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'missing' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str),
+                                            msg=msg)
+
+    def assertPydanticStringType(self, func: Callable[[], Any], loc_tuple_or_str: Loc, msg=None) -> None:
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'string_type' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str),
+                                            msg=msg)
+
+    def assertPydanticTooShort(self, func: Callable[[], Any], loc_tuple_or_str: Loc, msg=None) -> None:
+        self._assertPydanticValidationError(func,
+                                            lambda e: e.get('type') == 'too_short' \
+                                                      and e.get('loc') == self._loc(loc_tuple_or_str),
+                                            msg=msg)
+
+    def _assertPydanticValidationError(self,
+                                       func: Callable[[], Any],
+                                       matcher: Callable[[ErrorDetails], bool],
+                                       msg: Optional[str]=None) -> None:
+        with self.assertRaises(ValidationError) as cm:
+            func()
+        ve: ValidationError = cm.exception
+        for e in ve.errors():
+            if matcher(e):
+                return
+        self.fail(msg or f'Did not get a matching ValidationError; got:\n{"\n".join([str(e) for e in ve.errors()])}\n{ve!s}')
+
+    def _loc(self, loc_tuple_or_str: Loc) -> tuple[str]:
+        return (loc_tuple_or_str,) if isinstance(loc_tuple_or_str, str) else loc_tuple_or_str