testcloud 0.11.7__tar.gz → 0.12.0__tar.gz

testcloud-0.12.0/.fmf/version

@@ -0,0 +1 @@
+1

testcloud-0.12.0/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: release
+run-name: Release ${{ inputs.ref || github.ref_name }}
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      ref:
+        type: string
+        description: 'Tag to release'
+        required: true
+
+permissions: {}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ inputs.ref }}
+          persist-credentials: false
+      - uses: hynek/build-and-inspect-python-package@2abe76da66d0a6a4a227101f9348ee855797cfa5 # v3.0.1
+
+  deploy:
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/testcloud
+    permissions:
+      id-token: write
+      attestations: write
+
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: Packages
+          path: dist
+
+      - name: Generate artifact attestation for sdist and wheel
+        uses: actions/attest-build-provenance@0f67c3f4856b2e3261c31976d6725780e5e4c373 # v4.1.1
+        with:
+          subject-path: "dist/*"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

testcloud-0.12.0/.packit.yaml

@@ -0,0 +1,94 @@
+---
+
+specfile_path: packaging/rpm/testcloud.spec
+files_to_sync:
+  - src: packaging/rpm/
+    dest: ./
+    delete: true
+    filters:
+      - "protect .git*"
+      - "protect sources"
+      - "protect changelog"
+  - .packit.yaml
+
+upstream_package_name: testcloud
+downstream_package_name: testcloud
+
+upstream_project_url: https://github.com/teemtee/testcloud
+issue_repository: https://github.com/teemtee/testcloud
+
+srpm_build_deps:
+  - hatch
+  - python3-hatch-vcs
+
+actions:
+  create-archive:
+    - hatch build -t sdist
+    - bash -c "echo dist/testcloud-$PACKIT_PROJECT_VERSION.tar.gz"
+  get-current-version:
+    - hatch version
+
+targets: &all-targets
+  - fedora-all
+  - epel-9
+  - epel-10
+
+# Common definitions
+_:
+  # Copr jobs under the packit project
+  - &copr-under-packit
+    job: copr_build
+    additional_repos:
+      - copr://@teemtee/stable
+
+  # Copr jobs under the teemtee project
+  - &copr-under-teemtee
+    <<: *copr-under-packit
+    list_on_homepage: true
+    preserve_project: true
+    owner: "@teemtee"
+
+jobs:
+  # Build pull requests
+  - <<: *copr-under-packit
+    trigger: pull_request
+
+  # Build commits merged to main to latest
+  - <<: *copr-under-teemtee
+    trigger: commit
+    branch: main
+    project: latest
+    release_suffix: "{PACKIT_PROJECT_BRANCH}"
+
+  # Build released bits to stable
+  - <<: *copr-under-teemtee
+    trigger: release
+    project: stable
+
+  # Test pull requests
+  - job: tests
+    trigger: pull_request
+
+  # Propose downstream pull requests
+  - job: propose_downstream
+    trigger: release
+    dist_git_branches:
+      rawhide:
+        fast_forward_merge_into:
+          - fedora-branched
+          - epel-10
+          - epel-9
+
+  # Create koji builds
+  - job: koji_build
+    trigger: commit
+    allowed_pr_authors: ["packit", "all_committers"]
+    dist_git_branches: *all-targets
+
+  # Create bodhi updates
+  - job: bodhi_update
+    trigger: commit
+    dist_git_branches:
+      - fedora-branched
+      - epel-10
+      - epel-9

{testcloud-0.11.7/testcloud.egg-info → testcloud-0.12.0}/PKG-INFO

@@ -1,19 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.5
 Name: testcloud
-Version: 0.11.7
+Version: 0.12.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
-Author-email: roshi@fedoraproject.org
-License: GPLv2+
-Description-Content-Type: text/markdown
+Project-URL: Homepage, https://github.com/teemtee/testcloud
+Author-email: Mike Ruckman <roshi@fedoraproject.org>
+License-Expression: GPL-2.0-or-later
 License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: fedora-distro-aliases>=1.5
 Requires-Dist: libvirt-python
+Requires-Dist: packaging
 Requires-Dist: peewee
 Requires-Dist: requests
-Requires-Dist: packaging
 Provides-Extra: image-resolve-caching
-Requires-Dist: requests_cache>=1.2; extra == "image-resolve-caching"
+Requires-Dist: requests-cache>=1.2; extra == 'image-resolve-caching'
+Description-Content-Type: text/markdown
 
 # testcloud
 
