Increase coverage (#289)

Author: viseshrp

src/ansys/dynamicreporting/core/common_utils.py

@@ -66,7 +66,7 @@ def get_install_info(
         if "CEIDEVROOTDOS" in os.environ:
             dirs_to_check.append(Path(os.environ["CEIDEVROOTDOS"]))
         # Common, default install locations
-        if platform.system().startswith("Wind"):
+        if platform.system().startswith("Wind"):  # pragma: no cover
             install_loc = Path(rf"C:\Program Files\ANSYS Inc\v{CURRENT_VERSION}\CEI")
         else:
             install_loc = Path(f"/ansys_inc/v{CURRENT_VERSION}/CEI")

src/ansys/dynamicreporting/core/serverless/__init__.py

@@ -1,13 +1,43 @@
 # serverless
 
-# Import ADR directly
 from .adr import ADR
 
-# Expose ADR immediately
-__all__ = ["ADR"]
+# Item-related imports
+from .item import HTML, Animation, Dataset, File, Image, Item, Scene, Session, String, Table, Tree
 
-# for organization and to avoid repeating the same class names in multiple places
-_item_classes = [
+# Template-related imports
+from .template import (
+    BasicLayout,
+    BoxLayout,
+    CarouselLayout,
+    DataFilterLayout,
+    FooterLayout,
+    HeaderLayout,
+    ItemsComparisonGenerator,
+    IteratorGenerator,
+    IteratorLayout,
+    PanelLayout,
+    PPTXLayout,
+    PPTXSlideLayout,
+    ReportLinkLayout,
+    SliderLayout,
+    SQLQueryGenerator,
+    StatisticalGenerator,
+    TabLayout,
+    TableMergeGenerator,
+    TableMergeRCFilterGenerator,
+    TableMergeValueFilterGenerator,
+    TableReduceGenerator,
+    TableSortFilterGenerator,
+    TagPropertyLayout,
+    Template,
+    TOCLayout,
+    TreeMergeGenerator,
+    UserDefinedLayout,
+)
+
+__all__ = [
+    "ADR",
     "Session",
     "Dataset",
     "Item",
@@ -19,8 +49,6 @@
     "Animation",
     "Scene",
     "File",
-]
-_template_classes = [
     "Template",
     "BasicLayout",
     "PanelLayout",
@@ -49,16 +77,3 @@
     "StatisticalGenerator",
     "IteratorGenerator",
 ]
-
-# Dynamically import classes from item and template using importlib
-import importlib
-
-item_module = importlib.import_module(".item", package=__package__)
-template_module = importlib.import_module(".template", package=__package__)
-
-# Dynamically add these to the module namespace and __all__
-for cls_name in _item_classes + _template_classes:
-    cls = getattr(item_module, cls_name, None) or getattr(template_module, cls_name, None)
-    if cls:
-        globals()[cls_name] = cls
-        __all__.append(cls_name)

src/ansys/dynamicreporting/core/serverless/adr.py

@@ -11,7 +11,7 @@
 import uuid
 import warnings
 
-from django.core import management
+from django.core.management import call_command
 from django.core.management.utils import get_random_secret_key
 from django.db import DatabaseError, connections
 from django.http import HttpRequest
@@ -290,7 +290,7 @@ def _check_dir(dir_):
     @staticmethod
     def _migrate_db(db):
         try:  # upgrade databases
-            management.call_command("migrate", "--no-input", "--database", db, "--verbosity", 0)
+            call_command("migrate", "--no-input", "--database", db, "--verbosity", 0)
         except Exception as e:
             raise DatabaseMigrationError(extra_detail=str(e))
         else:
@@ -308,14 +308,23 @@ def _migrate_db(db):
                     nexus_group.permissions.set(Permission.objects.all())
                 nexus_group.user_set.add(user)
 
+    @classmethod
+    def get_database_config(cls) -> dict | None:
+        """Get the database configuration."""
+        if not cls._is_setup:
+            return None
+        from django.conf import settings
+
+        return settings.DATABASES
+
     def _is_sqlite(self, database: str) -> bool:
-        return not self._in_memory and "sqlite" in self._databases.get(database, {}).get(
+        return not self._in_memory and "sqlite" in self.get_database_config().get(database, {}).get(
             "ENGINE", ""
         )
 
     def _get_db_path(self, database: str) -> str:
         if self._is_sqlite(database):
-            return self._databases.get(database, {}).get("NAME", "")
+            return self.get_database_config().get(database, {}).get("NAME", "")
         return ""
 
     @classmethod
@@ -485,6 +494,7 @@ def setup(self, collect_static: bool = False) -> None:
         # Check for Linux TZ issue
         report_utils.apply_timezone_workaround()
 
+        # django configuration
         try:
             from django.conf import settings
 
@@ -497,8 +507,9 @@ def setup(self, collect_static: bool = False) -> None:
             raise ImproperlyConfiguredError(extra_detail=str(e))
 
         # migrations
-        if self._databases:
-            for db in self._databases:
+        database_config = self.get_database_config()
+        if database_config:
+            for db in database_config:
                 self._migrate_db(db)
         elif self._db_directory is not None:
             self._migrate_db("default")
@@ -518,7 +529,7 @@ def setup(self, collect_static: bool = False) -> None:
                     "The 'static_directory' option must be specified to collect static files."
                 )
             try:
-                management.call_command("collectstatic", "--no-input", "--verbosity", 0)
+                call_command("collectstatic", "--no-input", "--verbosity", 0)
             except Exception as e:
                 raise StaticFilesCollectionError(extra_detail=str(e))
 
@@ -550,7 +561,7 @@ def backup_database(
     ) -> None:
         if self._in_memory:
             raise ADRException("Backup is not available in in-memory mode.")
-        if database != "default" and database not in self._databases:
+        if database != "default" and database not in self.get_database_config():
             raise ADRException(f"{database} must be configured first using the 'databases' option.")
         target_dir = Path(output_directory).resolve(strict=True)
         if not target_dir.is_dir():
@@ -572,19 +583,19 @@ def backup_database(
         if ignore_primary_keys:
             args.append("--natural-primary")
         try:
-            management.call_command(*args)
+            call_command(*args)
         except Exception as e:
             raise ADRException(f"Backup failed: {e}")
 
     def restore_database(self, input_file: str | Path, *, database: str = "default") -> None:
-        if database != "default" and database not in self._databases:
+        if database != "default" and database not in self.get_database_config():
             raise ADRException(f"{database} must be configured first using the 'databases' option.")
         backup_file = Path(input_file).resolve(strict=True)
         if not backup_file.is_file():
             raise InvalidPath(extra_detail=f"{input_file} is not a valid file.")
         # call django management command to load the database
         try:
-            management.call_command(
+            call_command(
                 "loaddata",
                 str(backup_file),
                 "--database",
@@ -724,7 +735,7 @@ def render_report(
                 request=self._request, context=context, item_filter=item_filter
             )
         except Exception as e:
-            raise e
+            raise ADRException(f"Report rendering failed: {e}")
 
     @staticmethod
     def query(
@@ -748,7 +759,7 @@ def create_objects(
             raise ADRException("objects must be an iterable")
         count = 0
         for obj in objects:
-            if obj.db and kwargs.get("using", "default") != obj.db:
+            if obj.db and kwargs.get("using", "default") != obj.db:  # pragma: no cover
                 # required if copying across databases
                 obj.reinit()
             obj.save(**kwargs)
@@ -784,7 +795,7 @@ def copy_objects(
         target_database: str,
         *,
         query: str = "",
-        target_media_dir: str = "",
+        target_media_dir: str | Path = "",
         test: bool = False,
     ) -> int:
         """
@@ -796,9 +807,12 @@ def copy_objects(
         source_database = "default"  # todo: allow for source database to be specified
 
         if not issubclass(object_type, (Item, Template, Session, Dataset)):
-            raise TypeError(f"{object_type} is not valid")
+            raise TypeError(
+                f"'{object_type.__name__}' is not a type of Item, Template, Session, or Dataset"
+            )
 
-        if target_database not in self._databases or source_database not in self._databases:
+        database_config = self.get_database_config()
+        if target_database not in database_config or source_database not in database_config:
             raise ADRException(
                 f"'{source_database}' and '{target_database}' must be configured first using the 'databases' option."
             )
@@ -812,7 +826,7 @@ def copy_objects(
                 # check for media dir if item has a physical file
                 if getattr(item, "has_file", False) and media_dir is None:
                     if target_media_dir:
-                        media_dir = target_media_dir
+                        media_dir = Path(target_media_dir).resolve(strict=True)
                     elif self._is_sqlite(target_database):
                         media_dir = self._check_dir(
                             Path(self._get_db_path(target_database)).parent / "media"

tests/serverless/conftest.py

@@ -13,13 +13,13 @@ def adr_init(pytestconfig: pytest.Config) -> ADR:
     use_local = pytestconfig.getoption("use_local_launcher")
 
     base_dir = Path(__file__).parent / "test_data"
-    local_db = base_dir / f"auto_delete_{uuid4().hex}"
     static_dir = base_dir / "static"
     static_dir.mkdir(exist_ok=True)
-    media_dir = base_dir / "media"
-    media_dir.mkdir(exist_ok=True)
 
     if use_local:
+        local_db = base_dir / f"auto_delete_{uuid4().hex}"
+        media_dir = base_dir / "media"
+        media_dir.mkdir(exist_ok=True)
         adr = ADR(
             ansys_installation=pytestconfig.getoption("install_path"),
             db_directory=local_db,
@@ -28,12 +28,33 @@ def adr_init(pytestconfig: pytest.Config) -> ADR:
             static_url="/static2/",
         )
     else:
+        # existing db directory
+        source_db = base_dir / "documentation_examples"
+        dest_db = base_dir / "dest"
+        database_config = {
+            "default": {
+                "ENGINE": "sqlite3",
+                "NAME": str(source_db / "db.sqlite3"),
+                "USER": "nexus",
+                "PASSWORD": "cei",
+                "HOST": "",
+                "PORT": "",
+            },
+            "dest": {
+                "ENGINE": "sqlite3",
+                "NAME": str(dest_db / "db.sqlite3"),
+                "USER": "nexus",
+                "PASSWORD": "cei",
+                "HOST": "",
+                "PORT": "",
+            },
+        }
         adr = ADR(
             ansys_installation="docker",
             docker_image=DOCKER_DEV_REPO_URL,
-            db_directory=local_db,
+            databases=database_config,
+            media_directory=source_db / "media",
             static_directory=static_dir,
-            media_directory=media_dir,
             media_url="/media1/",
             static_url="/static2/",
         )