Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 1 | import filecmp |
| 2 | import os |
| 3 | import shutil |
| 4 | import tempfile |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 5 | import unittest |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 6 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 7 | from test import support |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 8 | |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 9 | |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 10 | class FileCompareTestCase(unittest.TestCase): |
| 11 | def setUp(self): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 12 | self.name = support.TESTFN |
| 13 | self.name_same = support.TESTFN + '-same' |
| 14 | self.name_diff = support.TESTFN + '-diff' |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 15 | data = 'Contents of file go here.\n' |
| 16 | for name in [self.name, self.name_same, self.name_diff]: |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 17 | with open(name, 'w') as output: |
| 18 | output.write(data) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 19 | |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 20 | with open(self.name_diff, 'a+') as output: |
| 21 | output.write('An extra line.\n') |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 22 | self.dir = tempfile.gettempdir() |
| 23 | |
| 24 | def tearDown(self): |
| 25 | os.unlink(self.name) |
| 26 | os.unlink(self.name_same) |
| 27 | os.unlink(self.name_diff) |
| 28 | |
| 29 | def test_matching(self): |
Berker Peksag | 143fe05 | 2014-08-14 08:34:32 +0300 | [diff] [blame] | 30 | self.assertTrue(filecmp.cmp(self.name, self.name), |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 31 | "Comparing file to itself fails") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 32 | self.assertTrue(filecmp.cmp(self.name, self.name, shallow=False), |
Berker Peksag | 143fe05 | 2014-08-14 08:34:32 +0300 | [diff] [blame] | 33 | "Comparing file to itself fails") |
| 34 | self.assertTrue(filecmp.cmp(self.name, self.name_same), |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 35 | "Comparing file to identical file fails") |
Berker Peksag | 143fe05 | 2014-08-14 08:34:32 +0300 | [diff] [blame] | 36 | self.assertTrue(filecmp.cmp(self.name, self.name_same, shallow=False), |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 37 | "Comparing file to identical file fails") |
| 38 | |
| 39 | def test_different(self): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 40 | self.assertFalse(filecmp.cmp(self.name, self.name_diff), |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 41 | "Mismatched files compare as equal") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 42 | self.assertFalse(filecmp.cmp(self.name, self.dir), |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 43 | "File and directory compare as equal") |
| 44 | |
Ned Deily | 7bff3cb | 2013-06-14 15:19:11 -0700 | [diff] [blame] | 45 | def test_cache_clear(self): |
| 46 | first_compare = filecmp.cmp(self.name, self.name_same, shallow=False) |
| 47 | second_compare = filecmp.cmp(self.name, self.name_diff, shallow=False) |
| 48 | filecmp.clear_cache() |
| 49 | self.assertTrue(len(filecmp._cache) == 0, |
| 50 | "Cache not cleared after calling clear_cache") |
| 51 | |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 52 | class DirCompareTestCase(unittest.TestCase): |
| 53 | def setUp(self): |
| 54 | tmpdir = tempfile.gettempdir() |
| 55 | self.dir = os.path.join(tmpdir, 'dir') |
| 56 | self.dir_same = os.path.join(tmpdir, 'dir-same') |
| 57 | self.dir_diff = os.path.join(tmpdir, 'dir-diff') |
Eli Bendersky | eb2884a | 2013-01-12 06:13:32 -0800 | [diff] [blame] | 58 | |
| 59 | # Another dir is created under dir_same, but it has a name from the |
| 60 | # ignored list so it should not affect testing results. |
| 61 | self.dir_ignored = os.path.join(self.dir_same, '.hg') |
| 62 | |
Raymond Hettinger | f70e076 | 2003-09-02 06:59:21 +0000 | [diff] [blame] | 63 | self.caseinsensitive = os.path.normcase('A') == os.path.normcase('a') |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 64 | data = 'Contents of file go here.\n' |
Eli Bendersky | eb2884a | 2013-01-12 06:13:32 -0800 | [diff] [blame] | 65 | for dir in (self.dir, self.dir_same, self.dir_diff, self.dir_ignored): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 66 | shutil.rmtree(dir, True) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 67 | os.mkdir(dir) |
Raymond Hettinger | f70e076 | 2003-09-02 06:59:21 +0000 | [diff] [blame] | 68 | if self.caseinsensitive and dir is self.dir_same: |
Raymond Hettinger | eeca37e | 2003-09-02 05:42:02 +0000 | [diff] [blame] | 69 | fn = 'FiLe' # Verify case-insensitive comparison |
| 70 | else: |
| 71 | fn = 'file' |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 72 | with open(os.path.join(dir, fn), 'w') as output: |
| 73 | output.write(data) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 74 | |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 75 | with open(os.path.join(self.dir_diff, 'file2'), 'w') as output: |
| 76 | output.write('An extra file.\n') |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 77 | |
| 78 | def tearDown(self): |
Eli Bendersky | eb2884a | 2013-01-12 06:13:32 -0800 | [diff] [blame] | 79 | for dir in (self.dir, self.dir_same, self.dir_diff): |
| 80 | shutil.rmtree(dir) |
| 81 | |
| 82 | def test_default_ignores(self): |
| 83 | self.assertIn('.hg', filecmp.DEFAULT_IGNORES) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 84 | |
| 85 | def test_cmpfiles(self): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 86 | self.assertTrue(filecmp.cmpfiles(self.dir, self.dir, ['file']) == |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 87 | (['file'], [], []), |
| 88 | "Comparing directory to itself fails") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 89 | self.assertTrue(filecmp.cmpfiles(self.dir, self.dir_same, ['file']) == |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 90 | (['file'], [], []), |
| 91 | "Comparing directory to same fails") |
| 92 | |
| 93 | # Try it with shallow=False |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 94 | self.assertTrue(filecmp.cmpfiles(self.dir, self.dir, ['file'], |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 95 | shallow=False) == |
| 96 | (['file'], [], []), |
| 97 | "Comparing directory to itself fails") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 98 | self.assertTrue(filecmp.cmpfiles(self.dir, self.dir_same, ['file'], |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 99 | shallow=False), |
| 100 | "Comparing directory to same fails") |
| 101 | |
| 102 | # Add different file2 |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 103 | with open(os.path.join(self.dir, 'file2'), 'w') as output: |
| 104 | output.write('Different contents.\n') |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 105 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 106 | self.assertFalse(filecmp.cmpfiles(self.dir, self.dir_same, |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 107 | ['file', 'file2']) == |
| 108 | (['file'], ['file2'], []), |
| 109 | "Comparing mismatched directories fails") |
| 110 | |
| 111 | |
| 112 | def test_dircmp(self): |
| 113 | # Check attributes for comparison of two identical directories |
R David Murray | 2b209cd | 2012-08-14 21:40:13 -0400 | [diff] [blame] | 114 | left_dir, right_dir = self.dir, self.dir_same |
| 115 | d = filecmp.dircmp(left_dir, right_dir) |
| 116 | self.assertEqual(d.left, left_dir) |
| 117 | self.assertEqual(d.right, right_dir) |
Raymond Hettinger | f70e076 | 2003-09-02 06:59:21 +0000 | [diff] [blame] | 118 | if self.caseinsensitive: |
| 119 | self.assertEqual([d.left_list, d.right_list],[['file'], ['FiLe']]) |
| 120 | else: |
| 121 | self.assertEqual([d.left_list, d.right_list],[['file'], ['file']]) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 122 | self.assertEqual(d.common, ['file']) |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 123 | self.assertEqual(d.left_only, []) |
| 124 | self.assertEqual(d.right_only, []) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 125 | self.assertEqual(d.same_files, ['file']) |
| 126 | self.assertEqual(d.diff_files, []) |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 127 | expected_report = [ |
| 128 | "diff {} {}".format(self.dir, self.dir_same), |
| 129 | "Identical files : ['file']", |
| 130 | ] |
| 131 | self._assert_report(d.report, expected_report) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 132 | |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 133 | # Check attributes for comparison of two different directories (right) |
R David Murray | 2b209cd | 2012-08-14 21:40:13 -0400 | [diff] [blame] | 134 | left_dir, right_dir = self.dir, self.dir_diff |
| 135 | d = filecmp.dircmp(left_dir, right_dir) |
| 136 | self.assertEqual(d.left, left_dir) |
| 137 | self.assertEqual(d.right, right_dir) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 138 | self.assertEqual(d.left_list, ['file']) |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 139 | self.assertEqual(d.right_list, ['file', 'file2']) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 140 | self.assertEqual(d.common, ['file']) |
| 141 | self.assertEqual(d.left_only, []) |
| 142 | self.assertEqual(d.right_only, ['file2']) |
| 143 | self.assertEqual(d.same_files, ['file']) |
| 144 | self.assertEqual(d.diff_files, []) |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 145 | expected_report = [ |
| 146 | "diff {} {}".format(self.dir, self.dir_diff), |
| 147 | "Only in {} : ['file2']".format(self.dir_diff), |
| 148 | "Identical files : ['file']", |
| 149 | ] |
| 150 | self._assert_report(d.report, expected_report) |
| 151 | |
| 152 | # Check attributes for comparison of two different directories (left) |
| 153 | left_dir, right_dir = self.dir, self.dir_diff |
| 154 | shutil.move( |
| 155 | os.path.join(self.dir_diff, 'file2'), |
| 156 | os.path.join(self.dir, 'file2') |
| 157 | ) |
| 158 | d = filecmp.dircmp(left_dir, right_dir) |
| 159 | self.assertEqual(d.left, left_dir) |
| 160 | self.assertEqual(d.right, right_dir) |
| 161 | self.assertEqual(d.left_list, ['file', 'file2']) |
| 162 | self.assertEqual(d.right_list, ['file']) |
| 163 | self.assertEqual(d.common, ['file']) |
| 164 | self.assertEqual(d.left_only, ['file2']) |
| 165 | self.assertEqual(d.right_only, []) |
| 166 | self.assertEqual(d.same_files, ['file']) |
| 167 | self.assertEqual(d.diff_files, []) |
| 168 | expected_report = [ |
| 169 | "diff {} {}".format(self.dir, self.dir_diff), |
| 170 | "Only in {} : ['file2']".format(self.dir), |
| 171 | "Identical files : ['file']", |
| 172 | ] |
| 173 | self._assert_report(d.report, expected_report) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 174 | |
| 175 | # Add different file2 |
Benjamin Peterson | 3d678e3 | 2014-05-03 20:18:50 -0400 | [diff] [blame] | 176 | with open(os.path.join(self.dir_diff, 'file2'), 'w') as output: |
| 177 | output.write('Different contents.\n') |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 178 | d = filecmp.dircmp(self.dir, self.dir_diff) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 179 | self.assertEqual(d.same_files, ['file']) |
| 180 | self.assertEqual(d.diff_files, ['file2']) |
Benjamin Peterson | f24600e | 2014-05-03 20:07:16 -0400 | [diff] [blame] | 181 | expected_report = [ |
| 182 | "diff {} {}".format(self.dir, self.dir_diff), |
| 183 | "Identical files : ['file']", |
| 184 | "Differing files : ['file2']", |
| 185 | ] |
| 186 | self._assert_report(d.report, expected_report) |
| 187 | |
| 188 | def test_report_partial_closure(self): |
| 189 | left_dir, right_dir = self.dir, self.dir_same |
| 190 | d = filecmp.dircmp(left_dir, right_dir) |
| 191 | expected_report = [ |
| 192 | "diff {} {}".format(self.dir, self.dir_same), |
| 193 | "Identical files : ['file']", |
| 194 | ] |
| 195 | self._assert_report(d.report_partial_closure, expected_report) |
| 196 | |
| 197 | def test_report_full_closure(self): |
| 198 | left_dir, right_dir = self.dir, self.dir_same |
| 199 | d = filecmp.dircmp(left_dir, right_dir) |
| 200 | expected_report = [ |
| 201 | "diff {} {}".format(self.dir, self.dir_same), |
| 202 | "Identical files : ['file']", |
| 203 | ] |
| 204 | self._assert_report(d.report_full_closure, expected_report) |
| 205 | |
| 206 | def _assert_report(self, dircmp_report, expected_report_lines): |
| 207 | with support.captured_stdout() as stdout: |
| 208 | dircmp_report() |
| 209 | report_lines = stdout.getvalue().strip().split('\n') |
| 210 | self.assertEqual(report_lines, expected_report_lines) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 211 | |
| 212 | |
| 213 | def test_main(): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 214 | support.run_unittest(FileCompareTestCase, DirCompareTestCase) |
Andrew M. Kuchling | e63846d | 2003-02-06 17:42:45 +0000 | [diff] [blame] | 215 | |
| 216 | if __name__ == "__main__": |
| 217 | test_main() |