fix(tests): Various maintenance tweaks for tests; adding js tests to CI workflow

Author: monotasker

.github/workflows/CI.yml

@@ -143,13 +143,13 @@ jobs:
         if: always()
         run: |
           touch .env
-          docker compose --file docker-compose.yml --file docker-compose.dev.yml up -d
+          docker compose --file docker-compose.yml up -d
 
       - name: Destroy containers
         if: always()
         run: |
           touch .env
-          docker compose --file docker-compose.yml --file docker-compose.dev.yml down
+          docker compose --file docker-compose.yml down
 
       - name: Prune Docker
         run: docker system prune -af

.github/workflows/tests.yml

@@ -95,14 +95,16 @@ jobs:
       # - name: Run translations test
       #   run: ./run-i18n-tests.sh
 
-      # - name: Install deps for frontend tests
-      #   working-directory: ./site/kcworks/assets/semantic-ui/js/kcworks
-      #   run: npm install
+      - name: Install deps for frontend tests
+        working-directory: .
+        run: npm install
 
       # - name: Install deps for frontend tests - translations
       #   working-directory: ./translations/kcworks
       #   run: npm install
 
-      # - name: Run frontend tests
-      #   working-directory: ./site/kcworks/assets/semantic-ui/js/kcworks
-      #   run: npm test
+      - name: Run frontend tests
+        working-directory: .
+        run: |
+          chmod +x run-js-tests.sh
+          bash run-js-tests.sh

docs/source/setup/installation.md

@@ -20,14 +20,15 @@ Do not use the `--recurse-submodules` option when cloning the repository or the
 ### 2. Create your configuration files
 
 - `cd knowledge-commons-works`
-- Create and configure the `.env` file in this folder as described {ref}`here <in_depth:add and configure an environment file>`
+- Create and configure the `.env` file in this folder as described {ref}`here <setting-up-configuration-files>`
 - Create the `.invenio.private` file with the following contents:
 
 ```shell
 [cli]
 services_setup = True
 instance_path = /opt/invenio/var/instance
 ```
+
 ### 3. Start the docker-compose project
 
 - `docker-compose --file docker-compose.yml up -d`

jest.config.js

