lockss-turtles 0.3.0.dev2__py3-none-any.whl → 0.3.0.dev4__py3-none-any.whl

CHANGELOG.rst

@@ -0,0 +1,77 @@
+=============
+Release Notes
+=============
+
+-----
+0.3.0
+-----
+
+Released: FIXME
+
+.. rubric:: Features
+
+*  Completely refactored to be in the package ``lockss.turtles``.
+
+*  Using Poetry to make uploadable to and installable from PyPI as `lockss-turtles <https://pypi.org/project/lockss-turtles>`_. Removed the requirements file.
+
+*  Validate the various YAML objects (like a ``PluginSet``) against a `JSON Schema <https://json-schema.org/>`_.
+
+.. rubric:: Changes
+
+*  Temporarily disabled the ``analyze-registry`` command.
+
+*  ``$XDG_CONFIG_HOME/turtles`` (by default ``$HOME/.config/turtles``) is now ``$XDG_CONFIG_HOME/lockss.turtles`` (by default ``$HOME/.config/lockss.turtles``) or ``/etc/lockss.turtles`` (formerly ``turtles``).
+
+*  ``settings.yaml`` is now ``plugin-signing.yaml`` and its ``kind`` is now ``PluginSigning``. The corresponding command line option ``--settings`` is now ``--plugin-signing``.
+
+*  ``plugin-sets.yaml``, its kind ``PluginSets``, its key ``plugin-sets``, and the command line option ``--plugin-sets`` are now ``plugin-set-catalog.yaml``, ``PluginSetCatalog``, ``plugin-set-files`` and ``--plugin-set-catalog``, respectively. The builder ``options`` key is deprecated.
+
+*  ``plugin-registries.yaml``, its kind ``PluginRegistries``, its key ``plugin-registries``, and the command line option ``--plugin-registries`` are now ``plugin-registry-catalog.yaml``, ``PluginRegistryCatalog``, ``plugin-registry-files`` and ``--plugin-registry-catalog``, respectively. The ``file-naming-convention`` key is now directly under ``layout`` and the value ``full`` is now ``identifier``. The layout ``options`` key is deprecated.
+
+-----
+0.2.0
+-----
+
+Released: 2022-10-26
+
+.. rubric:: Features
+
+*  ``MavenPluginSet``, for Maven projects inheriting from ``org.lockss:lockss-plugins-parent-pom``.
+
+*  ``AntPluginSet``: file naming convention layout option.
+
+*  Tabular output now includes the plugin version.
+
+.. rubric:: Bug Fixes
+
+*  ``AntPluginSet``: run ``ant load-plugins`` before building plugins.
+
+-----
+0.1.1
+-----
+
+Released: 2022-10-23
+
+.. rubric:: Bug Fixes
+
+*  ``RcsPluginRegistry``: Better handle incompletely managed RCS areas.
+
+*  ``DirectoryPluginRegistry``: Better file handling with ``cp``.
+
+-----
+0.1.0
+-----
+
+Released: 2022-10-10
+
+Initial release.
+
+.. rubric:: Features
+
+*  ``AntPluginSet``, based on the classic ``lockss-daemon`` Ant builder.
+
+*  ``DirectoryPluginRegistry``, for a simple layout.
+
+*  ``RcsPluginRegistry``, based on the classic RCS layout.
+
+*  Tabular output by `tabulate <https://pypi.org/project/tabulate/>`_.

lockss/turtles/__init__.py

