lockss-turtles 0.6.0.dev25__tar.gz → 0.6.0.dev26__tar.gz

{lockss_turtles-0.6.0.dev25 → lockss_turtles-0.6.0.dev26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockss-turtles
-Version: 0.6.0.dev25
+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
@@ -35,7 +35,7 @@ Description-Content-Type: text/x-rst
 Turtles
 =======
 
-.. |RELEASE| replace:: 0.6.0-dev25 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.dev25 → lockss_turtles-0.6.0.dev26}/README.rst

@@ -2,7 +2,7 @@
 Turtles
 =======
 
-.. |RELEASE| replace:: 0.6.0-dev25 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.dev25 → lockss_turtles-0.6.0.dev26}/pyproject.toml

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-turtles"
-version = "0.6.0-dev25" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.6.0-dev26" # 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.dev25 → lockss_turtles-0.6.0.dev26}/src/lockss/turtles/__init__.py

@@ -6,7 +6,7 @@ registries.
 """
 
 #: This package's version.
-__version__ = '0.6.0-dev25'
+__version__ = '0.6.0-dev26'
 
 #: This package's copyright.
 __copyright__ = '''

{lockss_turtles-0.6.0.dev25 → lockss_turtles-0.6.0.dev26}/src/lockss/turtles/plugin_signing_credentials.py

@@ -35,7 +35,7 @@ Module to represent plugin signing credentials.
 from pathlib import Path
 from typing import Literal
 
-from pydantic.v1 import Field
+from pydantic import Field
 
 from .util import BaseModelWithRoot
 
@@ -52,13 +52,17 @@ class PluginSigningCredentials(BaseModelWithRoot):
 
     #: This object's kind.
     kind: PluginSigningCredentialsKind = Field(title='Kind',
-                                         description="This object's kind")
+                                               description="This object's kind")
 
     #: Path to the plugin signing keystore.
-    plugin_signing_keystore: str = Field(title='Plugin Signing Keystore', description='A path to the plugin signing keystore', alias='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(title='Plugin Signing Alias', description='The plugin signing alias to use', alias='plugin-signing-alias')
+    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:
         """

{lockss_turtles-0.6.0.dev25 → lockss_turtles-0.6.0.dev26}/tests/unittest/lockss/turtles/test_plugin_set.py

@@ -51,6 +51,7 @@ class TestPluginSetCatalog(PydanticTestCase):
                                                   'plugin-set-files': [
                                                       'one.yaml'
                                                   ]}).initialize(ROOT)
