Add function to check str path and return file path

Author: ddalu5

pyntegrity/core.py

@@ -15,13 +15,23 @@
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
+import os
 import re
+import enum
+from pathlib import Path
 
+from .exceptions import FileNotFoundException
+from .exceptions import ObjectNotAFileException
 from .exceptions import HashStrNotValidException
+from .exceptions import MissingFilePermissionException
 from .exceptions import HashAlgorithmNotSupportedException
 
 from .config import SUPPORTED_HASH_ALGOS
 
+HashAlgoEnum = enum.Enum(
+    "HashAlgoEnum", {key: key for key in SUPPORTED_HASH_ALGOS.keys()}
+)
+
 
 def detect_hash_algo(checksum_str: str):
     """
@@ -58,3 +68,35 @@ def validate_checksum_str(checksum_str: str):
         raise HashStrNotValidException(
             detected_hash_algo=hash_name, checksum_str=checksum_str
         )
+
+
+def get_file_path_from_str(str_path: str):
+    """
+    Checks if path is a file and there is read access to it then return a Path object
+
+    :param str_path: provided file path
+    :return: file path
+    :rtype: Path
+    """
+    path_object = Path(str_path)
+    if path_object.is_file():
+        path_object = path_object.resolve()
+        if os.access(path_object, os.R_OK):
+            return path_object
+        else:
+            raise MissingFilePermissionException(file_path=str_path)
+    elif not path_object.exists():
+        raise FileNotFoundException(file_path=str_path)
+    else:
+        raise ObjectNotAFileException(file_path=str_path)
+
+
+class IntegrityValidator:
+    def __init__(self, str_path: str):
+        self.file = get_file_path_from_str(str_path)
+
+    def validate_file_integrity(self):
+        pass
+
+    def get_file_checksum(self):
+        pass

pyntegrity/exceptions.py

@@ -57,3 +57,39 @@ def __init__(self, detected_hash_algo: str, checksum_str: str):
             f'seem valid for the detected algorithm"{detected_hash_algo}"'
         )
         super().__init__(self.message)
+
+
+class FileNotFoundException(Exception):
+    def __init__(self, file_path: str):
+        """
+        Exception raised when the file isn't found using the provided path;
+
+        :param file_path: provided file path
+        """
+        self.file_path = file_path
+        self.message = f'[!] file "{file_path}" not found!'
+        super().__init__(self.message)
+
+
+class ObjectNotAFileException(Exception):
+    def __init__(self, file_path: str):
+        """
+        Exception raised when the provided path isn't a file;
+
+        :param file_path: provided file path
+        """
+        self.file_path = file_path
+        self.message = f'[!] the "{file_path}" is not a valid file!'
+        super().__init__(self.message)
+
+
+class MissingFilePermissionException(Exception):
+    def __init__(self, file_path: str):
+        """
+        Exception raised when the process can't read the file;
+
+        :param file_path: provided file path
+        """
+        self.file_path = file_path
+        self.message = f'[!] the program can not read the file "{file_path}" !'
+        super().__init__(self.message)

tests/data/test_file.dat

@@ -0,0 +1 @@
+


tests/data/test_file.txt

@@ -0,0 +1 @@
+Just a test file

tests/test_core.py

@@ -1,8 +1,12 @@
+from pathlib import Path
 from unittest import TestCase
 
 from pyntegrity.core import detect_hash_algo
+from pyntegrity.core import get_file_path_from_str
 from pyntegrity.core import validate_checksum_str
 
+from pyntegrity.exceptions import FileNotFoundException
+from pyntegrity.exceptions import ObjectNotAFileException
 from pyntegrity.exceptions import HashStrNotValidException
 from pyntegrity.exceptions import HashAlgorithmNotSupportedException
 
@@ -44,3 +48,17 @@ def test_validate_checksum_str_sha256_nok(self):
         )
         with self.assertRaises(HashStrNotValidException):
             validate_checksum_str(invalid_sha256)
+
+
+class TestGetFileFromStr(TestCase):
+    def test_get_file_path_from_str_ok(self):
+        obj = get_file_path_from_str("tests/data/test_file.txt")
+        self.assertTrue(isinstance(obj, Path))
+
+    def test_get_file_path_from_str_nok_is_not_file(self):
+        with self.assertRaises(ObjectNotAFileException):
+            get_file_path_from_str("tests/data/")
+
+    def test_get_file_path_from_str_nok_not_found(self):
+        with self.assertRaises(FileNotFoundException):
+            get_file_path_from_str("tests/data/doesnt_exists.csv")