@@ -16,6 +16,7 @@ module.exports = {
     '^@translations/invenio_rdm_records/i18next$': '<rootDir>/site/kcworks/dependencies/invenio-rdm-records/invenio_rdm_records/assets/semantic-ui/translations/invenio_rdm_records/i18next.js',
     '^@custom-test-utils/(.*)$': '<rootDir>/tests/js/$1',
     '^@js/invenio_modular_deposit_form/(.*)$': '<rootDir>/site/kcworks/dependencies/invenio-modular-deposit-form/invenio_modular_deposit_form/assets/semantic-ui/js/invenio_modular_deposit_form/$1',
+    '^@translations/(.*)$': '<rootDir>/assets/translations/$1',
   },
   setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
   transform: {

run-tests.sh

@@ -47,8 +47,12 @@ if [[ ${keep_services} -eq 0 ]]; then
 	trap cleanup EXIT
 fi
 
-# python -m check_manifest --no-build-isolation
-python -m setup extract_messages --output-file /dev/null
+# Extract and compile translations from python files
+uv run invenio-cli translations extract
+uv run invenio-cli translations update
+uv run invenio-cli translations compile
+
+# Build the documentation
 uv run sphinx-build -b html docs/source/ docs/build/
 
 # Start the services and get their environment variables

site/kcworks/services/records/permissions.py

@@ -17,7 +17,6 @@
 from collections.abc import Sequence
 from functools import reduce
 
-from flask import current_app
 from invenio_access.permissions import Permission, system_identity
 from invenio_administration.generators import Administration
 from invenio_communities.generators import (
@@ -78,10 +77,11 @@ def per_field_edit_permission_factory(
             if isinstance(list(roles)[0], str):
                 try:
                     assert all(r in community_role_generators.keys() for r in roles)
-                except AssertionError:
-                    current_app.logger.error(
-                        f"Invalid roles: {roles}. Valid roles are: {community_role_generators.keys()}"
-                    )
+                except AssertionError as e:
+                    raise PermissionError(
+                        f"Invalid roles: {roles}. Valid roles "
+                        f"are: {community_role_generators.keys()}"
+                    ) from e
                 role_generators.extend(
                     [g for r, g in community_role_generators.items() if r in roles]
                 )

site/kcworks/services/records/record_communities/community_change_permissions_component.py

@@ -17,15 +17,10 @@
 
 from typing import Any
 
-from flask import current_app
 from flask_principal import Identity
 from invenio_access.permissions import system_identity
 from invenio_communities.errors import SetDefaultCommunityError
-from invenio_communities.proxies import current_communities
-from invenio_rdm_records.proxies import (
-    current_rdm_records,
-    current_rdm_records_service,
-)
+from invenio_rdm_records.proxies import current_rdm_records_service
 from invenio_rdm_records.records.api import RDMRecord
 from invenio_records_resources.services.errors import PermissionDeniedError
 from invenio_records_resources.services.records.components.base import ServiceComponent
@@ -199,33 +194,12 @@ def set_default(
             )
             if published_version._record.parent.communities.default:  # type: ignore
                 previous_default_id = (
-                    published_version._record.parent.communities.default.id  # type: ignore
+                    published_version._record.parent.communities.default.id
                 )
             else:
                 previous_default_id = None
 
             if previous_default_id != default_community_id:
-                handlers = (
-                    current_rdm_records.record_communities_resource.error_handlers.copy()
-                )
-                handlers.update(current_app.config.get("COMMUNITIES_ERROR_HANDLERS"))
-                current_rdm_records.record_communities_resource.error_handlers = (
-                    handlers
-                )
-                current_app.logger.info("COMMUNITIES_ERROR_HANDLERS")
-                current_app.logger.info(
-                    current_app.config.get("COMMUNITIES_ERROR_HANDLERS")
-                )
-                current_app.logger.info(
-                    current_rdm_records.record_communities_resource.error_handlers
-                )
-                current_community = current_communities.service.read(
-                    system_identity,
-                    id_=previous_default_id,
-                ).to_dict()
-                current_community_title = current_community.get("metadata", {}).get(
-                    "title", ""
-                ) or current_community.get("slug")
                 try:
                     self._check_default_community_permission(
                         identity,

site/kcworks/utils.py

@@ -192,7 +192,7 @@ def get_changed_fields(
             try:
                 existing_value = (
                     list(existing_data_val)[index]
-                    if isinstance(existing_data_val, (list, tuple, set))
+                    if isinstance(existing_data_val, list | tuple | set)
                     else None
                 )
             except IndexError:
@@ -246,7 +246,11 @@ def get_value_by_path(data: dict, path: str, separator: str = ".") -> Any:
     """
     path_segments = path.split(separator)
     return reduce(
-        lambda d, key: d.get(key) if isinstance(d, dict) else d[int(key)],
+        lambda d, key: (
+            d.get(key)
+            if isinstance(d, dict)
+            else (d[int(key)] if d is not None else None)
+        ),
         path_segments,
         data,
     )

tests/api/test_accounts.py

@@ -8,7 +8,6 @@
 import datetime
 import json
 from collections.abc import Callable
-from pprint import pformat
 from types import SimpleNamespace
 
 import pytest
@@ -189,8 +188,6 @@ def test_knowledgeCommons_account_get_user(
     case 2: The pre-existing KCWorks user has a different email as the IDP response
     case 3: The KCWorks user is already linked to an external ID
     """
-    app: Flask = running_app.app
-
     if not already_linked:
         u: AugmentedUserFixture = user_factory(
             email=original_email,

tests/api/test_per_field_edit_permissions.py

@@ -370,6 +370,9 @@ def test_per_field_permissions_update_draft(
                 ),
                 None,
             )
+            running_app.app.logger.info(f"match: {match}")
+            running_app.app.logger.info(f"error: {error}")
+            running_app.app.logger.info(f"updated_draft: {updated_draft.get('errors')}")
             assert match is not None
             assert match == error
 
@@ -412,31 +415,31 @@ def expected(self) -> dict:  # noqa: D102
             "changed": {},
             "errors": [
                 {
-                    "field": "access|embargo|reason",
+                    "field": "access.embargo.reason",
                     "messages": [
                         "You do not have permission to edit this field because the "
                         "record is included in the test-community community. Please "
                         "contact the community owner or manager for assistance."
                     ],
                 },
                 {
-                    "field": "access|embargo|active",
+                    "field": "access.embargo.active",
                     "messages": [
                         "You do not have permission to edit this field because the "
                         "record is included in the test-community community. Please "
                         "contact the community owner or manager for assistance."
                     ],
                 },
                 {
-                    "field": "access|files",
+                    "field": "access.files",
                     "messages": [
                         "You do not have permission to edit this field because the "
                         "record is included in the test-community community. Please "
                         "contact the community owner or manager for assistance."
                     ],
                 },
                 {
-                    "field": "access|embargo|until",
+                    "field": "access.embargo.until",
                     "messages": [
                         "You do not have permission to edit this field because the "
                         "record is included in the test-community community. Please "
@@ -486,7 +489,7 @@ def expected(self) -> dict:  # noqa: D102
             },
             "errors": [
                 {
-                    "field": "metadata|title",
+                    "field": "metadata.title",
                     "messages": [
                         "You do not have permission to edit this field "
                         "because the record is included in the test-community "
@@ -682,7 +685,7 @@ def expected(self) -> dict:  # noqa: D102
             },
             "errors": [
                 {
-                    "field": "metadata|funding|2|award|identifiers|0|identifier",
+                    "field": "metadata.funding.2.award.identifiers.0.identifier",
                     "messages": [
                         "You do not have permission to edit this field "
                         "because the record is included in the test-community "
@@ -691,7 +694,7 @@ def expected(self) -> dict:  # noqa: D102
                     ],
                 },
                 {
-                    "field": "metadata|funding|0|funder|id",
+                    "field": "metadata.funding.0.funder.id",
                     "messages": [
                         "You do not have permission to edit this field "
                         "because the record is included in the test-community "
@@ -909,7 +912,7 @@ def expected(self) -> dict:  # noqa: D102
                 {
                     "field": "parent.communities.default",
                     "message": (
-                        "You do not have permission to remove this collection: "
+                        "You do not have permission to remove this work from "
                         "XXXX. Please contact the collection owner or "
                         "manager for assistance."
                     ),
@@ -954,14 +957,14 @@ def test_remove_from_community(
             identity, id_=record.id, data={"communities": [{"id": community.id}]}
         )
         assert processed == [
-            {"community": p.replace("XXXX", community.title)}
+            {"community": p.replace("XXXX", community.id)}
             for p in self.expected["processed"]
         ]
         assert len(errors) == len(self.expected["errors"])
         if len(errors) > 0:
             assert errors[0]["message"] == self.expected["errors"][0][
                 "message"
-            ].replace("XXXX", community.title)
+            ].replace("XXXX", community.to_dict()["metadata"]["title"])
             assert errors[0]["field"] == self.expected["errors"][0]["field"]
 
         # Update result object