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 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
|
# Copyright 2025 RedHat Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import hashlib
import io
from unittest import mock
import uuid
from oslo_utils import units
from glance_store._drivers import rbd as rbd_store
from glance_store import exceptions
from glance_store import location
from glance_store.tests import utils as test_utils
class TestException(Exception):
pass
class MockRados(object):
class Error(Exception):
pass
class ObjectNotFound(Exception):
pass
class ioctx(object):
def __init__(self, *args, **kwargs):
pass
def __enter__(self, *args, **kwargs):
return self
def __exit__(self, *args, **kwargs):
return False
def close(self, *args, **kwargs):
pass
class Rados(object):
def __init__(self, *args, **kwargs):
pass
def __enter__(self, *args, **kwargs):
return self
def __exit__(self, *args, **kwargs):
return False
def connect(self, *args, **kwargs):
pass
def open_ioctx(self, *args, **kwargs):
return MockRados.ioctx()
def shutdown(self, *args, **kwargs):
pass
def conf_get(self, *args, **kwargs):
pass
class MockRBD(object):
class ImageExists(Exception):
pass
class ImageHasSnapshots(Exception):
pass
class IncompleteWriteError(Exception):
pass
class ImageBusy(Exception):
pass
class ImageNotFound(Exception):
pass
class InvalidArgument(Exception):
pass
class NoSpace(Exception):
pass
class Image(object):
def __init__(self, *args, **kwargs):
pass
def __enter__(self, *args, **kwargs):
return self
def __exit__(self, *args, **kwargs):
pass
def create_snap(self, *args, **kwargs):
pass
def remove_snap(self, *args, **kwargs):
pass
def set_snap(self, *args, **kwargs):
pass
def list_children(self, *args, **kwargs):
pass
def protect_snap(self, *args, **kwargs):
pass
def unprotect_snap(self, *args, **kwargs):
pass
def read(self, *args, **kwargs):
raise NotImplementedError()
def write(self, *args, **kwargs):
raise NotImplementedError()
def resize(self, *args, **kwargs):
pass
def discard(self, offset, length):
raise NotImplementedError()
def close(self):
pass
def list_snaps(self):
raise NotImplementedError()
def parent_info(self):
raise NotImplementedError()
def size(self):
raise NotImplementedError()
class RBD(object):
def __init__(self, *args, **kwargs):
pass
def __enter__(self, *args, **kwargs):
return self
def __exit__(self, *args, **kwargs):
return False
def create(self, *args, **kwargs):
pass
def remove(self, *args, **kwargs):
pass
def list(self, *args, **kwargs):
raise NotImplementedError()
def clone(self, *args, **kwargs):
raise NotImplementedError()
def trash_move(self, *args, **kwargs):
pass
RBD_FEATURE_LAYERING = 1
class TestRBDStoreBase(object):
def _test_add(self):
"""Test that we can add an image via the RBD backend."""
expected_image_id = str(uuid.uuid4())
expected_file_size = 5 * units.Ki # 5K
expected_file_contents = b"*" * expected_file_size
expected_checksum = hashlib.md5(expected_file_contents,
usedforsecurity=False).hexdigest()
expected_multihash = hashlib.sha256(expected_file_contents).hexdigest()
image_file = io.BytesIO(expected_file_contents)
with mock.patch.object(rbd_store.rbd.Image, 'write'):
if self.multistore:
loc, size, checksum, metadata = self.store.add(
expected_image_id, image_file, expected_file_size)
self.assertEqual(self.backend, metadata['store'])
else:
loc, size, checksum, multihash, _ = self.store.add(
expected_image_id, image_file, expected_file_size,
self.hash_algo)
self.assertEqual(expected_multihash, multihash)
self.assertEqual(expected_file_size, size)
self.assertEqual(expected_checksum, checksum)
def _test_add_image_exceeding_max_size_raises_exception(self):
"""Test that adding an image exceeding max size raises exception."""
expected_image_id = str(uuid.uuid4())
total_bytes = units.Ki * 5
# actual data size
image_size = total_bytes
# Create data larger than image_size to simulate mismatch at end
data = b'a' * (total_bytes + 1024)
image_file = io.BytesIO(data)
with mock.patch.object(
rbd_store.Store, '_delete_image') as mock_delete:
with mock.patch.object(rbd_store.rbd.Image, 'write'):
if self.multistore:
self.assertRaisesRegex(
exceptions.Invalid, "Size exceeds: expected",
self.store.add, expected_image_id, image_file,
image_size)
else:
self.assertRaisesRegex(
exceptions.Invalid, "Size exceeds: expected",
self.store.add, expected_image_id, image_file,
image_size, self.hash_algo)
# Confirm that image deletion was called due to size mismatch
mock_delete.assert_called()
# The position should be equal to total input size
self.assertEqual(image_file.tell(), len(data))
def _test_write_less_than_declared_raises_exception(self):
"""Test that writing less than declared raises exception."""
expected_image_id = str(uuid.uuid4())
total_bytes = units.Ki * 5
# actual data size
image_size = total_bytes
# Create data smaller than image_size to simulate mismatch at end
data = b'a' * (total_bytes - 100)
image_file = io.BytesIO(data)
with mock.patch.object(
rbd_store.Store, '_delete_image') as mock_delete:
with mock.patch.object(rbd_store.rbd.Image, 'write'):
if self.multistore:
self.assertRaisesRegex(
exceptions.Invalid, "Size mismatch: expected",
self.store.add, expected_image_id, image_file,
image_size)
else:
self.assertRaisesRegex(
exceptions.Invalid, "Size mismatch: expected",
self.store.add, expected_image_id, image_file,
image_size, self.hash_algo)
# Confirm that image deletion was called due to size mismatch
mock_delete.assert_called()
# The position should be less than total input size
self.assertEqual(image_file.tell(), len(data))
def _test_add_with_verifier(self):
"""Test that 'verifier.update' is called when verifier is provided."""
verifier = mock.MagicMock(name='mock_verifier')
image_id = str(uuid.uuid4())
file_size = units.Ki # 1K
file_contents = b"*" * file_size
image_file = io.BytesIO(file_contents)
with mock.patch.object(rbd_store.rbd.Image, 'write'):
if self.multistore:
self.store.add(image_id, image_file, file_size,
verifier=verifier)
else:
self.store.add(image_id, image_file, file_size,
self.hash_algo, verifier=verifier)
verifier.update.assert_called_with(file_contents)
def _test_add_duplicate_image(self):
"""Test that adding a duplicate image raises exception."""
def _fake_create_image(*args, **kwargs):
self.called_commands_actual.append('create')
raise MockRBD.ImageExists()
with mock.patch.object(self.store, '_create_image') as create_image:
create_image.side_effect = _fake_create_image
if self.multistore:
self.assertRaises(exceptions.Duplicate, self.store.add,
'fake_image_id', self.data_iter,
self.data_len)
else:
self.assertRaises(exceptions.Duplicate, self.store.add,
'fake_image_id', self.data_iter,
self.data_len, self.hash_algo)
self.called_commands_expected = ['create']
def _test_delete(self):
"""Test that we can delete an existing image in the RBD store."""
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
with mock.patch.object(MockRBD.RBD, 'remove') as remove_image:
remove_image.side_effect = _fake_remove
if self.multistore:
loc = location.get_location_from_uri_and_backend(
self.location.get_uri(), 'ceph1', conf=self.conf)
else:
loc = location.Location('test_rbd_store',
rbd_store.StoreLocation,
self.conf,
uri=self.location.get_uri())
self.store.delete(loc)
self.called_commands_expected = ['remove']
def _test_delete_non_existing(self):
"""Test that deleting a non-existing image raises exception."""
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
raise MockRBD.ImageNotFound()
with mock.patch.object(MockRBD.RBD, 'remove') as remove:
remove.side_effect = _fake_remove
self.assertRaises(exceptions.NotFound, self.store._delete_image,
'fake_pool', self.location.image)
self.called_commands_expected = ['remove']
def _test_delete_image_with_snap(self):
"""Test deleting an image with snapshot."""
@mock.patch.object(MockRBD.RBD, 'remove')
@mock.patch.object(MockRBD.Image, 'remove_snap')
@mock.patch.object(MockRBD.Image, 'unprotect_snap')
def _test_delete_with_snap(unprotect, remove_snap, remove):
def _fake_unprotect_snap(*args, **kwargs):
self.called_commands_actual.append('unprotect_snap')
def _fake_remove_snap(*args, **kwargs):
self.called_commands_actual.append('remove_snap')
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
remove.side_effect = _fake_remove
unprotect.side_effect = _fake_unprotect_snap
remove_snap.side_effect = _fake_remove_snap
self.store._delete_image('fake_pool', self.location.image,
snapshot_name='snap')
self.called_commands_expected = ['unprotect_snap', 'remove_snap',
'remove']
_test_delete_with_snap()
def _test_delete_image_with_unprotected_snap(self):
"""Test deleting an image with unprotected snapshot."""
@mock.patch.object(MockRBD.RBD, 'remove')
@mock.patch.object(MockRBD.Image, 'remove_snap')
@mock.patch.object(MockRBD.Image, 'unprotect_snap')
def _test_delete_with_unprotected_snap(unprotect, remove_snap, remove):
def _fake_unprotect_snap(*args, **kwargs):
self.called_commands_actual.append('unprotect_snap')
raise MockRBD.InvalidArgument()
def _fake_remove_snap(*args, **kwargs):
self.called_commands_actual.append('remove_snap')
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
remove.side_effect = _fake_remove
unprotect.side_effect = _fake_unprotect_snap
remove_snap.side_effect = _fake_remove_snap
self.store._delete_image('fake_pool', self.location.image,
snapshot_name='snap')
self.called_commands_expected = ['unprotect_snap', 'remove_snap',
'remove']
_test_delete_with_unprotected_snap()
def _test_delete_image_with_snap_with_error(self):
"""Test deleting an image with snapshot that raises error."""
@mock.patch.object(MockRBD.RBD, 'remove')
@mock.patch.object(MockRBD.Image, 'remove_snap')
@mock.patch.object(MockRBD.Image, 'unprotect_snap')
def _test_delete_with_snap_error(unprotect, remove_snap, remove):
def _fake_unprotect_snap(*args, **kwargs):
self.called_commands_actual.append('unprotect_snap')
raise TestException()
def _fake_remove_snap(*args, **kwargs):
self.called_commands_actual.append('remove_snap')
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
remove.side_effect = _fake_remove
unprotect.side_effect = _fake_unprotect_snap
remove_snap.side_effect = _fake_remove_snap
self.assertRaises(TestException, self.store._delete_image,
'fake_pool', self.location.image,
snapshot_name='snap')
self.called_commands_expected = ['unprotect_snap']
_test_delete_with_snap_error()
def _test_delete_image_with_snap_exc_image_busy(self):
"""Test deleting an image with snapshot that is busy."""
def _fake_unprotect_snap(*args, **kwargs):
self.called_commands_actual.append('unprotect_snap')
raise MockRBD.ImageBusy()
with mock.patch.object(MockRBD.Image, 'unprotect_snap') as mocked:
mocked.side_effect = _fake_unprotect_snap
self.assertRaises(exceptions.InUseByStore,
self.store._delete_image,
'fake_pool', self.location.image,
snapshot_name='snap')
self.called_commands_expected = ['unprotect_snap']
def _test_delete_image_snap_has_external_references(self):
"""Test deleting an image with snapshot that has references."""
with mock.patch.object(MockRBD.Image, 'list_children') as mocked:
mocked.return_value = True
self.store._delete_image('fake_pool',
self.location.image,
snapshot_name='snap')
def _test_delete_image_with_snap_exc_image_has_snap(self):
"""Test deleting an image with snapshot that has snapshots."""
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
raise MockRBD.ImageHasSnapshots()
with mock.patch.object(MockRBD.RBD, 'remove') as remove:
remove.side_effect = _fake_remove
self.store._delete_image('fake_pool',
self.location.image)
self.called_commands_expected = ['remove']
def _test_get_partial_image(self):
"""Test that getting partial image raises exception."""
if self.multistore:
loc = location.get_location_from_uri_and_backend(
self.location.get_uri(), 'ceph1', conf=self.conf)
else:
loc = location.Location('test_rbd_store', rbd_store.StoreLocation,
self.conf, store_specs=self.store_specs)
self.assertRaises(exceptions.StoreRandomGetNotSupported,
self.store.get, loc, chunk_size=1)
def _test_rados_connect_error(self):
"""Test that rados connect error raises exception."""
@mock.patch.object(MockRados.Rados, 'connect',
side_effect=MockRados.Error)
def _test_connect_error(_):
rbd_store.rados.Error = MockRados.Error
rbd_store.rados.ObjectNotFound = MockRados.ObjectNotFound
def test():
with self.store.get_connection('conffile', 'rados_id'):
pass
if self.multistore:
self.assertRaises(exceptions.BadStoreConfiguration, test)
else:
self.assertRaises(exceptions.BackendException, test)
_test_connect_error()
def _test_create_image_conf_features(self):
"""Test creating image with configuration features."""
# Tests that we use non-0 features from ceph.conf and cast to int.
fsid = 'fake'
features = '3'
conf_get_mock = mock.Mock(return_value=features)
conn = mock.Mock(conf_get=conf_get_mock)
ioctxt = mock.sentinel.ioctxt
name = '1'
size = 1024
order = 3
with mock.patch.object(rbd_store.rbd.RBD, 'create') as create_mock:
location = self.store._create_image(
fsid, conn, ioctxt, name, size, order)
self.assertEqual(fsid, location.specs['fsid'])
self.assertEqual(rbd_store.DEFAULT_POOL, location.specs['pool'])
self.assertEqual(name, location.specs['image'])
self.assertEqual(rbd_store.DEFAULT_SNAPNAME,
location.specs['snapshot'])
create_mock.assert_called_once_with(ioctxt, name, size, order,
old_format=False, features=3)
def _test_add_with_thick_provisioning(self):
"""Test adding image with thick provisioning."""
chunk_size = units.Mi
content = b"*" * chunk_size + b"\x00" * chunk_size + b"*" * chunk_size
self._do_test_thin_provisioning(content, 3 * chunk_size, 3, False)
def _test_add_with_thin_provisioning(self):
"""Test adding image with thin provisioning."""
chunk_size = units.Mi
content = b"*" * chunk_size + b"\x00" * chunk_size + b"*" * chunk_size
self._do_test_thin_provisioning(content, 3 * chunk_size, 2, True)
def _test_add_thick_provisioning_without_holes(self):
"""Test adding image with thick provisioning without holes."""
chunk_size = units.Mi
content = b"*" * 3 * chunk_size
self._do_test_thin_provisioning(content, 3 * chunk_size, 3, False)
def _test_add_thin_provisioning_without_holes(self):
"""Test adding image with thin provisioning without holes."""
chunk_size = units.Mi
content = b"*" * 3 * chunk_size
self._do_test_thin_provisioning(content, 3 * chunk_size, 3, True)
def _test_add_thick_provisioning_with_partial_holes(self):
"""Test adding image with thick provisioning with partial holes."""
chunk_size = units.Mi
my_chunk = int(chunk_size * 1.5)
content = b"*" * my_chunk + b"\x00" * my_chunk + b"*" * my_chunk
self._do_test_thin_provisioning(content, 3 * my_chunk, 5, False)
def _test_add_thin_provisioning_with_partial_holes(self):
"""Test adding image with thin provisioning with partial holes."""
chunk_size = units.Mi
my_chunk = int(chunk_size * 1.5)
content = b"*" * my_chunk + b"\x00" * my_chunk + b"*" * my_chunk
self._do_test_thin_provisioning(content, 3 * my_chunk, 4, True)
def _do_test_thin_provisioning(self, content, size, write, thin):
"""Helper method to test thin provisioning."""
self.config(rbd_store_chunk_size=1,
rbd_thin_provisioning=thin,
group=self.backend)
self.store.configure()
image_id = 'fake_image_id'
image_file = io.BytesIO(content)
expected_checksum = hashlib.md5(content,
usedforsecurity=False).hexdigest()
expected_multihash = hashlib.sha256(content).hexdigest()
with mock.patch.object(rbd_store.rbd.Image, 'write') as mock_write:
if self.multistore:
loc, size, checksum, metadata = self.store.add(
image_id, image_file, size)
self.assertEqual(self.backend, metadata['store'])
else:
loc, size, checksum, multihash, _ = self.store.add(
image_id, image_file, size, self.hash_algo)
self.assertEqual(expected_multihash, multihash)
self.assertEqual(mock_write.call_count, write)
self.assertEqual(expected_checksum, checksum)
def _test_add_w_image_size_zero(self):
"""Test that correct size is returned even though 0 was provided."""
self.store.chunk_size = units.Ki
with mock.patch.object(rbd_store.rbd.Image, 'resize') as resize:
with mock.patch.object(rbd_store.rbd.Image, 'write') as write:
if self.multistore:
ret = self.store.add('fake_image_id', self.data_iter, 0)
self.assertEqual(self.backend, ret[3]['store'])
else:
ret = self.store.add('fake_image_id', self.data_iter, 0,
self.hash_algo)
self.assertTrue(resize.called)
self.assertTrue(write.called)
self.assertEqual(ret[1], self.data_len)
def _test_add_w_rbd_image_exception(self):
"""Test adding image with RBD image exception."""
@mock.patch.object(MockRBD.Image, '__enter__')
@mock.patch.object(rbd_store.Store, '_create_image')
@mock.patch.object(rbd_store.Store, '_delete_image')
def _test_add_with_exception(delete, create, enter):
def _fake_create_image(*args, **kwargs):
self.called_commands_actual.append('create')
return self.location
def _fake_delete_image(
target_pool, image_name, snapshot_name=None):
self.assertEqual(self.location.pool, target_pool)
self.assertEqual(self.location.image, image_name)
self.assertEqual(self.location.snapshot, snapshot_name)
self.called_commands_actual.append('delete')
def _fake_enter(*args, **kwargs):
raise exceptions.NotFound(image="fake_image_id")
create.side_effect = _fake_create_image
delete.side_effect = _fake_delete_image
enter.side_effect = _fake_enter
if self.multistore:
self.assertRaises(exceptions.NotFound,
self.store.add,
'fake_image_id', self.data_iter,
self.data_len)
else:
self.assertRaises(exceptions.NotFound,
self.store.add,
'fake_image_id', self.data_iter,
self.data_len, self.hash_algo)
self.called_commands_expected = ['create', 'delete']
_test_add_with_exception()
def _test_add_w_rbd_no_space_exception(self):
"""Test adding image with RBD no space exception."""
@mock.patch.object(MockRBD.Image, 'resize')
@mock.patch.object(rbd_store.Store, '_create_image')
@mock.patch.object(rbd_store.Store, '_delete_image')
def _test_add_with_no_space(delete, create, resize):
def _fake_create_image(*args, **kwargs):
self.called_commands_actual.append('create')
return self.location
def _fake_delete_image(
target_pool, image_name, snapshot_name=None):
self.assertEqual(self.location.pool, target_pool)
self.assertEqual(self.location.image, image_name)
self.assertEqual(self.location.snapshot, snapshot_name)
self.called_commands_actual.append('delete')
def _fake_resize(*args, **kwargs):
raise MockRBD.NoSpace()
create.side_effect = _fake_create_image
delete.side_effect = _fake_delete_image
resize.side_effect = _fake_resize
if self.multistore:
self.assertRaises(exceptions.StorageFull,
self.store.add,
'fake_image_id', self.data_iter, 0)
else:
self.assertRaises(exceptions.StorageFull,
self.store.add,
'fake_image_id', self.data_iter, 0,
self.hash_algo)
self.called_commands_expected = ['create', 'delete']
_test_add_with_no_space()
def _test_add_checksums(self):
"""Test that checksums are calculated correctly."""
self.store.chunk_size = units.Ki
image_id = 'fake_image_id'
file_size = 5 * units.Ki # 5K
file_contents = b"*" * file_size
image_file = io.BytesIO(file_contents)
expected_checksum = hashlib.md5(file_contents,
usedforsecurity=False).hexdigest()
expected_multihash = hashlib.sha256(file_contents).hexdigest()
with mock.patch.object(rbd_store.rbd.Image, 'write'):
if self.multistore:
loc, size, checksum, metadata = self.store.add(
image_id, image_file, file_size)
self.assertEqual(self.backend, metadata['store'])
else:
loc, size, checksum, multihash, _ = self.store.add(
image_id, image_file, file_size, self.hash_algo)
self.assertEqual(expected_multihash, multihash)
self.assertEqual(expected_checksum, checksum)
def _test_add_w_image_size_zero_less_resizes(self):
"""Test that correct size is returned with fewer resizes."""
data_len = 57 * units.Mi
data_iter = test_utils.FakeData(data_len)
with mock.patch.object(rbd_store.rbd.Image, 'resize') as resize:
with mock.patch.object(rbd_store.rbd.Image, 'write') as write:
if self.multistore:
ret = self.store.add('fake_image_id', data_iter, 0)
else:
ret = self.store.add('fake_image_id', data_iter, 0,
self.hash_algo)
# We expect to trim at the end so +1
expected = 1
expected_calls = []
data_len_temp = data_len
resize_amount = self.store.WRITE_CHUNKSIZE
while data_len_temp > 0:
resize_amount *= 2
expected_calls.append(resize_amount + (data_len -
data_len_temp))
data_len_temp -= resize_amount
expected += 1
self.assertEqual(expected, resize.call_count)
resize.assert_has_calls([mock.call(call) for call in
expected_calls])
expected = ([self.store.WRITE_CHUNKSIZE for i in range(int(
data_len / self.store.WRITE_CHUNKSIZE))] +
[(data_len % self.store.WRITE_CHUNKSIZE)])
actual = ([len(args[0]) for args, kwargs in
write.call_args_list])
self.assertEqual(expected, actual)
self.assertEqual(data_len,
resize.call_args_list[-1][0][0])
self.assertEqual(data_len, ret[1])
def _test_resize_on_write_ceiling(self):
"""Test resize on write ceiling functionality."""
image = mock.MagicMock()
# Non-zero image size means no resize
ret = self.store._resize_on_write(image, 32, 16, 16)
self.assertEqual(0, ret)
image.resize.assert_not_called()
# Current size is smaller than we need
self.store.size = 8
ret = self.store._resize_on_write(image, 0, 16, 16)
self.assertEqual(8 + self.store.WRITE_CHUNKSIZE * 2, ret)
self.assertEqual(self.store.WRITE_CHUNKSIZE * 2,
self.store.resize_amount)
image.resize.assert_called_once_with(ret)
# More reads under the limit do not require a resize
image.resize.reset_mock()
self.store.size = ret
ret = self.store._resize_on_write(image, 0, 64, 16)
self.assertEqual(8 + self.store.WRITE_CHUNKSIZE * 2, ret)
image.resize.assert_not_called()
# Read past the limit triggers another resize
ret = self.store._resize_on_write(image, 0, ret + 1, 16)
self.assertEqual(8 + self.store.WRITE_CHUNKSIZE * 6, ret)
image.resize.assert_called_once_with(ret)
self.assertEqual(self.store.WRITE_CHUNKSIZE * 4,
self.store.resize_amount)
# Check that we do not resize past the 8G ceiling.
# Start with resize_amount at 2G, 1G read so far
image.resize.reset_mock()
self.store.resize_amount = 2 * units.Gi
self.store.size = 1 * units.Gi
# First resize happens and we get to 5G,
# resize_amount goes to limit of 4G
ret = self.store._resize_on_write(image, 0, 4097 * units.Mi, 16)
self.assertEqual(4 * units.Gi, self.store.resize_amount)
self.assertEqual((1 + 4) * units.Gi, ret)
self.store.size = ret
# Second resize happens and we stay at 13, no resize
# resize amount stays at limit of 8G
ret = self.store._resize_on_write(image, 0, 6144 * units.Mi, 16)
self.assertEqual(8 * units.Gi, self.store.resize_amount)
self.assertEqual((1 + 4 + 8) * units.Gi, ret)
self.store.size = ret
# Third resize happens and we get to 21,
# resize amount stays at limit of 8G
ret = self.store._resize_on_write(image, 0, 14336 * units.Mi, 16)
self.assertEqual(8 * units.Gi, self.store.resize_amount)
self.assertEqual((1 + 4 + 8 + 8) * units.Gi, ret)
self.store.size = ret
# Fourth resize happens and we get to 29,
# resize amount stays at limit of 8G
ret = self.store._resize_on_write(image, 0, 22528 * units.Mi, 16)
self.assertEqual(8 * units.Gi, self.store.resize_amount)
self.assertEqual((1 + 4 + 8 + 8 + 8) * units.Gi, ret)
image.resize.assert_has_calls([
mock.call(5 * units.Gi),
mock.call(13 * units.Gi),
mock.call(21 * units.Gi),
mock.call(29 * units.Gi)])
def _test_create_image_in_native_thread(self):
"""Test creating image in native thread."""
@mock.patch('oslo_utils.eventletutils.is_monkey_patched')
def _test_native_thread(mock_patched):
mock_patched.return_value = True
# Tests that we use non-0 features from ceph.conf and cast to int.
fsid = 'fake'
features = '3'
conf_get_mock = mock.Mock(return_value=features)
conn = mock.Mock(conf_get=conf_get_mock)
ioctxt = mock.sentinel.ioctxt
name = '1'
size = 1024
order = 3
fake_proxy = mock.MagicMock()
fake_rbd = mock.MagicMock()
with mock.patch.object(rbd_store.tpool, 'Proxy') as tpool_mock, \
mock.patch.object(rbd_store.rbd, 'RBD') as rbd_mock:
tpool_mock.return_value = fake_proxy
rbd_mock.return_value = fake_rbd
location = self.store._create_image(
fsid, conn, ioctxt, name, size, order)
self.assertEqual(fsid, location.specs['fsid'])
self.assertEqual(rbd_store.DEFAULT_POOL,
location.specs['pool'])
self.assertEqual(name, location.specs['image'])
self.assertEqual(rbd_store.DEFAULT_SNAPNAME,
location.specs['snapshot'])
tpool_mock.assert_called_once_with(fake_rbd)
fake_proxy.create.assert_called_once_with(
ioctxt, name, size, order, old_format=False, features=3)
_test_native_thread()
def _test_delete_image_in_native_thread(self):
"""Test deleting image in native thread."""
@mock.patch('oslo_utils.eventletutils.is_monkey_patched')
def _test_native_thread(mock_patched):
mock_patched.return_value = True
fake_proxy = mock.MagicMock()
fake_rbd = mock.MagicMock()
fake_ioctx = mock.MagicMock()
with mock.patch.object(rbd_store.tpool, 'Proxy') as tpool_mock, \
mock.patch.object(rbd_store.rbd, 'RBD') as rbd_mock, \
mock.patch.object(
self.store, 'get_connection') as mock_conn:
mock_get_conn = mock_conn.return_value.__enter__.return_value
mock_ioctx = mock_get_conn.open_ioctx.return_value.__enter__
mock_ioctx.return_value = fake_ioctx
tpool_mock.return_value = fake_proxy
rbd_mock.return_value = fake_rbd
self.store._delete_image('fake_pool', self.location.image)
tpool_mock.assert_called_once_with(fake_rbd)
fake_proxy.remove.assert_called_once_with(fake_ioctx,
self.location.image)
_test_native_thread()
def _test_rbd_proxy(self):
"""Test RBD proxy functionality."""
@mock.patch.object(rbd_store, 'rbd')
@mock.patch.object(rbd_store, 'tpool')
@mock.patch('oslo_utils.eventletutils.is_monkey_patched')
def _test_proxy(mock_patched, mock_tpool, mock_rbd):
mock_patched.return_value = False
self.assertEqual(mock_rbd.RBD(), self.store.RBDProxy())
mock_patched.return_value = True
self.assertEqual(
mock_tpool.Proxy.return_value, self.store.RBDProxy())
_test_proxy()
def _test_delete_image(self):
"""Test deleting an image."""
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
with mock.patch.object(MockRBD.RBD, 'remove') as remove_image:
remove_image.side_effect = _fake_remove
self.store._delete_image('fake_pool', self.location.image)
self.called_commands_expected = ['remove']
def _test_delete_image_with_snap_exc_image_has_snap_2(self):
"""Test deleting an image with snapshot that has snapshots (case 2)."""
def _fake_remove(*args, **kwargs):
self.called_commands_actual.append('remove')
raise MockRBD.ImageHasSnapshots()
mock.patch.object(MockRBD.RBD, 'trash_move',
side_effect=MockRBD.ImageBusy).start()
with mock.patch.object(MockRBD.RBD, 'remove') as remove:
remove.side_effect = _fake_remove
self.assertRaises(exceptions.InUseByStore,
self.store._delete_image,
'fake_pool',
self.location.image)
self.called_commands_expected = ['remove']
MockRBD.RBD.trash_move.assert_called_once_with(
mock.ANY, 'fake_image')
|