lockss-turtles 0.6.0.dev24__py3-none-any.whl → 0.6.0.dev26__py3-none-any.whl

lockss/turtles/plugin.py

@@ -29,11 +29,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 """
-Library to represent a LOCKSS plugin.
+Module to represent a LOCKSS plugin.
 """
 
-# Remove in Python 3.14
-# See https://stackoverflow.com/questions/33533148/how-do-i-type-hint-a-method-with-the-type-of-the-enclosing-class/33533514#33533514
+# Remove in Python 3.14; see https://stackoverflow.com/a/33533514
 from __future__ import annotations
 
 from collections.abc import Callable

lockss/turtles/plugin_registry.py

@@ -29,11 +29,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 """
-Library to represent plugin registries and plugin registry catalogs.
+Module to represent plugin registries and plugin registry catalogs.
 """
 
-# Remove in Python 3.14
-# See https://stackoverflow.com/questions/33533148/how-do-i-type-hint-a-method-with-the-type-of-the-enclosing-class/33533514#33533514
+# Remove in Python 3.14; see https://stackoverflow.com/a/33533514
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
@@ -318,8 +317,8 @@ class DirectoryPluginRegistryLayout(BasePluginRegistryLayout):
     type: Literal['directory'] = Field(**BasePluginRegistryLayout.TYPE_FIELD)
 
     #: This plugin registry layout's file naming convention.
-    file_naming_convention: Optional[PluginRegistryLayoutFileNamingConvention] = Field(BasePluginRegistryLayout.FILE_NAMING_CONVENTION_DEFAULT,
-                                                                                       **BasePluginRegistryLayout.FILE_NAMING_CONVENTION_FIELD)
+    file_naming_convention: PluginRegistryLayoutFileNamingConvention = Field(BasePluginRegistryLayout.FILE_NAMING_CONVENTION_DEFAULT,
+                                                                             **BasePluginRegistryLayout.FILE_NAMING_CONVENTION_FIELD)
 
     def _copy_jar(self,
                   src_path: Path,
@@ -478,7 +477,7 @@ class PluginRegistryLayer(BaseModel):
         :return: This plugin registry layer's path.
         :rtype: Path
         """
-        return path(self.path)
+        return self.get_plugin_registry().get_root().joinpath(self.path)
 
     def get_plugin_registry(self) -> PluginRegistry:
         """

lockss/turtles/plugin_set.py

@@ -29,11 +29,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 """
-Library to represent plugin sets and plugin set catalogs.
+Module to represent plugin sets and plugin set catalogs.
 """
 
-# Remove in Python 3.14
-# See https://stackoverflow.com/questions/33533148/how-do-i-type-hint-a-method-with-the-type-of-the-enclosing-class/33533514#33533514
+# Remove in Python 3.14; see https://stackoverflow.com/a/33533514
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
@@ -42,7 +41,7 @@ from pathlib import Path
 import shlex
 import subprocess
 import sys
-from typing import Annotated, Any, ClassVar, Literal, Optional, Union
+from typing import Annotated, Any, Callable, ClassVar, Literal, Optional, Union
 
 from pydantic import BaseModel, Field
 
@@ -234,12 +233,12 @@ class MavenPluginSetBuilder(BasePluginSetBuilder):
     type: Literal['maven'] = Field(**BasePluginSetBuilder.TYPE_FIELD)
 
     #: This plugin set builder's main code path.
-    main: Optional[str] = Field(DEFAULT_MAIN,
-                                **BasePluginSetBuilder.MAIN_FIELD)
+    main: str = Field(DEFAULT_MAIN,
+                      **BasePluginSetBuilder.MAIN_FIELD)
 
     #: This plugin set builder's unit test path.
-    test: Optional[str] = Field(DEFAULT_TEST,
-                                **BasePluginSetBuilder.TEST_FIELD)
+    test: str = Field(DEFAULT_TEST,
+                      **BasePluginSetBuilder.TEST_FIELD)
 
     #: An internal flag to remember if a build has occurred.
     _built: bool
@@ -248,7 +247,7 @@ class MavenPluginSetBuilder(BasePluginSetBuilder):
                      plugin_id: PluginIdentifier,
                      keystore_path: Path,
                      keystore_alias: str,
-                     keystore_password=None) -> tuple[Path, Plugin]:
+                     keystore_password: Optional[Callable[[], str]]=None) -> tuple[Path, Plugin]:
         """
         Builds the given plugin with the supplied plugin signing credentials.
 
@@ -285,7 +284,7 @@ class MavenPluginSetBuilder(BasePluginSetBuilder):
     def _big_build(self,
                    keystore_path: Path,
                    keystore_alias: str,
-                   keystore_password: str=None) -> None:
+                   keystore_password: Optional[Callable[[], str]]=None) -> None:
         """
         Runs ``mvn package`` on the project if the ``_built`` flag is False.
 
