Implementing instance start, instance stop, instance destroy, image destroy for the testCloud cli
Unit tests pass, could probably use better coverage. Existing and new functionality works well locally other than T493 still being an issue.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | testCloud/cli.py (31 lines) | |||
| M | testCloud/image.py (15 lines) | |||
| M | testCloud/instance.py (72 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 4ac1edf22779 | a38adccc785b | 3fb8b924f2a4 | Tim Flink | support instance start, stop, destroy. Fixes T426, T488 | Jun 4 2015, 4:58 PM |
| Show First 20 Lines • Show All 92 Lines • ▼ Show 20 Line(s) | |||||
| 93 | def _start_instance(args): | 93 | def _start_instance(args): | ||
| 94 | """Handler for 'instance start' command. Expects the following elements in args: | 94 | """Handler for 'instance start' command. Expects the following elements in args: | ||
| 95 | * name(str) | 95 | * name(str) | ||
| 96 | 96 | | |||
| 97 | :param args: args from argparser | 97 | :param args: args from argparser | ||
| 98 | """ | 98 | """ | ||
| 99 | log.debug("start instance: {}".format(args.name)) | 99 | log.debug("start instance: {}".format(args.name)) | ||
| 100 | 100 | | |||
| 101 | tc_instance = instance.find_instance(args.name) | ||||
| 102 | | ||||
| 103 | if tc_instance is None: | ||||
| 104 | raise TestCloudCliError("Cannot start instance {} because it does "\ | ||||
| 105 | "not exist".format(args.name)) | ||||
| 106 | | ||||
| 107 | tc_instance.start() | ||||
| 108 | | ||||
| 101 | def _stop_instance(args): | 109 | def _stop_instance(args): | ||
| 102 | """Handler for 'instance stop' command. Expects the following elements in args: | 110 | """Handler for 'instance stop' command. Expects the following elements in args: | ||
| 103 | * name(str) | 111 | * name(str) | ||
| 104 | 112 | | |||
| 105 | :param args: args from argparser | 113 | :param args: args from argparser | ||
| 106 | """ | 114 | """ | ||
| 107 | log.debug("stop instance: {}".format(args.name)) | 115 | log.debug("stop instance: {}".format(args.name)) | ||
| 108 | 116 | | |||
| 117 | tc_instance = instance.find_instance(args.name) | ||||
| 118 | | ||||
| 119 | if tc_instance is None: | ||||
| 120 | raise TestCloudCliError("Cannot stop instance {} because it does "\ | ||||
| 121 | "not exist".format(args.name)) | ||||
| 122 | | ||||
| 123 | tc_instance.stop() | ||||
| 124 | | ||||
| 109 | def _destroy_instance(args): | 125 | def _destroy_instance(args): | ||
| 110 | """Handler for 'instance destroy' command. Expects the following elements in args: | 126 | """Handler for 'instance destroy' command. Expects the following elements in args: | ||
| 111 | * name(str) | 127 | * name(str) | ||
| 112 | 128 | | |||
| 113 | :param args: args from argparser | 129 | :param args: args from argparser | ||
| 114 | """ | 130 | """ | ||
| 115 | log.debug("destroy instance: {}".format(args.name)) | 131 | log.debug("destroy instance: {}".format(args.name)) | ||
| 116 | 132 | | |||
| 133 | tc_instance = instance.find_instance(args.name) | ||||
| 134 | | ||||
| 135 | if tc_instance is None: | ||||
| 136 | raise TestCloudCliError("Cannot remove instance {} because it does "\ | ||||
| 137 | "not exist".format(args.name)) | ||||
| 138 | | ||||
| 139 | tc_instance.destroy() | ||||
| 140 | | ||||
| 117 | 141 | | |||
| 118 | ################################################################################ | 142 | ################################################################################ | ||
| 119 | # image handling functions | 143 | # image handling functions | ||
| 120 | ################################################################################ | 144 | ################################################################################ | ||
| 121 | def _list_image(args): | 145 | def _list_image(args): | ||
| 122 | """Handler for 'image list' command. Does not expect anything else in args. | 146 | """Handler for 'image list' command. Does not expect anything else in args. | ||
| 123 | 147 | | |||
| 124 | :param args: args from argparser | 148 | :param args: args from argparser | ||
| 125 | """ | 149 | """ | ||
| 126 | log.debug("list images") | 150 | log.debug("list images") | ||
| 127 | images = image.list_images() | 151 | images = image.list_images() | ||
| 128 | print("Current Images:") | 152 | print("Current Images:") | ||
| 129 | for img in images: | 153 | for img in images: | ||
| 130 | print(" {}".format(img)) | 154 | print(" {}".format(img)) | ||
| 131 | 155 | | |||
| 132 | def _destroy_image(args): | 156 | def _destroy_image(args): | ||
| 133 | """Handler for 'image destroy' command. Expects the following elements in args: | 157 | """Handler for 'image destroy' command. Expects the following elements in args: | ||
| 134 | * name(str) | 158 | * name(str) | ||
| 135 | 159 | | |||
| 136 | :param args: args from argparser | 160 | :param args: args from argparser | ||
| 137 | """ | 161 | """ | ||
| 138 | 162 | | |||
| 139 | log.debug("destroying image {}".format(args.name)) | 163 | log.debug("destroying image {}".format(args.name)) | ||
| 140 | 164 | | |||
| 165 | tc_image = image.find_image(args.name) | ||||
| 166 | | ||||
| 167 | if tc_image is None: | ||||
| 168 | log.error("image {} not found, cannot destroy".format(args.name)) | ||||
| 169 | | ||||
| 170 | tc_image.destroy() | ||||
| 171 | | ||||
| 141 | 172 | | |||
| 142 | def get_argparser(): | 173 | def get_argparser(): | ||
| 143 | parser = argparse.ArgumentParser(description = description) | 174 | parser = argparse.ArgumentParser(description = description) | ||
| 144 | subparsers = parser.add_subparsers(title="Command Types", | 175 | subparsers = parser.add_subparsers(title="Command Types", | ||
| 145 | description="Types of commands available", | 176 | description="Types of commands available", | ||
| 146 | help="<command> help") | 177 | help="<command> help") | ||
| 147 | 178 | | |||
| 148 | 179 | | |||
| ▲ Show 20 Lines • Show All 164 Lines • Show Last 20 Lines | |||||
| Show All 25 Lines | |||||
| 26 | log = logging.getLogger('testCloud.image') | 26 | log = logging.getLogger('testCloud.image') | ||
| 27 | 27 | | |||
| 28 | def list_images(): | 28 | def list_images(): | ||
| 29 | image_dir = '{}/cache'.format(config_data.DATA_DIR) | 29 | image_dir = '{}/cache'.format(config_data.DATA_DIR) | ||
| 30 | images = os.listdir(image_dir) | 30 | images = os.listdir(image_dir) | ||
| 31 | 31 | | |||
| 32 | return images | 32 | return images | ||
| 33 | 33 | | |||
| 34 | def find_image(name, uri=None): | ||||
| 35 | images = list_images() | ||||
| 36 | | ||||
| 37 | if name in images: | ||||
| 38 | if uri is None: | ||||
| 39 | uri = 'file://{}/cache/{}'.format(config_data.DATA_DIR, name) | ||||
| 40 | return Image(uri) | ||||
| 41 | else: | ||||
| 42 | return None | ||||
| 43 | | ||||
| 34 | class Image(object): | 44 | class Image(object): | ||
| 35 | """Handles base cloud images and prepares them for boot. This includes | 45 | """Handles base cloud images and prepares them for boot. This includes | ||
| 36 | downloading images from remote systems (http, https supported) or copying | 46 | downloading images from remote systems (http, https supported) or copying | ||
| 37 | from mounted local filesystems. | 47 | from mounted local filesystems. | ||
| 38 | """ | 48 | """ | ||
| 39 | 49 | | |||
| 40 | def __init__(self, uri): | 50 | def __init__(self, uri): | ||
| 41 | """Create a new Image object for TestCloud | 51 | """Create a new Image object for TestCloud | ||
| ▲ Show 20 Lines • Show All 137 Lines • ▼ Show 20 Line(s) | 182 | # os.makedirs(config_data.PRISTINE) | |||
| 179 | else: | 189 | else: | ||
| 180 | if not os.path.exists(self.local_path): | 190 | if not os.path.exists(self.local_path): | ||
| 181 | self._download_remote_image(self.remote_path, self.local_path) | 191 | self._download_remote_image(self.remote_path, self.local_path) | ||
| 182 | 192 | | |||
| 183 | self._adjust_image_selinux(self.local_path) | 193 | self._adjust_image_selinux(self.local_path) | ||
| 184 | 194 | | |||
| 185 | return self.local_path | 195 | return self.local_path | ||
| 186 | 196 | | |||
| 197 | def destroy(self): | ||||
| 198 | log.debug("destroying image {}".format(self.local_path)) | ||||
| 199 | | ||||
| 200 | os.remove(self.local_path) | ||||
| 201 | | ||||
| 187 | # def save_pristine(self): | 202 | # def save_pristine(self): | ||
| 188 | # """Save a copy of the downloaded image to the config_dataured PRISTINE dir. | 203 | # """Save a copy of the downloaded image to the config_dataured PRISTINE dir. | ||
| 189 | # Only call this after an image has been downloaded. | 204 | # Only call this after an image has been downloaded. | ||
| 190 | # """ | 205 | # """ | ||
| 191 | # | 206 | # | ||
| 192 | # subprocess.call(['cp', | 207 | # subprocess.call(['cp', | ||
| 193 | # self.local_path, | 208 | # self.local_path, | ||
| 194 | # config_data.PRISTINE]) | 209 | # config_data.PRISTINE]) | ||
| Show All 12 Lines | |||||
| Show All 11 Lines | |||||
| 12 | import os | 12 | import os | ||
| 13 | import sys | 13 | import sys | ||
| 14 | import subprocess | 14 | import subprocess | ||
| 15 | import glob | 15 | import glob | ||
| 16 | import logging | 16 | import logging | ||
| 17 | from pprint import pprint | 17 | from pprint import pprint | ||
| 18 | 18 | | |||
| 19 | import libvirt | 19 | import libvirt | ||
| 20 | import shutil | ||||
| 20 | 21 | | |||
| 21 | from . import config | 22 | from . import config | ||
| 22 | from .exceptions import TestCloudInstanceError | 23 | from .exceptions import TestCloudInstanceError | ||
| 23 | 24 | | |||
| 24 | config_data = config.get_config() | 25 | config_data = config.get_config() | ||
| 25 | 26 | | |||
| 26 | log = logging.getLogger('testCloud.instance') | 27 | log = logging.getLogger('testCloud.instance') | ||
| 27 | 28 | | |||
| Show All 32 Lines | 60 | for domain in conn.listAllDomains(): | |||
| 60 | # the libvirt docs seem to indicate that the second int is for state | 61 | # the libvirt docs seem to indicate that the second int is for state | ||
| 61 | # details, only used when state is ERROR, so only looking at the first | 62 | # details, only used when state is ERROR, so only looking at the first | ||
| 62 | # int returned for domain.state() | 63 | # int returned for domain.state() | ||
| 63 | 64 | | |||
| 64 | domains[domain.name()] = DOMAIN_STATUS_ENUM[domain.state()[0]] | 65 | domains[domain.name()] = DOMAIN_STATUS_ENUM[domain.state()[0]] | ||
| 65 | 66 | | |||
| 66 | return domains | 67 | return domains | ||
| 67 | 68 | | |||
| 68 | def find_instance(name, image): | 69 | def find_instance(name, image=None): | ||
| 69 | """Find an instance using a given name and image, if it exists. | 70 | """Find an instance using a given name and image, if it exists. | ||
| 70 | 71 | | |||
| 71 | :param name: name of instance to find | 72 | :param name: name of instance to find | ||
| 72 | :param image: :py:class:`testCloud.image.Image` | 73 | :param image: :py:class:`testCloud.image.Image` | ||
| 73 | :returns: :py:class:`Instance` if the instance exists, None if it doesn't | 74 | :returns: :py:class:`Instance` if the instance exists, None if it doesn't | ||
| 74 | """ | 75 | """ | ||
| 75 | 76 | | |||
| 76 | instances = _list_instances() | 77 | instances = _list_instances() | ||
| Show All 20 Lines | 93 | for instance in all_instances: | |||
| 97 | instances[instance] = system_domains[instance] | 98 | instances[instance] = system_domains[instance] | ||
| 98 | 99 | | |||
| 99 | return instances | 100 | return instances | ||
| 100 | 101 | | |||
| 101 | class Instance(object): | 102 | class Instance(object): | ||
| 102 | """The Instance class handles the creation, location and customization | 103 | """The Instance class handles the creation, location and customization | ||
| 103 | of existing testCloud instances (which are qcow2 backed from an Image)""" | 104 | of existing testCloud instances (which are qcow2 backed from an Image)""" | ||
| 104 | 105 | | |||
| 105 | def __init__(self, name, image): | 106 | def __init__(self, name, image=None): | ||
| 106 | self.name = name | 107 | self.name = name | ||
| 107 | self.image = image | 108 | self.image = image | ||
| 108 | self.path = "{}/instances/{}".format(config_data.DATA_DIR, self.name) | 109 | self.path = "{}/instances/{}".format(config_data.DATA_DIR, self.name) | ||
| 109 | self.seed_path = "{}/{}-seed.img".format(self.path, self.name) | 110 | self.seed_path = "{}/{}-seed.img".format(self.path, self.name) | ||
| 110 | self.meta_path = "{}/meta".format(self.path) | 111 | self.meta_path = "{}/meta".format(self.path) | ||
| 111 | self.local_disk = "{}/{}-local.qcow2".format(self.path, self.name) | 112 | self.local_disk = "{}/{}-local.qcow2".format(self.path, self.name) | ||
| 112 | 113 | | |||
| 113 | self.ram = 512 | 114 | self.ram = 512 | ||
| 114 | self.vnc = False | 115 | self.vnc = False | ||
| 115 | self.graphics = False | 116 | self.graphics = False | ||
| 116 | self.atomic = False | 117 | self.atomic = False | ||
| 117 | self.seed = None | 118 | self.seed = None | ||
| 118 | self.kernel = None | 119 | self.kernel = None | ||
| 119 | self.initrd = None | 120 | self.initrd = None | ||
| 120 | 121 | | |||
| 121 | # get rid of | 122 | # get rid of | ||
| 122 | self.backing_store = image.local_path | 123 | self.backing_store = image.local_path if image else None | ||
| 123 | self.image_path = config_data.CACHE_DIR + self.name + ".qcow2" | 124 | self.image_path = config_data.CACHE_DIR + self.name + ".qcow2" | ||
| 124 | 125 | | |||
| 125 | def prepare(self): | 126 | def prepare(self): | ||
| 126 | # create the dirs needed for this instance | 127 | # create the dirs needed for this instance | ||
| 127 | self._create_dirs() | 128 | self._create_dirs() | ||
| 128 | 129 | | |||
| 129 | # generate metadata | 130 | # generate metadata | ||
| 130 | self._create_user_data(config_data.PASSWORD) | 131 | self._create_user_data(config_data.PASSWORD) | ||
| ▲ Show 20 Lines • Show All 80 Lines • ▼ Show 20 Line(s) | |||||
| 211 | def _extract_initrd_and_kernel(self): | 212 | def _extract_initrd_and_kernel(self): | ||
| 212 | """Download the necessary kernel and initrd for booting a specified | 213 | """Download the necessary kernel and initrd for booting a specified | ||
| 213 | cloud image.""" | 214 | cloud image.""" | ||
| 214 | 215 | | |||
| 215 | # still need to figure out if the image needs to be copied from | 216 | # still need to figure out if the image needs to be copied from | ||
| 216 | # cache for each instance | 217 | # cache for each instance | ||
| 217 | # for now, assuming that it doesn't | 218 | # for now, assuming that it doesn't | ||
| 218 | 219 | | |||
| 220 | if self.image is None: | ||||
| 221 | raise TestCloudInstanceError("attempted to access image "\ | ||||
| 222 | "information for instance {} but "\ | ||||
| 223 | "that information was not supplied "\ | ||||
| 224 | "at creation time".format(self.name)) | ||||
| 225 | | ||||
| 219 | log.info("extracting kernel and initrd from {}".format(self.image.local_path)) | 226 | log.info("extracting kernel and initrd from {}".format(self.image.local_path)) | ||
| 220 | subprocess.call(['virt-builder', '--get-kernel', | 227 | subprocess.call(['virt-builder', '--get-kernel', | ||
| 221 | self.image.local_path], | 228 | self.image.local_path], | ||
| 222 | cwd=self.path) | 229 | cwd=self.path) | ||
| 223 | 230 | | |||
| 224 | self.kernel = glob.glob("%s/*vmlinuz*" % self.path)[0] | 231 | self.kernel = glob.glob("%s/*vmlinuz*" % self.path)[0] | ||
| 225 | self.initrd = glob.glob("%s/*initramfs*" % self.path)[0] | 232 | self.initrd = glob.glob("%s/*initramfs*" % self.path)[0] | ||
| 226 | 233 | | |||
| 227 | if self.kernel is None or self.initrd is None: | 234 | if self.kernel is None or self.initrd is None: | ||
| 228 | raise IndexError("Unable to find kernel or initrd, did they " + | 235 | raise IndexError("Unable to find kernel or initrd, did they " + | ||
| 229 | "download?") | 236 | "download?") | ||
| 230 | sys.exit(1) | 237 | sys.exit(1) | ||
| 231 | 238 | | |||
| 232 | 239 | | |||
| 233 | def _create_local_disk(self): | 240 | def _create_local_disk(self): | ||
| 234 | """Create a instance using the backing store provided by Image.""" | 241 | """Create a instance using the backing store provided by Image.""" | ||
| 235 | 242 | | |||
| 243 | if self.image is None: | ||||
| 244 | raise TestCloudInstanceError("attempted to access image "\ | ||||
| 245 | "information for instance {} but "\ | ||||
| 246 | "that information was not supplied "\ | ||||
| 247 | "at creation time".format(self.name)) | ||||
| 248 | | ||||
| 236 | subprocess.call(['qemu-img', | 249 | subprocess.call(['qemu-img', | ||
| 237 | 'create', | 250 | 'create', | ||
| 238 | '-f', | 251 | '-f', | ||
| 239 | 'qcow2', | 252 | 'qcow2', | ||
| 240 | '-b', | 253 | '-b', | ||
| 241 | self.image.local_path, | 254 | self.image.local_path, | ||
| 242 | self.local_disk | 255 | self.local_disk | ||
| 243 | ]) | 256 | ]) | ||
| ▲ Show 20 Lines • Show All 83 Lines • ▼ Show 20 Line(s) | 300 | # | |||
| 327 | def boot(self): | 340 | def boot(self): | ||
| 328 | """Boot an already spawned instance.""" | 341 | """Boot an already spawned instance.""" | ||
| 329 | 342 | | |||
| 330 | subprocess.Popen(['virsh', | 343 | subprocess.Popen(['virsh', | ||
| 331 | 'start', | 344 | 'start', | ||
| 332 | self.name | 345 | self.name | ||
| 333 | ]) | 346 | ]) | ||
| 334 | 347 | | |||
| 335 | def selfdestruct(self): | 348 | def _destroy_virsh_instance(self): | ||
| 336 | """Remove an instance from virsh.""" | 349 | """Remove an instance from virsh.""" | ||
| 337 | 350 | | |||
| 338 | for cmd in ['destroy', 'undefine']: | 351 | for cmd in ['destroy', 'undefine']: | ||
| 339 | subprocess.Popen(['virsh', | 352 | subprocess.Popen(['virsh', | ||
| 340 | cmd, | 353 | cmd, | ||
| 341 | self.name | 354 | self.name | ||
| 342 | ]) | 355 | ]) | ||
| 356 | | ||||
| 357 | def _run_virsh_command(self, command): | ||||
| 358 | subprocess.Popen(['virsh', | ||||
| 359 | '-c', | ||||
| 360 | 'qemu:///system', | ||||
| 361 | command, | ||||
| 362 | self.name | ||||
| 363 | ]) | ||||
| 364 | | ||||
| 343 | def start(self): | 365 | def start(self): | ||
| 344 | """Start the instance""" | 366 | """Start the instance""" | ||
| 345 | raise NotImplementedError("Instance start is not yet implemented") | 367 | | ||
| 368 | log.debug("starting instance {} with virsh".format(self.name)) | ||||
| 369 | | ||||
| 370 | # stop (destroy) the vm using virsh | ||||
| 371 | self._run_virsh_command('start') | ||||
| 372 | | ||||
| 346 | 373 | | |||
| 347 | def stop(self): | 374 | def stop(self): | ||
| 348 | """Stop the instance""" | 375 | """Stop the instance""" | ||
| 349 | raise NotImplementedError("Instance stop is not yet implemented") | 376 | | ||
| 377 | log.debug("stopping instance {} with virsh".format(self.name)) | ||||
| 378 | | ||||
| 379 | # stop (destroy) the vm using virsh | ||||
| 380 | self._run_virsh_command('destroy') | ||||
| 381 | | ||||
| 350 | 382 | | |||
| 351 | def destroy(self): | 383 | def destroy(self): | ||
| 352 | """Stop the instance""" | 384 | """Destroy an already stopped instance | ||
| 353 | raise NotImplementedError("Instance destruction is not yet implemented") | 385 | | ||
| 386 | :raises TestCloudInstanceError: if the image does not exist or is still | ||||
| 387 | running | ||||
| 388 | """ | ||||
| 389 | | ||||
| 390 | log.debug("removing instance {} from libvirt with " | ||||
| 391 | "virsh".format(self.name)) | ||||
| 392 | | ||||
| 393 | # this should be changed if/when we start supporting configurable | ||||
| 394 | # libvirt connections | ||||
| 395 | system_domains = _list_system_domains("qemu:///system") | ||||
| 396 | if self.name in system_domains and \ | ||||
| 397 | system_domains[self.name] == 'running': | ||||
| 398 | | ||||
| 399 | raise TestCloudInstanceError("Cannot remove running instance {}. " | ||||
| 400 | "Please stop the instance before " | ||||
| 401 | "removing.".format(self.name)) | ||||
| 402 | | ||||
| 403 | # remove from virsh, assuming that it's stopped already | ||||
| 404 | self._run_virsh_command('undefine') | ||||
| 405 | | ||||
| 406 | log.debug("removing instance {} from disk".format(self.path)) | ||||
| 407 | | ||||
| 408 | # remove from disk | ||||
| 409 | shutil.rmtree(self.path) | ||||
| 354 | 410 | | |||
| 355 | 411 | | |||
| 356 | 412 | | |||