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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
|
import collections
import itertools
import logging
import os
import random
import torf
debug = logging.getLogger('test').debug
def display_filespecs(filespecs, piece_size):
filecount = len(filespecs)
header = ['.' + ' ' * (((4 * filecount) + (2 * filecount - 1)) + 2 - 1)]
for i in range(8):
header.append(str(i) + ' ' * (piece_size - 1))
line = (', '.join(f'{fn}:{fs:2d}' for fn,fs in filespecs),
' - ',
''.join(fn * fs for fn,fs in filespecs))
debug(f'\n{"".join(header)}\n{"".join(line)}')
class fuzzylist(list):
"""
List that is fuzzily equal to other lists
>>> x = fuzzylist('a', 'b', 'c', maybe=('x', 'y', 'z'))
>>> x
['a', 'b', 'c']
>>> x == ['z', 'b', 'a', 'c', 'y']
True
Limit the number of optional items:
>>> x = fuzzylist('a', 'b', 'c', maybe=('x', 'x'))
>>> x == ['a', 'x', 'b', 'x', 'c']
True
>>> x == ['a', 'x', 'b', 'x', 'c', 'x']
False
`max_maybe_items` also allows you to limit the number of optional items:
>>> x = fuzzylist('a', 'b', 'c', maybe=('x', 'y', 'z'), max_maybe_items={'x':1})
>>> x == ['a', 'x', 'b', 'z', 'c']
True
>>> x == ['a', 'x', 'b', 'x', 'c']
False
Unlike `set(...) == set(...)`, this doesn't remove duplicate items and
allows unhashable items.
"""
def __init__(self, *args, maybe=(), max_maybe_items={}):
self.maybe = list(maybe)
self.max_maybe_items = dict(max_maybe_items)
super().__init__(args)
def __eq__(self, other):
if tuple(self) != tuple(other):
# Check if either list contains any disallowed items, accepting
# items from `maybe`.
other_maybe = getattr(other, 'maybe', [])
for item in self:
if item not in other and item not in other_maybe:
return False
self_maybe = self.maybe
for item in other:
if item not in self and item not in self_maybe:
return False
# Check if either list contains an excess of items.
other_max = getattr(other, 'max_maybe_items', {})
for item in itertools.chain(self, self.maybe):
maxcount = max(other_max.get(item, 1),
(other + other_maybe).count(item))
if self.count(item) > maxcount:
return False
self_max = self.max_maybe_items
for item in itertools.chain(other, other_maybe):
maxcount = max(self_max.get(item, 1),
(self + self_maybe).count(item))
if other.count(item) > maxcount:
return False
return True
def __ne__(self, other):
return not self.__eq__(other)
def __bool__(self):
return len(self) > 0 or len(self.maybe) > 0
def __add__(self, other):
items = super().__add__(other)
maybe = self.maybe + getattr(other, 'maybe', [])
max_maybe_items = {**self.max_maybe_items, **getattr(other, 'max_maybe_items', {})}
return type(self)(*items, maybe=maybe, max_maybe_items=max_maybe_items)
def __repr__(self):
s = f'{type(self).__name__}('
s += '[' + ', '.join(repr(item) for item in super().__iter__()) + ']'
if self.maybe:
s += f', maybe={repr(self.maybe)}'
if self.max_maybe_items:
s += f', max_maybe_items={repr(self.max_maybe_items)}'
return s + ')'
class fuzzydict(dict):
"""
Dictionary that ignores empty `fuzzylist` values when determining equality,
e.g. fuzzydict(x=fuzzylist()) == {}
"""
def __eq__(self, other):
if super().__eq__(other):
return True
elif not isinstance(other, dict):
return NotImplemented
keys_same = set(self).intersection(other)
for k in keys_same:
if self[k] != other[k]:
return False
keys_diff = set(self).difference(other)
for k in keys_diff:
sv = self.get(k, fuzzylist())
ov = other.get(k, fuzzylist())
if sv != ov:
return False
return True
def __repr__(self):
return f'{type(self).__name__}({super().__repr__()})'
def ComparableException(exc):
"""
Horrible hack that allows us to compare exceptions comfortably
`exc1 == exc2` is True if both exceptions have the same type and the same
message. Type checking with issubclass() and isinstance() also works as
expected.
"""
# Make the returned class object an instance of the type of `exc` and the
# returned Comparable* class.
class ComparableExceptionMeta(type):
_cls = type(exc)
@classmethod
def __subclasscheck__(mcls, cls):
return issubclass(cls, mcls._cls) or issubclass(cls, mcls)
@classmethod
def __instancecheck__(mcls, inst):
return isinstance(cls, mcls._cls) or isinstance(cls, mcls)
# Make subclass of the same name with "Comparable" prepended
clsname = 'Comparable' + type(exc).__name__
bases = (type(exc),)
def __eq__(self, other, _real_cls=type(exc)):
return isinstance(other, (type(self), _real_cls)) and str(self) == str(other)
def __hash__(self):
return hash(str(self))
attrs = {}
attrs['__eq__'] = __eq__
attrs['__hash__'] = __hash__
cls = ComparableExceptionMeta(clsname, bases, attrs)
if isinstance(exc, torf.TorfError):
return cls(*exc.posargs, **exc.kwargs)
else:
raise exc
def random_positions(stream):
"""Return list of 1 to 5 random indexes in `stream`"""
positions = random.sample(range(len(stream)), k=min(len(stream), 5))
return sorted(positions[:random.randint(1, len(positions))])
def change_file_size(filepath, original_size):
"""Randomly change size of `filepath` on disk and return new contents"""
diff_range = list(range(-original_size, original_size + 1))
diff_range.remove(0)
diff = random.choice(diff_range)
data = bytearray(open(filepath, 'rb').read())
debug(f' Original data ({len(data)} bytes): {data}')
if diff > 0:
# Make add `diff` bytes at `pos`
pos = random.choice(range(original_size + 1))
data[pos:pos] = b'\xA0' * diff
elif diff < 0:
# Remove `abs(diff)` bytes at `pos`
pos = random.choice(range(original_size - abs(diff) + 1))
data[pos : pos + abs(diff)] = ()
with open(filepath, 'wb') as f:
f.write(data)
f.truncate()
assert os.path.getsize(filepath) == original_size + diff
debug(f' Changed data ({len(data)} bytes): {data}')
with open(filepath, 'rb') as f:
return f.read()
def round_up_to_multiple(n, x):
"""Round `n` up to the next multiple of `x`"""
return n - n % -x
def round_down_to_multiple(n, x):
"""Round `n` down to the previous multiple of `x`"""
if n % x != 0:
return round_up_to_multiple(n, x) - x
else:
return n
def file_range(filename, filespecs):
"""Return `filename`'s first and last byte index in stream"""
pos = 0
for fn,size in filespecs:
if fn == filename:
return pos, pos + size - 1
pos += size
raise RuntimeError(f'Could not find {filename} in {filespecs}')
def file_piece_indexes(filename, filespecs, piece_size, exclusive=False):
"""
Return list of indexes of pieces that contain bytes from `filename`
If `exclusive` is True, don't include pieces that contain bytes from
multiple files.
"""
file_beg,file_end = file_range(filename, filespecs)
first_piece_index_pos = round_down_to_multiple(file_beg, piece_size)
piece_indexes = []
for pos in range(first_piece_index_pos, file_end + 1, piece_size):
if not exclusive or len(pos2files(pos, filespecs, piece_size)) == 1:
piece_indexes.append(pos // piece_size)
return piece_indexes
def pos2files(pos, filespecs, piece_size, include_file_at_pos=True):
"""
Calculate which piece the byte at `pos` belongs to and return a list of file
names of those files that are covered by that piece.
"""
p = 0
filenames = []
for filename,filesize in filespecs:
filepos_beg = p
filepos_end = filepos_beg + filesize - 1
first_piece_index = filepos_beg // piece_size
last_piece_index = filepos_end // piece_size
first_piece_index_pos_beg = first_piece_index * piece_size
last_piece_index_pos_end = (last_piece_index + 1) * piece_size - 1
if first_piece_index_pos_beg <= pos <= last_piece_index_pos_end:
filenames.append(filename)
p += filesize
if not include_file_at_pos:
file_at_pos,_ = pos2file(pos, filespecs, piece_size)
return [f for f in filenames if f != file_at_pos]
else:
return filenames
def pos2file(pos, filespecs, piece_size):
"""Return file name and relative position of `pos` in file"""
p = 0
for filename,filesize in filespecs:
if p <= pos < p + filesize:
return (filename, pos - p)
p += filesize
raise RuntimeError(f'Could not find file at position {pos} in {filespecs}')
def calc_piece_indexes(filespecs, piece_size, files_missing=(), files_missized=()):
"""
Turn a list of (filename, filesize) tuples into a dictionary that maps file
names to the piece indexes they cover. Pieces that overlap multiple files
belong to the last file they cover.
"""
piece_indexes = collections.defaultdict(lambda: fuzzylist())
pos = 0
for i, (filename, filesize) in enumerate(filespecs):
# Piece indexes that cover only one file must be reported for that file.
exclusive_file_pis = file_piece_indexes(filename, filespecs, piece_size, exclusive=True)
# Piece indexes that cover multiple files may be reported for any of
# those files.
multiple_file_pis = [
pi for pi in file_piece_indexes(filename, filespecs, piece_size, exclusive=False)
if pi not in exclusive_file_pis
]
piece_indexes[filename].extend(exclusive_file_pis)
piece_indexes[filename].maybe.extend(multiple_file_pis)
pos += filesize
# Remove empty lists
for k in tuple(piece_indexes):
if not piece_indexes[k]:
del piece_indexes[k]
# For each missing/missized file, the first piece of the file may get two
# calls, one for the "no such file"/"wrong file size" error and one for the
# "corrupt piece" error.
for filepath in itertools.chain(files_missing, files_missized):
filename = os.path.basename(filepath)
file_beg,file_end = file_range(filename, filespecs)
piece_index = file_beg // piece_size
if piece_index not in piece_indexes[filename].maybe:
piece_indexes[filename].maybe.append(piece_index)
return fuzzydict(piece_indexes)
def calc_good_pieces(filespecs, piece_size, files_missing, corruption_positions, files_missized):
"""
Same as `calc_piece_indexes`, but exclude corrupt pieces and pieces of
missing or missized files
"""
debug('* Calculating good pieces')
all_piece_indexes = calc_piece_indexes(filespecs, piece_size, files_missing, files_missized)
bad_pis = {corrpos // piece_size for corrpos in corruption_positions}
debug(f' missing files: {files_missing}')
debug(f' missized files: {files_missized}')
debug(f' all piece_indexes: {all_piece_indexes}')
debug(f' corrupt piece_indexes: {bad_pis}')
# Find pieces that exclusively belong to missing or missized files
for filepath in itertools.chain(files_missing, files_missized):
file_beg,file_end = file_range(os.path.basename(filepath), filespecs)
first_bad_pi = file_beg // piece_size
last_bad_pi = file_end // piece_size
bad_pis.update(range(first_bad_pi, last_bad_pi + 1))
debug(f' combined bad piece_indexes: {bad_pis}')
# Remove pieces that are in bad_pis
good_pieces = collections.defaultdict(lambda: fuzzylist())
for fname,all_pis in all_piece_indexes.items():
# Maintain mandatory and optional piece_indexes from all_piece_indexes
for pi in itertools.chain(all_pis, all_pis.maybe):
if pi not in bad_pis:
debug(f' filename={fname}: piece_index={pi}: good')
if pi in all_pis.maybe:
good_pieces[fname].maybe.append(pi)
else:
good_pieces[fname].append(pi)
else:
debug(f' filename={fname}: piece_index={pi}: bad')
good_pieces = fuzzydict(good_pieces)
debug(f' corruptions and missing/missized files removed: {good_pieces}')
return good_pieces
def skip_good_pieces(good_pieces, filespecs, piece_size, corruption_positions):
"""
For each file in `good_pieces`, remove piece_indexes between the first
corruption and the end of the file
"""
debug('* Skipping good pieces after corruptions')
# Find out which piece_indexes should be skipped
skipped_pis = set()
for corrpos in sorted(corruption_positions):
corr_pi = corrpos // piece_size
affected_files = pos2files(corrpos, filespecs, piece_size)
debug(f' corruption at position {corrpos}, piece_index {corr_pi}: {affected_files}')
for file in affected_files:
file_pis_exclusive = file_piece_indexes(file, filespecs, piece_size, exclusive=True)
debug(f' {file}: piece_indexes exclusive: {file_pis_exclusive}')
file_pis = file_piece_indexes(file, filespecs, piece_size, exclusive=False)
debug(f' piece_indexes non-exclusive: {file_pis}')
try:
first_corr_index_in_file = file_pis.index(corr_pi)
except ValueError:
# Skip all pieces in `file` that don't contain bytes from other files
debug(f' piece_index {corr_pi} is not part of {file}: {file_pis_exclusive}')
skipped_pis.update(file_pis_exclusive)
else:
# Skip all pieces after the first corrupted piece in `file`
skip_pis = file_pis[first_corr_index_in_file + 1:]
debug(f' skipping piece_indexes after corruption: {skip_pis}')
skipped_pis.update(skip_pis)
# Make skipped piece_indexes optional while unskipped piece_indexes stay
# mandatory.
debug(f' skipping piece_indexes: {skipped_pis}')
good_pieces_skipped = collections.defaultdict(lambda: fuzzylist())
for fname,pis in good_pieces.items():
for pi in pis:
if pi in skipped_pis:
good_pieces_skipped[fname].maybe.append(pi)
else:
good_pieces_skipped[fname].append(pi)
return fuzzydict(good_pieces_skipped)
def calc_corruptions(filespecs, piece_size, corruption_positions):
"""Map file names to (piece_index, exception) tuples"""
exceptions = []
reported = set()
for corrpos in sorted(corruption_positions):
corr_pi = corrpos // piece_size
if corr_pi not in reported:
filepath, _ = pos2file(corrpos, filespecs, piece_size)
exc = ComparableException(torf.VerifyContentError(filepath, corr_pi, piece_size, filespecs))
exceptions.append(exc)
reported.add(corr_pi)
return fuzzylist(*exceptions)
def skip_corruptions(all_corruptions, filespecs, piece_size, corruption_positions, files_missing, files_missized):
"""Make every non-first corruption optional"""
debug(f'Skipping corruptions: {all_corruptions}')
pis_seen = set()
files_seen = set()
corruptions = fuzzylist()
files_autoskipped = set(str(f) for f in itertools.chain(files_missing, files_missized))
debug(f' missing or missized: {files_autoskipped}')
for exc in all_corruptions:
# Corruptions for files we haven't seen yet must be reported
if any(f not in files_seen and f not in files_autoskipped
for f in exc.files):
debug(f' mandatory: {exc}')
files_seen.update(exc.files)
pis_seen.add(exc.piece_index)
corruptions.append(exc)
# Corruptions for files we already have seen may still be reported
# because skipping is racy and it's impossible to predict how many
# pieces are processed before the skip manifests.
else:
debug(f' optional: {exc}')
corruptions.maybe.append(exc)
pis_seen.add(exc.piece_index)
# Because we fake skipped files, their last piece is reported as corrupt if
# it contains bytes from the next file even if there is no corruption in the
# skipped file's last piece. But this is not guaranteed because it's
# possible the corrupt file is fully processed before its corruption is
# noticed.
for corrpos in corruption_positions:
# Find all files that are affected by the corruption
affected_files = pos2files(corrpos, filespecs, piece_size)
debug(f' affected_files: {affected_files}')
# Find piece_index of the end of the last affected file
_,file_end = file_range(affected_files[-1], filespecs)
piece_index = file_end // piece_size
debug(f' {affected_files[-1]} ends at piece_index {piece_index}')
# Add optional exception for that piece
exc = ComparableException(torf.VerifyContentError(piece_index, piece_size, filespecs))
if exc not in itertools.chain(corruptions, corruptions.maybe):
debug(f'Adding possible exception for last affected file {affected_files[-1]}: {exc}')
corruptions.maybe.append(exc)
return corruptions
def calc_pieces_done(filespecs_abspath, piece_size, files_missing=(), files_missized=()):
debug('* Calculating pieces_done')
# The callback gets the number of verified pieces (pieces_done). This
# function calculates the expected values for that argument.
#
# It's not as simple as range(1, <number of pieces>+1). For example, if a
# file is missing, we get the same pieces_done value two times, once for "No
# such file" and maybe again for "Corrupt piece" if the piece contains parts
# of another file.
# Every pieces_done value is reported at least once
total_size = sum(filesize for _,filesize in filespecs_abspath)
pieces_done_list = list((pi // piece_size) + 1
for pi in range(0, total_size, piece_size))
debug(f' progress reports: {pieces_done_list}')
# List of pieces_done values that may appear multiple times
maybes = set()
# Map pieces_done values to the number of times they may appear
max_maybe_items = collections.defaultdict(lambda: 1)
# Missing or missized files are reported in addition to progress reports
files_missing = {str(filepath) for filepath in files_missing}
debug(f' files_missing: {files_missing}')
files_missized = {str(filepath) for filepath in files_missized}
debug(f' files_missized: {files_missized}')
for filepath in files_missing.union(files_missized):
# Because we're multithreaded, we can't expect the missing/missized file
# to be reported at its first piece. We can't predict at all when the
# error is reported. The only thing we can savely say that for each
# missing/missized file, every pieces_done_value *may* increase by 1.
for pieces_done_value in pieces_done_list:
maybes.add(pieces_done_value)
max_maybe_items[pieces_done_value] += 1
fuzzy_pieces_done_list = fuzzylist(*pieces_done_list,
maybe=sorted(maybes),
max_maybe_items=max_maybe_items)
return fuzzy_pieces_done_list
|