PyHardLinkBackup 1.5.0__py3-none-any.whl

PyHardLinkBackup/utilities/tests/test_filesystem.py

@@ -0,0 +1,126 @@
+import hashlib
+import logging
+import os
+import tempfile
+from pathlib import Path
+from unittest.mock import patch
+
+from cli_base.cli_tools.test_utils.base_testcases import BaseTestCase
+
+from PyHardLinkBackup.constants import HASH_ALGO
+from PyHardLinkBackup.utilities.filesystem import (
+    copy_and_hash,
+    hash_file,
+    iter_scandir_files,
+    read_and_hash_file,
+    supports_hardlinks,
+)
+
+
+class TestHashFile(BaseTestCase):
+    maxDiff = None
+
+    def test_hash_file(self):
+        self.assertEqual(
+            hashlib.new(HASH_ALGO, b'test content').hexdigest(),
+            '6ae8a75555209fd6c44157c0aed8016e763ff435a19cf186f76863140143ff72',
+        )
+        with tempfile.NamedTemporaryFile() as temp:
+            temp_file_path = Path(temp.name)
+            temp_file_path.write_bytes(b'test content')
+
+            with self.assertLogs(level='INFO') as logs:
+                file_hash = hash_file(temp_file_path)
+        self.assertEqual(file_hash, '6ae8a75555209fd6c44157c0aed8016e763ff435a19cf186f76863140143ff72')
+        self.assertIn(' sha256 hash: 6ae8a7', ''.join(logs.output))
+
+    def test_copy_and_hash(self):
+        with tempfile.TemporaryDirectory() as temp:
+            temp_path = Path(temp)
+
+            src_path = temp_path / 'source.txt'
+            dst_path = temp_path / 'dest.txt'
+
+            src_path.write_bytes(b'test content')
+
+            with self.assertLogs(level='INFO') as logs:
+                file_hash = copy_and_hash(src=src_path, dst=dst_path)
+
+            self.assertEqual(dst_path.read_bytes(), b'test content')
+        self.assertEqual(file_hash, '6ae8a75555209fd6c44157c0aed8016e763ff435a19cf186f76863140143ff72')
+        self.assertIn(' backup to ', ''.join(logs.output))
+
+    def test_read_and_hash_file(self):
+        with tempfile.NamedTemporaryFile() as temp:
+            temp_file_path = Path(temp.name)
+            temp_file_path.write_bytes(b'test content')
+
+            with self.assertLogs(level='INFO') as logs:
+                content, file_hash = read_and_hash_file(temp_file_path)
+        self.assertEqual(content, b'test content')
+        self.assertEqual(file_hash, '6ae8a75555209fd6c44157c0aed8016e763ff435a19cf186f76863140143ff72')
+        self.assertIn(' sha256 hash: 6ae8a7', ''.join(logs.output))
+
+    def test_iter_scandir_files(self):
+        with tempfile.TemporaryDirectory() as temp:
+            temp_path = Path(temp)
+
+            (temp_path / 'file1.txt').write_bytes(b'content1')
+            (temp_path / 'file2.txt').write_bytes(b'content2')
+            subdir = temp_path / 'subdir'
+            subdir.mkdir()
+            (subdir / 'file3.txt').write_bytes(b'content3')
+
+            # Add a symlink to file1.txt
+            (temp_path / 'symlink_to_file1.txt').symlink_to(temp_path / 'file1.txt')
+
+            # Add a hardlink to file2.txt
+            os.link(temp_path / 'file2.txt', temp_path / 'hardlink_to_file2.txt')
+
+            exclude_subdir = temp_path / '__pycache__'
+            exclude_subdir.mkdir()
+            (exclude_subdir / 'BAM.txt').write_bytes(b'foobar')
+
+            broken_symlink_path = temp_path / 'broken_symlink'
+            broken_symlink_path.symlink_to(temp_path / 'not/existing/file.txt')
+
+            with self.assertLogs(level='DEBUG') as logs:
+                files = list(iter_scandir_files(temp_path, excludes={'__pycache__'}))
+
+        file_names = sorted([Path(f.path).relative_to(temp_path).as_posix() for f in files])
+
+        self.assertEqual(
+            file_names,
+            [
+                'broken_symlink',
+                'file1.txt',
+                'file2.txt',
+                'hardlink_to_file2.txt',
+                'subdir/file3.txt',
+                'symlink_to_file1.txt',
+            ],
+        )
+        logs = ''.join(logs.output)
+        self.assertIn('Scanning directory ', logs)
+        self.assertIn('Excluding directory ', logs)
+
+    def test_supports_hardlinks(self):
+        with tempfile.TemporaryDirectory() as temp:
+            with self.assertLogs(level=logging.INFO) as logs:
+                self.assertTrue(supports_hardlinks(Path(temp)))
+            self.assertEqual(
+                ''.join(logs.output),
+                f'INFO:PyHardLinkBackup.utilities.filesystem:Hardlink support in {temp}: True',
+            )
+
+            with (
+                self.assertLogs(level=logging.ERROR) as logs,
+                patch('PyHardLinkBackup.utilities.filesystem.os.link', side_effect=OSError),
+            ):
+                self.assertFalse(supports_hardlinks(Path(temp)))
+            logs = ''.join(logs.output)
+            self.assertIn(f'Hardlink test failed in {temp}:', logs)
+            self.assertIn('OSError', logs)
+
+        with self.assertLogs(level=logging.DEBUG), self.assertRaises(NotADirectoryError):
+            supports_hardlinks(Path('/not/existing/directory'))

PyHardLinkBackup/utilities/tyro_cli_shared_args.py

@@ -0,0 +1,12 @@
+from typing import Annotated
+
+import tyro
+
+
+TyroExcludeDirectoriesArgType = Annotated[
+    tuple[str, ...],
+    tyro.conf.arg(
+        help='List of directories to exclude from backup.',
+    ),
+]
+DEFAULT_EXCLUDE_DIRECTORIES = ('__pycache__', '.cache', '.temp', '.tmp', '.tox', '.nox')