testcloud 0.10.0__tar.gz → 0.11.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testcloud
-Version: 0.10.0
+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

{testcloud-0.10.0 → 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.10.0'
+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/pyproject.toml

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

testcloud-0.11.0/setup.py

@@ -0,0 +1,72 @@
+import codecs
+import os
+import re
+
+from setuptools import Command, setup
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+
+def read(*parts):
+    return codecs.open(os.path.join(here, *parts), "r").read()
+
+
+def find_version(*file_paths):
+    version_file = read(*file_paths)
+    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
+    if version_match:
+        return version_match.group(1)
+    raise RuntimeError("Unable to find version string.")
+
+
+class PyTest(Command):
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        import subprocess
+
+        errno = subprocess.call(["pytest-3"])
+        raise SystemExit(errno)
+
+
+with open("README.md") as f:
+    long_description_readme = f.read()
+
+setup(
+    name="testcloud",
+    version=find_version("testcloud", "__init__.py"),
+    description="A tool to download and boot cloud images locally, with an easy to use API.",
+    long_description=long_description_readme,
+    long_description_content_type="text/markdown",
+    author="Mike Ruckman",
+    author_email="roshi@fedoraproject.org",
+    license="GPLv2+",
+    url="https://pagure.io/testcloud",
+    packages=["testcloud", "testcloud.distro_utils"],
+    package_dir={"testcloud": "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=[
+        "libvirt-python",
+        "peewee",
+        "requests",
+        "packaging",
+    ],
+    extras_require={"image_resolve_caching": ["requests_cache>=1.2"]},
+)

{testcloud-0.10.0 → testcloud-0.11.0}/test/test_config.py

@@ -18,11 +18,11 @@ class TestConfig(object):
         config._config = None
 
     def test_get_config_object(self, monkeypatch):
-        '''Simple test to grab a config object, will return default config
+        """Simple test to grab a config object, will return default config
         values.
-        '''
+        """
 
-        monkeypatch.setattr(config, 'CONF_DIRS', [])
+        monkeypatch.setattr(config, "CONF_DIRS", [])
         ref_conf = config.ConfigData()
 
         test_conf = config.get_config()
@@ -30,8 +30,8 @@ class TestConfig(object):
         assert ref_conf.META_DATA == test_conf.META_DATA
 
     def test_missing_config_file(self, monkeypatch):
-        '''Make sure that None is returned if no config files are found'''
-        monkeypatch.setattr(config, 'CONF_DIRS', [])
+        """Make sure that None is returned if no config files are found"""
+        monkeypatch.setattr(config, "CONF_DIRS", [])
 
         test_config_filename = config._find_config_file()
         assert test_config_filename is None
@@ -40,11 +40,11 @@ class TestConfig(object):
     # leaving them here as we have no differentiation between unit and
     # functional tests at the moment
     def test_load_config_object(self, tmpdir):
-        '''load config object from file, make sure it's loaded properly'''
+        """load config object from file, make sure it's loaded properly"""
 
-        refdir = tmpdir.mkdir('conf')
-        ref_conf_filename = '{}/{}'.format(refdir, config.CONF_FILE)
-        with open(ref_conf_filename, 'w+') as ref_conffile:
+        refdir = tmpdir.mkdir("conf")
+        ref_conf_filename = "{}/{}".format(refdir, config.CONF_FILE)
+        with open(ref_conf_filename, "w+") as ref_conffile:
             ref_conffile.write(REF_CONF_CONTENTS)
 
         test_config = config._load_config(ref_conf_filename)
@@ -52,13 +52,13 @@ class TestConfig(object):
         assert test_config.DATA_DIR == REF_DATA_DIR
 
     def test_merge_config_file(self, tmpdir):
-        '''merge loaded config object with defaults, make sure that the defaults
+        """merge loaded config object with defaults, make sure that the defaults
         are overridden.
-        '''
+        """
 
-        refdir = tmpdir.mkdir('conf')
-        ref_conf_filename = '{}/{}'.format(refdir, config.CONF_FILE)
-        with open(ref_conf_filename, 'w+') as ref_conffile:
+        refdir = tmpdir.mkdir("conf")
+        ref_conf_filename = "{}/{}".format(refdir, config.CONF_FILE)
+        with open(ref_conf_filename, "w+") as ref_conffile:
             ref_conffile.write(REF_CONF_CONTENTS)
 
         test_config_obj = config._load_config(ref_conf_filename)
@@ -70,16 +70,16 @@ class TestConfig(object):
         assert test_config.DATA_DIR == REF_DATA_DIR
 
     def test_load_merge_config_file(self, tmpdir, monkeypatch):
-        '''get config, making sure that an addional config file is found. make
+        """get config, making sure that an addional config file is found. make
         sure that default values are properly overridden.
-        '''
+        """
 
-        refdir = tmpdir.mkdir('conf')
-        ref_conf_filename = '{}/{}'.format(refdir, config.CONF_FILE)
-        with open(ref_conf_filename, 'w+') as ref_conffile:
+        refdir = tmpdir.mkdir("conf")
+        ref_conf_filename = "{}/{}".format(refdir, config.CONF_FILE)
+        with open(ref_conf_filename, "w+") as ref_conffile:
             ref_conffile.write(REF_CONF_CONTENTS)
 
-        monkeypatch.setattr(config, 'CONF_DIRS', [str(refdir)])
+        monkeypatch.setattr(config, "CONF_DIRS", [str(refdir)])
         test_config = config.get_config()
 
         assert test_config.DATA_DIR == REF_DATA_DIR

testcloud-0.11.0/test/test_image.py

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# Copyright 2015, Red Hat, Inc.
+# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
+# See the LICENSE file for more details on Licensing
+
+""" This module is for testing the behaviour of the Image class."""
+
+import pytest
+
+from testcloud import image
+from testcloud import exceptions
+
+
+class TestImage:
+
+    def test_image_download_path(self):
+        pass
+
+    def test_image_name(self):
+        pass
+
+    def test_download(self):
+        pass
+
+
+#    def test_save_pristine(self):
+#        pass
+#
+#    def test_load_pristine(self):
+#        pass
+
+
+class TestImageUriProcess(object):
+    """The basic idea of what these tests do is to make sure that uris are
+    parsed properly. http, https and file are OK and supported. ftp is an
+    an example of a type which is not currently supported and should raise an
+    exception."""
+
+    def setup_method(self, method):
+        self.image_name = "image.img"
+        self.len_data = 3
+
+    def test_http_ur1(self):
+        ref_type = "http"
+        ref_path = "localhost/images/{}".format(self.image_name)
+        ref_uri = "{}://{}".format(ref_type, ref_path)
+
+        test_image = image.Image(ref_uri)
+        test_data = test_image._process_uri(ref_uri)
+
+        assert len(test_data) == self.len_data
+        assert test_data["type"] == ref_type
+        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)
+        ref_uri = "{}://{}".format(ref_type, ref_path)
+
+        test_image = image.Image(ref_uri)
+        test_data = test_image._process_uri(ref_uri)
+
+        assert len(test_data) == self.len_data
+        assert test_data["type"] == ref_type
+        assert test_data["name"] == self.image_name
+        assert test_data["path"] == ref_path
+
+    def test_file_uri(self):
+        ref_type = "file"
+        ref_path = "/srv/images/{}".format(self.image_name)
+        ref_uri = "{}://{}".format(ref_type, ref_path)
+
+        test_image = image.Image(ref_uri)
+        test_data = test_image._process_uri(ref_uri)
+
+        assert len(test_data) == self.len_data
+        assert test_data["type"] == ref_type
+        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)
+        ref_uri = "{}://{}".format(ref_type, ref_path)
+
+        with pytest.raises(exceptions.TestcloudImageError):
+            image.Image(ref_uri)
+
+    def test_invalid_uri(self):
+        ref_uri = "leprechaunhandywork"
+
+        with pytest.raises(exceptions.TestcloudImageError):
+            image.Image(ref_uri)

{testcloud-0.10.0 → testcloud-0.11.0}/test/test_instance.py

@@ -11,6 +11,7 @@ from unittest import mock
 
 from testcloud import instance, image, config, domain_configuration
 
+
 class dotdict(dict):
     # https://stackoverflow.com/a/23689767
     """dot.notation access to dictionary attributes"""
@@ -18,6 +19,7 @@ class dotdict(dict):
     __setattr__ = dict.__setitem__
     __delattr__ = dict.__delitem__
 
+
 class TestInstance:
 
     def test_expand_qcow(self):
@@ -45,30 +47,29 @@ class TestFindInstance(object):
         self.conf = config.ConfigData()
 
     def test_non_existant_instance(self, monkeypatch):
-        ref_name = 'test-123'
-        ref_image = image.Image('file:///someimage.qcow2')
+        ref_name = "test-123"
+        ref_image = image.Image("file:///someimage.qcow2")
 
         stub_listdir = mock.Mock()
         stub_listdir.return_value = []
-        monkeypatch.setattr(os, 'listdir', stub_listdir)
+        monkeypatch.setattr(os, "listdir", stub_listdir)
 
         test_instance = instance.find_instance(ref_name, ref_image)
 
         assert test_instance is None
 
     def test_find_exist_instance(self, monkeypatch):
-        ref_name = 'test-123'
-        ref_image = image.Image('file:///someimage.qcow2')
-        ref_path = os.path.join(self.conf.DATA_DIR,
-                                'instances/{}'.format(ref_name))
+        ref_name = "test-123"
+        ref_image = image.Image("file:///someimage.qcow2")
+        ref_path = os.path.join(self.conf.DATA_DIR, "instances/{}".format(ref_name))
 
         stub_listdir = mock.Mock()
         stub_listdir.return_value = [ref_name]
-        monkeypatch.setattr(os, 'listdir', stub_listdir)
+        monkeypatch.setattr(os, "listdir", stub_listdir)
 
         stub_data_dir = mock.Mock()
         stub_data_dir.return_value = dotdict({"DATA_DIR": self.conf.DATA_DIR})
-        monkeypatch.setattr(config, 'get_config', stub_data_dir)
+        monkeypatch.setattr(config, "get_config", stub_data_dir)
 
         test_instance = instance.find_instance(ref_name, ref_image)