@@ -28,7 +28,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-__version__ = '0.3.0-dev2'
+__version__ = '0.3.0-dev4'
 
 __copyright__ = '''\
 Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University

lockss/turtles/app.py

@@ -44,17 +44,19 @@ class TurtlesApp(object):
 
     XDG_CONFIG_DIR = xdg.xdg_config_home().joinpath(__package__)
 
-    GLOBAL_CONFIG_DIR = Path('/etc', __package__)
+    USR_CONFIG_DIR = Path('/usr/local/share', __package__)
 
-    CONFIG_DIRS = [XDG_CONFIG_DIR, GLOBAL_CONFIG_DIR]
+    ETC_CONFIG_DIR = Path('/etc', __package__)
+
+    CONFIG_DIRS = [XDG_CONFIG_DIR, USR_CONFIG_DIR, ETC_CONFIG_DIR]
 
     PLUGIN_REGISTRY_CATALOG = 'plugin-registry-catalog.yaml'
 
     PLUGIN_SET_CATALOG = 'plugin-set-catalog.yaml'
 
-    PLUGIN_SIGNING = 'plugin-signing.yaml'
+    PLUGIN_SIGNING_CREDENTIALS = 'plugin-signing-credentials.yaml'
 
-    PLUGIN_SIGNING_SCHEMA = 'plugin-signing-schema.json'
+    PLUGIN_SIGNING_CREDENTIALS_SCHEMA = 'plugin-signing-credentials-schema.json'
 
     @staticmethod
     def _default_files(file_str):
@@ -78,7 +80,7 @@ class TurtlesApp(object):
         self._password = None
         self._plugin_registries = None
         self._plugin_sets = None
-        self._plugin_signing = None
+        self._plugin_signing_credentials = None
 
     # Returns plugin_id -> (set_id, jar_path, plugin)
     def build_plugin(self, plugin_ids):
@@ -90,8 +92,8 @@ class TurtlesApp(object):
     def default_plugin_set_catalogs(self):
         return TurtlesApp._default_files(TurtlesApp.PLUGIN_SET_CATALOG)
 
-    def default_plugin_signing(self):
-        return TurtlesApp._default_files(TurtlesApp.PLUGIN_SIGNING)
+    def default_plugin_signing_credentials(self):
+        return TurtlesApp._default_files(TurtlesApp.PLUGIN_SIGNING_CREDENTIALS)
 
     # Returns (src_path, plugin_id) -> list of (registry_id, layer_id, dst_path, plugin)
     def deploy_plugin(self, src_paths, layer_ids, interactive=False):
@@ -115,11 +117,11 @@ class TurtlesApp(object):
             for plugin_set_file in plugin_set_catalog.plugin_set_files():
                 self._plugin_sets.extend(PluginSet.from_path(plugin_set_file))
 
-    def load_plugin_signing(self, plugin_signing_path=None):
-        if self._plugin_signing is None:
-            plugin_signing_path = _path(plugin_signing_path) if plugin_signing_path else self._select_file(TurtlesApp.PLUGIN_SIGNING)
-            plugin_signing_schema_path = importlib.resources.path(lockss.turtles.resources, TurtlesApp.PLUGIN_SIGNING_SCHEMA)
-            self._plugin_signing = _load_and_validate(plugin_signing_schema_path, plugin_signing_path)
+    def load_plugin_signing_credentials(self, plugin_signing_credentials_path=None):
+        if self._plugin_signing_credentials is None:
+            plugin_signing_credentials_path = _path(plugin_signing_credentials_path) if plugin_signing_credentials_path else self._select_file(TurtlesApp.PLUGIN_SIGNING_CREDENTIALS)
+            plugin_signing_credentials_schema_path = importlib.resources.path(lockss.turtles.resources, TurtlesApp.PLUGIN_SIGNING_SCHEMA)
+            self._plugin_signing_credentials = _load_and_validate(plugin_signing_credentials_schema_path, plugin_signing_credentials_path)
 
     # Returns plugin_id -> list of (registry_id, layer_id, dst_path, plugin)
     def release_plugin(self, plugin_ids, layer_ids, interactive=False):
@@ -138,8 +140,8 @@ class TurtlesApp(object):
     def select_plugin_set_catalog(self, preselected=None):
         return TurtlesApp._select_file(TurtlesApp.PLUGIN_SET_CATALOG, preselected)
 
-    def select_plugin_signing(self, preselected=None):
-        return TurtlesApp._select_file(TurtlesApp.PLUGIN_SIGNING, preselected)
+    def select_plugin_signing_credentials(self, preselected=None):
+        return TurtlesApp._select_file(TurtlesApp.PLUGIN_SIGNING_CREDENTIALS, preselected)
 
     def set_password(self, pw):
         self._password = pw if callable(pw) else lambda x: pw
@@ -176,10 +178,10 @@ class TurtlesApp(object):
         return self._password() if self._password else None
 
     def _get_plugin_signing_alias(self):
-        return self._plugin_signing['plugin-signing-alias']
+        return self._plugin_signing_credentials['plugin-signing-alias']
 
     def _get_plugin_signing_keystore(self):
-        return self._plugin_signing['plugin-signing-keystore']
+        return self._plugin_signing_credentials['plugin-signing-keystore']
 
     def _get_plugin_signing_password(self):
         return self._get_password()

lockss/turtles/cli.py

@@ -52,6 +52,8 @@ def _file_lines(path):
 
 class TurtlesCli(object):
 
+    PROG = 'turtles'
+
     def __init__(self):
         super().__init__()
         self._app = TurtlesApp()
@@ -130,7 +132,7 @@ class TurtlesCli(object):
     def _build_plugin(self):
         # Prerequisites
         self._app.load_plugin_sets(self._args.plugin_set_catalog)
-        self._app.load_plugin_signing(self._args.plugin_signing)
+        self._app.load_plugin_signing_credentials(self._args.plugin_signing_credentials)
         self._obtain_password()
         # Action
         # ... plugin_id -> (set_id, jar_path, plugin)
@@ -215,22 +217,22 @@ class TurtlesCli(object):
                                help='set the plugin signing password')
 
     def _make_option_plugin_registry_catalog(self, container):
-        container.add_argument('--plugin-registry-catalog',
+        container.add_argument('--plugin-registry-catalog', '-r',
                                metavar='FILE',
                                type=Path,
                                help=f'load plugin registry catalog from %(metavar)s (default: {" or ".join(map(str, self._app.default_plugin_registry_catalogs()))})')
 
     def _make_option_plugin_set_catalog(self, container):
-        container.add_argument('--plugin-set-catalog',
+        container.add_argument('--plugin-set-catalog', '-s',
                                metavar='FILE',
                                type=Path,
                                help=f'load plugin set catalog from %(metavar)s (default: {" or ".join(map(str, self._app.default_plugin_set_catalogs()))})')
 
-    def _make_option_plugin_signing(self, container):
-        container.add_argument('--plugin-signing',
+    def _make_option_plugin_signing_credentials(self, container):
+        container.add_argument('--plugin-signing-credentials', '-c',
                                metavar='FILE',
                                type=Path,
-                               help=f'load plugin signing settings from %(metavar)s (default: {" or ".join(map(str, self._app.default_plugin_signing()))})')
+                               help=f'load plugin signing credentials from %(metavar)s (default: {" or ".join(map(str, self._app.default_plugin_signing_credentials()))})')
 
     def _make_option_production(self, container):
         container.add_argument('--production', '-p',
@@ -292,7 +294,7 @@ class TurtlesCli(object):
                                help='add the layers in %(metavar)s to the list of plugin registry layers to process')
 
     def _make_parser(self):
-        self._parser = argparse.ArgumentParser(prog=__package__)
+        self._parser = argparse.ArgumentParser(prog=TurtlesCli.PROG)
         self._subparsers = self._parser.add_subparsers(title='commands',
                                                        description="Add --help to see the command's own help message",
                                                        # With subparsers, metavar is also used as the heading of the column of subcommands
@@ -328,7 +330,7 @@ class TurtlesCli(object):
         self._make_options_identifiers(parser)
         self._make_option_password(parser)
         self._make_option_plugin_set_catalog(parser)
-        self._make_option_plugin_signing(parser)
+        self._make_option_plugin_signing_credentials(parser)
 
     def _make_parser_copyright(self, container):
         parser = container.add_parser('copyright',
@@ -363,7 +365,7 @@ class TurtlesCli(object):
         self._make_option_password(parser)
         self._make_option_plugin_registry_catalog(parser)
         self._make_option_plugin_set_catalog(parser)
-        self._make_option_plugin_signing(parser)
+        self._make_option_plugin_signing_credentials(parser)
         self._make_option_production(parser)
         self._make_option_testing(parser)
 
@@ -392,7 +394,7 @@ class TurtlesCli(object):
         # Prerequisites
         self._app.load_plugin_sets(self._args.plugin_set_catalog)
         self._app.load_plugin_registries(self._args.plugin_registries)
-        self._app.load_plugin_signing(self._args.plugin_signing)
+        self._app.load_plugin_signing_credentials(self._args.plugin_signing_credentials)
         self._obtain_password()
         # Action
         # ... plugin_id -> list of (registry_id, layer_id, dst_path, plugin)

lockss/turtles/plugin_registry.py

@@ -102,9 +102,6 @@ class PluginRegistry(object):
     def layout_type(self):
         return self._parsed['layout']['type']
 
-    def layout_options(self):
-        return self._parsed['layout'].get('options', dict())
-
     def name(self):
         return self._parsed['name']
 
@@ -221,6 +218,9 @@ class RcsPluginRegistryLayer(DirectoryPluginRegistryLayer):
     def __init__(self, plugin_registry, parsed):
         super().__init__(plugin_registry, parsed)
 
+    def get_file_naming_convention(self):
+        return self.plugin_registry()._parsed['layout'].get('file-naming-convention', RcsPluginRegistry.IDENTIFIER)
+
     def _copy_jar(self, src_path, dst_path, interactive=False):
         basename = dst_path.name
         plugin = Plugin.from_jar(src_path)
@@ -239,11 +239,10 @@ class RcsPluginRegistryLayer(DirectoryPluginRegistryLayer):
         subprocess.run(cmd, check=True, cwd=self.path())
 
     def _get_dstfile(self, plugid):
-        conv = self.plugin_registry().layout_options().get('file-naming-convention')
-        if conv == RcsPluginRegistry.ABBREVIATED:
-            return f'{plugid.split(".")[-1]}.jar'
-        elif conv == RcsPluginRegistry.IDENTIFIER or conv is None:
+        conv = self.get_file_naming_convention()
+        if conv == RcsPluginRegistry.IDENTIFIER:
             return super()._get_dstfile(plugid)
+        elif conv == RcsPluginRegistry.ABBREVIATED:
+            return f'{plugid.split(".")[-1]}.jar'
         else:
-            raise RuntimeError(
-                f'{self.plugin_registry().id()}: unknown file naming convention in layout options: {conv}')
+            raise RuntimeError(f'{self.plugin_registry().id()}: unknown file naming convention: {conv}')

lockss/turtles/resources/plugin-registry-schema.json

@@ -98,6 +98,13 @@
       "items": {
         "type":"string"
       }
+    },
+    "suppressed-plugin-identifiers": {
+      "description": "A list of plugin identifiers excluded from the plugin registry",
+      "type": "array",
+      "items": {
+        "type":"string"
+      }
     }
   }
 }

lockss/turtles/resources/plugin-set-schema.json

@@ -4,6 +4,12 @@
   "title": "Plugin Set",
   "description": "LOCKSS plugin set",
   "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "name",
+    "builder"
+  ],
   "properties": {
     "kind": {
       "description": "This object's kind",
@@ -21,6 +27,9 @@
     "builder": {
       "description": "A plugin builder",
       "type": "object",
+      "required": [
+        "type"
+      ],
       "properties": {
         "type": {
           "description": "A plugin builder type",
@@ -30,10 +39,7 @@
           ]
         }
       },
-      "required": [
-        "type"
-      ],
-      "anyOf": [
+      "allOf": [
         {
           "if": {
             "properties": {
@@ -45,12 +51,14 @@
           "then": {
             "properties": {
               "main": {
-                "description": "The plugin set's main tree path",
-                "type": "string"
+                "description": "The path (relative to the root of the project) to the plugins' source code",
+                "type": "string",
+                "default": "plugins/src"
               },
               "test": {
-                "description": "The plugin set's test tree path",
-                "type": "string"
+                "description": "The path (relative to the root of the project) to the plugins' unit tests",
+                "type": "string",
+                "default": "plugins/test/src"
               }
             }
           }
@@ -66,23 +74,19 @@
           "then": {
             "properties": {
               "main": {
-                "description": "The plugin set's main tree path",
-                "type": "string"
+                "description": "The path (relative to the root of the project) to the plugins' source code",
+                "type": "string",
+                "default": "src/main/java"
               },
               "test": {
-                "description": "The plugin set's test tree path",
-                "type": "string"
+                "description": "The path (relative to the root of the project) to the plugins' unit tests",
+                "type": "string",
+                "default": "src/test/java"
               }
             }
           }
         }
       ]
     }
-  },
-  "required": [
-    "kind",
-    "id",
-    "name",
-    "builder"
-  ]
+  }
 }

lockss/turtles/resources/{plugin-signing-schema.json → plugin-signing-credentials-schema.json}

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://assets.lockss.org/schemas/json/plugin-signing-schema.json",
-  "title": "Plugin Signing",
-  "description": "LOCKSS plugin signing settings",
+  "$id": "https://assets.lockss.org/schemas/json/plugin-signing-credentials-schema.json",
+  "title": "Plugin Signing Credentials",
+  "description": "LOCKSS plugin signing credentials",
   "type": "object",
   "properties": {
     "kind": {
       "description": "This object's kind",
       "type": "string",
-      "const": "PluginSigning"
+      "const": "PluginSigningCredentials"
     },
     "plugin-signing-keystore": {
       "description": "A path to the plugin signing keystore",

{lockss_turtles-0.3.0.dev2.dist-info → lockss_turtles-0.3.0.dev4.dist-info}/LICENSE

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