test(base-coverter): test functions of base converter

Author: a-parida12

.gitignore

@@ -130,4 +130,5 @@ dmypy.json
 
 # env 
 .pdf2dicom/
-.pdf2dcm
+.pdf2dcm
+*DS_Store*

pdf2dcm/__init__.py

@@ -1 +1,2 @@
-__version__ = "0.1.0"
+__version__ = "0.1.0"
+from .pdf2encaps import Pdf2EncapsDCM  # noqa

pdf2dcm/base.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 import pydicom
-from pydicom.dataset import Dataset, FileDataset
+from pydicom.dataset import FileMetaDataset, FileDataset
+from pydicom.errors import InvalidDicomError
 from abc import ABC, abstractmethod
 
 from .utils.uid import generate_random_uid
@@ -21,7 +22,9 @@ def __init__(self):
             "SOPInstanceUID",
         ]
 
-    def personalize_dcm(self, template_dcm_path: Path, pdf_dcm: Dataset) -> Dataset:
+    def personalize_dcm(
+        self, template_dcm_path: Path, pdf_dcm: FileDataset
+    ) -> FileDataset:
         template_dcm = pydicom.filereader(template_dcm_path)
 
         for field in self.repersonalisation_fields:
@@ -42,14 +45,14 @@ def personalize_dcm(self, template_dcm_path: Path, pdf_dcm: Dataset) -> Dataset:
         return pdf_dcm
 
     @staticmethod
-    def _get_dicom_meta() -> Dataset:
+    def _get_dicom_meta() -> FileMetaDataset:
         """Generates the file meta-data for a DICOM PDF
 
         Returns:
-            Dataset: dcm header with meta information
+            FileMetaDataset: dcm header with meta information
         """
 
-        file_meta = Dataset()
+        file_meta = FileMetaDataset()
         file_meta.FileMetaInformationVersion = b"\x00\x01"
         file_meta.TransferSyntaxUID = (
             "1.2.840.10008.1.2.1"  # std transfer uid little endian, implicit vr
@@ -58,11 +61,11 @@ def _get_dicom_meta() -> Dataset:
         return file_meta
 
     @staticmethod
-    def _get_dicom_body(meta: Dataset) -> FileDataset:
+    def _get_dicom_body(meta: FileMetaDataset) -> FileDataset:
         """Creates a temporary file as part of the DICOM PDF creation process
 
         Args:
-            meta (Dataset): the meta information of the dicom file
+            meta (FileMetaDataset): the meta information of the dicom file
 
         Returns:
             FileDataset: dicom file body information
@@ -99,7 +102,20 @@ def _store_ds(store_path: Path, ds: FileDataset) -> Path:
         return store_path
 
     @staticmethod
-    def check_valid_dcm(path: Path):
+    def check_valid_dcm(path: Path) -> bool:
+        """check whether given file is a dicom or not
+
+        Args:
+            path (Path): path to a dicom file
+
+        Returns:
+            bool: boolean value True for dicom else False
+        """
+        try:
+            pydicom.dcmread(path, defer_size=1024)
+        except InvalidDicomError:
+            return False
+
         return True
 
     @abstractmethod

pdf2dcm/pdf2encaps.py

@@ -2,12 +2,10 @@
 from .utils import uid
 from pathlib import Path
 import os
+from pydicom.dataset import FileMetaDataset, FileDataset
 
 
-from pydicom.dataset import Dataset, FileDataset
-
-
-class Pdf2EncapsPdf(BaseConverter):
+class Pdf2EncapsDCM(BaseConverter):
     def __init__(self):
         pass
 
@@ -18,7 +16,7 @@ def _get_encapspdf_meta(self) -> FileDataset:
         file_meta.ImplementationClassUID = uid.ENCAPS_PDF_IMPL_CLASS_UID
         return file_meta
 
-    def encapsulate_pdf(self, file_meta, pdf_file_path) -> Dataset:
+    def encapsulate_pdf(self, file_meta, pdf_file_path) -> FileMetaDataset:
         ds = self._get_dicom_body(file_meta)
         ds.SOPClassUID = uid.ENCAPS_PDF_MEDIA_SOP_CLASS_UID
 

tests/conftest.py

@@ -1,8 +1,15 @@
 # add root-dir to sys path for tests
 import sys
-
+import pytest
 from os.path import abspath
 from os.path import dirname as d
 
 parent_dir = f"{d(d(abspath(__file__)))}"
 sys.path.append(parent_dir)
+
+from pdf2dcm import Pdf2EncapsDCM  # noqa
+
+
+@pytest.fixture
+def baseconverter():
+    yield Pdf2EncapsDCM()

tests/test_01_base.py

@@ -0,0 +1,44 @@
+import pytest
+import os
+import pydicom
+from pydicom.dataset import FileMetaDataset, FileDataset
+
+
+@pytest.mark.base
+def test_01_1_get_dicom_meta(baseconverter):
+    ds = baseconverter._get_dicom_meta()
+    assert type(ds) == FileMetaDataset
+    assert ds.ImplementationVersionName == "pdf2dcm"
+
+
+@pytest.mark.base
+def test_01_2_get_dicom_body(baseconverter):
+    meta = FileMetaDataset()
+    ds = baseconverter._get_dicom_body(meta)
+
+    assert type(ds) == FileDataset
+    assert type(ds.ContentTime) == str
+    assert ds.Modality == "DOC"
+    assert ds.ConversionType == "WSD"
+
+
+@pytest.mark.base
+def test_01_3_check_dcm(baseconverter):
+    not_dicom_path = "tests/test_data/test_file.pdf"
+    dicom_path = "tests/test_data/CT_small.dcm"
+
+    assert type(baseconverter.check_valid_dcm(not_dicom_path)) == bool
+    assert not baseconverter.check_valid_dcm(not_dicom_path)
+    assert baseconverter.check_valid_dcm(dicom_path)
+
+
+def test_01_4_save_dcm(baseconverter):
+    dicom_path = "tests/test_data/CT_small.dcm"
+    ds = pydicom.dcmread(dicom_path, defer_size=1024)
+    out_dicom_path = "tests/test_data/test.dcm"
+    out_path = baseconverter._store_ds(out_dicom_path, ds)
+
+    assert out_path == out_dicom_path
+    assert os.path.exists(out_path)
+
+    os.remove(out_path)