@@ -129,7 +130,7 @@ the **virt-manager** tool.
 
 Instances can be created with a different architecture than the host architecture. You'll need to have a proper
 qemu binary installed for this to work (eg. qemu-system-aarch64-core for aarch64 on x86_64 on Fedora). Supported
-architectures in testcloud are: x86_64, aarch64, ppc64le, and s390x. Any combinations of these are supported.
+architectures in testcloud are: x86_64, aarch64, ppc64le, s390x, and riscv64. Any combinations of these are supported.
 
 Some examples:
 
@@ -148,6 +149,11 @@ $ testcloud create centos-stream --arch x86_64
 $ testcloud create fedora:rawhide --arch ppc64le
 ```
 
+```
+# Debian riscv64 on x86_64 (or any other)
+$ testcloud create debian:13 --arch riscv64
+```
+
 ### Starting, stopping, and removing an instance
 
 Instances can be started and stopped using the `instance` interface of
@@ -435,21 +441,28 @@ This is a good place to contribute if you\'re looking to help out.
 
 ### Releasing
 
-Testcloud is being released to all stable Fedora releases, EPEL branches, and PyPi.
+Testcloud is being released to all stable Fedora releases, EPEL branches, and PyPI.
 The release process can be summed up to these steps:
 
-1. A batch of changes has accumulated
-2. Testsuite sanity is verified (via either tox or pytest)
-3. Documentation is verified up-to-date (README.md, docs/, manpages/)
-4. Compatibility with tmt is verified
-5. `__version__` is updated in `testcloud/__init__.py`, `version` is updated in `docs/source/conf.py`
-6. Version bumps are commited, pushed, a new tag is pushed to this repository
-7. A new version is uploaded on PyPi:
-       ```
-       python3 setup.py sdist bdist_wheel && twine upload dist/*
-       ```
-8. Resulting .tar.gz is copied to the dist-git, and build are submitted to all of the stable Fedoras and EPELs
-9. New bodhi builds are queued into the -testing repositories
+ * Make sure the documentation is up-to-date (README.md, docs, manpages)
+ * Add release notes as needed and commit as `Release x.y.z`
+ * Push changes, create a release pull request, make sure all tests pass, merge
+ * Tag the commit with `x.y.z`, push tags using `git push --tags`
+ * Create a new [github release](https://github.com/teemtee/testcloud/releases/) based on the tag above
+ * Mention the most important changes in the release name, do not include version
+ * Push the `Generate release notes` button to create the content, publish the release
+ * Check Fedora [pull requests](https://src.fedoraproject.org/rpms/testcloud/pull-requests) and review proposed changes
+ * Make sure that tests pass and merge individual pull requests
+ * Close the corresponding [release milestone](https://github.com/teemtee/testcloud/milestones)
+
+### Releases
+
+#### 0.12.0
+
+* Add support for the RISC-V architecture
+* Replace deprecated oraculum with `fedora-distro-aliases`
+* Run `chcon` only on systems where SELinux is enabled
+* Enable pull request testing and automate releases
 
 ### Issue Tracking and Roadmap
 

{testcloud-0.11.7 → testcloud-0.12.0}/README.md

@@ -112,7 +112,7 @@ the **virt-manager** tool.
 
 Instances can be created with a different architecture than the host architecture. You'll need to have a proper
 qemu binary installed for this to work (eg. qemu-system-aarch64-core for aarch64 on x86_64 on Fedora). Supported
-architectures in testcloud are: x86_64, aarch64, ppc64le, and s390x. Any combinations of these are supported.
+architectures in testcloud are: x86_64, aarch64, ppc64le, s390x, and riscv64. Any combinations of these are supported.
 
 Some examples:
 
@@ -131,6 +131,11 @@ $ testcloud create centos-stream --arch x86_64
 $ testcloud create fedora:rawhide --arch ppc64le
 ```
 
+```
+# Debian riscv64 on x86_64 (or any other)
+$ testcloud create debian:13 --arch riscv64
+```
+
 ### Starting, stopping, and removing an instance
 
 Instances can be started and stopped using the `instance` interface of
@@ -418,21 +423,28 @@ This is a good place to contribute if you\'re looking to help out.
 
 ### Releasing
 
-Testcloud is being released to all stable Fedora releases, EPEL branches, and PyPi.
+Testcloud is being released to all stable Fedora releases, EPEL branches, and PyPI.
 The release process can be summed up to these steps:
 
-1. A batch of changes has accumulated
-2. Testsuite sanity is verified (via either tox or pytest)
-3. Documentation is verified up-to-date (README.md, docs/, manpages/)
-4. Compatibility with tmt is verified
-5. `__version__` is updated in `testcloud/__init__.py`, `version` is updated in `docs/source/conf.py`
-6. Version bumps are commited, pushed, a new tag is pushed to this repository
-7. A new version is uploaded on PyPi:
-       ```
-       python3 setup.py sdist bdist_wheel && twine upload dist/*
-       ```
-8. Resulting .tar.gz is copied to the dist-git, and build are submitted to all of the stable Fedoras and EPELs
-9. New bodhi builds are queued into the -testing repositories
+ * Make sure the documentation is up-to-date (README.md, docs, manpages)
+ * Add release notes as needed and commit as `Release x.y.z`
+ * Push changes, create a release pull request, make sure all tests pass, merge
+ * Tag the commit with `x.y.z`, push tags using `git push --tags`
+ * Create a new [github release](https://github.com/teemtee/testcloud/releases/) based on the tag above
+ * Mention the most important changes in the release name, do not include version
+ * Push the `Generate release notes` button to create the content, publish the release
+ * Check Fedora [pull requests](https://src.fedoraproject.org/rpms/testcloud/pull-requests) and review proposed changes
+ * Make sure that tests pass and merge individual pull requests
+ * Close the corresponding [release milestone](https://github.com/teemtee/testcloud/milestones)
+
+### Releases
+
+#### 0.12.0
+
+* Add support for the RISC-V architecture
+* Replace deprecated oraculum with `fedora-distro-aliases`
+* Run `chcon` only on systems where SELinux is enabled
+* Enable pull request testing and automate releases
 
 ### Issue Tracking and Roadmap
 

{testcloud-0.11.7 → testcloud-0.12.0}/docs/source/conf.py

@@ -12,6 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import importlib.metadata
 import sys
 import os
 
@@ -55,7 +56,7 @@ copyright = "2016-2024, testCloud devs"
 # built documents.
 #
 # The short X.Y version.
-version = "0.11.7"
+version = importlib.metadata.version("testcloud")
 # The full version, including alpha/beta/rc tags.
 release = version
 

testcloud-0.12.0/docs/source/develop.rst

@@ -0,0 +1,108 @@
+.. _development:
+
+=====================
+Testcloud Development
+=====================
+
+To develop **testcloud**, you need to perform a more complicated process to install all its dependencies, download the source code and perform a set-up.
+
+Prerequisites
+=============
+#. Install the dependencies for testcloud.
+
+    .. code-block:: bash
+
+        $ sudo dnf builddep testcloud
+
+#. Start ``libvirtd``.
+
+    .. code-block:: bash
+
+        $ sudo systemctl start libvirtd
+
+#. Add the ``testcloud`` group to the system.
+
+    .. code-block:: bash
+
+        $ sudo groupadd testcloud
+
+#. Add a user into the ``testcloud`` group.
+
+    .. code-block:: bash
+
+        $ sudo usermod -a -G testcloud $USER
+
+#. Log out of the system and log in again to update the group information on your user or use a login shell on a different terminal.
+
+    .. code-block:: bash
+
+        $ su - $USER
+
+Installation
+============
+
+#. Clone the testcloud repository.
+
+    .. code-block:: bash
+
+        $ git clone https://pagure.io/testcloud.git
+
+#. Create the application directories.
+
+    .. code-block:: bash
+
+        $ sudo mkdir -p -m 775 /var/lib/testcloud
+
+        $ sudo mkdir -p -m 775 /var/lib/testcloud/instances
+
+        $ sudo mkdir -p -m 775 /var/lib/testcloud/backingstores
+
+#. Change ownership on these directories to enable their use with testcloud.
+
+    .. code-block:: bash
+
+        $ sudo chown qemu:testcloud /var/lib/testcloud
+
+        $ sudo chown qemu:testcloud /var/lib/testcloud/instances
+
+        $ sudo chown qemu:testcloud /var/lib/testcloud/backingstores
+
+#. Copy the ``.rules`` file to the ``polkit`` rules.
+
+    .. code-block:: bash
+
+        $ sudo cp conf/99-testcloud-nonroot-libvirt-access.rules /etc/polkit-1/rules.d/
+
+
+Running testcloud
+=================
+
+#. Navigate to your testcloud git repository.
+
+    .. code-block:: bash
+
+        $ cd testcloud
+
+#. Execute the ``run_testcloud.py`` script to run the testcloud. You can use any options as with the regular installation, for example:
+
+    .. code-block:: bash
+
+        $ ./run_testcloud.py instance create ...
+
+.. tip::
+
+    Alternatively, you can use **pip** to install testcloud onto the system and then use it like it has been installed normally.
+    To do it, use the ``pip3 install -e . --user`` command in the project directory.
+
+
+Testing
+=======
+
+There is a small test suite that you can run using ``tox``, to start the tests:
+
+    .. code-block:: bash
+
+        $ tox
+
+Thank you very much for contributions.
+

testcloud-0.12.0/packaging/rpm/testcloud.spec

@@ -0,0 +1,127 @@
+%if 0%{?rhel} <= 9
+%global _sysusersdir /usr/lib/sysusers.d
+%endif
+
+Name:           testcloud
+Version:        0.0.0
+Release:        %autorelease
+Summary:        Tool for running cloud images locally
+
+License:        GPL-2.0-or-later
+URL:            https://github.com/teemtee/testcloud
+Source0:        %{pypi_source testcloud}
+Source1:        testcloud.sysusers
+
+ExclusiveArch: %{kernel_arches} noarch
+BuildArch:      noarch
+
+BuildRequires:  systemd-rpm-macros
+%{?sysusers_requires_compat}
+
+Requires:       polkit
+
+Recommends:     edk2-ovmf
+
+Requires:       python3-%{name} = %{version}-%{release}
+
+%description
+testcloud is a relatively simple system which is capable of booting images
+designed for cloud systems on a local system with minimal configuration.
+testcloud is designed to be (and remain) somewhat simple, trading fancy cloud
+system features for ease of use and sanity in development.
+
+%package -n python3-%{name}
+Summary:        Python 3 interface to testcloud
+
+BuildRequires:  bash-completion
+BuildRequires:  python3-devel
+BuildRequires:  python3-pytest
+
+Requires:       acl
+Requires:       genisoimage
+Requires:       libvirt-daemon
+Requires:       libvirt-daemon-config-network
+Requires:       libvirt-daemon-driver-qemu
+Requires:       libvirt-daemon-driver-storage-core
+Requires:       python3-fedora-distro-aliases
+Recommends:     butane
+Suggests:       python3-libguestfs
+Suggests:       libguestfs-tools-c
+
+%description -n python3-%{name}
+Python 3 interface to testcloud.
+
+%pre
+%sysusers_create_compat %{SOURCE1}
+
+%prep
+%autosetup -n %{name}-%{version} -p1
+# Drop coverage testing
+sed -i 's/ --cov-report=term-missing --cov testcloud//g' tox.ini
+
+%generate_buildrequires
+%pyproject_buildrequires
+
+%build
+export SETUPTOOLS_SCM_PRETEND_VERSION=%{version}
+%pyproject_wheel
+
+%install
+%pyproject_install
+%pyproject_save_files testcloud
+
+# man page
+mkdir -p %{buildroot}%{_mandir}/man1
+install -pm 644 manpages/testcloud.1 %{buildroot}%{_mandir}/man1
+
+# bash completion
+mkdir -p %{buildroot}%{_datadir}/bash-completion/completions
+install -pm 644 conf/testcloud %{buildroot}%{_datadir}/bash-completion/completions/testcloud
+
+# configuration files
+mkdir -p %{buildroot}%{_sysconfdir}/testcloud/
+install conf/settings-example.py %{buildroot}%{_sysconfdir}/testcloud/settings.py
+
+# Create running directory for testcloud
+install -d %{buildroot}%{_sharedstatedir}/testcloud/
+
+# backingstores dir
+install -d %{buildroot}/%{_sharedstatedir}/testcloud/backingstores
+
+# instance dir
+install -d %{buildroot}/%{_sharedstatedir}/testcloud/instances
+
+# create polkit rules dir and install polkit rule
+mkdir -p %{buildroot}%{_sysconfdir}/polkit-1/rules.d
+install conf/99-testcloud-nonroot-libvirt-access.rules %{buildroot}%{_sysconfdir}/polkit-1/rules.d/99-testcloud-nonroot-libvirt-access.rules
+
+# sysusers conf file for creation of testcloud group
+install -p -m644 -D %{SOURCE1} %{buildroot}%{_sysusersdir}/%{name}.conf
+
+%check
+%pyproject_check_import
+%pytest
+
+%files
+%doc README.md
+%{_mandir}/man1/testcloud.1*
+%license LICENSE
+
+%dir %{_sysconfdir}/testcloud
+%dir %attr(0775, qemu, testcloud) %{_sharedstatedir}/testcloud
+%dir %attr(0775, qemu, testcloud) %{_sharedstatedir}/testcloud/backingstores
+%dir %attr(0775, qemu, testcloud) %{_sharedstatedir}/testcloud/instances
+
+%attr(0644, root, root) %{_sysconfdir}/polkit-1/rules.d/99-testcloud-nonroot-libvirt-access.rules
+
+%config(noreplace) %{_sysconfdir}/testcloud/settings.py
+%{_bindir}/testcloud
+%{_bindir}/t7d
+%{_datadir}/bash-completion/completions/testcloud
+
+%{_sysusersdir}/%{name}.conf
+
+%files -n python3-%{name} -f %{pyproject_files}
+
+%changelog
+%autochangelog

testcloud-0.12.0/packaging/rpm/testcloud.sysusers

@@ -0,0 +1 @@
+g testcloud -

testcloud-0.12.0/plans/tmt.fmf

@@ -0,0 +1,20 @@
+summary: Integration testing with tmt
+
+discover:
+    how: fmf
+    test: /test/tmt
+
+provision:
+    how: virtual
+    memory: 4096
+
+execute:
+    how: tmt
+
+adjust:
+  - provision:
+        hardware:
+            virtualization:
+                is-supported: true
+            memory: ">= 8 GB"
+    when: trigger == commit

testcloud-0.12.0/plans/unit.fmf

@@ -0,0 +1,8 @@
+summary: Run unit tests
+
+discover:
+    how: fmf
+    test: /test/unit
+
+execute:
+    how: tmt

testcloud-0.12.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "testcloud"
+dynamic = ["version"]
+description = "A tool to download and boot cloud images locally, with an easy to use API."
+readme = "README.md"
+license = "GPL-2.0-or-later"
+requires-python = ">=3.9"
+authors = [
+    {name = "Mike Ruckman", email = "roshi@fedoraproject.org"},
+]
+dependencies = [
+    "libvirt-python",
+    "peewee",
+    "requests",
+    "packaging",
+    "fedora-distro-aliases>=1.5",
+]
+
+[project.optional-dependencies]
+image_resolve_caching = ["requests_cache>=1.2"]
+
+[project.scripts]
+testcloud = "testcloud.cli:main"
+t7d = "testcloud.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/teemtee/testcloud"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options.version_scheme = "release-branch-semver"
+raw-options.git_describe_command = [
+    "git", "describe", "--dirty", "--tags", "--long",
+    "--abbrev=9", "--match", "*[0-9]*",
+]
+
+[tool.black]
+line-length=140
+
+[tool.pytest.ini_options]
+testpaths = ["test"]

{testcloud-0.11.7 → testcloud-0.12.0}/requirements.txt

@@ -4,6 +4,7 @@
 libvirt-python
 requests
 peewee
+fedora-distro-aliases>=1.5
 #guestfs - after it is on pypi ( https://bugzilla.redhat.com/show_bug.cgi?id=1075594 )
 
 # Test suite requirements

testcloud-0.12.0/test/tmt/regular-user/data/.fmf/version

@@ -0,0 +1 @@
+1

testcloud-0.12.0/test/tmt/regular-user/data/main.fmf

@@ -0,0 +1,22 @@
+/plan:
+    discover:
+        how: fmf
+    provision:
+        how: virtual
+    execute:
+        how: tmt
+
+    /fedora:
+        provision+:
+            image: fedora
+        environment:
+            EXPECTED: Fedora Linux
+
+    /centos:
+        provision+:
+            image: centos-stream-10
+        environment:
+            EXPECTED: CentOS Stream
+
+/test:
+    test: grep "$EXPECTED" /etc/os-release

testcloud-0.12.0/test/tmt/regular-user/main.fmf

@@ -0,0 +1,8 @@
+summary: Regular user can provision a guest
+description:
+    Provision a fedora and centos-stream guest using a
+    short name under a regular user and run a simple check.
+test: ./test.sh
+framework: beakerlib
+require: tmt+provision-virtual
+duration: 20m