core-parser-app 2.8.0__tar.gz → 2.9.0__tar.gz

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: core_parser_app
-Version: 2.8.0
+Version: 2.9.0
 Summary: XSD parser tools for the curator core project
 Home-page: https://github.com/usnistgov/core_parser_app
 Author: NIST IT Lab

core_parser_app-2.9.0/core_parser_app/management/commands/loadmodules.py

@@ -0,0 +1,25 @@
+"""Load modules command
+"""
+from django.core.management.base import BaseCommand
+from django.urls import get_resolver
+
+from core_parser_app.tools.modules.discover import reload_modules
+
+
+class Command(BaseCommand):
+    help = "Reload modules from list of urls"
+
+    def handle(self, *args, **options):
+        """handle
+
+        Args:
+            *args:
+            **options:
+
+        Returns:
+
+        """
+        reload_modules(get_resolver().url_patterns)
+        self.stdout.write(
+            self.style.SUCCESS("Modules were reloaded in database.")
+        )

core_parser_app-2.9.0/core_parser_app/tools/modules/discover.py

@@ -0,0 +1,101 @@
+"""Auto discovery of modules
+"""
+import logging
+
+from django.db import IntegrityError
+from django.urls import URLPattern, URLResolver
+
+from core_main_app.commons.exceptions import ModelError
+from core_parser_app.components.module import api as module_api
+from core_parser_app.components.module.models import Module
+from core_parser_app.tools.modules.exceptions import ModuleError
+from core_parser_app.tools.modules.views.module import AbstractModule
+
+logger = logging.getLogger(__name__)
+
+
+def reload_modules(urls):
+    """Reload modules in database
+
+    :return:
+    """
+    logger.info("START discover modules.")
+
+    try:
+        # Remove all existing modules
+        module_api.delete_all()
+    except Exception as exc:
+        logger.warning(str(exc))
+        return
+
+    # Look for modules in project urls
+    try:
+        for url in urls:
+            if isinstance(url, URLPattern):
+                _save_module(url)
+            elif isinstance(url, URLResolver):
+                for url_pattern in url.url_patterns:
+                    _save_module(url_pattern)
+    except ModelError:
+        # something went wrong, delete already added modules
+        error_msg = (
+            "A validation error occurred during the module discovery. "
+            "Please provide a name to all modules urls using the name argument."
+        )
+
+        logger.error(
+            "Discover modules failed with error %s. All modules will be deleted.",
+            error_msg,
+        )
+        module_api.delete_all()
+        raise ModuleError(error_msg)
+    except Exception as exception:
+        # something went wrong, delete already added modules
+        logger.error(
+            "Discover modules failed with error %s. All modules will be deleted.",
+            str(exception),
+        )
+        module_api.delete_all()
+        raise exception
+
+    logger.info("FINISH discover modules.")
+
+
+def _save_module(url_pattern):
+    """Save module from a URL pattern
+
+    Args:
+        url_pattern:
+
+    Returns:
+
+    """
+    module_view_name = _get_module_view_name_from_url(url_pattern)
+    if module_view_name.startswith("core_module_"):
+        module_view = AbstractModule.get_view_from_view_path(module_view_name)
+        if issubclass(module_view, AbstractModule):
+            module_object = Module(
+                url=url_pattern.pattern.regex.pattern,
+                name=url_pattern.name,
+                view=module_view_name,
+                multiple=module_view.is_managing_occurrences,
+            )
+            try:
+                module_api.upsert(module_object)
+            except IntegrityError:
+                logger.info(
+                    "The module %s is already present in the database.",
+                    url_pattern.name,
+                )
+
+
+def _get_module_view_name_from_url(url_pattern):
+    """
+
+    Args:
+        url_pattern:
+
+    Returns:
+
+    """
+    return url_pattern.lookup_str if hasattr(url_pattern, "lookup_str") else ""

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/core_parser_app/tools/modules/views/module.py