@@ -301,8 +300,9 @@ class MavenPluginSetBuilder(BasePluginSetBuilder):
             # Do build
             cmd = ['mvn', 'package',
                    f'-Dkeystore.file={keystore_path!s}',
-                   f'-Dkeystore.alias={keystore_alias}',
-                   f'-Dkeystore.password={keystore_password}']
+                   f'-Dkeystore.alias={keystore_alias}']
+            if keystore_password:
+                cmd.extend(f'-Dkeystore.password={keystore_password()}')
             try:
                 subprocess.run(cmd, cwd=self.get_root(), check=True, stdout=sys.stdout, stderr=sys.stderr)
             except subprocess.CalledProcessError as cpe:
@@ -363,12 +363,12 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
     type: Literal['ant'] = Field(**BasePluginSetBuilder.TYPE_FIELD)
 
     #: This plugin set builder's main code path.
-    main: Optional[str] = Field(DEFAULT_MAIN,
-                                **BasePluginSetBuilder.MAIN_FIELD)
+    main: str = Field(DEFAULT_MAIN,
+                      **BasePluginSetBuilder.MAIN_FIELD)
 
     #: This plugin set builder's unit test path.
-    test: Optional[str] = Field(DEFAULT_TEST,
-                                **BasePluginSetBuilder.TEST_FIELD)
+    test: str = Field(DEFAULT_TEST,
+                      **BasePluginSetBuilder.TEST_FIELD)
 
     #: An internal flag to remember if a build has occurred.
     _built: bool
@@ -377,7 +377,7 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
                      plugin_id: PluginIdentifier,
                      keystore_path: Path,
                      keystore_alias: str,
-                     keystore_password=None) -> tuple[Path, Plugin]:
+                     keystore_password: Optional[Callable[[], str]]=None) -> tuple[Path, Plugin]:
         """
         Builds the given plugin with the supplied plugin signing credentials.
 
@@ -388,7 +388,7 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
         :param keystore_alias: The alias to use in the plugin signing keystore.
         :type keystore_alias: str
         :param keystore_password: The plugin signing password.
-        :type keystore_password:
+        :type keystore_password: Optional[Callable[[], str]]
         :return: A tuple of the built and signed JAR file and a Plugin object
                  instantiated from it.
         :rtype: tuple[Path, Plugin]
@@ -433,7 +433,7 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
                       plugin_id: PluginIdentifier,
                       keystore_path: Path,
                       keystore_alias: str,
-                      keystore_password: str=None) -> tuple[Path, Plugin]:
+                      keystore_password: Optional[Callable[[], str]]=None) -> tuple[Path, Plugin]:
         """
         Performs the "little build" of the given plugin.
 
@@ -444,7 +444,7 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
         :param keystore_alias: The alias to use in the plugin signing keystore.
         :type keystore_alias: str
         :param keystore_password: The plugin signing password.
-        :type keystore_password:
+        :type keystore_password: Optional[Callable[[], str]]
         :return: A tuple of the built and signed JAR file and a Plugin object
                  instantiated from it.
         :rtype: tuple[Path, Plugin]
@@ -483,8 +483,8 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
                '--jar', str(jar_path),
                '--alias', keystore_alias,
                '--keystore', str(keystore_path)]
-        if keystore_password is not None:
-            cmd.extend(['--password', keystore_password])
+        if keystore_password:
+            cmd.extend(['--password', keystore_password()])
         try:
             subprocess.run(cmd, cwd=self.get_root(), check=True, stdout=sys.stdout, stderr=sys.stderr)
         except subprocess.CalledProcessError as cpe:
