testcloud 0.9.13__tar.gz → 0.11.0__tar.gz

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testcloud
-Version: 0.9.13
+Version: 0.11.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.11.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.11.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.11.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.11.0}/docs/source/conf.py

@@ -18,56 +18,56 @@ import os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath("../../"))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'testCloud'
-copyright = u'2016-2023, testCloud devs'
+project = "testCloud"
+copyright = "2016-2024, testCloud devs"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.9.13'
+version = "0.11.0"
 # The full version, including alpha/beta/rc tags.
 release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -75,167 +75,161 @@ exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'nature'
+html_theme = "nature"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'testClouddoc'
+htmlhelp_basename = "testClouddoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'testCloud.tex', u'testCloud Documentation',
-   u'testCloud devs', 'manual'),
+    ("index", "testCloud.tex", "testCloud Documentation", "testCloud devs", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'testcloud', u'testCloud Documentation',
-     [u'testCloud devs'], 1)
-]
+man_pages = [("index", "testcloud", "testCloud Documentation", ["testCloud devs"], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -244,19 +238,17 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'testCloud', u'testCloud Documentation',
-   u'testCloud devs', 'testCloud', 'One line description of project.',
-   'Miscellaneous'),
+    ("index", "testCloud", "testCloud Documentation", "testCloud devs", "testCloud", "One line description of project.", "Miscellaneous"),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False

testcloud-0.11.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.11.0/pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length=140

{testcloud-0.9.13 → testcloud-0.11.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.11.0}/run_testcloud.py

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