Fix #454: Add end-to-end tests for the plugin-related `SoftwareMetadata` API by sdruskat · Pull Request #456 · softwarepub/hermes

sdruskat · 2025-11-21T10:10:33Z

No description provided.

sdruskat · 2025-11-21T10:25:41Z

Re-opening after rebase on correct branch.

…oftwareMetadata

test/hermes_test/model/test_api_e2e.py

…-test-plugin-api

Merged implementation for curate step back into the feature branches base branch.

Merged features for process (new data model) back into the feature branches base branch.

…eposit

Merged implementation for process and deposit step back into the feature branches base branch.

Merged implementation for postprocess step back into the feature branches base branch.

…e and changed the way commands handle errors in plugin runs

SKernchen · 2026-03-20T08:35:23Z

docs/source/tutorials/writing-a-plugin-for-hermes.md

-The full code and structure is available at  [hermes-plugin-git](https://github.com/softwarepub/hermes-plugin-git).
+This tutorial will present the basic steps for writing additional plugins.
+
+The full code and structure of a harvest plugin is available at [hermes-plugin-git](https://github.com/softwarepub/hermes-plugin-git).


Made an Issue to update the plugin for later: softwarepub/hermes-plugin-git#3

docs/source/tutorials/writing-a-plugin-for-hermes.md

src/hermes/commands/deposit/file.py

SKernchen · 2026-03-20T09:40:06Z

src/hermes/commands/deposit/invenio_rdm.py

+        # That would be able to replace _search_license_info.
+        # FIXME: Some licenses in valid_licenses["hits"]["hits"]["props"]["url"] are only http although
+        # https://spdx.org/licenses/license.json lists them in crossRef as https
+


Yes that should be possible.
We should fix the licenses to https.

SKernchen · 2026-03-20T09:42:17Z

src/hermes/commands/deposit/invenio_rdm.py

                if license_info is not None:
                    break
            else:
+                # FIXME: Why is this only raised here and not always when license_info is None?


I think, it was originally because that was were the deposit step broke two years ago, when Zenodo implemented the need of the correct license identifier. But you are right, we should fix that.

SKernchen · 2026-03-20T09:47:15Z

src/hermes/commands/postprocess/invenio.py

-    try:
-        cff = yaml.load(open('CITATION.cff', 'r'), yaml.Loader)
-        new_identifier = {
+class cff_doi(HermesPostprocessPlugin):


Maybe also for codemeta, because we can not be sure the user has a cff

SKernchen · 2026-03-20T12:10:38Z

src/hermes/commands/process/standard_merge.py

+        "Or".join(types): MergeSet(match_multiple_types(
+            *(("schema:" + type, MATCH_FUNCTION_FOR_TYPE.get("schema:" + type, DEFAULT_MATCH)) for type in types)
+        ))
+        for types in [


Maybe we can curl this information? Or automate the mapping?
But really good work 👍

Maybe.
I'll think about whether or not this can be (easily) done.
Edit: It seems doable, I'll implement it in the next days.

SKernchen · 2026-03-20T12:58:05Z

test/hermes_test/commands/deposit/test_invenio_e2e.py

+
+@pytest.fixture
+def sandbox_auth():
+    path = Path("./../auth.txt")


We need to tell users how to provide auth or skip the test for ci

Especially for our testsuite ci

Yes, implementing a way to provide auth seems reasonable.
(But the test is already skipped if the file doesn't exist.)

SKernchen · 2026-03-20T13:01:02Z

test/hermes_test/commands/deposit/test_invenio_e2e.py

+
+
+@pytest.mark.parametrize(
+    "metadata, invenio_metadata",


invenio_metada can change, maybe we should test the format as well?

SKernchen · 2026-03-20T13:04:50Z

test/hermes_test/commands/process/test_process.py

Maybe also test for 3-way-merges. And test strategies in different files would be great.

SKernchen · 2026-03-20T14:42:56Z

Findings from user test:
process step:

process step fails when one harvester failed in the harvest step
(maybe process should not look into toml?)

deposit step:
error:

'ld_list' object has no attribute 'startswith'
for file add log.info where to find file would be good

notactuallyfinn · 2026-03-20T15:13:51Z

Could you please provide more information on this error?

'ld_list' object has no attribute 'startswith'

SKernchen · 2026-03-20T15:23:29Z

src/hermes/commands/deposit/invenio_rdm.py

            return None


 class IvenioRDMDepositPlugin(InvenioDepositPlugin):


Suggested change

class InvenioRDMDepositPlugin(InvenioDepositPlugin):

SKernchen · 2026-03-20T15:25:11Z

pyproject.toml

 [project.entry-points."hermes.deposit"]
 file = "hermes.commands.deposit.file:FileDepositPlugin"
 invenio = "hermes.commands.deposit.invenio:InvenioDepositPlugin"
 invenio_rdm = "hermes.commands.deposit.invenio_rdm:IvenioRDMDepositPlugin"


Suggested change

invenio_rdm = "hermes.commands.deposit.invenio_rdm:InvenioRDMDepositPlugin"

SKernchen · 2026-03-20T15:44:54Z

Could you please provide more information on this error?

'ld_list' object has no attribute 'startswith'

That is the only information provided for this error:
1774021073.908437: hermes.cli: ERROR | An error occurred during execution of deposit (Find details in './hermes.log') 1774021073.910363: hermes.cli: DEBUG | Original exception was: 'ld_list' object has no attribute 'startswith'
I do not know where it is coming from. Everything with startswith seemed fine to me 🤷‍♀️

sdruskat changed the base branch from develop to refactor/data-model November 21, 2025 10:12

sdruskat changed the base branch from refactor/data-model to refactor/423-implement-public-api November 21, 2025 10:17

sdruskat closed this Nov 21, 2025

sdruskat force-pushed the feature/454-e2e-test-plugin-api branch from f45d9b4 to 9be8041 Compare November 21, 2025 10:23

sdruskat deleted the feature/454-e2e-test-plugin-api branch November 21, 2025 10:24

sdruskat restored the feature/454-e2e-test-plugin-api branch November 21, 2025 10:24

Add test file

a68f2ae

sdruskat reopened this Nov 21, 2025

Michael Fritzsche added 9 commits January 12, 2026 10:59

added first e2e harvest test for SoftwareMetadata

95288a2

added more tests

4920090

refactored end to end tests

38ef40e

updated creation of SoftwareMetadata objects in e2e tests

ddcd26a

added tests and support for curate step

9b44b53

started to add support for deposit step and added useful method for S…

6c3ba13

…oftwareMetadata

worked on invenio deposit

feeb16b

Merge branch 'refactor/data-model' into feature/454-e2e-deposit

4f6cc9d

fixed bugs in invenio.py

ed0916b

SKernchen reviewed Jan 30, 2026

View reviewed changes

test/hermes_test/model/test_api_e2e.py Outdated Show resolved Hide resolved

test/hermes_test/model/test_api_e2e.py Outdated Show resolved Hide resolved

notactuallyfinn and others added 11 commits January 30, 2026 14:07

fixed bug and adjusted tests

382e2c3

adjusted invenio.py and its test a bit

96861ec

added adjusted files from feature/153-refactor-datamodel for process

248ae33

added first tests

ebebca4

(re)added version and help commands to the available commands

f21df49

made test for process step more complex

d4d9ca8

made process step and ld_container._to_expanded_json more robust

7cfa7bc

improved flake8 rating

520ef39

Merge branch 'refactor/423-implement-public-api' into feature/454-e2e…

8606933

…-test-plugin-api

Remove SysExit call

d04b0e2

Fix typo

13a0952

notactuallyfinn and others added 17 commits March 9, 2026 13:07

Merge pull request #468 from softwarepub/feature/454-e2e-curate

62f1345

Merged implementation for curate step back into the feature branches base branch.

fixed mistake in merge

1e781ca

Merge pull request #470 from softwarepub/feature/454-e2e-process

2878155

Merged features for process (new data model) back into the feature branches base branch.

Merge branch 'feature/454-e2e-test-plugin-api' into feature/454-e2e-d…

57cdfb0

…eposit

Merge pull request #469 from softwarepub/feature/454-e2e-deposit

e5065c2

Merged implementation for process and deposit step back into the feature branches base branch.

fixed minor bugs

0e8b49c

adapted postprocess and added test

bd7e732

changed imports and fixed syntax error for python 3.10

a30d385

Merge pull request #475 from softwarepub/feature/454-e2e-postprocess

50c58d3

Merged implementation for postprocess step back into the feature branches base branch.

fixed syntax error and added lost dependency

230ee05

adjusted comments and config for doc build to try get it running

1fcbb4b

tweeked documentation a bit

65f3d10

tweeked documentation of ld_list

4f3372c

improved comments for ld_dict

45459fc

split test_api_e2e.py into multiple files

8afb37b

added and updated comments

4a08fbe

commented the rest of the new files

1d1c18d

notactuallyfinn marked this pull request as ready for review March 16, 2026 10:40

notactuallyfinn added 4 commits March 16, 2026 13:52

added support for user defined merge strategies

02340e0

added class to ignore list for autoapi

5e296cb

updated documentation for plugin development, made curate pluginizabl…

630dd00

…e and changed the way commands handle errors in plugin runs

fixed formatting errors

296fbb7

SKernchen reviewed Mar 20, 2026

View reviewed changes

notactuallyfinn added 2 commits March 20, 2026 13:00

reactivated tests and added afew log calls

758dbde

applied simple suggestions

7de8c7d

SKernchen reviewed Mar 20, 2026

View reviewed changes

		return None


		class IvenioRDMDepositPlugin(InvenioDepositPlugin):


	invenio_rdm = "hermes.commands.deposit.invenio_rdm:InvenioRDMDepositPlugin"

Conversation

sdruskat commented Nov 21, 2025

Uh oh!

sdruskat commented Nov 21, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notactuallyfinn Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SKernchen commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

notactuallyfinn commented Mar 20, 2026

Uh oh!

SKernchen Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SKernchen commented Mar 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

notactuallyfinn Mar 20, 2026 •

edited

Loading

SKernchen commented Mar 20, 2026 •

edited

Loading

SKernchen Mar 20, 2026 •

edited

Loading