lockss-turtles 0.6.0.dev18__py3-none-any.whl → 0.6.0.dev19__py3-none-any.whl

lockss/turtles/__init__.py

@@ -5,7 +5,7 @@ Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin
 registries.
 """
 
-__version__ = '0.6.0-dev18'
+__version__ = '0.6.0-dev19'
 
 __copyright__ = '''
 Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University

lockss/turtles/cli.py

@@ -33,6 +33,7 @@ Tool for managing LOCKSS plugin sets and LOCKSS plugin registries
 """
 
 from getpass import getpass
+from itertools import chain
 from pathlib import Path
 
 from exceptiongroup import ExceptionGroup
@@ -97,9 +98,9 @@ class PluginDeploymentOptions(BaseModel):
         raise FileNotFoundError(file_or(TurtlesApp.default_plugin_set_catalog_choices()))
 
     def get_plugin_registry_layers(self) -> list[PluginRegistryLayerIdentifier]:
-        ret = [*(self.plugin_registry_layer or []), *[file_lines(file_path) for file_path in self.plugin_registry_layers or []]]
+        ret = [*(self.plugin_registry_layer or []), *chain.from_iterable(file_lines(file_path) for file_path in self.plugin_registry_layers or [])]
         for layer in reversed(['testing', 'production']):
-            if getattr(self, layer, False):
+            if getattr(self, layer, False) and layer not in ret:
                 ret.insert(0, layer)
         if ret:
             return ret

lockss/turtles/plugin_set.py

@@ -67,6 +67,7 @@ class PluginSetCatalog(BaseModelWithRoot):
         """
         Return this plugin set catalog's list of plugin set definition file
         paths (relative to the root if not absolute).
+
         :return: A list of plugin set definition file paths.
         :rtype: list[Path]
         """
@@ -80,7 +81,8 @@ PluginSetBuilderType = Literal['ant', 'maven']
 class BasePluginSetBuilder(BaseModelWithRoot, ABC):
     """
     An abstract Pydantic model (``lockss.turtles.util.BaseModelWithRoot``) to
-    represent a plugin set builder.
+    represent a plugin set builder, with concrete implementations
+    ``AntPluginSetBuilder`` and ``MavenPluginSetBuilder``.
     """
 
     #: Pydantic definition of the ``type`` field.
@@ -112,10 +114,10 @@ class BasePluginSetBuilder(BaseModelWithRoot, ABC):
 
     def get_main(self) -> Path:
         """
-        Returns the plugin set's main code path (relative to the root if not
-        absolute).
+        Returns this plugin set builder's main code path (relative to the root
+        if not absolute).
 
-        :return: The plugin set's main code path.
+        :return: This plugin set's main code path.
         :rtype: Path
         :raises ValueError: If this object is not properly initialized.
         """
@@ -123,10 +125,10 @@ class BasePluginSetBuilder(BaseModelWithRoot, ABC):
 
     def get_test(self) -> Path:
         """
-        Returns the plugin set's unit test path (relative to the root if not
-        absolute).
+        Returns this plugin set builder's unit test path (relative to the root
+        if not absolute).
 
-        :return: The plugin set's unit test path.
+        :return: This plugin set's unit test path.
         :rtype: Path
         :raises ValueError: If this object is not properly initialized.
         """
@@ -166,7 +168,7 @@ class BasePluginSetBuilder(BaseModelWithRoot, ABC):
 
     def _get_main(self) -> str:
         """
-        Return the concrete implementation's ``main`` field.
+        Returns the concrete implementation's ``main`` field.
 
         :return: The ``main`` field.
         :rtype: str
@@ -175,7 +177,7 @@ class BasePluginSetBuilder(BaseModelWithRoot, ABC):
 
     def _get_test(self) -> str:
         """
-        Return the concrete implementation's ``test`` field.
+        Returns the concrete implementation's ``test`` field.
 
         :return: The ``test`` field.
         :rtype: str
@@ -196,13 +198,19 @@ class BasePluginSetBuilder(BaseModelWithRoot, ABC):
 
 
 class AntPluginSetBuilder(BasePluginSetBuilder):
+    #: Default value for the ``main`` field.
     DEFAULT_MAIN: ClassVar[str] = 'plugins/src'
+    #: Default value for the ``test`` field.
     DEFAULT_TEST: ClassVar[str] = 'plugins/test/src'
 
+    #: This plugin set builder's type.
     type: Literal['ant'] = Field(**BasePluginSetBuilder.TYPE_FIELD)
+    #: This plugin set builder's main code path.
     main: Optional[str] = Field(DEFAULT_MAIN, **BasePluginSetBuilder.MAIN_FIELD)
+    #: This plugin set builder's unit test path.
     test: Optional[str] = Field(DEFAULT_TEST, **BasePluginSetBuilder.TEST_FIELD)
 
+    #: An internal flag to remember if a build has occurred.
     _built: bool
 
     def build_plugin(self, plugin_id: PluginIdentifier, keystore_path: Path, keystore_alias: str, keystore_password=None) -> tuple[Path, Plugin]:
@@ -219,6 +227,9 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
         self._built = False
 
     def _big_build(self) -> None:
+        """
+        Optionally performs the "big build".
+        """
         if not self._built:
             # Do build
             subprocess.run('ant load-plugins',
@@ -226,10 +237,26 @@ class AntPluginSetBuilder(BasePluginSetBuilder):
             self._built = True
 
     def _little_build(self, plugin_id: PluginIdentifier, keystore_path: Path, keystore_alias: str, keystore_password: str=None) -> tuple[Path, Plugin]:
+        """
+        Performs the "little build" of the given plugin.
+
+        :param plugin_id: A plugin identifier.
+        :type plugin_id: PluginIdentifier
+        :param keystore_path: The path to the plugin signing keystore.
+        :type keystore_path: Path
+        :param keystore_alias: The signing alias to use from the plugin signing
+                               keystore.
+        :type keystore_alias: str
+        :param keystore_password: The signing password.
+        :type keystore_password: str
+        :return: A tuple of the plugin JAR path and the corresponding ``Plugin``
+                 object.
+        :rtype: tuple[Path, Plugin]
+        """
         orig_plugin = None
         cur_id = plugin_id
         # Get all directories for jarplugin -d
-        dirs = list()
+        dirs = []
         while cur_id is not None:
             cur_plugin = self.make_plugin(cur_id)
             orig_plugin = orig_plugin or cur_plugin
@@ -312,7 +339,7 @@ class MavenPluginSetBuilder(BasePluginSetBuilder):
     def _little_build(self, plugin_id: PluginIdentifier) -> tuple[Path, Plugin]:
         jar_path = self.get_root().joinpath('target', 'pluginjars', f'{plugin_id}.jar')
         if not jar_path.is_file():
-            raise Exception(f'{plugin_id}: built JAR not found: {jar_path!s}')
+            raise FileNotFoundError(str(jar_path))
         return jar_path, Plugin.from_jar(jar_path)
 
     def _sanitize(self, called_process_error: subprocess.CalledProcessError) -> subprocess.CalledProcessError:

{lockss_turtles-0.6.0.dev18.dist-info → lockss_turtles-0.6.0.dev19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lockss-turtles
-Version: 0.6.0.dev18
+Version: 0.6.0.dev19
 Summary: Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries
 License: BSD-3-Clause
 Author: Thib Guicherd-Callin
@@ -34,7 +34,7 @@ Description-Content-Type: text/x-rst
 Turtles
 =======
 
-.. |RELEASE| replace:: 0.6.0-dev18
+.. |RELEASE| replace:: 0.6.0-dev19
 .. |RELEASE_DATE| replace:: ?
 
 .. |HELP| replace:: ``--help/-h``

{lockss_turtles-0.6.0.dev18.dist-info → lockss_turtles-0.6.0.dev19.dist-info}/RECORD

@@ -1,15 +1,15 @@
-lockss/turtles/__init__.py,sha256=l85NQRMGYRq2ptQpR3ssp7sKSXMW-vfL_EZI-mZbjl4,1744
+lockss/turtles/__init__.py,sha256=cBj5LqZHvI7BaYdTG5wtlImMX8zdhImZFc0uXc_CIq0,1744
 lockss/turtles/__main__.py,sha256=BqRTG3dejCgLh87UJ1Os9DD9unxnQkOdUQM6eqWS3Sg,1680
 lockss/turtles/app.py,sha256=SAmd_k_2viX_SY2aiXNgQq0k1oPYMUwNBicsnzAo9e4,16689
-lockss/turtles/cli.py,sha256=ZB1H7egHWjG2IkPxwW0NvlLTBQ99bpN5wuzOO7_xa30,20681
+lockss/turtles/cli.py,sha256=lNdRVP8RkY80lRNZny9v2VXL8lPt0jNOhOEdzCUd-XU,20749
 lockss/turtles/plugin.py,sha256=re44YVlzXVU8azDshxn7oHw1GdTQLLQgYwkvZlur-60,5384
 lockss/turtles/plugin_registry.py,sha256=G_CwTFgDV4om1W0-QY7Ww_7mneCbckXuEWMk7ZFOPW4,11916
-lockss/turtles/plugin_set.py,sha256=OCQjRnb4FeIRsuwJpJ63UoXYNeENm39V-iQL47xXZ0M,14711
+lockss/turtles/plugin_set.py,sha256=XCIGmSKHZlSk-L0hhvzE38OU3JmWYgWFTI3V8Uaq1x0,15814
 lockss/turtles/util.py,sha256=8EyWvzTLNycQM_ZKCtWm8FpKJSrwaCSWh8006UYq6vU,2498
 unittest/lockss/turtles/__init__.py,sha256=hrgWx4GaP-hhPBuRlbLndJnOQmZicKCLaP-dQTCu1sQ,3162
 unittest/lockss/turtles/test_plugin_set.py,sha256=q6JmooDR-wijAQ8x9DWKTNB6Of4EOr3Dgq8oaX0LTpQ,4179
-lockss_turtles-0.6.0.dev18.dist-info/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
-lockss_turtles-0.6.0.dev18.dist-info/METADATA,sha256=iyywFL8UvcuqBz6M-T3Vv4AVn8FhtO81nOJCw9biIYU,39692
-lockss_turtles-0.6.0.dev18.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-lockss_turtles-0.6.0.dev18.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
-lockss_turtles-0.6.0.dev18.dist-info/RECORD,,
+lockss_turtles-0.6.0.dev19.dist-info/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
+lockss_turtles-0.6.0.dev19.dist-info/METADATA,sha256=LAGhBiXHtJ_Ure1XKjdlVN8DOrFQvbSKjLXFym4CtG4,39692
+lockss_turtles-0.6.0.dev19.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+lockss_turtles-0.6.0.dev19.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
+lockss_turtles-0.6.0.dev19.dist-info/RECORD,,