@@ -552,7 +552,7 @@ class PluginSet(BaseModel):
                      plugin_id: PluginIdentifier,
                      keystore_path: Path,
                      keystore_alias: str,
-                     keystore_password=None) -> tuple[Path, Plugin]:
+                     keystore_password: Optional[Callable[[], str]]=None) -> tuple[Path, Plugin]:
         """
         Builds the given plugin with the supplied plugin signing credentials.
 
@@ -563,7 +563,7 @@ class PluginSet(BaseModel):
         :param keystore_alias: The alias to use in the plugin signing keystore.
         :type keystore_alias: str
         :param keystore_password: The plugin signing password.
-        :type keystore_password:
+        :type keystore_password: Optional[Callable[[], str]]
         :return: A tuple of the built and signed JAR file and a Plugin object
                  instantiated from it.
         """

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

@@ -29,11 +29,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 """
-Utilities for the ``lockss.turtles`` package.
+Utility module.
 """
 
-# Remove in Python 3.14
-# See https://stackoverflow.com/questions/33533148/how-do-i-type-hint-a-method-with-the-type-of-the-enclosing-class/33533514#33533514
+# Remove in Python 3.14; see https://stackoverflow.com/a/33533514
 from __future__ import annotations
 
 from collections.abc import Iterable

{lockss_turtles-0.6.0.dev24.dist-info → lockss_turtles-0.6.0.dev26.dist-info}/METADATA

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: lockss-turtles
-Version: 0.6.0.dev24
+Version: 0.6.0.dev26
 Summary: Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries
 License: BSD-3-Clause
+License-File: LICENSE
 Author: Thib Guicherd-Callin
 Author-email: thib@cs.stanford.edu
 Maintainer: Thib Guicherd-Callin
@@ -34,7 +35,7 @@ Description-Content-Type: text/x-rst
 Turtles
 =======
 
-.. |RELEASE| replace:: 0.6.0-dev24 NOT YET RELEASED
+.. |RELEASE| replace:: 0.6.0-dev26 NOT YET RELEASED
 .. |RELEASE_DATE| replace:: NOT YET RELEASED
 .. |TURTLES| replace:: **Turtles**
 

lockss_turtles-0.6.0.dev26.dist-info/RECORD

@@ -0,0 +1,18 @@
+lockss/turtles/__init__.py,sha256=DFU1_qgdgSb_zxc9Lw6YgvadqEQQ4qAwx_0x1hX-cQU,1827
+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=4fUmpp_GF_WY06gyhm9tVofYINoTXYUqAvKik3Z4bE4,24640
+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=PIBeAKoDudInJOGhwTSug_b4AugGtK5yFmapUtQYTNw,18372
+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.dev26.dist-info/METADATA,sha256=PqR_im9Se6s6-2gDrojNn07LUi2CKESgngN4UTmX8YM,2362
+lockss_turtles-0.6.0.dev26.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+lockss_turtles-0.6.0.dev26.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
+lockss_turtles-0.6.0.dev26.dist-info/licenses/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
+lockss_turtles-0.6.0.dev26.dist-info/RECORD,,

{lockss_turtles-0.6.0.dev24.dist-info → lockss_turtles-0.6.0.dev26.dist-info}/WHEEL

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

unittest/lockss/turtles/__init__.py

@@ -29,37 +29,78 @@
 # 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):
+                                       msg: Optional[str]=None) -> None:
         with self.assertRaises(ValidationError) as cm:
             func()
-            self.fail('Expected ValidationError but did not get one')
-        self.assertIsInstance(cm.exception, ValidationError)
         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 assertPydanticMissing(self, func: Callable[[], Any], loc: Loc, msg=None) -> None:
-        if isinstance(loc, str):
-            loc = (loc,)
-        self._assertPydanticValidationError(func, lambda e: e.get('type') == 'missing' and e.get('loc') == loc)
-
-    def assertPydanticLiteralError(self, func: Callable[[], Any], loc: Loc, expected: str, msg=None) -> None:
-        if isinstance(loc, str):
-            loc = (loc,)
-        self._assertPydanticValidationError(func, lambda e: e.get('type') == 'literal_error' and e.get('loc') == loc and (ctx := e.get('ctx')) and ctx.get('expected') == repr(expected))
+    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