testcloud 0.9.13__tar.gz → 0.10.0__tar.gz

{testcloud-0.9.13 → testcloud-0.10.0}/.gitignore

@@ -16,6 +16,7 @@ conf/settings.py
 
 # virtualenv
 /env*/
+/.env*/
 
 # unit testing
 /.coverage

{testcloud-0.9.13/testcloud.egg-info → testcloud-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testcloud
-Version: 0.9.13
+Version: 0.10.0
 Summary: A tool to download and boot cloud images locally, with an easy to use API.
 Home-page: https://pagure.io/testcloud
 Author: Mike Ruckman
@@ -8,8 +8,8 @@ Author-email: roshi@fedoraproject.org
 License: GPLv2+
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Jinja2
 Requires-Dist: libvirt-python
+Requires-Dist: peewee
 Requires-Dist: requests
 Requires-Dist: packaging
 Provides-Extra: image-resolve-caching
@@ -329,7 +329,7 @@ To install **testcloud** for development purposes:
 1. Install the dependencies for **testcloud**.
 
        ```
-       $ sudo dnf install libvirt python3-libvirt libguestfs libguestfs-tools python3-requests python3-jinja2
+       $ sudo dnf builddep testcloud
        ```
 
 2. Start **libvirtd**.

{testcloud-0.9.13 → testcloud-0.10.0}/README.md

@@ -312,7 +312,7 @@ To install **testcloud** for development purposes:
 1. Install the dependencies for **testcloud**.
 
        ```
-       $ sudo dnf install libvirt python3-libvirt libguestfs libguestfs-tools python3-requests python3-jinja2
+       $ sudo dnf builddep testcloud
        ```
 
 2. Start **libvirtd**.

{testcloud-0.9.13 → testcloud-0.10.0}/conf/settings-example.py

@@ -69,6 +69,8 @@
 # failing the boot process. Setting this to 0 disables waiting and
 # returns immediately after starting the boot process.
 #BOOT_TIMEOUT = 160
+# timeout after which we should kill unfinished downloads of images
+#IMAGE_DOWNLOAD_TIMEOUT = 1800
 
 # Maximum space (in GiB) that unused images can occupy in /var/lib/testcloud/backingstores directory
 # Once the limit is reached, testcloud will attempt to remove oldest files

testcloud-0.10.0/conf/testcloud

@@ -0,0 +1,90 @@
+__testcloud()
+{
+    local cur prev prev2 prev3 base_opts image_opts instance_opts instance_create_opts
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    prev2="${COMP_WORDS[COMP_CWORD-2]}"
+    prev3="${COMP_WORDS[COMP_CWORD-3]}"
+    base_opts="instance image -h --help"
+    image_opts="list destroy -h --help"
+    instance_opts="list start stop remove create -c -h --help"
+    instance_create_opts="-h --ram --no-graphic --vnc --timeout --disksize"
+
+    echo ${COMP_WORDS[@]} >> /tmp/compwords
+
+    if [[ ${COMP_WORDS[@]} =~ "testcloud image" || ${COMP_WORDS[@]} =~ "t7d image" ]]; then
+        if [[ ${prev} == "image" ]]; then
+            COMPREPLY=( $(compgen -W "${image_opts}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev2} == "image" && ${prev} == "list" ]]; then
+            return 0
+
+        elif [[ ${prev2} == "image" && ${prev} == "destroy" ]]; then
+            local images
+            images=`testcloud image list 2> /dev/null | grep -E "^  "`
+            COMPREPLY=( $(compgen -W "${images}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev3} == "image" && ${prev2} == "destroy" ]]; then
+            return 0
+        fi
+
+    elif [[ ${COMP_WORDS[@]} =~ "testcloud" || ${COMP_WORDS[@]} =~ "t7d" ]]; then
+        if [[ ${prev} == "create" ]]; then
+            COMPREPLY=( $(compgen -W "${instance_create_opts}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev} == "remove" ]]; then
+            local instances
+            instances="`testcloud list | tail -n+3 | head -n-1 | cut -f1 -d' '` --force"
+            COMPREPLY=( $(compgen -W "${instances}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev2} == "remove" ]]; then
+            local instances
+            COMPREPLY=( $(compgen -W "--force" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev} == "list" ]]; then
+            COMPREPLY=( $(compgen -W "--all" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev} == "stop" ]]; then
+            local instances
+            instances=`testcloud list | grep running | cut -f1 -d" "`
+            COMPREPLY=( $(compgen -W "${instances}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev} == "start" ]]; then
+            local instances
+            instances=`testcloud list | grep shutoff | cut -f1 -d" "`
+            COMPREPLY=( $(compgen -W "${instances}" -- ${cur}) )
+            return 0
+
+        elif [[ ${prev2} == "stop" ]]; then
+            return 0
+
+        elif [[ ${prev2} == "start" ]]; then
+            return 0
+
+        elif [[ ${COMP_WORDS[@]} =~ " -c" && ! ${COMP_WORDS[@]} =~ "///system" && ! ${COMP_WORDS[@]} =~ "///session" ]]; then
+            _get_comp_words_by_ref -n : cur
+            COMPREPLY=( $(compgen -W "qemu:///system qemu:///session" -- ${cur}) )
+            __ltrim_colon_completions "$cur" # left trim colon (blahblah)
+            return 0
+        fi
+
+        # fallback
+        COMPREPLY=( $(compgen -W "${instance_opts}" -- ${cur}) )
+        return 0
+
+
+    elif [[ ${cur} == * ]]; then
+        COMPREPLY=( $(compgen -W "${base_opts}" -- ${cur}) )
+        return 0
+    fi
+}
+
+complete -F __testcloud testcloud t7d

{testcloud-0.9.13 → testcloud-0.10.0}/docs/source/conf.py

@@ -55,7 +55,7 @@ copyright = u'2016-2023, testCloud devs'
 # built documents.
 #
 # The short X.Y version.
-version = '0.9.13'
+version = '0.10.0'
 # The full version, including alpha/beta/rc tags.
 release = version
 

testcloud-0.10.0/manpages/testcloud.1

@@ -0,0 +1,170 @@
+.\" This is the manual page for testcloud.
+.\" Contact lruzicka@redhat.com if you find an errors or a typo.
+.TH TESTCLOUD 1 "11 Nov 2020" "1.0" "testcloud man page"
+.SH NAME
+testcloud \- download \fIqcow2\fR cloud images and boot them locally.
+.SH SYNOPSIS
+\fBtestcloud\fR [-h, --help] [COMMAND]... [OPTION]... [SUBCOMMAND]... [OPTION]...
+.SH DESCRIPTION
+.LP
+\fBtestcloud\fR is a small helper script to download and boot cloud/coreos images
+locally. Testcloud supports wide range of distributions, namely Fedora, Fedora CoreOS,
+CentOS, CentOS Stream, Red Hat Enterprise Linux, Debian and Ubuntu.
+
+\fBtestcloud\fR can run either in system mode or in constrained user session mode,
+which is usefull for running it eg. in unprivileged containers.
+.PP
+To run \fBtestcloud\fR, you need to provide the \fBURL\fR of a cloud image or string in \fBdistribution:version\fR format
+to the script which will be used for booting.
+
+If you do not have an image location of your own, you can use one
+of the images from the \fBFedora Cloud\fR download pages at \fIhttps://alt.fedoraproject.org/cloud/\fR.
+.PP
+Then, \fBtestcloud\fR will download the image and save it in the \fI/var/lib/testcloud/backingstores/\fR.
+It will use this image to create a backing store for a newly created instance which will be placed in
+\fI/var/tmp/instances/\fR. When the same image has been previously downloaded, \fBtestcloud\fR will NOT
+download it again and it will use the current image to create the instance.
+.PP
+When the new instance is created, \fBtestcloud\fR will show its IP address that you can use to
+access the running instance via \fIssh\fR. The login name is \fBfedora\fR and the password is
+\fBpassw0rd\fR. The IP address of an instance is shown when you list the instance (see COMMANDS).
+.PP
+The instance can also be manipulated and controlled with \fBvirt-manager\fR.
+.SH CONFIGURATION
+The default configuration should work for many people. However, if you need to override the
+default settings, you can do it in the \fIsettings.py\fR file. The example file in
+\fIconf/settings-example.py\fR shows the available configuration values which you can
+alter to suit your needs.
+.PP
+The configuration file must be placed in one of the following locations in order to be
+recognized.
+.IP
+\fIconf/settings.py\fR in the git checkout
+.IP
+\fI~/.config/testcloud/settings.py\fR
+.IP
+\fI/etc/testcloud/settings.py\fR
+.SH COMMANDS
+\fBimage\fR
+        Control and manipulate the images (see OPTIONS) for more details.
+.SH OPTIONS
+\fB-h, --help\fR
+        Shows the help message and exits.
+
+\fB-c CONNECTION, --connection CONNECTION\fR
+        Provide the URL of a remote libvirt instance to be used instead of the local one. This option can be used with the \fBinstance\fR command only.
+
+.SH SUBCOMMANDS
+\fBcreate\fR
+        Create a new instance. See the INSTANCE CREATE OPTIONS section for more details.
+
+\fBlist\fR
+        List available running instances and images. Use the \fB--all\fR options to list all instances.
+
+\fBstart\fR
+        Start an existing instance.
+
+\fBstop\fR
+        Stop a running instance.
+
+\fBreboot\fR
+        Force the instance to reboot.
+
+\fBremove\fR
+        Remove an instance or image. If an instance is running, it cannot be removed without the \fB-f\fR option.
+
+\fBdestroy\fR
+        Remove an instance or image. Deprecated, do not use.
+
+\fBclean\fR
+        Remove non-existing or unsynced libvirt VMs from testcloud.
+
+.SH INSTANCE CREATE OPTIONS
+\fBURL\fR
+        Specify the URL from where testcloud should download the instance qcow2 image or distro:version handle. \fBThis option is compulsory\fR.
+        Some examples of supported short urls:
+        - fedora:rawhide (latest compose), fedora:33, fedora:latest (latest Fedora GA image)
+        - fedora-coreos:next, fedora-coreos:testing, fedora-coreos:stable
+        - fedora:qa-matrix (image from https://fedoraproject.org/wiki/Test_Results:Current_Cloud_Test )
+        - centos:XX (eg. centos:8, centos:latest)
+        - centos-stream:XX (eg. centos-stream:8, centos-stream:latest)
+        - ubuntu:release_name (eg. ubuntu:focal, ubuntu:latest)
+        - debian:release_name/release_number (eg. debian:11, debian:sid, debian:latest)
+
+\fB-n, --name NAME\fR
+        Set desired instance name. A nice and memorable name will be generated for you if not specified.
+
+\fB--arch ARCH\fR
+        Set the desired guest architecture. Host arch is the default, supported are: x86_64, aarch64, ppc64le, and s390x.
+
+\fB--ram RAM\fR
+        Set the amount of RAM that will be available to the instance's VM (in MiB).
+
+\fB--vcpus VCPUS\fR
+        Set the number of virtual CPU cores to be assinged to the VM.
+
+\fB--disksize DISKSIZE\fR
+        Set the disk size of the instance VM (in GiB).
+
+\fB--vnc\fR
+        Open a VNC connection to the \fB:1\fR display of the instance VM.
+
+\fB--no-graphic\fR
+        Turn off the instance VM's graphical display.
+
+\fB--timeout TIMEOUT\fR
+        Specify the time (in seconds) to wait for the instance boot to complete. To disable waiting time (default behaviour) set to \fB0\fR.
+
+\fB--disk_number\fR
+        \fB:\fR To provide disk number you want
+
+\fB--nic_number\fR
+        \fB:\fR To provide nic number you want
+
+\fB--virtiofs\fR
+        \fB:\fR To specify a local directory to mount and mount target like <host path>:<guest path>
+
+\fB--iommu\fR
+        \fB:\fR To provide virtual iommu device
+
+\fB ADDITIONAL COREOS OPTIONS\fR
+
+\fB--bu_file BU_FILE\fR
+        \fB:\fR To provide a bu_file you want to use
+
+\fB--ign_file IGN_FILE\fR
+        \fB:\fR To provide an ign_file you want to use
+
+\fB--ssh_path\fR
+        \fB:\fR To provide a ssh pubkey path you want to use
+
+.SH EXAMPLES
+.PP
+Create a new instance:
+.IP
+\fBtestcloud create <URL>\fR
+.PP
+List all available instances:
+.IP
+\fBtestcloud list\fR
+.PP
+Start an existing instance:
+.IP
+\fBtestcloud start <instance_name>\fR
+.PP
+Stop an existing instance:
+.IP
+\fBtestcloud stop <instance_name>\fR
+.PP
+Remove a running instance:
+.IP
+\fBtestcloud remove -f <instance_name>\fR
+
+.SH SEE ALSO
+
+\fBtestcloud's help\fR and the Project's \fBREADME.md\fR file
+
+.SH BUGS
+No known bugs. If you have found a bug, please report it at \fIhttps://bugzilla.redhat.com\fR.
+.SH AUTHOR
+Mike Ruckman (roshi@fedoraproject.org)

{testcloud-0.9.13 → testcloud-0.10.0}/requirements.txt

@@ -1,9 +1,9 @@
 # This is a list of pypi packages to be installed into virtualenv. Alternatively,
 # you can install these as RPMs instead of pypi packages. See README.
 
-Jinja2
 libvirt-python
 requests
+peewee
 #guestfs - after it is on pypi ( https://bugzilla.redhat.com/show_bug.cgi?id=1075594 )
 
 # Test suite requirements

{testcloud-0.9.13 → testcloud-0.10.0}/run_testcloud.py

@@ -1,4 +1,4 @@
-#! /usr/bin/python3
+#! /usr/bin/env python3
 from testcloud import cli
 
 cli.main()

{testcloud-0.9.13 → testcloud-0.10.0}/setup.py

@@ -50,9 +50,10 @@ setup(name='testcloud',
       include_package_data=True,
       cmdclass={'test': PyTest},
       entry_points=dict(console_scripts=["testcloud=testcloud.cli:main", "t7d=testcloud.cli:main"]),
+      data_files = [('share/man/man1', ['manpages/testcloud.1']), ('share/bash-completion/completions', ['conf/testcloud'])],
       install_requires=[
-          'Jinja2',
           'libvirt-python',
+          'peewee',
           'requests',
           'packaging'
       ],

{testcloud-0.9.13 → testcloud-0.10.0}/test/test_image.py

@@ -52,6 +52,44 @@ class TestImageUriProcess(object):
         assert test_data['name'] == self.image_name
         assert test_data['path'] == ref_path
 
+#    def test_http_ur1_params(self):
+#        ref_type = 'http'
+#        ref_path = 'localhost/images/{}'.format(self.image_name)
+#        ref_uri = '{}://{}?url_param=value'.format(ref_type, ref_path)
+#
+#        test_image = image.Image(ref_uri)
+#        test_data = test_image._process_uri(ref_uri)
+#
+#        assert test_data['type'] == ref_type
+#        assert test_data['name'] == self.image_name
+#        assert test_data['path'] == ref_path
+#
+#    def test_http_ur1_anchor(self):
+#        ref_type = 'http'
+#        ref_path = 'localhost/images/{}'.format(self.image_name)
+#        ref_uri = '{}://{}#anchor'.format(ref_type, ref_path)
+#
+#        test_image = image.Image(ref_uri)
+#        test_data = test_image._process_uri(ref_uri)
+#
+#        assert test_data['type'] == ref_type
+#        assert test_data['name'] == self.image_name
+#        assert test_data['path'] == ref_path
+#
+#
+#    def test_http_ur1_url_quoted(self):
+#        ref_type = 'http'
+#        ref_path = 'localhost/images/image%20name.img'
+#        ref_uri = '{}://{}'.format(ref_type, ref_path)
+#
+#        test_image = image.Image(ref_uri)
+#        test_data = test_image._process_uri(ref_uri)
+#
+#        assert test_data['type'] == ref_type
+#        assert test_data['name'] == "image name.img"
+#        assert test_data['path'] == ref_path
+
+
     def test_https_uri(self):
         ref_type = 'https'
         ref_path = 'localhost/images/{}'.format(self.image_name)
@@ -78,6 +116,20 @@ class TestImageUriProcess(object):
         assert test_data['name'] == self.image_name
         assert test_data['path'] == ref_path
 
+#    def test_box(self):
+#        ref_uri = "http://local.host/file.box"
+#        test_image = image.Image(ref_uri)
+#        test_data = test_image._process_uri(ref_uri)
+#        assert test_data['name'] == "file.qcow2"
+#
+#
+#    def test_xz(self):
+#        ref_uri = "http://local.host/file.iso.xz"
+#        test_image = image.Image(ref_uri)
+#        test_data = test_image._process_uri(ref_uri)
+#        assert test_data['name'] == "file.iso"
+
+
     def test_invalid_uri_type(self):
         ref_type = 'ftp'
         ref_path = '/localhost/images/{}'.format(self.image_name)

testcloud-0.10.0/testcloud/__init__.py

@@ -0,0 +1,18 @@
+# NOTE: if you update version, *make sure* to also update `docs/source/conf.py`
+__version__ = "0.10.0"
+
+import signal
+import sys
+import threading
+
+
+def sigterm_handler(_signo, _stack_frame):
+    # A call to sys.exit() is translated into an exception so that clean-up handlers
+    #  (finally clauses of try statements) can be executed, and so that a debugger can
+    #  execute a script without running the risk of losing control.
+    sys.exit(0)
+
+
+
+if threading.current_thread() is threading.main_thread():
+    signal.signal(signal.SIGTERM, sigterm_handler)

{testcloud-0.9.13 → testcloud-0.10.0}/testcloud/cli.py

@@ -80,9 +80,6 @@ def _handle_connection_tip(ip, port, vagrant=False):
             print("ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null cloud-user@%s -p %d" % (ip, port))
 
     print("-"*80)
-    if port != 22:
-        print("Due to limitations of tescloud's user session VMs and bugs in some systems,"
-              " the ssh connection may not be available immediately...")
     if vagrant:
         print("Due to limited support for images without cloud-init pre installed,"
               "it may take up to 2 minutes for connection to be ready...")
@@ -96,9 +93,6 @@ def _handle_permissions_error_cli(error):
     print("su - $USER")
     sys.exit(1)
 
-def _bail_from_legacy_cli(args):
-    log.error("instance subcommand was removed from testcloud. For instance operations, omit the 'instance' keyword.")
-
 def _list_instance(args):
     """Handler for 'list' command. Expects the following elements in args:
         * name(str)
@@ -286,15 +280,14 @@ def _download_image(args):
         sys.exit(1)
 
     try:
+        # FIXME maybe change to smth like   ... if args.url[:4] not in ["http", "file"]
         url = get_image_url(args.url, arch=args.arch) if not any([prot in args.url for prot in ["http", "file"]]) else args.url
     except TestcloudImageError:
         log.error("Couldn't find the desired image ( %s )..." % args.url)
         sys.exit(1)
 
-    tc_image = image.Image(url)
-
     try:
-        tc_image._download_remote_image(url, os.path.join(args.dest_path, os.path.basename(urlparse(url).path)))
+       image.Image._download_remote_image(url, os.path.join(args.dest_path, os.path.basename(urlparse(url).path)))
     except TestcloudImageError:
         log.error("Couldn't download the requested image due to an error.")
         sys.exit(1)
@@ -628,7 +621,6 @@ def _list_image(args):
     for img in images:
         print("  {}".format(img))
 
-
 def _remove_image(args):
     """Handler for 'image remove' command. Expects the following elements in args:
         * name(str)
@@ -642,6 +634,7 @@ def _remove_image(args):
 
     if tc_image is None:
         log.error("image {} not found, cannot remove".format(args.name))
+        return
 
     tc_image.remove()
 
@@ -652,13 +645,6 @@ def get_argparser():
                                        description="Types of commands available",
                                        help="<command> --help")
 
-    instarg_legacy = subparsers.add_parser("instance", help="help on instance options")
-    instarg_legacy.set_defaults(func=_bail_from_legacy_cli)
-
-    instarg_legacy.add_argument("anything",
-                                type=str,
-                                nargs='*')
-
     parser.add_argument("-c",
                          "--connection",
                          default="qemu:///system",
@@ -842,6 +828,7 @@ def get_argparser():
     imgarg_list = imgarg_subp.add_parser("list", help="list images")
     imgarg_list.set_defaults(func=_list_image)
 
+
     # image remove
     imgarg_remove = imgarg_subp.add_parser('remove', help="remove image")
     imgarg_remove.add_argument("name",

{testcloud-0.9.13 → testcloud-0.10.0}/testcloud/config.py

@@ -157,6 +157,8 @@ storage:
     CMD_LINE_ENVS_COREOS = {}
     # timeout, in seconds for instance boot process
     BOOT_TIMEOUT = 160
+    # timeout after which we should kill unfinished downloads of images
+    IMAGE_DOWNLOAD_TIMEOUT = 1800
 
     # Maximum space (in GiB) that unused images can occupy in /var/lib/testcloud/backingstores directory
     # Once the limit is reached, testcloud will attempt to remove oldest files

{testcloud-0.9.13 → testcloud-0.10.0}/testcloud/domain_configuration.py

@@ -222,7 +222,8 @@ class UserNetworkConfiguration(NetworkConfiguration):
     def __init__(self, mac_address, port=6666, device_type="virtio-net-pci") -> None:
         super().__init__()
         self.mac_address = mac_address
-        self.additional_qemu_args = ["-netdev", "user,id=testcloud_net.{},hostfwd=tcp::{}-:22".format(port, port),
+        self.additional_qemu_args = ["-netdev", "user,id=testcloud_net.{},hostfwd=tcp::{}-:22,hostfwd=tcp::{}-:10022".format(
+                                    port, port, (port-1000)),
                                      "-device", "{},addr=1e.0,netdev=testcloud_net.{}".format(device_type, port)]
 
     def generate(self):