| lbrabec | |
| tflink | |
| mkrizek |
| testcloud |
Similarly to 7c58f028f, where instance destroy got renamed to
instance remove, this does the same for image subparser, so that the
terminology is in sync between both subcommands. In order to keep
backwards compatibility, instance/image destroy is now still supported
in CLI, marked as deprecated. This also changes instance and image modules
API, keeping the destroy() methods, printing a deprecation warning and
recommending to use remove().
This is a follow-up of D931.
See testcloud instance -h and testcloud image -h. Try both destroy and remove. Try the API calls (at this very moment, libtaskotron still calls destroy).
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | .gitignore (1 line) | |||
| M | README.rst (2 lines) | |||
| M | docs/source/indepth.rst (2 lines) | |||
| M | docs/source/index.rst (6 lines) | |||
| M | testcloud/cli.py (32 lines) | |||
| M | testcloud/image.py (14 lines) | |||
| M | testcloud/instance.py (6 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 4b75512ae083 | 6a33deb83564 | 25dbb1108da2 | Kamil Páral | rename `image destroy` to `image remove`, add compat options (Show More…) | Jul 15 2016, 8:32 AM |
| 1 | # compile and editor files | 1 | # compile and editor files | ||
|---|---|---|---|---|---|
| 2 | *.py[co] | 2 | *.py[co] | ||
| 3 | *~ | 3 | *~ | ||
| 4 | *.swp | 4 | *.swp | ||
| 5 | 5 | | |||
| 6 | # configuration | 6 | # configuration | ||
| 7 | conf/settings.py | 7 | conf/settings.py | ||
| 8 | 8 | | |||
| 9 | # building & packages | 9 | # building & packages | ||
| 10 | /build/ | 10 | /build/ | ||
| 11 | /dist/ | 11 | /dist/ | ||
| 12 | /*.egg-info | 12 | /*.egg-info | ||
| 13 | /*.tar.gz | 13 | /*.tar.gz | ||
| 14 | /*.rpm | 14 | /*.rpm | ||
| 15 | /docs/build/ | ||||
| 15 | 16 | | |||
| 16 | # virtualenv | 17 | # virtualenv | ||
| 17 | /env_*/ | 18 | /env_*/ | ||
| 18 | 19 | | |||
| 19 | # unit testing | 20 | # unit testing | ||
| 20 | /.coverage | 21 | /.coverage | ||
| Show First 20 Lines • Show All 66 Lines • ▼ Show 20 Line(s) | |||||
| 67 | This will be used as a backing store for your instance under /var/tmp/instances/<instance | 67 | This will be used as a backing store for your instance under /var/tmp/instances/<instance | ||
| 68 | name>. These instances will be viewable within virt-manager. To see your running | 68 | name>. These instances will be viewable within virt-manager. To see your running | ||
| 69 | instances run: | 69 | instances run: | ||
| 70 | 70 | | |||
| 71 | .. code:: bash | 71 | .. code:: bash | ||
| 72 | 72 | | |||
| 73 | testcloud instance list | 73 | testcloud instance list | ||
| 74 | 74 | | |||
| 75 | Instances can be stopped, started and destroyed as well through this interface. To | 75 | Instances can be stopped, started and removed as well through this interface. To | ||
| 76 | see a list of options, run: | 76 | see a list of options, run: | ||
| 77 | 77 | | |||
| 78 | .. code:: bash | 78 | .. code:: bash | ||
| 79 | 79 | | |||
| 80 | testcloud instance -h | 80 | testcloud instance -h | ||
| 81 | 81 | | |||
| 82 | Options | 82 | Options | ||
| 83 | ------- | 83 | ------- | ||
| ▲ Show 20 Lines • Show All 61 Lines • Show Last 20 Lines | |||||
| Show All 29 Lines | |||||
| 30 | same filename already exists - not the most resilient method ever conceived but | 30 | same filename already exists - not the most resilient method ever conceived but | ||
| 31 | it does work in most cases. | 31 | it does work in most cases. | ||
| 32 | 32 | | |||
| 33 | testcloud Instance | 33 | testcloud Instance | ||
| 34 | ------------------ | 34 | ------------------ | ||
| 35 | 35 | | |||
| 36 | A reasonable description of a testcloud instance is that it is a cloud image | 36 | A reasonable description of a testcloud instance is that it is a cloud image | ||
| 37 | backed virtual machine. This virtual machine can be created, stopped, started | 37 | backed virtual machine. This virtual machine can be created, stopped, started | ||
| 38 | or destroyed using the CLI interface from testcloud. | 38 | or removed using the CLI interface from testcloud. | ||
| 39 | 39 | | |||
| 40 | testcloud instances make heavy use of `libvirt <http://libvirt.org/>`_ and | 40 | testcloud instances make heavy use of `libvirt <http://libvirt.org/>`_ and | ||
| 41 | virt-install, part of the `virt-manager <http://virt-manager.org/>`_ application. | 41 | virt-install, part of the `virt-manager <http://virt-manager.org/>`_ application. | ||
| 42 | 42 | | |||
| 43 | General Process | 43 | General Process | ||
| 44 | =============== | 44 | =============== | ||
| 45 | 45 | | |||
| 46 | Each instance has its own directory in the ``DATA_DIR`` and the tuple of | 46 | Each instance has its own directory in the ``DATA_DIR`` and the tuple of | ||
| ▲ Show 20 Lines • Show All 62 Lines • Show Last 20 Lines | |||||
| Show All 30 Lines | |||||
| 31 | image commands and instance commands. | 31 | image commands and instance commands. | ||
| 32 | 32 | | |||
| 33 | Image Commands | 33 | Image Commands | ||
| 34 | -------------- | 34 | -------------- | ||
| 35 | 35 | | |||
| 36 | ``testcloud image list`` | 36 | ``testcloud image list`` | ||
| 37 | List all of the images currently cached by testcloud | 37 | List all of the images currently cached by testcloud | ||
| 38 | 38 | | |||
| 39 | ``testcloud image destroy <image name>`` | 39 | ``testcloud image remove <image name>`` | ||
| 40 | Remove the image named ``<image name>`` from the local image backing store. Make sure | 40 | Remove the image named ``<image name>`` from the local image backing store. Make sure | ||
| 41 | to replace ``<image name>`` with the name of an image which is currently | 41 | to replace ``<image name>`` with the name of an image which is currently | ||
| 42 | cached. | 42 | cached. | ||
| 43 | 43 | | |||
| 44 | Instance Commands | 44 | Instance Commands | ||
| 45 | ----------------- | 45 | ----------------- | ||
| 46 | 46 | | |||
| 47 | ``testcloud instance list`` | 47 | ``testcloud instance list`` | ||
| Show All 10 Lines | |||||
| 58 | 58 | | |||
| 59 | 59 | | |||
| 60 | ``testcloud instance stop <instance name>`` | 60 | ``testcloud instance stop <instance name>`` | ||
| 61 | Stop the instance with name ``<instance name>`` | 61 | Stop the instance with name ``<instance name>`` | ||
| 62 | 62 | | |||
| 63 | ``testcloud instance start <instance name>`` | 63 | ``testcloud instance start <instance name>`` | ||
| 64 | Start the instance with name ``<instance name>`` | 64 | Start the instance with name ``<instance name>`` | ||
| 65 | 65 | | |||
| 66 | ``testcloud instance destroy <instance name>`` | 66 | ``testcloud instance remove <instance name>`` | ||
| 67 | Destroy the instance with name ``<instance name>``. This command will fail if | 67 | Remove the instance with name ``<instance name>``. This command will fail if | ||
| 68 | the instance is not currently stopped | 68 | the instance is not currently stopped | ||
| 69 | 69 | | |||
| 70 | 70 | | |||
| 71 | Getting Help | 71 | Getting Help | ||
| 72 | ============ | 72 | ============ | ||
| 73 | 73 | | |||
| 74 | Self service methods for asking questions and filing tickets: | 74 | Self service methods for asking questions and filing tickets: | ||
| 75 | 75 | | |||
| Show All 37 Lines | |||||
| Show First 20 Lines • Show All 176 Lines • ▼ Show 20 Line(s) | 173 | def _list_image(args): | |||
|---|---|---|---|---|---|
| 177 | """ | 177 | """ | ||
| 178 | log.debug("list images") | 178 | log.debug("list images") | ||
| 179 | images = image.list_images() | 179 | images = image.list_images() | ||
| 180 | print("Current Images:") | 180 | print("Current Images:") | ||
| 181 | for img in images: | 181 | for img in images: | ||
| 182 | print(" {}".format(img)) | 182 | print(" {}".format(img)) | ||
| 183 | 183 | | |||
| 184 | 184 | | |||
| 185 | def _destroy_image(args): | 185 | def _remove_image(args): | ||
| 186 | """Handler for 'image destroy' command. Expects the following elements in args: | 186 | """Handler for 'image remove' command. Expects the following elements in args: | ||
| 187 | * name(str) | 187 | * name(str) | ||
| 188 | 188 | | |||
| 189 | :param args: args from argparser | 189 | :param args: args from argparser | ||
| 190 | """ | 190 | """ | ||
| 191 | 191 | | |||
| 192 | log.debug("destroying image {}".format(args.name)) | 192 | log.debug("removing image {}".format(args.name)) | ||
| 193 | 193 | | |||
| 194 | tc_image = image.find_image(args.name) | 194 | tc_image = image.find_image(args.name) | ||
| 195 | 195 | | |||
| 196 | if tc_image is None: | 196 | if tc_image is None: | ||
| 197 | log.error("image {} not found, cannot destroy".format(args.name)) | 197 | log.error("image {} not found, cannot remove".format(args.name)) | ||
| 198 | 198 | | |||
| 199 | tc_image.destroy() | 199 | tc_image.remove() | ||
| 200 | 200 | | |||
| 201 | 201 | | |||
| 202 | def get_argparser(): | 202 | def get_argparser(): | ||
| 203 | parser = argparse.ArgumentParser(description=description) | 203 | parser = argparse.ArgumentParser(description=description) | ||
| 204 | subparsers = parser.add_subparsers(title="Command Types", | 204 | subparsers = parser.add_subparsers(title="Command Types", | ||
| 205 | description="Types of commands available", | 205 | description="Types of commands available", | ||
| 206 | help="<command> --help") | 206 | help="<command> --help") | ||
| 207 | 207 | | |||
| Show All 34 Lines | |||||
| 242 | instarg_remove = instarg_subp.add_parser("remove", help="remove instance") | 242 | instarg_remove = instarg_subp.add_parser("remove", help="remove instance") | ||
| 243 | instarg_remove.add_argument("name", | 243 | instarg_remove.add_argument("name", | ||
| 244 | help="name of instance to remove") | 244 | help="name of instance to remove") | ||
| 245 | instarg_remove.add_argument("-f", | 245 | instarg_remove.add_argument("-f", | ||
| 246 | "--force", | 246 | "--force", | ||
| 247 | help="Stop the instance if it's running", | 247 | help="Stop the instance if it's running", | ||
| 248 | action="store_true") | 248 | action="store_true") | ||
| 249 | instarg_remove.set_defaults(func=_remove_instance) | 249 | instarg_remove.set_defaults(func=_remove_instance) | ||
| 250 | | ||||
| 251 | instarg_destroy = instarg_subp.add_parser("destroy", help="deprecated alias for remove") | ||||
| 252 | instarg_destroy.add_argument("name", | ||||
| 253 | help="name of instance to remove") | ||||
| 254 | instarg_destroy.add_argument("-f", | ||||
| 255 | "--force", | ||||
| 256 | help="Stop the instance if it's running", | ||||
| 257 | action="store_true") | ||||
| 258 | instarg_destroy.set_defaults(func=_remove_instance) | ||||
| 250 | # instance reboot | 259 | # instance reboot | ||
| 251 | instarg_reboot = instarg_subp.add_parser("reboot", help="reboot instance") | 260 | instarg_reboot = instarg_subp.add_parser("reboot", help="reboot instance") | ||
| 252 | instarg_reboot.add_argument("name", | 261 | instarg_reboot.add_argument("name", | ||
| 253 | help="name of instance to reboot") | 262 | help="name of instance to reboot") | ||
| 254 | instarg_reboot.add_argument("--timeout", | 263 | instarg_reboot.add_argument("--timeout", | ||
| 255 | help="Time (in seconds) to wait for boot to " | 264 | help="Time (in seconds) to wait for boot to " | ||
| 256 | "complete before completion, setting to 0" | 265 | "complete before completion, setting to 0" | ||
| 257 | " disables all waiting.", | 266 | " disables all waiting.", | ||
| Show All 38 Lines | |||||
| 296 | imgarg_subp = imgarg.add_subparsers(title="subcommands", | 305 | imgarg_subp = imgarg.add_subparsers(title="subcommands", | ||
| 297 | description="Types of commands available", | 306 | description="Types of commands available", | ||
| 298 | help="<command> help") | 307 | help="<command> help") | ||
| 299 | 308 | | |||
| 300 | # image list | 309 | # image list | ||
| 301 | imgarg_list = imgarg_subp.add_parser("list", help="list images") | 310 | imgarg_list = imgarg_subp.add_parser("list", help="list images") | ||
| 302 | imgarg_list.set_defaults(func=_list_image) | 311 | imgarg_list.set_defaults(func=_list_image) | ||
| 303 | 312 | | |||
| 304 | # image destroy | 313 | # image remove | ||
| 305 | imgarg_destroy = imgarg_subp.add_parser("destroy", help="destroy image") | 314 | imgarg_remove = imgarg_subp.add_parser('remove', help="remove image") | ||
| 315 | imgarg_remove.add_argument("name", | ||||
| 316 | help="name of image to remove") | ||||
| 317 | imgarg_remove.set_defaults(func=_remove_image) | ||||
| 318 | | ||||
| 319 | imgarg_destroy = imgarg_subp.add_parser('destroy', help="deprecated alias for remove") | ||||
| 306 | imgarg_destroy.add_argument("name", | 320 | imgarg_destroy.add_argument("name", | ||
| 307 | help="name of image to destroy") | 321 | help="name of image to remove") | ||
| 308 | imgarg_destroy.set_defaults(func=_destroy_image) | 322 | imgarg_destroy.set_defaults(func=_remove_image) | ||
| 309 | 323 | | |||
| 310 | return parser | 324 | return parser | ||
| 311 | 325 | | |||
| 312 | 326 | | |||
| 313 | def _configure_logging(level=logging.DEBUG): | 327 | def _configure_logging(level=logging.DEBUG): | ||
| 314 | '''Set up logging framework, when running in main script mode. Should not | 328 | '''Set up logging framework, when running in main script mode. Should not | ||
| 315 | be called when running in library mode. | 329 | be called when running in library mode. | ||
| 316 | 330 | | |||
| ▲ Show 20 Lines • Show All 49 Lines • Show Last 20 Lines | |||||
| Show First 20 Lines • Show All 198 Lines • ▼ Show 20 Line(s) | 189 | def prepare(self): | |||
|---|---|---|---|---|---|
| 199 | else: | 199 | else: | ||
| 200 | if not os.path.exists(self.local_path): | 200 | if not os.path.exists(self.local_path): | ||
| 201 | self._download_remote_image(self.remote_path, self.local_path) | 201 | self._download_remote_image(self.remote_path, self.local_path) | ||
| 202 | 202 | | |||
| 203 | self._adjust_image_selinux(self.local_path) | 203 | self._adjust_image_selinux(self.local_path) | ||
| 204 | 204 | | |||
| 205 | return self.local_path | 205 | return self.local_path | ||
| 206 | 206 | | |||
| 207 | def destroy(self): | 207 | def remove(self): | ||
| 208 | """Destroy the image, removing it from disk. This operation cannot be | 208 | """Remove the image from disk. This operation cannot be undone. | ||
| 209 | undone. | | |||
| 210 | """ | 209 | """ | ||
| 211 | 210 | | |||
| 212 | log.debug("destroying image {}".format(self.local_path)) | 211 | log.debug("removing image {}".format(self.local_path)) | ||
| 213 | | ||||
| 214 | os.remove(self.local_path) | 212 | os.remove(self.local_path) | ||
| 213 | | ||||
| 214 | def destroy(self): | ||||
| 215 | '''A deprecated method. Please call :meth:`remove` instead.''' | ||||
| 216 | | ||||
| 217 | log.debug('DEPRECATED: destroy() method was deprecated. Please use remove()') | ||||
| 218 | self.remove() | ||||
| Show First 20 Lines • Show All 462 Lines • ▼ Show 20 Line(s) | 437 | def remove(self, autostop=True): | |||
|---|---|---|---|---|---|
| 463 | if domain_exists: | 463 | if domain_exists: | ||
| 464 | self._get_domain().undefine() | 464 | self._get_domain().undefine() | ||
| 465 | log.debug("Unregistering domain from libvirt.") | 465 | log.debug("Unregistering domain from libvirt.") | ||
| 466 | 466 | | |||
| 467 | log.debug("removing instance {} from disk".format(self.path)) | 467 | log.debug("removing instance {} from disk".format(self.path)) | ||
| 468 | 468 | | |||
| 469 | # remove from disk | 469 | # remove from disk | ||
| 470 | shutil.rmtree(self.path) | 470 | shutil.rmtree(self.path) | ||
| 471 | | ||||
| 472 | def destroy(self): | ||||
| 473 | '''A deprecated method. Please call :meth:`remove` instead.''' | ||||
| 474 | | ||||
| 475 | log.debug('DEPRECATED: destroy() method was deprecated. Please use remove()') | ||||
| 476 | self.remove() | ||||