1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
# SPDX-FileCopyrightText: © 2010 Germar Reitze
# SPDX-FileCopyrightText: © 2024 Christian Buhtz <c.buhtz@posteo.jp>
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
# This file is part of the program "Back In Time" which is released under GNU
# General Public License v2 (GPLv2). See LICENSES directory or go to
# <https://spdx.org/licenses/GPL-2.0-or-later.html>.
"""Tests about the uniquenessset module."""
# pylint: disable=wrong-import-position,C0411,import-outside-toplevel,R0801
import os
import sys
import unittest
import packaging.version
import pyfakefs.fake_filesystem_unittest as pyfakefs_ut
from pathlib import Path
from tempfile import TemporaryDirectory
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
import logger # noqa: E402,RUF100
from uniquenessset import UniquenessSet # noqa: E402,RUF100
logger.DEBUG = True
class General(pyfakefs_ut.TestCase):
"""Behavior of class UniquenessSet.
"""
def setUp(self):
"""Setup a fake filesystem."""
self.setUpPyfakefs(allow_root_user=False)
def _create_unique_file_pairs(self, pairs):
result = []
for one, two, content in pairs:
for fp in [one, two]:
# create dir
fp.parent.mkdir(parents=True, exist_ok=True)
# create file
with fp.open('wt', encoding='utf-8') as handle:
handle.write(content)
# Sync their timestamps
os.utime(two, times=(one.stat().st_atime, one.stat().st_mtime))
result.extend((one, two))
return result
@unittest.skipIf(sys.version_info[:2] < (3, 12),
'Relevant only with Python 3.12 or newer (#1911)')
def test_001_depency_workaround(self):
"""Workaround until #1575 is fixed.
Python 3.13 needs PyFakeFS at min version 5.7
Python 3.12 needs PyFakeFS at min version 5.6
See: <https://github.com/bit-team/backintime/
pull/1916#issuecomment-2438703637>
"""
import pyfakefs
pyfakefs_version = packaging.version.parse(pyfakefs.__version__)
min_required_version = packaging.version.parse('5.7.0')
self.assertTrue(
pyfakefs_version >= min_required_version,
'With Python 3.12 or later the PyFakeFS version should be '
f'minimum {min_required_version} '
f'or later but is {pyfakefs_version}.')
def test_ctor_defaults(self):
"""Default values in constructor."""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
files = self._create_unique_file_pairs([(
temp_path / 'foo',
temp_path / 'bar',
'xyz')])
sut = UniquenessSet()
# unique-check by default
self.assertTrue(sut.check(files[0]))
# Comopared to previous file, not unique by size & mtime
self.assertFalse(sut.check(files[1]))
def test_fail_equal_without_equal_to(self):
"""Uncovered (but not important) edge case."""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
fp = temp_path / 'foo'
fp.write_text('bar')
sut = UniquenessSet(deep_check=False,
follow_symlink=False,
equal_to='')
with self.assertRaises(AttributeError):
# Explicit equal-check not possible because 'equal_to' is
# empty.
sut.checkEqual(fp)
def test_unique_myself(self):
"""Test file uniqueness to itself"""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
fp = temp_path / 'bar'
fp.write_text('foo')
# unique-check is used because 'equal_to' is empty
sut = UniquenessSet(deep_check=False,
follow_symlink=False,
equal_to='')
# Is unique, because no check was done before.
self.assertTrue(sut.check(fp))
# Not unique anymore, not even to itself, because its hash was
# stored from the previous check.
self.assertFalse(sut.check(fp))
def test_size_mtime(self):
"""Uniqueness by size and mtime"""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
files = self._create_unique_file_pairs([
(
temp_path / '1' / 'foo',
temp_path / '2' / 'foo',
'bar'
),
(
temp_path / '3' / 'foo',
temp_path / '4' / 'foo',
'42'
),
])
sut = UniquenessSet(deep_check=False,
follow_symlink=False,
equal_to='')
self.assertTrue(sut.check(files[0]))
self.assertTrue(sut.check(files[2]))
self.assertFalse(sut.check(files[1]))
self.assertFalse(sut.check(files[3]))
def test_unique_size_but_different_mtime(self):
"""Unique size but mtime is different."""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
files = self._create_unique_file_pairs([
(
temp_path / '1' / 'foo',
temp_path / '2' / 'foo',
'bar'
),
(
temp_path / '3' / 'foo',
temp_path / '4' / 'foo',
'different_size'
),
])
# different mtime
os.utime(files[0], times=(0, 0))
os.utime(files[2], times=(0, 0))
# same size different mtime
sut = UniquenessSet(deep_check=False,
follow_symlink=False,
equal_to='')
# Each file is unique (different from each other)
self.assertTrue(sut.check(files[0]))
self.assertTrue(sut.check(files[1]))
self.assertTrue(sut.check(files[2]))
self.assertTrue(sut.check(files[3]))
def test_deep_check(self):
"""Uniqueness by content only"""
with TemporaryDirectory(prefix='bit.') as temp_name:
temp_path = Path(temp_name)
# Size is the same (3 chars content per file)
fpa = temp_path / 'foo'
fpa.write_text('one')
fpb = temp_path / 'bar'
fpb.write_text('bar')
# mtime is the same
os.utime(fpb, times=(fpa.stat().st_atime, fpa.stat().st_mtime))
# Not deep: check by size and mtime
sut = UniquenessSet(deep_check=False,
follow_symlink=False,
equal_to='')
self.assertTrue(sut.check(fpa))
self.assertFalse(sut.check(fpb))
# Now with deep check
sut = UniquenessSet(deep_check=True,
follow_symlink=False,
equal_to='')
self.assertTrue(sut.check(fpa))
self.assertTrue(sut.check(fpb))
|
