poll the started instance until it times out or has a network interface, timeout is configurable in the config file or from the command line
tested locally, works for me
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | conf/settings-example.py (5 lines) | |||
| M | testcloud/cli.py (19 lines) | |||
| M | testcloud/config.py (3 lines) | |||
| M | testcloud/instance.py (60 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| dbb60a6ffa8a | 53062ebfa2fc | 2b2986cfedce | Tim Flink | fixing lint errors in cli | Dec 2 2015, 5:59 PM |
| 2b2986cfedce | fd11d02000cf | f86ae7199a2b | Tim Flink | adding timeout arg to instance start and create, depricating instance.boot | Dec 2 2015, 5:46 PM |
| f86ae7199a2b | bf13f49f9c02 | ff3839baabec | Tim Flink | adding interface checking polling and timeout to interface boot | Dec 2 2015, 5:07 PM |
| Show All 31 Lines | |||||
| 32 | #runcmd: | 32 | #runcmd: | ||
| 33 | # - [ sh, -c, 'echo -e "ROOT_SIZE=4G\nDATA_SIZE=10G" > /etc/sysconfig/docker-storage-setup'] | 33 | # - [ sh, -c, 'echo -e "ROOT_SIZE=4G\nDATA_SIZE=10G" > /etc/sysconfig/docker-storage-setup'] | ||
| 34 | #""" | 34 | #""" | ||
| 35 | # | 35 | # | ||
| 36 | # Extra cmdline args for the qemu invocation. | 36 | # Extra cmdline args for the qemu invocation. | ||
| 37 | # Customize as needed :) | 37 | # Customize as needed :) | ||
| 38 | 38 | | |||
| 39 | #CMD_LINE_ARGS = [] | 39 | #CMD_LINE_ARGS = [] | ||
| 40 | | ||||
| 41 | # The timeout, in seconds, to wait for an instance to boot before | ||||
| 42 | # failing the boot process. Setting this to 0 disables waiting and | ||||
| 43 | # returns immediately after starting the boot process. | ||||
| 44 | #BOOT_TIMEOUT = 30 | ||||
| Show First 20 Lines • Show All 77 Lines • ▼ Show 20 Line(s) | 76 | " re-creating ".format(args.name, | |||
|---|---|---|---|---|---|
| 78 | args.name)) | 78 | args.name)) | ||
| 79 | 79 | | |||
| 80 | else: | 80 | else: | ||
| 81 | tc_instance = instance.Instance(args.name, tc_image) | 81 | tc_instance = instance.Instance(args.name, tc_image) | ||
| 82 | 82 | | |||
| 83 | # prepare instance | 83 | # prepare instance | ||
| 84 | tc_instance.prepare() | 84 | tc_instance.prepare() | ||
| 85 | 85 | | |||
| 86 | # boot instance | 86 | # create instance domain | ||
| 87 | tc_instance.spawn_vm() | 87 | tc_instance.spawn_vm() | ||
| 88 | 88 | | |||
| 89 | # start created domain | ||||
| 90 | tc_instance.boot(args.timeout) | ||||
| 91 | | ||||
| 89 | # find vm ip | 92 | # find vm ip | ||
| 90 | vm_ip = find_vm_ip(args.name) | 93 | vm_ip = find_vm_ip(args.name) | ||
| 91 | 94 | | |||
| 92 | # Write ip to file | 95 | # Write ip to file | ||
| 93 | tc_instance.create_ip_file(vm_ip) | 96 | tc_instance.create_ip_file(vm_ip) | ||
| 94 | print("The IP of vm {}: {}".format(args.name, vm_ip)) | 97 | print("The IP of vm {}: {}".format(args.name, vm_ip)) | ||
| 95 | 98 | | |||
| 96 | 99 | | |||
| 97 | def _start_instance(args): | 100 | def _start_instance(args): | ||
| 98 | """Handler for 'instance start' command. Expects the following elements in args: | 101 | """Handler for 'instance start' command. Expects the following elements in args: | ||
| 99 | * name(str) | 102 | * name(str) | ||
| 100 | 103 | | |||
| 101 | :param args: args from argparser | 104 | :param args: args from argparser | ||
| 102 | """ | 105 | """ | ||
| 103 | log.debug("start instance: {}".format(args.name)) | 106 | log.debug("start instance: {}".format(args.name)) | ||
| 104 | 107 | | |||
| 105 | tc_instance = instance.find_instance(args.name) | 108 | tc_instance = instance.find_instance(args.name) | ||
| 106 | 109 | | |||
| 107 | if tc_instance is None: | 110 | if tc_instance is None: | ||
| 108 | raise TestcloudCliError("Cannot start instance {} because it does " | 111 | raise TestcloudCliError("Cannot start instance {} because it does " | ||
| 109 | "not exist".format(args.name)) | 112 | "not exist".format(args.name)) | ||
| 110 | 113 | | |||
| 111 | tc_instance.start() | 114 | tc_instance.start(args.timeout) | ||
| 112 | 115 | | |||
| 113 | 116 | | |||
| 114 | def _stop_instance(args): | 117 | def _stop_instance(args): | ||
| 115 | """Handler for 'instance stop' command. Expects the following elements in args: | 118 | """Handler for 'instance stop' command. Expects the following elements in args: | ||
| 116 | * name(str) | 119 | * name(str) | ||
| 117 | 120 | | |||
| 118 | :param args: args from argparser | 121 | :param args: args from argparser | ||
| 119 | """ | 122 | """ | ||
| ▲ Show 20 Lines • Show All 78 Lines • ▼ Show 20 Line(s) | 183 | def get_argparser(): | |||
| 198 | instarg_list.add_argument("--all", | 201 | instarg_list.add_argument("--all", | ||
| 199 | help="list all instances, running and stopped", | 202 | help="list all instances, running and stopped", | ||
| 200 | action="store_true") | 203 | action="store_true") | ||
| 201 | 204 | | |||
| 202 | # instance start | 205 | # instance start | ||
| 203 | instarg_start = instarg_subp.add_parser("start", help="start instance") | 206 | instarg_start = instarg_subp.add_parser("start", help="start instance") | ||
| 204 | instarg_start.add_argument("name", | 207 | instarg_start.add_argument("name", | ||
| 205 | help="name of instance to start") | 208 | help="name of instance to start") | ||
| 209 | instarg_start.add_argument("--timeout", | ||||
| 210 | help="Time (in seconds) to wait for boot to " | ||||
| 211 | "complete before completion, setting to 0" | ||||
| 212 | " disables all waiting.", | ||||
| 213 | type=int, | ||||
| 214 | default=config_data.BOOT_TIMEOUT) | ||||
| 206 | instarg_start.set_defaults(func=_start_instance) | 215 | instarg_start.set_defaults(func=_start_instance) | ||
| 207 | 216 | | |||
| 208 | # instance stop | 217 | # instance stop | ||
| 209 | instarg_stop = instarg_subp.add_parser("stop", help="stop instance") | 218 | instarg_stop = instarg_subp.add_parser("stop", help="stop instance") | ||
| 210 | instarg_stop.add_argument("name", | 219 | instarg_stop.add_argument("name", | ||
| 211 | help="name of instance to stop") | 220 | help="name of instance to stop") | ||
| 212 | instarg_stop.set_defaults(func=_stop_instance) | 221 | instarg_stop.set_defaults(func=_stop_instance) | ||
| 213 | 222 | | |||
| Show All 21 Lines | |||||
| 235 | instarg_create.add_argument("--atomic", | 244 | instarg_create.add_argument("--atomic", | ||
| 236 | help="Use this flag if you're booting an Atomic Host.", | 245 | help="Use this flag if you're booting an Atomic Host.", | ||
| 237 | action="store_true") | 246 | action="store_true") | ||
| 238 | # this might work better as a second, required positional arg | 247 | # this might work better as a second, required positional arg | ||
| 239 | instarg_create.add_argument("-u", | 248 | instarg_create.add_argument("-u", | ||
| 240 | "--url", | 249 | "--url", | ||
| 241 | help="URL to qcow2 image is required.", | 250 | help="URL to qcow2 image is required.", | ||
| 242 | type=str) | 251 | type=str) | ||
| 252 | instarg_create.add_argument("--timeout", | ||||
| 253 | help="Time (in seconds) to wait for boot to " | ||||
| 254 | "complete before completion, setting to 0" | ||||
| 255 | " disables all waiting.", | ||||
| 256 | type=int, | ||||
| 257 | default=config_data.BOOT_TIMEOUT) | ||||
| 243 | 258 | | |||
| 244 | imgarg = subparsers.add_parser("image", help="help on image options") | 259 | imgarg = subparsers.add_parser("image", help="help on image options") | ||
| 245 | imgarg_subp = imgarg.add_subparsers(title="subcommands", | 260 | imgarg_subp = imgarg.add_subparsers(title="subcommands", | ||
| 246 | description="Types of commands available", | 261 | description="Types of commands available", | ||
| 247 | help="<command> help") | 262 | help="<command> help") | ||
| 248 | 263 | | |||
| 249 | # image list | 264 | # image list | ||
| 250 | imgarg_list = imgarg_subp.add_parser("list", help="list images") | 265 | imgarg_list = imgarg_subp.add_parser("list", help="list images") | ||
| ▲ Show 20 Lines • Show All 62 Lines • Show Last 20 Lines | |||||
| Show First 20 Lines • Show All 114 Lines • ▼ Show 20 Line(s) | 114 | runcmd: | |||
|---|---|---|---|---|---|
| 115 | - [ sh, -c, 'echo -e "ROOT_SIZE=4G\nDATA_SIZE=10G" > /etc/sysconfig/docker-storage-setup'] | 115 | - [ sh, -c, 'echo -e "ROOT_SIZE=4G\nDATA_SIZE=10G" > /etc/sysconfig/docker-storage-setup'] | ||
| 116 | """ | 116 | """ | ||
| 117 | 117 | | |||
| 118 | # Extra cmdline args for the qemu invocation. | 118 | # Extra cmdline args for the qemu invocation. | ||
| 119 | # Customize as needed :) | 119 | # Customize as needed :) | ||
| 120 | 120 | | |||
| 121 | CMD_LINE_ARGS = [] | 121 | CMD_LINE_ARGS = [] | ||
| 122 | 122 | | |||
| 123 | # timeout, in seconds for instance boot process | ||||
| 124 | BOOT_TIMEOUT = 30 | ||||
| 125 | | ||||
| 123 | def merge_object(self, obj): | 126 | def merge_object(self, obj): | ||
| 124 | '''Overwrites default values with values from a python object which have | 127 | '''Overwrites default values with values from a python object which have | ||
| 125 | names containing all upper case letters. | 128 | names containing all upper case letters. | ||
| 126 | 129 | | |||
| 127 | :param obj: python object containing configuration values | 130 | :param obj: python object containing configuration values | ||
| 128 | :type obj: python object | 131 | :type obj: python object | ||
| 129 | ''' | 132 | ''' | ||
| 130 | 133 | | |||
| 131 | for key in dir(obj): | 134 | for key in dir(obj): | ||
| 132 | if key.isupper(): | 135 | if key.isupper(): | ||
| 133 | setattr(self, key, getattr(obj, key)) | 136 | setattr(self, key, getattr(obj, key)) | ||
| 1 | #!/usr/bin/env python | 1 | #!/usr/bin/env python | ||
|---|---|---|---|---|---|
| 2 | # -*- coding: utf-8 -*- | 2 | # -*- coding: utf-8 -*- | ||
| 3 | # Copyright 2015, Red Hat, Inc. | 3 | # Copyright 2015, Red Hat, Inc. | ||
| 4 | # License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> | 4 | # License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> | ||
| 5 | # See the LICENSE file for more details on Licensing | 5 | # See the LICENSE file for more details on Licensing | ||
| 6 | 6 | | |||
| 7 | """ | 7 | """ | ||
| 8 | Representation of a Testcloud spawned (or to-be-spawned) virtual machine | 8 | Representation of a Testcloud spawned (or to-be-spawned) virtual machine | ||
| 9 | """ | 9 | """ | ||
| 10 | 10 | | |||
| 11 | import os | 11 | import os | ||
| 12 | import sys | 12 | import sys | ||
| 13 | import subprocess | 13 | import subprocess | ||
| 14 | import glob | 14 | import glob | ||
| 15 | import logging | 15 | import logging | ||
| 16 | import time | ||||
| 16 | 17 | | |||
| 17 | import libvirt | 18 | import libvirt | ||
| 18 | import shutil | 19 | import shutil | ||
| 19 | import uuid | 20 | import uuid | ||
| 20 | import jinja2 | 21 | import jinja2 | ||
| 21 | 22 | | |||
| 22 | from . import config | 23 | from . import config | ||
| 23 | from . import util | 24 | from . import util | ||
| ▲ Show 20 Lines • Show All 301 Lines • ▼ Show 20 Line(s) | 324 | def spawn_vm(self): | |||
| 325 | 326 | | |||
| 326 | self.write_domain_xml() | 327 | self.write_domain_xml() | ||
| 327 | 328 | | |||
| 328 | with open(self.xml_path, 'r') as xml_file: | 329 | with open(self.xml_path, 'r') as xml_file: | ||
| 329 | domain_xml = ''.join([x for x in xml_file.readlines()]) | 330 | domain_xml = ''.join([x for x in xml_file.readlines()]) | ||
| 330 | 331 | | |||
| 331 | conn = libvirt.open('qemu:///system') | 332 | conn = libvirt.open('qemu:///system') | ||
| 332 | conn.defineXML(domain_xml) | 333 | conn.defineXML(domain_xml) | ||
| 333 | self.boot() | | |||
| 334 | | ||||
| 335 | log.info("Successfully booted your local cloud image!") | | |||
| 336 | 334 | | |||
| 337 | def expand_qcow(self, size="+10G"): | 335 | def expand_qcow(self, size="+10G"): | ||
| 338 | """Expand the storage for a qcow image. Currently only used for Atomic | 336 | """Expand the storage for a qcow image. Currently only used for Atomic | ||
| 339 | Hosts.""" | 337 | Hosts.""" | ||
| 340 | 338 | | |||
| 341 | log.info("expanding qcow2 image {}".format(self.image_path)) | 339 | log.info("expanding qcow2 image {}".format(self.image_path)) | ||
| 342 | subprocess.call(['qemu-img', | 340 | subprocess.call(['qemu-img', | ||
| 343 | 'resize', | 341 | 'resize', | ||
| 344 | self.image_path, | 342 | self.image_path, | ||
| 345 | size]) | 343 | size]) | ||
| 346 | 344 | | |||
| 347 | log.info("Resized image for Atomic testing...") | 345 | log.info("Resized image for Atomic testing...") | ||
| 348 | return | 346 | return | ||
| 349 | 347 | | |||
| 350 | def set_seed(self, path): | 348 | def set_seed(self, path): | ||
| 351 | """Set the seed image for the instance.""" | 349 | """Set the seed image for the instance.""" | ||
| 352 | self.seed = path | 350 | self.seed = path | ||
| 353 | 351 | | |||
| 354 | def boot(self): | 352 | def boot(self, timeout=config_data.BOOT_TIMEOUT): | ||
| 355 | """Boot an already spawned instance.""" | 353 | """Deprecated alias for :py:meth:`start`""" | ||
| 354 | | ||||
| 355 | log.warn("instance.boot has been depricated and will be removed in a " | ||||
| 356 | "future release, use instance.start instead") | ||||
| 356 | 357 | | |||
| 357 | self._get_domain().create() | 358 | self.start(timeout) | ||
| 358 | 359 | | |||
| 359 | def start(self): | 360 | def start(self, timeout=config_data.BOOT_TIMEOUT): | ||
| 360 | """Start the instance""" | 361 | """Start an existing instance and wait up to :py:attr:`timeout` seconds | ||
| 362 | for a network interface to appear. | ||||
| 361 | 363 | | |||
| 362 | log.debug("attempting to start instance {}.".format(self.name)) | 364 | :param int timeout: number of seconds to wait before timing out. | ||
| 365 | Setting this to 0 will disable timeout, default | ||||
| 366 | is configured with :py:const:`BOOT_TIMEOUT` config | ||||
| 367 | value. | ||||
| 368 | :raises TestcloudInstanceError: if there is an error while creating the | ||||
| 369 | instance or if the timeout is reached | ||||
| 370 | while looking for a network interface | ||||
| 371 | """ | ||||
| 363 | 372 | | |||
| 364 | self._get_domain().create() | 373 | log.debug("Creating domain {}".format(self.name)) | ||
| 374 | dom = self._get_domain() | ||||
| 375 | create_status = dom.create() | ||||
| 376 | | ||||
| 377 | # libvirt doesn't directly raise errors on boot failure, check the | ||||
| 378 | # return code to verify that the boot process was successful from | ||||
| 379 | # libvirt's POV | ||||
| 380 | if create_status != 0: | ||||
| 381 | raise TestcloudInstanceError("Instance {} did not start " | ||||
| 382 | "successfully, see libvirt logs for " | ||||
| 383 | "details".format(self.name)) | ||||
| 384 | log.debug("Polling domain for active network interface") | ||||
| 385 | | ||||
| 386 | poll_tick = 0.5 | ||||
| 387 | timeout_ticks = timeout / poll_tick | ||||
| 388 | count = 0 | ||||
| 389 | | ||||
| 390 | # poll libvirt for domain interfaces, returning when an interface is | ||||
| 391 | # found, indicating that the boot process is post-cloud-init | ||||
| 392 | while count <= timeout_ticks: | ||||
| 393 | domif = dom.interfaceAddresses(0) | ||||
| 394 | | ||||
| 395 | if len(domif) > 0 or timeout_ticks == 0: | ||||
| 396 | log.info("Successfully booted instance {}".format(self.name)) | ||||
| 397 | return | ||||
| 398 | | ||||
| 399 | count += 1 | ||||
| 400 | time.sleep(poll_tick) | ||||
| 401 | | ||||
| 402 | # If we get here, the boot process has timed out | ||||
| 403 | raise TestcloudInstanceError("Instance {} has failed to boot in {} " | ||||
| 404 | "seconds".format(self.name, timeout)) | ||||
| 365 | 405 | | |||
| 366 | def stop(self): | 406 | def stop(self): | ||
| 367 | """Stop the instance""" | 407 | """Stop the instance""" | ||
| 368 | 408 | | |||
| 369 | log.debug("stopping instance {}.".format(self.name)) | 409 | log.debug("stopping instance {}.".format(self.name)) | ||
| 370 | 410 | | |||
| 371 | # stop (destroy) the vm using virsh | 411 | # stop (destroy) the vm using virsh | ||
| 372 | self._get_domain().destroy() | 412 | self._get_domain().destroy() | ||
| Show All 31 Lines | |||||