invenio-app-rdm 13.0.0b2.dev2__py2.py3-none-any.whl → 13.0.0b2.dev4__py2.py3-none-any.whl

tests/fixtures/test_fixtures.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+from pathlib import Path
+
+from invenio_access.permissions import system_identity
+from invenio_pages.proxies import current_pages_service
+from invenio_rdm_records.proxies import current_oaipmh_server_service
+
+from invenio_app_rdm.fixtures import StaticPages
+from invenio_app_rdm.fixtures.oai_sets import OAICustomSets
+
+
+def test_load_oai_sets(app):
+    dir_ = Path(__file__).parent
+    service = current_oaipmh_server_service
+    oai_sets = OAICustomSets(
+        [dir_ / "app_data", dir_.parent.parent / "invenio_app_rdm/fixtures/data"],
+        "oai_sets.yaml",
+    )
+
+    oai_sets.load()
+
+    res_set = service.search(system_identity, params={"q": f"set1"})
+
+    assert res_set.total == 1
+
+
+def test_load_pages(app):
+    dir_ = Path(__file__).parent
+    StaticPages(
+        [dir_ / "app_data", dir_.parent.parent / "invenio_app_rdm/fixtures/data"],
+        "pages.yaml",
+        [dir_ / "app_data/pages", dir_ / "pages"],
+        force=True,
+    ).load()
+
+    pages = current_pages_service.search(system_identity)
+
+    assert pages.total == 1
+
+    assert pages.to_dict()["hits"]["hits"][0]["title"] == "About"

tests/mock_module/__init__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+"""Mock module entry point."""

tests/mock_module/templates/mock_mail.html

