lockss-turtles 0.6.0.dev18__tar.gz → 0.6.0.dev20__tar.gz

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lockss-turtles
-Version: 0.6.0.dev18
+Version: 0.6.0.dev20
 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-dev20
 .. |RELEASE_DATE| replace:: ?
 
 .. |HELP| replace:: ``--help/-h``

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/README.rst

@@ -2,7 +2,7 @@
 Turtles
 =======
 
-.. |RELEASE| replace:: 0.6.0-dev18
+.. |RELEASE| replace:: 0.6.0-dev20
 .. |RELEASE_DATE| replace:: ?
 
 .. |HELP| replace:: ``--help/-h``

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/pyproject.toml

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-turtles"
-version = "0.6.0-dev18" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.6.0-dev20" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
 description = "Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries"
 license = { text = "BSD-3-Clause" }
 readme = "README.rst"

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/src/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-dev20'
 
 __copyright__ = '''
 Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/src/lockss/turtles/app.py

@@ -74,7 +74,7 @@ class TurtlesApp(object):
 
     ETC_CONFIG_DIR: ClassVar[Path] = Path('/etc', CONFIG_DIR_NAME)
 
-    CONFIG_DIRS: ClassVar[tuple[Path, ...]] = (XDG_CONFIG_DIR, USR_CONFIG_DIR, ETC_CONFIG_DIR)
+    CONFIG_DIRS: ClassVar[tuple[Path, ...]] = (XDG_CONFIG_DIR, ETC_CONFIG_DIR, USR_CONFIG_DIR)
 
     PLUGIN_REGISTRY_CATALOG: ClassVar[str] = 'plugin-registry-catalog.yaml'
 

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/src/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
@@ -51,10 +52,10 @@ from .util import file_or
 
 
 class PluginBuildingOptions(BaseModel):
-    plugin_set: Optional[list[FilePath]] = Field(aliases=['-s'], description=f'(plugin sets) add one or more plugin set definition files to the loaded plugin sets')
-    plugin_set_catalog: Optional[list[FilePath]] = Field(aliases=['-S'], description=f'(plugin sets) add one or more plugin set catalogs to the loaded plugin set catalogs; if no plugin set catalogs or plugin sets are specified, load {file_or(TurtlesApp.default_plugin_set_catalog_choices())}')
-    plugin_signing_credentials: Optional[FilePath] = Field(aliases=['-c'], description=f'(plugin signing credentials) load the plugin signing credentials from the given file, or if none, from {file_or(TurtlesApp.default_plugin_signing_credentials_choices())}')
-    plugin_signing_password: Optional[str] = Field(description='(plugin signing credentials) set the plugin signing password, or if none, prompt interactively')
+    plugin_set: Optional[list[FilePath]] = Field(aliases=['-s'], title='Plugin Sets', description=f'(plugin sets) add one or more plugin set definition files to the loaded plugin sets')
+    plugin_set_catalog: Optional[list[FilePath]] = Field(aliases=['-S'], title='Plugin Set Catalogs', description=f'(plugin sets) add one or more plugin set catalogs to the loaded plugin set catalogs; if no plugin set catalogs or plugin sets are specified, load {file_or(TurtlesApp.default_plugin_set_catalog_choices())}')
+    plugin_signing_credentials: Optional[FilePath] = Field(aliases=['-c'], title='Plugin Signing Credentials', description=f'(plugin signing credentials) load the plugin signing credentials from the given file, or if none, from {file_or(TurtlesApp.default_plugin_signing_credentials_choices())}')
+    plugin_signing_password: Optional[str] = Field(title='Plugin Signing Password', description='(plugin signing credentials) set the plugin signing password, or if none, prompt interactively')
 
     def get_plugin_sets(self) -> list[Path]:
         return [path(p) for p in self.plugin_set or []]
@@ -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
@@ -118,7 +119,7 @@ class PluginIdentifierOptions(BaseModel):
         return path(v)
 
     def get_plugin_identifiers(self) -> list[str]:
-        ret = [*(self.plugin_identifier or []), *[file_lines(file_path) for file_path in self.plugin_identifiers or []]]
+        ret = [*(self.plugin_identifier or []), *chain.from_iterable(file_lines(file_path) for file_path in self.plugin_identifiers or [])]
         if ret:
             return ret
         raise ValueError('Empty list of plugin identifiers')
@@ -136,7 +137,7 @@ class PluginJarOptions(BaseModel):
         return path(v)
 
     def get_plugin_jars(self):
-        ret = [*(self.plugin_jar or []), *[file_lines(file_path) for file_path in self.plugin_jars or []]]
+        ret = [*(self.plugin_jar or []), *chain.from_iterable(file_lines(file_path) for file_path in self.plugin_jars or [])]
         if len(ret):
             return ret
         raise ValueError('Empty list of plugin JARs')
@@ -160,7 +161,7 @@ class ReleasePluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginDep
 
 class TurtlesCommand(BaseModel):
     bp: Optional[BuildPluginCommand] = Field(description='synonym for: build-plugin')
-    build_plugin: Optional[BuildPluginCommand] = Field(description='build (package and sign) plugins', alias='build-plugin')
+    build_plugin: Optional[BuildPluginCommand] = Field(description='build plugins', alias='build-plugin')
     copyright: Optional[StringCommand.type(__copyright__)] = Field(description=COPYRIGHT_DESCRIPTION)
     deploy_plugin: Optional[DeployPluginCommand] = Field(description='deploy plugins', alias='deploy-plugin')
     dp: Optional[DeployPluginCommand] = Field(description='synonym for: deploy-plugin')

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/src/lockss/turtles/plugin_registry.py

@@ -66,7 +66,7 @@ PluginRegistryLayoutFileNamingConvention = Literal['abbreviated', 'identifier',
 class BasePluginRegistryLayout(BaseModel, ABC):
     TYPE_FIELD: ClassVar[dict[str, str]] = dict(title='Plugin Registry Layout Type', description='A plugin registry layout type')
     FILE_NAMING_CONVENTION_DEFAULT: ClassVar[PluginRegistryLayoutFileNamingConvention] = 'identifier'
-    FILE_NAMING_CONVENTION_FIELD: ClassVar[dict[str, str]] = dict(title='Plugin Registry Layout File Naming Convention', description='A file naming convention for the plugin registry layout', alias='file-naming-convention')
+    FILE_NAMING_CONVENTION_FIELD: ClassVar[dict[str, str]] = dict(alias='file-naming-convention', title='Plugin Registry Layout File Naming Convention', description='A file naming convention for the plugin registry layout')
 
     _plugin_registry: Optional[PluginRegistry]
 
@@ -213,13 +213,13 @@ PluginRegistryIdentifier = str
 
 
 class PluginRegistry(BaseModelWithRoot):
-    kind: PluginRegistryKind = Field(description="This object's kind")
+    kind: PluginRegistryKind = Field(title='Kind', description="This object's kind")
     id: PluginRegistryIdentifier = Field(title='Plugin Registry Identifier', description='An identifier for the plugin set')
     name: str = Field(title='Plugin Registry Name', description='A name for the plugin set')
     layout: PluginRegistryLayout = Field(title='Plugin Registry Layout', description='A layout for the plugin registry')
     layers: list[PluginRegistryLayer] = Field(min_length=1, title='Plugin Registry Layers', description="A non-empty list of plugin registry layers")
-    plugin_identifiers: list[PluginIdentifier] = Field(min_length=1, title='Plugin Identifiers', description="A non-empty list of plugin identifiers", alias='plugin-identifiers')
-    suppressed_plugin_identifiers: list[PluginIdentifier] = Field([], title='Suppressed Plugin Identifiers', description="A list of suppressed plugin identifiers", alias='suppressed-plugin-identifiers')
+    plugin_identifiers: list[PluginIdentifier] = Field(alias='plugin-identifiers', min_length=1, title='Plugin Identifiers', description="A non-empty list of plugin identifiers")
+    suppressed_plugin_identifiers: list[PluginIdentifier] = Field([], alias='suppressed-plugin-identifiers', title='Suppressed Plugin Identifiers', description="A list of suppressed plugin identifiers")
 
     def get_id(self) -> PluginRegistryIdentifier:
         return self.id

{lockss_turtles-0.6.0.dev18 → lockss_turtles-0.6.0.dev20}/src/lockss/turtles/plugin_set.py

@@ -59,14 +59,15 @@ class PluginSetCatalog(BaseModelWithRoot):
     plugin set catalog.
     """
     #: This object's kind.
-    kind: PluginSetCatalogKind = Field(description="This object's kind")
+    kind: PluginSetCatalogKind = Field(title='Kind', description="This object's kind")
     #: A non-empty list of plugin set files.
-    plugin_set_files: list[str] = Field(min_length=1, description="A non-empty list of plugin set files", title='Plugin Set Files', alias='plugin-set-files')
+    plugin_set_files: list[str] = Field(alias='plugin-set-files', min_length=1, title='Plugin Set Files', description="A non-empty list of plugin set files")
 
     def get_plugin_set_files(self) -> list[Path]:
         """
         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: