mirror of
https://github.com/python/cpython.git
synced 2025-08-31 05:58:33 +00:00
gh-57141: Add dircmp shallow option (GH-109499)
Co-authored-by: Steve Ward <planet36@gmail.com> Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
This commit is contained in:
Tobias Rautenkranz
GitHub
parent
ea1b1c579f
commit
60743a9a7e
4 changed files with 120 additions and 31 deletions
|
|
@ -8,11 +8,24 @@ from test import support
|
|||
from test.support import os_helper
|
||||
|
||||
|
||||
def _create_file_shallow_equal(template_path, new_path):
|
||||
"""create a file with the same size and mtime but different content."""
|
||||
shutil.copy2(template_path, new_path)
|
||||
with open(new_path, 'r+b') as f:
|
||||
next_char = bytearray(f.read(1))
|
||||
next_char[0] = (next_char[0] + 1) % 256
|
||||
f.seek(0)
|
||||
f.write(next_char)
|
||||
shutil.copystat(template_path, new_path)
|
||||
assert os.stat(new_path).st_size == os.stat(template_path).st_size
|
||||
assert os.stat(new_path).st_mtime == os.stat(template_path).st_mtime
|
||||
|
||||
class FileCompareTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.name = os_helper.TESTFN
|
||||
self.name_same = os_helper.TESTFN + '-same'
|
||||
self.name_diff = os_helper.TESTFN + '-diff'
|
||||
self.name_same_shallow = os_helper.TESTFN + '-same-shallow'
|
||||
data = 'Contents of file go here.\n'
|
||||
for name in [self.name, self.name_same, self.name_diff]:
|
||||
with open(name, 'w', encoding="utf-8") as output:
|
||||
|
|
@ -20,12 +33,19 @@ class FileCompareTestCase(unittest.TestCase):
|
|||
|
||||
with open(self.name_diff, 'a+', encoding="utf-8") as output:
|
||||
output.write('An extra line.\n')
|
||||
|
||||
for name in [self.name_same, self.name_diff]:
|
||||
shutil.copystat(self.name, name)
|
||||
|
||||
_create_file_shallow_equal(self.name, self.name_same_shallow)
|
||||
|
||||
self.dir = tempfile.gettempdir()
|
||||
|
||||
def tearDown(self):
|
||||
os.unlink(self.name)
|
||||
os.unlink(self.name_same)
|
||||
os.unlink(self.name_diff)
|
||||
os.unlink(self.name_same_shallow)
|
||||
|
||||
def test_matching(self):
|
||||
self.assertTrue(filecmp.cmp(self.name, self.name),
|
||||
|
|
@ -36,12 +56,17 @@ class FileCompareTestCase(unittest.TestCase):
|
|||
"Comparing file to identical file fails")
|
||||
self.assertTrue(filecmp.cmp(self.name, self.name_same, shallow=False),
|
||||
"Comparing file to identical file fails")
|
||||
self.assertTrue(filecmp.cmp(self.name, self.name_same_shallow),
|
||||
"Shallow identical files should be considered equal")
|
||||
|
||||
def test_different(self):
|
||||
self.assertFalse(filecmp.cmp(self.name, self.name_diff),
|
||||
"Mismatched files compare as equal")
|
||||
self.assertFalse(filecmp.cmp(self.name, self.dir),
|
||||
"File and directory compare as equal")
|
||||
self.assertFalse(filecmp.cmp(self.name, self.name_same_shallow,
|
||||
shallow=False),
|
||||
"Mismatched file to shallow identical file compares as equal")
|
||||
|
||||
def test_cache_clear(self):
|
||||
first_compare = filecmp.cmp(self.name, self.name_same, shallow=False)
|
||||
|
|
@ -56,6 +81,8 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
self.dir = os.path.join(tmpdir, 'dir')
|
||||
self.dir_same = os.path.join(tmpdir, 'dir-same')
|
||||
self.dir_diff = os.path.join(tmpdir, 'dir-diff')
|
||||
self.dir_diff_file = os.path.join(tmpdir, 'dir-diff-file')
|
||||
self.dir_same_shallow = os.path.join(tmpdir, 'dir-same-shallow')
|
||||
|
||||
# Another dir is created under dir_same, but it has a name from the
|
||||
# ignored list so it should not affect testing results.
|
||||
|
|
@ -63,7 +90,17 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
|
||||
self.caseinsensitive = os.path.normcase('A') == os.path.normcase('a')
|
||||
data = 'Contents of file go here.\n'
|
||||
for dir in (self.dir, self.dir_same, self.dir_diff, self.dir_ignored):
|
||||
|
||||
shutil.rmtree(self.dir, True)
|
||||
os.mkdir(self.dir)
|
||||
subdir_path = os.path.join(self.dir, 'subdir')
|
||||
os.mkdir(subdir_path)
|
||||
dir_file_path = os.path.join(self.dir, "file")
|
||||
with open(dir_file_path, 'w', encoding="utf-8") as output:
|
||||
output.write(data)
|
||||
|
||||
for dir in (self.dir_same, self.dir_same_shallow,
|
||||
self.dir_diff, self.dir_diff_file):
|
||||
shutil.rmtree(dir, True)
|
||||
os.mkdir(dir)
|
||||
subdir_path = os.path.join(dir, 'subdir')
|
||||
|
|
@ -72,14 +109,25 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
fn = 'FiLe' # Verify case-insensitive comparison
|
||||
else:
|
||||
fn = 'file'
|
||||
with open(os.path.join(dir, fn), 'w', encoding="utf-8") as output:
|
||||
output.write(data)
|
||||
|
||||
file_path = os.path.join(dir, fn)
|
||||
|
||||
if dir is self.dir_same_shallow:
|
||||
_create_file_shallow_equal(dir_file_path, file_path)
|
||||
else:
|
||||
shutil.copy2(dir_file_path, file_path)
|
||||
|
||||
with open(os.path.join(self.dir_diff, 'file2'), 'w', encoding="utf-8") as output:
|
||||
output.write('An extra file.\n')
|
||||
|
||||
# Add different file2 with respect to dir_diff
|
||||
with open(os.path.join(self.dir_diff_file, 'file2'), 'w', encoding="utf-8") as output:
|
||||
output.write('Different contents.\n')
|
||||
|
||||
|
||||
def tearDown(self):
|
||||
for dir in (self.dir, self.dir_same, self.dir_diff):
|
||||
for dir in (self.dir, self.dir_same, self.dir_diff,
|
||||
self.dir_same_shallow, self.dir_diff_file):
|
||||
shutil.rmtree(dir)
|
||||
|
||||
def test_default_ignores(self):
|
||||
|
|
@ -102,11 +150,7 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
shallow=False),
|
||||
"Comparing directory to same fails")
|
||||
|
||||
# Add different file2
|
||||
with open(os.path.join(self.dir, 'file2'), 'w', encoding="utf-8") as output:
|
||||
output.write('Different contents.\n')
|
||||
|
||||
self.assertFalse(filecmp.cmpfiles(self.dir, self.dir_same,
|
||||
self.assertFalse(filecmp.cmpfiles(self.dir, self.dir_diff_file,
|
||||
['file', 'file2']) ==
|
||||
(['file'], ['file2'], []),
|
||||
"Comparing mismatched directories fails")
|
||||
|
|
@ -116,11 +160,22 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
"""Assert that two lists are equal, up to ordering."""
|
||||
self.assertEqual(sorted(actual), sorted(expected))
|
||||
|
||||
def test_dircmp_identical_directories(self):
|
||||
self._assert_dircmp_identical_directories()
|
||||
self._assert_dircmp_identical_directories(shallow=False)
|
||||
|
||||
def test_dircmp(self):
|
||||
def test_dircmp_different_file(self):
|
||||
self._assert_dircmp_different_file()
|
||||
self._assert_dircmp_different_file(shallow=False)
|
||||
|
||||
def test_dircmp_different_directories(self):
|
||||
self._assert_dircmp_different_directories()
|
||||
self._assert_dircmp_different_directories(shallow=False)
|
||||
|
||||
def _assert_dircmp_identical_directories(self, **options):
|
||||
# Check attributes for comparison of two identical directories
|
||||
left_dir, right_dir = self.dir, self.dir_same
|
||||
d = filecmp.dircmp(left_dir, right_dir)
|
||||
d = filecmp.dircmp(left_dir, right_dir, **options)
|
||||
self.assertEqual(d.left, left_dir)
|
||||
self.assertEqual(d.right, right_dir)
|
||||
if self.caseinsensitive:
|
||||
|
|
@ -142,9 +197,10 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
]
|
||||
self._assert_report(d.report, expected_report)
|
||||
|
||||
def _assert_dircmp_different_directories(self, **options):
|
||||
# Check attributes for comparison of two different directories (right)
|
||||
left_dir, right_dir = self.dir, self.dir_diff
|
||||
d = filecmp.dircmp(left_dir, right_dir)
|
||||
d = filecmp.dircmp(left_dir, right_dir, **options)
|
||||
self.assertEqual(d.left, left_dir)
|
||||
self.assertEqual(d.right, right_dir)
|
||||
self._assert_lists(d.left_list, ['file', 'subdir'])
|
||||
|
|
@ -164,12 +220,8 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
self._assert_report(d.report, expected_report)
|
||||
|
||||
# Check attributes for comparison of two different directories (left)
|
||||
left_dir, right_dir = self.dir, self.dir_diff
|
||||
shutil.move(
|
||||
os.path.join(self.dir_diff, 'file2'),
|
||||
os.path.join(self.dir, 'file2')
|
||||
)
|
||||
d = filecmp.dircmp(left_dir, right_dir)
|
||||
left_dir, right_dir = self.dir_diff, self.dir
|
||||
d = filecmp.dircmp(left_dir, right_dir, **options)
|
||||
self.assertEqual(d.left, left_dir)
|
||||
self.assertEqual(d.right, right_dir)
|
||||
self._assert_lists(d.left_list, ['file', 'file2', 'subdir'])
|
||||
|
|
@ -180,27 +232,51 @@ class DirCompareTestCase(unittest.TestCase):
|
|||
self.assertEqual(d.same_files, ['file'])
|
||||
self.assertEqual(d.diff_files, [])
|
||||
expected_report = [
|
||||
"diff {} {}".format(self.dir, self.dir_diff),
|
||||
"Only in {} : ['file2']".format(self.dir),
|
||||
"diff {} {}".format(self.dir_diff, self.dir),
|
||||
"Only in {} : ['file2']".format(self.dir_diff),
|
||||
"Identical files : ['file']",
|
||||
"Common subdirectories : ['subdir']",
|
||||
]
|
||||
self._assert_report(d.report, expected_report)
|
||||
|
||||
# Add different file2
|
||||
with open(os.path.join(self.dir_diff, 'file2'), 'w', encoding="utf-8") as output:
|
||||
output.write('Different contents.\n')
|
||||
d = filecmp.dircmp(self.dir, self.dir_diff)
|
||||
|
||||
def _assert_dircmp_different_file(self, **options):
|
||||
# A different file2
|
||||
d = filecmp.dircmp(self.dir_diff, self.dir_diff_file, **options)
|
||||
self.assertEqual(d.same_files, ['file'])
|
||||
self.assertEqual(d.diff_files, ['file2'])
|
||||
expected_report = [
|
||||
"diff {} {}".format(self.dir, self.dir_diff),
|
||||
"diff {} {}".format(self.dir_diff, self.dir_diff_file),
|
||||
"Identical files : ['file']",
|
||||
"Differing files : ['file2']",
|
||||
"Common subdirectories : ['subdir']",
|
||||
]
|
||||
self._assert_report(d.report, expected_report)
|
||||
|
||||
def test_dircmp_no_shallow_different_file(self):
|
||||
# A non shallow different file2
|
||||
d = filecmp.dircmp(self.dir, self.dir_same_shallow, shallow=False)
|
||||
self.assertEqual(d.same_files, [])
|
||||
self.assertEqual(d.diff_files, ['file'])
|
||||
expected_report = [
|
||||
"diff {} {}".format(self.dir, self.dir_same_shallow),
|
||||
"Differing files : ['file']",
|
||||
"Common subdirectories : ['subdir']",
|
||||
]
|
||||
self._assert_report(d.report, expected_report)
|
||||
|
||||
def test_dircmp_shallow_same_file(self):
|
||||
# A non shallow different file2
|
||||
d = filecmp.dircmp(self.dir, self.dir_same_shallow)
|
||||
self.assertEqual(d.same_files, ['file'])
|
||||
self.assertEqual(d.diff_files, [])
|
||||
expected_report = [
|
||||
"diff {} {}".format(self.dir, self.dir_same_shallow),
|
||||
"Identical files : ['file']",
|
||||
"Common subdirectories : ['subdir']",
|
||||
]
|
||||
self._assert_report(d.report, expected_report)
|
||||
|
||||
def test_dircmp_subdirs_type(self):
|
||||
"""Check that dircmp.subdirs respects subclassing."""
|
||||
class MyDirCmp(filecmp.dircmp):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue