/usr/share/pyshared/lsm/client.py is in python-libstoragemgmt 0.0.20-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 | # Copyright (C) 2011-2013 Red Hat, Inc.
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# Author: tasleson
import time
import os
import unittest
from data import Volume, NfsExport
from iplugin import INetworkAttachedStorage
from transport import Transport
import common
## Removes self for the hash d
# @param d Hash to remove self from
# @returns d with hash removed.
def del_self(d):
"""
Used to remove the self key from the dict d. Self is included when calling
the function locals() in a class method.
"""
del d['self']
return d
## Main client class for library.
# ** IMPORTANT **
# Theory of operation for methods in this class.
# We are using the name of the method and the name of the parameters and
# using python introspection abilities to translate them to the method and
# parameter names. Makes the code compact, but you will break things if the
# IPlugin class does not match the method names and parameters here!
class Client(INetworkAttachedStorage):
"""
Client side class used for managing storage that utilises RPC mechanism.
"""
## Method added so that the interface for the client RPC and the plug-in
## itself match.
def startup(self, uri, plain_text_password, timeout_ms, flags=0):
raise RuntimeError("Do not call directly!")
## Called when we are ready to initialize the plug-in.
# @param self The this pointer
# @param uri The uniform resource identifier
# @param plain_text_password Password as plain text
# @param timeout_ms The timeout in ms
# @param flags Reserved for future use, must be zero.
# @returns None
def __start(self, uri, password, timeout, flags=0):
"""
Instruct the plug-in to get ready
"""
self.tp.rpc('startup', del_self(locals()))
## Checks to see if any unix domain sockets exist in the base directory
# and opens a socket to one to see if the server is actually there.
# @param self The this pointer
# @returns True if daemon appears to be present, else false.
def _check_daemon_exists(self):
if os.path.exists(self.uds_path):
for root, sub_folders, files in os.walk(self.uds_path):
for filename in files:
uds = os.path.join(root, filename)
try:
#This operation will work if the daemon is available
s = Transport.getSocket(uds)
s.close()
return True
except common.LsmError:
pass
else:
#Base directory is not present?
pass
return False
## Class constructor
# @param self The this pointer
# @param uri The uniform resource identifier
# @param plain_text_password Password as plain text (Optional)
# @param timeout_ms The timeout in ms
# @param flags Reserved for future use, must be zero.
# @returns None
def __init__(self, uri, plain_text_password=None, timeout_ms=30000,
flags=0):
self.uri = uri
self.password = plain_text_password
self.timeout = timeout_ms
self.uds_path = common.UDS_PATH
u = common.uri_parse(uri, ['scheme'])
#Figure out which path to use
if 'LSM_UDS_PATH' in os.environ:
self.uds_path = os.environ['LSM_UDS_PATH']
scheme = u['scheme']
if "+" in scheme:
(plug, proto) = scheme.split("+")
scheme = plug
self.plugin_path = os.path.join(self.uds_path, scheme)
if os.path.exists(self.plugin_path):
self.tp = Transport(Transport.getSocket(self.plugin_path))
else:
#At this point we don't know if the user specified an incorrect
#plug-in in the URI or the daemon isn't started. We will check
#the directory for other unix domain sockets.
if self._check_daemon_exists():
raise common.LsmError(common.ErrorNumber.PLUGIN_NOT_EXIST,
"Plug-in " + self.plugin_path +
" not found!")
else:
raise common.LsmError(common.ErrorNumber.DAEMON_NOT_RUNNING,
'lsmd is not running')
self.__start(uri, plain_text_password, timeout_ms, flags)
## Synonym for close.
def shutdown(self, flags=0):
"""
Synonym for close.
"""
self.close(flags)
## Does an orderly shutdown of the plug-in
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
def close(self, flags=0):
"""
Does an orderly shutdown of the plug-in
"""
self.tp.rpc('shutdown', del_self(locals()))
self.tp.close()
self.tp = None
## Sets the timeout for the plug-in
# @param self The this pointer
# @param ms Time-out in ms
# @param flags Reserved for future use, must be zero.
def set_time_out(self, ms, flags=0):
"""
Sets any time-outs for the plug-in (ms)
Return None on success, else LsmError exception
"""
return self.tp.rpc('set_time_out', del_self(locals()))
## Retrieves the current time-out value.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns Time-out value
def get_time_out(self, flags=0):
"""
Retrieves the current time-out
Return time-out in ms, else raise LsmError
"""
return self.tp.rpc('get_time_out', del_self(locals()))
## Retrieves the status of the specified job id.
# @param self The this pointer
# @param job_id The job identifier
# @param flags Reserved for future use, must be zero.
# @returns A tuple ( status (enumeration), percent_complete, completed item)
def job_status(self, job_id, flags=0):
"""
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
"""
return self.tp.rpc('job_status', del_self(locals()))
## Frees the resources for the specfied job id.
# @param self The this pointer
# @param job_id Job id in which to release resource for
# @param flags Reserved for future use, must be zero.
def job_free(self, job_id, flags=0):
"""
Frees resources for a given job number.
Returns None on success, else raises an LsmError
"""
return self.tp.rpc('job_free', del_self(locals()))
## Gets the capabilities of the array.
# @param self The this pointer
# @param system The system of interest
# @param flags Reserved for future use, must be zero.
# @returns Capability object
def capabilities(self, system, flags=0):
"""
Fetches the capabilities of the array
Returns a capability object, see data,py for details.
"""
return self.tp.rpc('capabilities', del_self(locals()))
## Gets information about the plug-in
# @param self The this pointer
# @param flags Reserved for future use
# @returns Tuple (description, version)
def plugin_info(self, flags=0):
"""
Returns a description and version of plug-in
"""
return self.tp.rpc('plugin_info', del_self(locals()))
## Returns an array of pool objects.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of pool objects.
def pools(self, flags=0):
"""
Returns an array of pool objects. Pools are used in both block and
file system interfaces, thus the reason they are in the base class.
"""
return self.tp.rpc('pools', del_self(locals()))
## Returns an array of system objects.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of system objects.
def systems(self, flags=0):
"""
Returns an array of system objects. System information is used to
distinguish resources from on storage array to another when the plug=in
supports the ability to have more than one array managed by it
"""
return self.tp.rpc('systems', del_self(locals()))
## Returns an array of initiator objects
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of initiator objects.
def initiators(self, flags=0):
"""
Return an array of initiator objects
"""
return self.tp.rpc('initiators', del_self(locals()))
## Register a user/password for the specified initiator for CHAP
# authentication.
# Note: If you pass an empty user and password the expected behavior is to
# remove any authentication for the specified initiator.
# @param self The this pointer
# @param initiator The initiator object
# @param in_user User for inbound CHAP
# @param in_password Password for outbound CHAP
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
def iscsi_chap_auth(self, initiator, in_user, in_password,
out_user, out_password, flags=0):
"""
Register a user/password for the specified initiator for CHAP
authentication.
"""
return self.tp.rpc('iscsi_chap_auth', del_self(locals()))
## Grants access so an initiator can read/write the specified volume.
# @param self The this pointer
# @param initiator_id The iqn, WWID etc.
# @param initiator_type Enumerated initiator type
# @param volume Volume to grant access to
# @param access Enumerated access type
# @param flags Reserved for future use, must be zero
# @returns None on success, else job id.
def initiator_grant(self, initiator_id, initiator_type, volume, access,
flags=0):
"""
Allows an initiator to access a volume.
"""
return self.tp.rpc('initiator_grant', del_self(locals()))
## Revokes access for a volume for the specified initiator.
# @param self The this pointer
# @param initiator The iqn, WWID etc.
# @param volume The volume to revoke access for
# @param flags Reserved for future use, must be zero
# @return None on success, else job id
def initiator_revoke(self, initiator, volume, flags=0):
"""
Revokes access to a volume for the specified initiator
"""
return self.tp.rpc('initiator_revoke', del_self(locals()))
## Returns a list of volumes that are accessible from the specified
# initiator.
# @param self The this pointer
# @param initiator The initiator object
# @param flags Reserved for future use, must be zero
def volumes_accessible_by_initiator(self, initiator, flags=0):
"""
Returns a list of volumes that the initiator has access to.
"""
return self.tp.rpc('volumes_accessible_by_initiator',
del_self(locals()))
## Returns a list of initiators that have access to the specified volume.
# @param self The this pointer
# @param volume The volume in question
# @param flags Reserved for future use, must be zero
# @returns List of initiators
def initiators_granted_to_volume(self, volume, flags=0):
return self.tp.rpc('initiators_granted_to_volume', del_self(locals()))
## Returns an array of volume objects
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of volume objects.
def volumes(self, flags=0):
"""
Returns an array of volume objects
"""
return self.tp.rpc('volumes', del_self(locals()))
## Creates a volume
# @param self The this pointer
# @param pool The pool object to allocate storage from
# @param volume_name The human text name for the volume
# @param size_bytes Size of the volume in bytes
# @param provisioning How the volume is to be provisioned
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new volume), when one is None the other is
# valid.
def volume_create(self, pool, volume_name, size_bytes, provisioning,
flags=0):
"""
Creates a volume, given a pool, volume name, size and provisioning
returns a tuple (job_id, new volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('volume_create', del_self(locals()))
## Re-sizes a volume
# @param self The this pointer
# @param volume The volume object to re-size
# @param new_size_bytes Size of the volume in bytes
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new re-sized volume), when one is
# None the other is valid.
def volume_resize(self, volume, new_size_bytes, flags=0):
"""
Re-sizes a volume.
Returns a tuple (job_id, re-sized_volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('volume_resize', del_self(locals()))
## Replicates a volume from the specified pool.
# @param self The this pointer
# @param pool The pool to re-size from
# @param rep_type Replication type(enumeration,see common.data.Volume)
# @param volume_src The volume to replicate
# @param name Human readable name of replicated volume
# @param flags Reserved for future use, must be zero.
# @returns A tuple (job_id, new replicated volume), when one is
# None the other is valid.
def volume_replicate(self, pool, rep_type, volume_src, name, flags=0):
"""
Replicates a volume from the specified pool.
Returns a tuple (job_id, replicated volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('volume_replicate', del_self(locals()))
## Size of a replicated block.
# @param self The this pointer
# @param system The system to request the rep. block range size from
# @param flags Reserved for future use, must be zero
# @returns Size of the replicated block in bytes
def volume_replicate_range_block_size(self, system, flags=0):
"""
Returns the size of a replicated block in bytes.
"""
return self.tp.rpc('volume_replicate_range_block_size',
del_self(locals()))
## Replicates a portion of a volume to itself or another volume.
# @param self The this pointer
# @param rep_type Replication type
# (enumeration, see common.data.Volume)
# @param volume_src The volume src to replicate from
# @param volume_dest The volume dest to replicate to
# @param ranges An array of Block range objects
# @see lsm.common.data.BlockRange
# @param flags Reserved for future use, must be zero.
def volume_replicate_range(self, rep_type, volume_src, volume_dest, ranges,
flags=0):
"""
Replicates a portion of a volume to itself or another volume. The src,
dest and number of blocks values change with vendor, call
volume_replicate_range_block_size to get block unit size.
Returns Job id or None when completed, else raises LsmError on errors.
"""
return self.tp.rpc('volume_replicate_range', del_self(locals()))
## Deletes a volume
# @param self The this pointer
# @param volume The volume object which represents the volume to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id. Raises LsmError on errors.
def volume_delete(self, volume, flags=0):
"""
Deletes a volume.
Returns None on success, else job id
"""
return self.tp.rpc('volume_delete', del_self(locals()))
## Makes a volume online and available to the host.
# @param self The this pointer
# @param volume The volume to place online
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError
def volume_online(self, volume, flags=0):
"""
Makes a volume available to the host
returns None on success, else raises LsmError on errors.
"""
return self.tp.rpc('volume_online', del_self(locals()))
## Takes a volume offline
# @param self The this pointer
# @param volume The volume object
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError on errors.
def volume_offline(self, volume, flags=0):
"""
Makes a volume unavailable to the host
returns None on success, else raises LsmError on errors.
"""
return self.tp.rpc('volume_offline', del_self(locals()))
## Access control for allowing an access group to access a volume
# @param self The this pointer
# @param group The access group
# @param volume The volume to grant access to
# @param access The desired access
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def access_group_grant(self, group, volume, access, flags=0):
"""
Allows an access group to access a volume.
"""
return self.tp.rpc('access_group_grant', del_self(locals()))
## Revokes access to a volume to initiators in an access group
# @param self The this pointer
# @param group The access group
# @param volume The volume to grant access to
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def access_group_revoke(self, group, volume, flags=0):
"""
Revokes access for an access group for a volume
"""
return self.tp.rpc('access_group_revoke', del_self(locals()))
## Returns a list of access group objects
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns List of access groups
def access_group_list(self, flags=0):
"""
Returns a list of access groups
"""
return self.tp.rpc('access_group_list', del_self(locals()))
## Creates an access a group with the specified initiator in it.
# @param self The this pointer
# @param name The initiator group name
# @param initiator_id Initiator id
# @param id_type Type of initiator (Enumeration)
# @param system_id Which system to create this group on
# @param flags Reserved for future use, must be zero.
# @returns AccessGroup on success, else raises LsmError
def access_group_create(self, name, initiator_id, id_type, system_id,
flags=0):
"""
Creates an access group and add the specified initiator id, id_type and
desired access.
"""
return self.tp.rpc('access_group_create', del_self(locals()))
## Deletes an access group.
# @param self The this pointer
# @param group The access group to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def access_group_del(self, group, flags=0):
"""
Deletes an access group
"""
return self.tp.rpc('access_group_del', del_self(locals()))
## Adds an initiator to an access group
# @param self The this pointer
# @param group Group to add initiator to
# @param initiator_id Initiators id
# @param id_type Initiator id type (enumeration)
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def access_group_add_initiator(self, group, initiator_id, id_type,
flags=0):
"""
Adds an initiator to an access group
"""
return self.tp.rpc('access_group_add_initiator', del_self(locals()))
## Deletes an initiator from an access group
# @param self The this pointer
# @param group The access group to remove initiator from
# @param initiator_id The initiator to remove from the group
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def access_group_del_initiator(self, group, initiator_id, flags=0):
"""
Deletes an initiator from an access group
"""
return self.tp.rpc('access_group_del_initiator', del_self(locals()))
## Returns the list of volumes that access group has access to.
# @param self The this pointer
# @param group The access group to list volumes for
# @param flags Reserved for future use, must be zero.
# @returns list of volumes
def volumes_accessible_by_access_group(self, group, flags=0):
"""
Returns the list of volumes that access group has access to.
"""
return self.tp.rpc('volumes_accessible_by_access_group',
del_self(locals()))
##Returns the list of access groups that have access to the specified
#volume.
# @param self The this pointer
# @param volume The volume to list access groups for
# @param flags Reserved for future use, must be zero.
# @returns list of access groups
def access_groups_granted_to_volume(self, volume, flags=0):
"""
Returns the list of access groups that have access to the specified
volume.
"""
return self.tp.rpc('access_groups_granted_to_volume',
del_self(locals()))
## Checks to see if a volume has child dependencies.
# @param self The this pointer
# @param volume The volume to check
# @param flags Reserved for future use, must be zero.
# @returns True or False
def volume_child_dependency(self, volume, flags=0):
"""
Returns True if this volume has other volumes which are dependant on it.
Implies that this volume cannot be deleted or possibly modified because
it would affect its children.
"""
return self.tp.rpc('volume_child_dependency', del_self(locals()))
## Removes any child dependency.
# @param self The this pointer
# @param volume The volume to remove dependencies for
# @param flags Reserved for future use, must be zero.
# @returns None if complete, else job id.
def volume_child_dependency_rm(self, volume, flags=0):
"""
If this volume has child dependency, this method call will fully
replicate the blocks removing the relationship between them. This
should return None (success) if volume_child_dependency would return
False.
Note: This operation could take a very long time depending on the size
of the volume and the number of child dependencies.
Returns None if complete else job id, raises LsmError on errors.
"""
return self.tp.rpc('volume_child_dependency_rm', del_self(locals()))
## Returns a list of file system objects.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns A list of FS objects.
def fs(self, flags=0):
"""
Returns a list of file systems on the controller.
"""
return self.tp.rpc('fs', del_self(locals()))
## Deletes a file system
# @param self The this pointer
# @param fs The file system to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def fs_delete(self, fs, flags=0):
"""
WARNING: Destructive
Deletes a file system and everything it contains
Returns None on success, else job id
"""
return self.tp.rpc('fs_delete', del_self(locals()))
## Re-sizes a file system
# @param self The this pointer
# @param fs The file system to re-size
# @param new_size_bytes The new size of the file system in bytes
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, re-sized file system),
# When one is None the other is valid
def fs_resize(self, fs, new_size_bytes, flags=0):
"""
Re-size a file system
Returns a tuple (job_id, re-sized file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('fs_resize', del_self(locals()))
## Creates a file system.
# @param self The this pointer
# @param pool The pool object to allocate space from
# @param name The human text name for the file system
# @param size_bytes The size of the file system in bytes
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, file system),
# When one is None the other is valid
def fs_create(self, pool, name, size_bytes, flags=0):
"""
Creates a file system given a pool, name and size.
Note: size is limited to 2**64 bytes
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('fs_create', del_self(locals()))
## Clones a file system
# @param self The this pointer
# @param src_fs The source file system to clone
# @param dest_fs_name The destination file system clone name
# @param snapshot Optional, create clone from previous snapshot
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, file system)
def fs_clone(self, src_fs, dest_fs_name, snapshot=None, flags=0):
"""
Creates a thin, point in time read/writable copy of src to dest.
Optionally uses snapshot as backing of src_fs
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('fs_clone', del_self(locals()))
## Clones an individial file or files on the specified file system
# @param self The this pointer
# @param fs The file system the files are on
# @param src_file_name The source file name
# @param dest_file_name The dest. file name
# @param snapshot Optional, the snapshot to base clone source
# file from
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def file_clone(self, fs, src_file_name, dest_file_name, snapshot=None,
flags=0):
"""
Creates a thinly provisioned clone of src to dest.
Note: Source and Destination are required to be on same filesystem and
all directories in destination path need to exist.
Returns None on success, else job id
"""
return self.tp.rpc('file_clone', del_self(locals()))
## Returns a list of snapshots
# @param self The this pointer
# @param fs The file system
# @param flags Reserved for future use, must be zero.
# @returns a list of snapshot objects.
def fs_snapshots(self, fs, flags=0):
"""
Returns a list of snapshot names for the supplied file system
"""
return self.tp.rpc('fs_snapshots', del_self(locals()))
## Creates a snapshot (Point in time read only copy)
# @param self The this pointer
# @param fs The file system to snapshot
# @param snapshot_name The human readable snapshot name
# @param files The list of specific files to snapshot.
# @param flags Reserved for future use, must be zero.
# @returns tuple (job_id, snapshot)
def fs_snapshot_create(self, fs, snapshot_name, files, flags=0):
"""
Snapshot is a point in time read-only copy
Create a snapshot on the chosen file system with a supplied name for
each of the files. Passing None implies snapping all files on the file
system. When files is non-none it implies snap shooting those file.
NOTE: Some arrays only support snapshots at the file system level. In
this case it will not be considered an error if file names are passed.
In these cases the file names are effectively discarded as all files
are done.
Returns a tuple (job_id, snapshot)
Notes:
- Snapshot name may not match what was passed in
(depends on array implementation)
- Tuple return values are mutually exclusive, when one
is None the other must be valid.
"""
return self.tp.rpc('fs_snapshot_create', del_self(locals()))
## Deletes a snapshot
# @param self The this pointer
# @param fs The filesystem the snapshot it for
# @param snapshot The specific snap shot to delete
# @param flags Reserved for future use, must be zero.
# @returns None on success, else job id
def fs_snapshot_delete(self, fs, snapshot, flags=0):
"""
Frees the re-sources for the given snapshot on the supplied filesystem.
Returns None on success else job id, LsmError exception on error
"""
return self.tp.rpc('fs_snapshot_delete', del_self(locals()))
## Reverts a snapshot
# @param self The this pointer
# @param fs The file system object to revert snapthot for
# @param snapshot The snapshot file to revert back too
# @param files The specific files to revert
# @param restore_files Individual files to restore
# @param all_files Set to True if all files should be reverted back
# @param flags Reserved for future use, must be zero.
# @return None on success, else job id
def fs_snapshot_revert(self, fs, snapshot, files, restore_files,
all_files=False, flags=0):
"""
WARNING: Destructive!
Reverts a file-system or just the specified files from the snapshot. If
a list of files is supplied but the array cannot restore just them then
the operation will fail with an LsmError raised. If files == None and
all_files = True then all files on the file-system are reverted.
Restore_file if None none must be the same length as files with each
index in each list referring to the associated file.
Returns None on success, else job id, LsmError exception on error
"""
return self.tp.rpc('fs_snapshot_revert', del_self(locals()))
## Checks to see if a file system has child dependencies.
# @param fs The file system to check
# @param files The files to check (optional)
# @param flags Reserved for future use, must be zero.
# @returns True or False
def fs_child_dependency(self, fs, files, flags=0):
"""
Returns True if the specified filesystem or specified file on this
file system has child dependencies. This implies that this filesystem
or specified file on this file system cannot be deleted or possibly
modified because it would affect its children.
"""
return self.tp.rpc('fs_child_dependency', del_self(locals()))
## Removes child dependencies from a FS or specific file.
# @param self The this pointer
# @param fs The file system to remove child dependencies for
# @param files The list of files to remove child dependencies (opt.)
# @param flags Reserved for future use, must be zero.
# @returns None if complete, else job id.
def fs_child_dependency_rm(self, fs, files, flags=0):
"""
If this filesystem or specified file on this filesystem has child
dependency this method will fully replicate the blocks removing the
relationship between them. This should return None(success) if
fs_child_dependency would return False.
Note: This operation could take a very long time depending on the size
of the filesystem and the number of child dependencies.
Returns None if completed, else job id. Raises LsmError on errors.
"""
return self.tp.rpc('fs_child_dependency_rm', del_self(locals()))
## Returns a list of all the NFS client authentication types.
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of client authentication types.
def export_auth(self, flags=0):
"""
What types of NFS client authentication are supported.
"""
return self.tp.rpc('export_auth', del_self(locals()))
## Returns a list of all the exported file systems
# @param self The this pointer
# @param flags Reserved for future use, must be zero.
# @returns An array of export objects
def exports(self, flags=0):
"""
Get a list of all exported file systems on the controller.
"""
return self.tp.rpc('exports', del_self(locals()))
## Exports a FS as specified in the export.
# @param self The this pointer
# @param fs_id The FS ID to export
# @param export_path The export path (Set to None for array to pick)
# @param root_list List of hosts with root access
# @param rw_list List of hosts with read/write access
# @param ro_list List of hosts with read only access
# @param anon_uid UID to map to anonymous
# @param anon_gid GID to map to anonymous
# @param auth_type NFS client authentication type
# @param options Options to pass to plug-in
# @param flags Reserved for future use, must be zero.
# @returns NfsExport on success, else raises LsmError
def export_fs(self, fs_id, export_path, root_list, rw_list, ro_list,
anon_uid=NfsExport.ANON_UID_GID_NA,
anon_gid=NfsExport.ANON_UID_GID_NA,
auth_type=None, options=None, flags=0):
"""
Exports a filesystem as specified in the arguments
"""
return self.tp.rpc('export_fs', del_self(locals()))
## Removes the specified export
# @param self The this pointer
# @param export The export to remove
# @param flags Reserved for future use, must be zero.
# @returns None on success, else raises LsmError
def export_remove(self, export, flags=0):
"""
Removes the specified export
"""
return self.tp.rpc('export_remove', del_self(locals()))
class TestClient(unittest.TestCase):
def wait_to_finish(self, job, vol):
if vol is not None:
return vol
else:
(status, percent, volume) = self.c.job_status(job)
print 'Job status:', status, ' percent complete=', percent
while status == common.JobStatus.INPROGRESS:
time.sleep(1)
(status, percent, volume) = self.c.job_status(job)
print 'Job status:', status, ' percent complete=', percent
self.c.job_free(job)
if status == common.JobStatus.COMPLETE:
self.assertTrue(volume is not None)
return volume
def setUp(self):
#Most of the uri is not needed for the simulator
#Remember that the setup and teardown methods are run for each test
#case!
self.c = Client('sim://username@host:5988/?namespace=root/foo')
def test_tmo(self):
expected = 40000
self.c.set_time_out(expected)
tmo = self.c.get_time_out()
self.assertTrue(tmo == expected)
def test_job_errors(self):
self.assertRaises(common.LsmError, self.c.job_free, 0)
self.assertRaises(common.LsmError, self.c.job_status, 0)
def test_pools(self):
self.pools = self.c.pools()
self.assertTrue(len(self.pools) == 2)
for p in self.pools:
print p
def test_volumes(self):
volumes = self.c.volumes()
self.assertTrue(len(volumes) == 0)
pools = self.c.pools()
#create a volume
p = pools[0]
#Create volumes
num_volumes = 10
for i in range(num_volumes):
vol = self.wait_to_finish(
*(self.c.volume_create(p, "TestVol" + str(i), 1024 * 1024 * 10,
Volume.PROVISION_DEFAULT)))
print str(vol)
volumes = self.c.volumes()
self.assertTrue(len(volumes) == num_volumes)
#delete volumes
for i in volumes:
self.c.volume_delete(i)
volumes = self.c.volumes()
self.assertTrue(len(volumes) == 0)
#Create a volume and replicate it
vol = self.wait_to_finish(
*(self.c.volume_create(p, "To be replicated", 1024 * 1024 * 10,
Volume.PROVISION_DEFAULT)))
rep = self.wait_to_finish(
*(self.c.volume_replicate(p, Volume.REPLICATE_CLONE, vol,
'Replicated')))
volumes = self.c.volumes()
self.assertTrue(len(volumes) == 2)
self.c.volume_delete(rep)
re_sized = self.wait_to_finish(
*(self.c.volume_resize(vol, vol.size_bytes * 2)))
self.assertTrue(vol.size_bytes == re_sized.size_bytes / 2)
self.c.volume_offline(re_sized)
self.c.volume_online(re_sized)
def tearDown(self):
self.c.close()
if __name__ == "__main__":
unittest.main()
|