@@ -0,0 +1,28 @@
+{#
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+-#}
+
+{% set BASE_URL = config.SITE_UI_URL %}
+
+{%- for entry in entries -%}
+{{ "ID: %s" | format(entry.file.id) }}
+{{ "URI: %s" | format(entry.file.uri) }}
+{%- if 'filename' in entry %}
+{{ "Name: %s" | format(entry.filename) }}
+{%- endif %}
+{{ "Created: %s" | format(entry.file.created) }}
+{{ "Checksum: %s" | format(entry.file.checksum) }}
+{{ "Last check: %s" | format(entry.file.last_check_at) }}
+{%- if 'record' in entry %}
+{{ "Record: %s/records/%s" | format(BASE_URL, entry.record.id) }}
+{%- endif %}
+{%- if 'draft' in entry %}
+{{ "Draft: %s/uploads/%s" | format(BASE_URL, entry.draft.id) }}
+{%- endif %}
+{{ "-" * 80 }}
+{% endfor %}

tests/mock_module/views.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+"""Mock module blueprint."""
+
+from flask import Blueprint
+
+
+def create_blueprint(app):
+    """Creates a blueprint for mock module and registers a mock url rule."""
+    blueprint = Blueprint(
+        "app_rdm_mock_module",
+        __name__,
+        template_folder="templates",
+        static_folder="static",
+    )
+
+    blueprint.add_url_rule(
+        "/test_app_rdm/mock",
+        endpoint="test_app_rdm_mock_endpoint",
+        view_func=mock_view_func,
+    )
+
+    return blueprint
+
+
+def mock_view_func(mock_arg):
+    """Mock view function."""
+    return mock_arg

tests/redirector/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 Graz University of Technology.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Tests."""

tests/redirector/conftest.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+"""Redirector test fixtures."""
+
+import pytest
+
+
+@pytest.fixture(scope="module")
+def app_config(app_config, redirection_rules):
+    """Override pytest-invenio app_config fixture to disable CSRF check."""
+    app_config["REDIRECTOR_RULES"] = redirection_rules
+
+    return app_config
+
+
+@pytest.fixture(scope="module")
+def redirection_rules():
+    """Creates a dictionary of redirection rules."""
+
+    def internal_view_function_str():
+        """Generates a redirection url to a mock endpoint."""
+        from flask import request, url_for
+
+        values = request.view_args
+        _type = values["type"]
+        values["mock_arg"] = _type
+        target = url_for("app_rdm_mock_module.test_app_rdm_mock_endpoint", **values)
+        return target
+
+    def internal_view_function_str():
+        """Generates a redirection tuple(url, code) to a mock endpoint."""
+        from flask import request, url_for
+
+        values = request.view_args
+        _type = values["type"]
+        values["mock_arg"] = _type
+        target = url_for("app_rdm_mock_module.test_app_rdm_mock_endpoint", **values)
+        return (target, 302)
+
+    rules = {
+        "test_redirector_endpoint_external": {
+            "source": "/test/redirect_external",
+            "target": "https://cern.ch/",
+        },
+        "test_redirector_endpoint_internal": {
+            "source": "/test/redirect_internal/<type>",
+            "target": internal_view_function_str,
+        },
+    }
+    return rules

tests/redirector/test_redirector.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+"""Redirector tests."""
+
+
+def test_redirector(client_with_login, redirection_rules):
+    """Tests redirector resource."""
+    client = client_with_login
+    for endpoint, rule in redirection_rules.items():
+        source = rule["source"]
+        target = rule["target"]
+        response = client.get(source)
+        expected_url = target
+        expected_code = 301
+        # Target can be either a url or a function that returns a tuple(url, code)
+        if callable(target):
+            target_output = target()
+            if type(target_output) == tuple:
+                expected_url, expected_code = target_output
+            else:
+                expected_url = target_output
+
+        assert response.status_code == expected_code
+        assert response.headers["location"] == expected_url

tests/test_tasks.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-2024 CERN.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+"""Test invenio-app-rdm celery tasks."""
+
+from invenio_app_rdm.tasks import file_integrity_report
+
+
+def test_task_file_integrity_report(app, invalid_file_instance):
+    """Test celery task for file integrity reports."""
+    assert invalid_file_instance.last_check is False
+
+    # A report must be generated for the file
+    mail = app.extensions.get("mail")
+    assert mail
+
+    recipients = "test@invenio.org"
+    sender = "test@invenio.org"
+
+    file_name = invalid_file_instance.objects[0].key
+    uri = invalid_file_instance.uri
+    file_id = invalid_file_instance.id
+    file_name = invalid_file_instance.objects[0].key
+    checksum = invalid_file_instance.checksum
+
+    with mail.record_messages() as outbox:
+        # Configure email and validate that email was sent
+        app.config["APP_RDM_FILES_INTEGRITY_REPORT_TEMPLATE"] = "mock_mail.html"
+        app.config["APP_RDM_ADMIN_EMAIL_RECIPIENT"] = recipients
+        app.config["MAIL_DEFAULT_SENDER"] = sender
+
+        file_integrity_report()
+        assert len(outbox) == 1
+        mail_sent = outbox[0]
+        assert mail_sent.recipients == [recipients]
+        assert mail_sent.sender == sender
+        assert "Checksum: {}".format(checksum) in mail_sent.body
+        assert "URI: {}".format(uri) in mail_sent.body
+        assert "ID: {}".format(str(file_id)) in mail_sent.body
+        assert "Name: {}".format(file_name) in mail_sent.body
+
+
+def test_integrity_report_invalid_template(app, invalid_file_instance):
+    """Test non-existant e-mail template."""
+    assert invalid_file_instance.last_check is False
+
+    mail = app.extensions.get("mail")
+    assert mail
+
+    with mail.record_messages() as outbox:
+        # Remove the template, no e-mail is sent
+        app.config["APP_RDM_FILES_INTEGRITY_REPORT_TEMPLATE"] = None
+        file_integrity_report()
+        assert len(outbox) == 0
+
+
+def test_integrity_report_invalid_addresses(app, invalid_file_instance):
+    """Test invalid recipient address."""
+    assert invalid_file_instance.last_check is False
+
+    mail = app.extensions.get("mail")
+    assert mail
+
+    with mail.record_messages() as outbox:
+        # Use mock template
+        app.config["APP_RDM_FILES_INTEGRITY_REPORT_TEMPLATE"] = "mock_mail.html"
+
+        # Recipient is not set, mail is not sent.
+        app.config["APP_RDM_ADMIN_EMAIL_RECIPIENT"] = None
+        file_integrity_report()
+        assert len(outbox) == 0
+
+
+def test_integrity_report_default_template(app, invalid_file_instance):
+    """Test invalid recipient address."""
+    assert invalid_file_instance.last_check is False
+
+    mail = app.extensions.get("mail")
+    assert mail
+
+    recipients = "test@invenio.org"
+    sender = "test@invenio.org"
+
+    uri = invalid_file_instance.uri
+    file_id = invalid_file_instance.id
+    file_name = invalid_file_instance.objects[0].key
+    checksum = invalid_file_instance.checksum
+
+    with mail.record_messages() as outbox:
+        # Use default template
+        app.config["APP_RDM_ADMIN_EMAIL_RECIPIENT"] = recipients
+        app.config["MAIL_DEFAULT_SENDER"] = sender
+        file_integrity_report()
+        assert len(outbox) == 1
+        mail_sent = outbox[0]
+        assert mail_sent.recipients == [recipients]
+        assert mail_sent.sender == sender
+        assert "Checksum: {}".format(checksum) in mail_sent.body
+        assert "URI: {}".format(uri) in mail_sent.body
+        assert "ID: {}".format(str(file_id)) in mail_sent.body
+        assert "Name: {}".format(file_name) in mail_sent.body

tests/test_utils.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 TU Wien.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Tests for utility functions."""
+
+from datetime import datetime
+
+from invenio_app_rdm.records_ui.utils import set_default_value
+
+
+def test_set_default_value__value():
+    """Test setting a value."""
+    dict_ = {"metadata": {"publication_date": None}}
+    value = "1939-01-01"
+    path = "publication_date"
+
+    set_default_value(dict_, value, path)
+
+    assert dict_["metadata"]["publication_date"] == value
+
+
+def test_set_default_value__callable():
+    """Test setting a value via a callable."""
+    dict_ = {"metadata": {"publication_date": None}}
+
+    def func():
+        return datetime.now().strftime("%Y-%m-%d")
+
+    path = "publication_date"
+    today = func()
+
+    set_default_value(dict_, func, path)
+
+    assert dict_["metadata"]["publication_date"] == today
+
+
+def test_set_default_value__no_path_prefix():
+    """Test setting a value for an unprefixed path."""
+    dict_ = {"metadata": {"publication_date": None}}
+    value = "1939-01-01"
+    path = ".publication_date"
+
+    set_default_value(dict_, value, path)
+
+    assert dict_["metadata"]["publication_date"] is None
+    assert dict_["publication_date"] == value
+
+
+def test_set_default_value__explicit_and_automatic_prefix():
+    """Compare values set with auto-prefix and explicit prefix."""
+    dict1 = {"metadata": {"publication_date": None}}
+    dict2 = dict1.copy()
+    value = "1939-01-01"
+    path1 = "publication_date"
+    path2 = ".metadata.publication_date"
+
+    set_default_value(dict1, value, path1)
+    set_default_value(dict2, value, path2)
+
+    assert (
+        dict1["metadata"]["publication_date"] == dict2["metadata"]["publication_date"]
+    )
+    assert dict1["metadata"]["publication_date"] == value

tests/test_version.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 CERN.
+# Copyright (C) 2019 Northwestern University.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Simple test of version import."""
+
+
+def test_version():
+    """Test version import."""
+    from invenio_app_rdm import __version__
+
+    assert __version__

tests/test_views.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 KTH Royal Institute of Technology.
+#
+# Invenio-RDM is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+
+from unittest.mock import Mock, patch
+
+import pytest
+
+from invenio_app_rdm.theme.views import add_static_page_routes
+
+
+def test_add_static_page_routes():
+    """Test add_static_page_routes function."""
+
+    # Mocking the blueprint and app objects
+    mock_blueprint = Mock()
+    mock_app = Mock()
+    mock_app.config = {"APP_RDM_PAGES": {"endpoint1": "/path1", "endpoint2": "/path2"}}
+
+    # Mocking the create_page_view function
+    with patch("invenio_app_rdm.theme.views.create_page_view") as mock_create_page_view:
+        mock_create_page_view.side_effect = lambda x: f"view_func_{x}"
+
+        add_static_page_routes(mock_blueprint, mock_app)
+
+    mock_blueprint.add_url_rule.assert_any_call(
+        "/path1", endpoint="endpoint1", view_func="view_func_/path1"
+    )
+    mock_blueprint.add_url_rule.assert_any_call(
+        "/path2", endpoint="endpoint2", view_func="view_func_/path2"
+    )
+
+    # Check if was called with the right arguments
+    mock_create_page_view.assert_any_call("/path1")
+    mock_create_page_view.assert_any_call("/path2")
+
+    # Check if was called the right number of times
+    assert mock_blueprint.add_url_rule.call_count == 2

tests/ui/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 Graz University of Technology.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Tests."""

tests/ui/conftest.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 CERN.
+# Copyright (C) 2019 Northwestern University.
+# Copyright (C) 2024 Graz University of Technology.
+#
+# Invenio App RDM is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Pytest fixtures and plugins for the UI application."""
+
+from io import BytesIO
+
+import pytest
+from flask_webpackext.manifest import (
+    JinjaManifest,
+    JinjaManifestEntry,
+    JinjaManifestLoader,
+)
+from invenio_access.permissions import system_identity
+from invenio_app.factory import create_ui
+from invenio_rdm_records.proxies import current_rdm_records
+from invenio_search import current_search
+
+
+#
+# Mock the webpack manifest to avoid having to compile the full assets.
+#
+class MockJinjaManifest(JinjaManifest):
+    """Mock manifest."""
+
+    def __getitem__(self, key):
+        """Get a manifest entry."""
+        return JinjaManifestEntry(key, [key])
+
+    def __getattr__(self, name):
+        """Get a manifest entry."""
+        return JinjaManifestEntry(name, [name])
+
+
+class MockManifestLoader(JinjaManifestLoader):
+    """Manifest loader creating a mocked manifest."""
+
+    def load(self, filepath):
+        """Load the manifest."""
+        return MockJinjaManifest()
+
+
+@pytest.fixture(scope="module")
+def app_config(app_config):
+    """Create test app."""
+    app_config["WEBPACKEXT_MANIFEST_LOADER"] = MockManifestLoader
+    return app_config
+
+
+@pytest.fixture(scope="module")
+def create_app():
+    """Create test app."""
+    return create_ui
+
+
+@pytest.fixture()
+def index_templates(running_app):
+    """Ensure the index templates are in place."""
+    list(current_search.put_templates(ignore=[400]))
+
+
+@pytest.fixture()
+def record(running_app, minimal_record):
+    """Create and publish a record."""
+    s = current_rdm_records.records_service
+    draft = s.create(system_identity, minimal_record)
+    return s.publish(system_identity, draft.id)
+
+
+@pytest.fixture()
+def record_with_file(running_app, minimal_record):
+    """Create and publish a record with file."""
+    minimal_record["files"] = {"enabled": True}
+
+    record_service = current_rdm_records.records_service
+    file_service = record_service.draft_files
+
+    draft = record_service.create(system_identity, minimal_record)
+    file_to_initialise = [
+        {
+            "key": "article.txt",
+            "checksum": "md5:c785060c866796cc2a1708c997154c8e",
+            "size": 17,  # 2kB
+            "metadata": {
+                "description": "Published article PDF.",
+            },
+        }
+    ]
+    file_service.init_files(system_identity, draft.id, file_to_initialise)
+    content = BytesIO(b"test file content")
+    file_service.set_file_content(
+        system_identity,
+        draft.id,
+        file_to_initialise[0]["key"],
+        content,
+        content.getbuffer().nbytes,
+    )
+    file_service.commit_file(system_identity, draft.id, "article.txt")
+    return record_service.publish(system_identity, draft.id)

tests/ui/test_deposits.py

@@ -0,0 +1,115 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 Northwestern University.
+#
+# Invenio-App-RDM is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+"""Test deposit views."""
+
+import pytest
+from invenio_access.permissions import system_identity
+from invenio_search.engine import dsl
+from invenio_vocabularies.proxies import current_service as vocabulary_service
+from invenio_vocabularies.records.api import Vocabulary
+
+from invenio_app_rdm.records_ui.views.deposits import VocabulariesOptions
+
+
+@pytest.fixture()
+def additional_resource_types(running_app):
+    """Resource type vocabulary record."""
+    vocabulary_service.create(
+        system_identity,
+        {
+            "id": "publication",
+            "icon": "file alternate",
+            "props": {
+                "csl": "report",
+                "datacite_general": "Text",
+                "datacite_type": "",
+                "eurepo": "info:eu-repo/semantics/other",
+                "openaire_resourceType": "17",
+                "openaire_type": "publication",
+                "schema.org": "https://schema.org/CreativeWork",
+                "subtype": "",
+                "type": "publication",
+            },
+            "title": {"en": "Publication"},
+            "tags": ["depositable", "linkable"],
+            "type": "resourcetypes",
+        },
+    )
+    vocabulary_service.create(
+        system_identity,
+        {
+            "id": "publication-annotationcollection",
+            "icon": "file alternate",
+            "props": {
+                "csl": "report",
+                "datacite_general": "Collection",
+                "datacite_type": "",
+                "eurepo": "info:eu-repo/semantics/technicalDocumentation",
+                "openaire_resourceType": "9",
+                "openaire_type": "publication",
+                "schema.org": "https://schema.org/Collection",
+                "subtype": "publication-annotationcollection",
+                "type": "publication",
+            },
+            "title": {"en": "Annotation collection"},
+            "tags": ["depositable", "linkable"],
+            "type": "resourcetypes",
+        },
+    )
+
+    Vocabulary.index.refresh()
+
+
+def test_resource_types(app, client_with_login, additional_resource_types):
+    options = VocabulariesOptions()
+    expected = [
+        # If no corresponding parent type entry (e.g. image-photo), type_name
+        # is own title and subtype_name is empty.
+        {
+            "icon": "chart bar outline",
+            "id": "image-photo",
+            "subtype_name": "",
+            "type_name": "Photo",
+        },
+        # If parent type is itself (e.g. Publication), type_name is own title
+        # and subtype_name is empty.
+        {
+            "icon": "file alternate",
+            "id": "publication",
+            "subtype_name": "",
+            "type_name": "Publication",
+        },
+        # If corresponding parent type entry, type_name is parent's title
+        # and subtype_name is own title.
+        {
+            "icon": "file alternate",
+            "id": "publication-annotationcollection",
+            "subtype_name": "Annotation collection",
+            "type_name": "Publication",
+        },
+    ]
+
+    # the choice of this filter isn't important for the test
+    result = options._resource_types(dsl.Q("term", tags="depositable"))
+
+    sorted_result = sorted(result, key=lambda e: e["id"])
+    assert expected == sorted_result
+
+
+def test_dump_subjects_vocabulary(running_app):
+    options = VocabulariesOptions()
+    expected = {
+        "limit_to": [
+            {"text": "All", "value": "all"},
+            {"text": "MeSH", "value": "MeSH"},
+        ]
+    }
+
+    result = options.subjects()
+
+    assert expected == result