+        self.valid = [self.valid_absolute, self.valid_relative]
 
     def test_missing_kind(self) -> None:
         self.assertPydanticMissing(lambda: PluginSetCatalog(),
@@ -85,8 +86,8 @@ class TestPluginSetCatalog(PydanticTestCase):
         self.assertRaises(ValueError, lambda: psc.get_plugin_set_files())
 
     def test_kind(self) -> None:
-        self.assertEqual(self.valid_absolute.kind, 'PluginSetCatalog')
-        self.assertEqual(self.valid_relative.kind, 'PluginSetCatalog')
+        for valid in self.valid:
+            self.assertEqual(valid.kind, 'PluginSetCatalog')
 
     def test_get_plugin_set_files(self) -> None:
         self.assertListEqual(self.valid_absolute.get_plugin_set_files(),
@@ -106,6 +107,7 @@ class _BasePluginSetBuilderTestCase(ABC, PydanticTestCase):
         self.valid_relative = self.instance(type=self.type(),
                                             main='maindir',
                                             test='testdir').initialize(ROOT)
+        self.valid = [self.valid_absolute, self.valid_relative]
 
     @abstractmethod
     def instance(self, **kwargs) -> BasePluginSetBuilder:
@@ -157,8 +159,8 @@ class _BasePluginSetBuilderTestCase(ABC, PydanticTestCase):
         self.assertRaises(ValueError, lambda: psb.get_test())
 
     def test_get_type(self) -> None:
-        self.assertEqual(self.valid_absolute.get_type(), self.type())
-        self.assertEqual(self.valid_relative.get_type(), self.type())
+        for valid in self.valid:
+            self.assertEqual(valid.get_type(), self.type())
 
     def test_get_main(self) -> None:
         self.assertEqual(self.valid_absolute.get_main(), Path('/tmp/maindir'))

lockss_turtles-0.6.0.dev26/tests/unittest/lockss/turtles/test_plugin_signing_credentials.py

@@ -0,0 +1,102 @@
+#!/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.
+
+# 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
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from pathlib import Path
+
+from . import PydanticTestCase, ROOT
+from lockss.turtles.plugin_signing_credentials import PluginSigningCredentials
+
+class TestPluginSigningCredentials(PydanticTestCase):
+
+    def setUp(self) -> None:
+        super().setUp()
+        self.valid_absolute = PluginSigningCredentials(**{'kind': 'PluginSigningCredentials',
+                                                          'plugin-signing-keystore': '/tmp/keystore.txt',
+                                                          'plugin-signing-alias': 'myalias'}).initialize(ROOT)
+        self.valid_relative = PluginSigningCredentials(**{'kind': 'PluginSigningCredentials',
+                                                          'plugin-signing-keystore': 'keystore.txt',
+                                                          'plugin-signing-alias': 'myalias'}).initialize(ROOT)
+        self.valid = [self.valid_absolute, self.valid_relative]
+
+    def test_missing_kind(self) -> None:
+        self.assertPydanticMissing(lambda: PluginSigningCredentials(),
+                                   'kind')
+
+    def test_null_kind(self) -> None:
+        self.assertPydanticLiteralError(lambda: PluginSigningCredentials(kind=None),
+                                        'kind',
+                                        'PluginSigningCredentials')
+
+    def test_wrong_kind(self) -> None:
+        self.assertPydanticLiteralError(lambda: PluginSigningCredentials(kind='WrongKind'),
+                                        'kind',
+                                        'PluginSigningCredentials')
+
+    def test_missing_plugin_signing_alias(self) -> None:
+        self.assertPydanticMissing(lambda: PluginSigningCredentials(),
+                                   'plugin-signing-alias')
+
+    def test_null_plugin_signing_alias(self) -> None:
+        self.assertPydanticStringType(lambda: PluginSigningCredentials(**{'plugin-signing-alias': None}),
+                                      'plugin-signing-alias')
+
+    def test_missing_plugin_signing_keystore(self) -> None:
+        self.assertPydanticMissing(lambda: PluginSigningCredentials(),
+                                   'plugin-signing-keystore')
+
+    def test_null_plugin_signing_keystore(self) -> None:
+        self.assertPydanticStringType(lambda: PluginSigningCredentials(**{'plugin-signing-keystore': None}),
+                                      'plugin-signing-keystore')
+
+    def test_uninitialized(self) -> None:
+        psc = PluginSigningCredentials(**{'kind': 'PluginSigningCredentials',
+                                          'plugin-signing-keystore': '/tmp/keystore.txt',
+                                          'plugin-signing-alias': 'myalias'})
+        self.assertRaises(ValueError, lambda: psc.get_root())
+        self.assertRaises(ValueError, lambda: psc.get_plugin_signing_keystore())
+
+    def test_kind(self) -> None:
+        for valid in self.valid:
+            self.assertEqual(valid.kind, 'PluginSigningCredentials')
+
+    def test_get_plugin_signing_alias(self) -> None:
+        for valid in self.valid:
+            self.assertEqual(valid.get_plugin_signing_alias(), 'myalias')
+
+    def test_get_plugin_signing_keystore(self) -> None:
+        self.assertEqual(self.valid_absolute.get_plugin_signing_keystore(),
+                         Path('/tmp/keystore.txt'))
+        self.assertEqual(self.valid_relative.get_plugin_signing_keystore(),
+                         ROOT.joinpath('keystore.txt'))