@@ -247,7 +247,6 @@ class AbstractModule(View, metaclass=ABCMeta):
         :param view:
         :return:
         """
-        # module = module_api.get_by_url(url)
         pkglist = view.split(".")
 
         pkgs = ".".join(pkglist[:-1])

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/core_parser_app/tools/parser/static/core_parser_app/js/buttons.js

@@ -60,7 +60,7 @@
                 // If new modules are included, we need to load the resources
                 initModules();
 
-                console.log("Element " + elementId + " successfully created");
+                console.log("Element " + elementId + " created");
             },
             error: function() {
                 console.error("An error occurred while generating a new element.");
@@ -109,7 +109,7 @@
                 }
 
                 $element.remove();
-                console.log("Element " + elementId + " successfully removed");
+                console.log("Element " + elementId + " removed");
             },
             error: function() {
                 console.error("An error occurred while generating a new element.");

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/core_parser_app.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: core-parser-app
-Version: 2.8.0
+Version: 2.9.0
 Summary: XSD parser tools for the curator core project
 Home-page: https://github.com/usnistgov/core_parser_app
 Author: NIST IT Lab

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/core_parser_app.egg-info/SOURCES.txt

@@ -29,6 +29,9 @@ core_parser_app/components/module/__init__.py
 core_parser_app/components/module/admin_site.py
 core_parser_app/components/module/api.py
 core_parser_app/components/module/models.py
+core_parser_app/management/__init__.py
+core_parser_app/management/commands/__init__.py
+core_parser_app/management/commands/loadmodules.py
 core_parser_app/migrations/0001_initial.py
 core_parser_app/migrations/__init__.py
 core_parser_app/static/core_parser_app/common/css/modules.css
@@ -141,6 +144,8 @@ tests/test_settings.py
 tests/test_utils.py
 tests/access_control/__init__.py
 tests/access_control/test_unit.py
+tests/commands/__init__.py
+tests/commands/tests_unit.py
 tests/components/__init__.py
 tests/components/data_structure/__init__.py
 tests/components/data_structure/tests_int.py
@@ -153,6 +158,8 @@ tests/components/data_structure_element/fixtures/__init__.py
 tests/components/data_structure_element/fixtures/fixtures.py
 tests/components/module/__init__.py
 tests/components/module/tests_unit.py
+tests/discover/__init__.py
+tests/discover/tests_unit.py
 tests/tools/__init__.py
 tests/tools/modules/__init__.py
 tests/tools/modules/tests/__init__.py

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/core_parser_app.egg-info/requires.txt

@@ -2,4 +2,4 @@ celery
 Django
 djangorestframework
 lxml==4.9.*
-core-main-app==2.8.*
+core-main-app==2.9.*

core_parser_app-2.9.0/requirements.core.txt

@@ -0,0 +1 @@
+core-main-app==2.9.*

{core_parser_app-2.8.0 → core_parser_app-2.9.0}/setup.py

@@ -41,7 +41,7 @@ required = [req_link(r) if r.startswith("https://") else r for r in required]
 
 setup(
     name="core_parser_app",
-    version="2.8.0",
+    version="2.9.0",
     description="XSD parser tools for the curator core project",
     long_description=long_desc,
     author="NIST IT Lab",

core_parser_app-2.9.0/tests/commands/tests_unit.py

@@ -0,0 +1,15 @@
+"""Module command unit testing
+"""
+from io import StringIO
+from unittest.case import TestCase
+
+from django.core.management import call_command
+
+
+class TestLoadModulesCommand(TestCase):
+    """Test Load Modules command"""
+
+    def test_command_output(self):
+        out = StringIO()
+        call_command("loadmodules", stdout=out)
+        self.assertIn("Modules were reloaded in database.", out.getvalue())

core_parser_app-2.9.0/tests/discover/tests_unit.py

@@ -0,0 +1,128 @@
+"""Module discover unit testing
+"""
+from unittest.case import TestCase
+from unittest.mock import patch
+
+from django.db import IntegrityError
+from django.urls import re_path
+
+from core_main_app.commons.exceptions import ModelError
+from core_parser_app.tools.modules.discover import reload_modules
+from core_parser_app.tools.modules.exceptions import ModuleError
+from core_parser_app.tools.modules.views.module import AbstractModule
+
+
+class TestDiscoverModules(TestCase):
+    """Test Discover Modules"""
+
+    @patch("core_parser_app.components.module.api.delete_all")
+    def test_discover_modules_stops_if_an_error_occurs_when_deleting_modules(
+        self, mock_delete_all
+    ):
+        """test_discover_modules_stops_if_an_error_occurs_when_deleting_modules
+
+        Returns:
+
+        """
+        mock_delete_all.side_effect = Exception()
+        reload_modules([])
+        self.assertTrue(mock_delete_all.called)
+
+    @patch(
+        "core_parser_app.tools.modules.views.module.AbstractModule.get_view_from_view_path"
+    )
+    @patch(
+        "core_parser_app.tools.modules.discover._get_module_view_name_from_url"
+    )
+    @patch("core_parser_app.components.module.api.delete_all")
+    @patch("core_parser_app.components.module.api.upsert")
+    def test_discover_modules_deletes_modules_if_model_errors(
+        self,
+        mock_upsert,
+        mock_delete_all,
+        mock_get_module_view_name_from_url,
+        mock_get_view_from_view_path,
+    ):
+        """test_discover_modules_deletes_modules_if_model_errors
+
+        Returns:
+
+        """
+        mock_upsert.side_effect = ModelError("error")
+        mock_get_module_view_name_from_url.return_value = "core_module_test"
+        mock_get_view_from_view_path.return_value = ModuleTest
+        with self.assertRaises(ModuleError):
+            reload_modules(
+                [re_path("module-test", ModuleTest, name="core_module_test")]
+            )
+        self.assertEqual(mock_delete_all.call_count, 2)
+
+    @patch(
+        "core_parser_app.tools.modules.views.module.AbstractModule.get_view_from_view_path"
+    )
+    @patch(
+        "core_parser_app.tools.modules.discover._get_module_view_name_from_url"
+    )
+    @patch("core_parser_app.components.module.api.delete_all")
+    @patch("core_parser_app.components.module.api.upsert")
+    def test_discover_modules_deletes_modules_if_exception(
+        self,
+        mock_upsert,
+        mock_delete_all,
+        mock_get_module_view_name_from_url,
+        mock_get_view_from_view_path,
+    ):
+        """test_discover_modules_deletes_modules_if_exception
+
+        Returns:
+
+        """
+        mock_upsert.side_effect = Exception("error")
+        mock_get_module_view_name_from_url.return_value = "core_module_test"
+        mock_get_view_from_view_path.return_value = ModuleTest
+        with self.assertRaises(Exception):
+            reload_modules(
+                [re_path("module-test", ModuleTest, name="core_module_test")]
+            )
+        self.assertEqual(mock_delete_all.call_count, 2)
+
+    @patch(
+        "core_parser_app.tools.modules.views.module.AbstractModule.get_view_from_view_path"
+    )
+    @patch(
+        "core_parser_app.tools.modules.discover._get_module_view_name_from_url"
+    )
+    @patch("core_parser_app.components.module.api.delete_all")
+    @patch("core_parser_app.components.module.api.upsert")
+    def test_discover_continues_if_integrity_error(
+        self,
+        mock_upsert,
+        mock_delete_all,
+        mock_get_module_view_name_from_url,
+        mock_get_view_from_view_path,
+    ):
+        """test_discover_modules_deletes_modules_if_integrity_error
+
+        Returns:
+
+        """
+        mock_upsert.side_effect = IntegrityError("error")
+        mock_get_module_view_name_from_url.return_value = "core_module_test"
+        mock_get_view_from_view_path.return_value = ModuleTest
+        reload_modules(
+            [re_path("module-test", ModuleTest, name="core_module_test")]
+        )
+        self.assertEqual(mock_delete_all.call_count, 1)
+
+
+class ModuleTest(AbstractModule):
+    """ModuleTest"""
+
+    def _render_module(self, request):
+        pass
+
+    def _retrieve_data(self, request):
+        pass
+
+    def _render_data(self, request):
+        pass

core_parser_app-2.8.0/core_parser_app/tools/modules/discover.py

@@ -1,77 +0,0 @@
-"""Auto discovery of modules
-"""
-import logging
-
-from django.db import IntegrityError
-
-from core_main_app.commons.exceptions import ModelError
-from core_parser_app.components.module import api as module_api
-from core_parser_app.components.module.models import Module
-from core_parser_app.tools.modules.exceptions import ModuleError
-from core_parser_app.tools.modules.views.module import AbstractModule
-
-logger = logging.getLogger(__name__)
-
-
-def discover_modules(urls):
-    """
-
-    :return:
-    """
-    logger.info("START discover modules.")
-
-    try:
-        # Remove all existing modules
-        module_api.delete_all()
-    except Exception:
-        logger.warning("Module table is not ready yet")
-        return
-
-    # Look for modules in project urls
-    try:
-        for url in urls:
-            if hasattr(url, "url_patterns"):
-                for url_pattern in url.url_patterns:
-                    module_view_name = (
-                        url_pattern.lookup_str
-                        if hasattr(url_pattern, "lookup_str")
-                        else ""
-                    )
-                    if module_view_name.startswith("core_module_"):
-                        module_view = AbstractModule.get_view_from_view_path(
-                            module_view_name
-                        )
-                        if issubclass(module_view, AbstractModule):
-                            # FIXME: do not use private field
-                            module_object = Module(
-                                url=url_pattern.pattern._regex,
-                                name=url_pattern.name,
-                                view=module_view_name,
-                                multiple=module_view.is_managing_occurrences,
-                            )
-                            try:
-                                module_api.upsert(module_object)
-                            except IntegrityError:
-                                logger.info(
-                                    "The module %s is already present in the database.",
-                                    url_pattern.name,
-                                )
-    except ModelError:
-        # something went wrong, delete already added modules
-        module_api.delete_all()
-
-        error_msg = (
-            "A validation error occurred during the module discovery. "
-            "Please provide a name to all modules urls using the name argument."
-        )
-
-        logger.error("Discover modules failed with %s.", error_msg)
-
-        raise ModuleError(error_msg)
-    except Exception as exception:
-        # something went wrong, delete already added modules
-        module_api.delete_all()
-        logger.error("Discover modules failed with %s.", str(exception))
-        raise exception
-
-    logger.info("FINISH discover modules.")

core_parser_app-2.8.0/requirements.core.txt

@@ -1 +0,0 @@
-core-main-app==2.8.*