Added poweroff option for stopping machine

Also, clean up raising exceptions.

README.rst

@@ -29,25 +29,55 @@ Requirements
   formats
 
 
+Tested distros
+--------------
+
+- Ubuntu
+  - 18.04
+  - 20.04
+  - 22.04
+  - 24.04
+- Fedora
+  - 37
+  - 38
+  - 39
+  - 40
+- Centos Stream
+  - 8
+  - 9
+- Debian
+  - 10 (buster)
+  - 11 (bullseye)
+  - 12 (bookworm)
+  - 13 (trixie) - prerelease
+
+There is possibility to use whatever OS image which supports cloud-init. Use
+the ``--image`` param for ``create`` command to pass image filename, although
+it's wise to at least discover (or not, but it may be easier in certain
+distributions) what username is supposed to be used as a default user and pass
+it with ``--username`` param.
+
+
 How to run it
 -------------
 
 First, make sure you fulfill the requirements; either by using packages from
-your operating system, or by using virtualenv for Python requirements, i.e.:
+your operating system, or by using virtualenv, i.e.:
 
 .. code:: shell-session
 
    $ python -m virtualenv .venv
    $ . .venv/bin/activate
-   (.venv) $ pip install -r requirements.txt
+   (.venv) $ pip install .
 
-then you can issue:
+You'll have ``boxpy`` command created for you as well.
 
 .. code:: shell-session
 
-   $ alias boxpy='python /path/to/box.py'
+   $ boxpy -V
+   boxpy 1.9.2
 
-or simply link it somewhere in the path:
+Other option is simply link it somewhere in the path:
 
 .. code:: shell-session
 

box.py

@@ -18,12 +18,10 @@ import requests
 import yaml
 
 
-__version__ = "1.9.2"
+__version__ = "1.10.1"
 
 CACHE_DIR = os.environ.get('XDG_CACHE_HOME', os.path.expanduser('~/.cache'))
 CLOUD_IMAGE = "ci.iso"
-FEDORA_RELEASE_MAP = {'37': '1.7', '38': '1.6', '39': '1.5'}
-DEBIAN_CODENAME_MAP = {'12': 'bookworm', '11': 'bullseye', '10': 'buster'}
 TYPE_MAP = {'HardDisk': 'disk', 'DVD': 'dvd', 'Floppy': 'floppy'}
 DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora',
               'centos': 'Centos Stream', 'debian': 'Debian'}
@@ -220,8 +218,22 @@ _boxpy() {
             fi
             ;;
         stop)
+            items=(--poweroff)
             if [[ ${prev} == ${cmd} ]]; then
-                _vms_comp runningvms
+                if [[ ${cmd} = "stop" ]]; then
+                    _vms_comp runningvms
+                else
+                    COMPREPLY=( $(compgen -W "${items[*]}" -- ${cur}) )
+                fi
+            else
+                _get_excluded_items "${items[@]}"
+                COMPREPLY=( $(compgen -W "$result" -- ${cur}) )
+
+                case "${prev}" in
+                    --*)
+                        COMPREPLY=( )
+                        ;;
+                esac
             fi
             ;;
     esac
@@ -675,7 +687,7 @@ class VBoxManage:
         dom = xml.dom.minidom.parse(path)
         if len(dom.getElementsByTagName('HardDisk')) != 1:
             # don't know what to do with multiple discs
-            raise BoxError()
+            raise BoxError
 
         disk = dom.getElementsByTagName('HardDisk')[0]
         location = disk.getAttribute('location')
@@ -818,7 +830,8 @@ class VBoxManage:
                 self.uuid = line.split('UUID:')[1].strip()
 
         if not self.uuid:
-            raise BoxVBoxFailure(f'Cannot create VM "{self.name_or_uuid}".')
+            msg = f'Cannot create VM "{self.name_or_uuid}".'
+            raise BoxVBoxFailure(msg)
 
         port = conf.port if conf.port else self._find_unused_port()
 
@@ -841,14 +854,14 @@ class VBoxManage:
 
         if Run(cmd).returncode != 0:
             LOG.fatal(f'Cannot modify VM "{self.name_or_uuid}"')
-            raise BoxVBoxFailure()
+            raise BoxVBoxFailure
 
         if conf.disable_nested == 'False':
             if Run(['vboxmanage', 'modifyvm', self.name_or_uuid,
                     '--nested-hw-virt', 'on']).returncode != 0:
                 LOG.fatal(f'Cannot set nested virtualization for VM '
                           f'"{self.name_or_uuid}"')
-                raise BoxVBoxFailure()
+                raise BoxVBoxFailure
 
         return self.uuid
 
@@ -884,7 +897,7 @@ class VBoxManage:
         if Run(['vboxmanage', 'modifymedium', 'disk', src, '--resize',
                 str(size), '--move', fullpath]).returncode != 0:
             LOG.fatal('Resizing and moving image %s has failed', dst)
-            raise BoxVBoxFailure()
+            raise BoxVBoxFailure
         return fullpath
 
     def storageattach(self, controller_name, port, type_, image):
@@ -908,7 +921,7 @@ class VBoxManage:
         if Run(['vboxmanage', 'startvm', self.name_or_uuid, '--type',
                 type_]).returncode != 0:
             LOG.fatal('Failed to start: %s', self.name_or_uuid)
-            raise BoxVBoxFailure()
+            raise BoxVBoxFailure
 
     def setextradata(self, key, val):
         res = Run(['vboxmanage', 'setextradata', self.name_or_uuid, key, val])
@@ -922,7 +935,7 @@ class VBoxManage:
         if Run(['vboxmanage', 'modifyvm', self.name_or_uuid, f'--{nic}',
                 kind]).returncode != 0:
             LOG.fatal('Cannot modify VM "%s"', self.name_or_uuid)
-            raise BoxVBoxFailure()
+            raise BoxVBoxFailure
 
     def is_port_in_use(self, port):
         used_ports = self._get_defined_ports()
@@ -984,7 +997,7 @@ class Image:
     IMG = ""
     CHECKSUMTOOL = 'sha256sum'
 
-    def __init__(self, vbox, version, arch, release, fname=None):
+    def __init__(self, vbox, version, arch, fname=None):
         self.vbox = vbox
         self._tmp = tempfile.mkdtemp(prefix='boxpy_')
         self._img_fname = fname
@@ -1047,8 +1060,7 @@ class Image:
             return True
 
         fname = os.path.join(CACHE_DIR, self._img_fname)
-        LOG.header('Downloading image %s from %s', self._img_fname,
-                   self._img_url)
+        LOG.header('Downloading image %s', self._img_url)
         Run(['wget', '-q', self._img_url, '-O', fname])
 
         if not self._checksum():
@@ -1060,15 +1072,15 @@ class Image:
         return True
 
     def _get_checksum(self, fname):
-        raise NotImplementedError()
+        raise NotImplementedError
 
 
 class Ubuntu(Image):
     URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s"
     IMG = "ubuntu-%s-server-cloudimg-%s.img"
 
-    def __init__(self, vbox, version, arch, release, fname=None):
-        super().__init__(vbox, version, arch, release)
+    def __init__(self, vbox, version, arch, fname=None):
+        super().__init__(vbox, version, arch)
         self._img_fname = self.IMG % (version, arch)
         self._img_url = self.URL % (version, self._img_fname)
         self._checksum_file = 'SHA256SUMS'
@@ -1090,13 +1102,18 @@ class Debian(Image):
     URL = "https://cloud.debian.org/images/cloud/%s/daily/latest/%s"
     IMG = "debian-%s-generic-%s-daily.qcow2"
     CHECKSUMTOOL = 'sha512sum'
+    CODENAME_MAP = {'13': 'trixie',
+                    '12': 'bookworm',
+                    '11': 'bullseye',
+                    '10': 'buster'}
 
-    def __init__(self, vbox, version, arch, release, fname=None):
-        super().__init__(vbox, version, arch, release)
+    def __init__(self, vbox, version, arch, fname=None):
+        super().__init__(vbox, version, arch)
+        codename = self.CODENAME_MAP[version]
         self._img_fname = self.IMG % (version, arch)
-        self._img_url = self.URL % (release, self._img_fname)
+        self._img_url = self.URL % (codename, self._img_fname)
         self._checksum_file = 'SHA512SUMS'
-        self._checksum_url = self.URL % (release, self._checksum_file)
+        self._checksum_url = self.URL % (codename, self._checksum_file)
 
     def _get_checksum(self, fname):
         expected_sum = None
@@ -1115,12 +1132,21 @@ class Fedora(Image):
            "Cloud/%s/images/%s")
     IMG = "Fedora-Cloud-Base-%s-%s.%s.qcow2"
     CHKS = "Fedora-Cloud-%s-%s-%s-CHECKSUM"
+    REVISION = {'37': '1.7',
+                '38': '1.6',
+                '39': '1.5',
+                '40': '1.14'}
 
-    def __init__(self, vbox, version, arch, release, fname=None):
-        super().__init__(vbox, version, arch, release)
-        self._img_fname = self.IMG % (version, release, arch)
+    def __init__(self, vbox, version, arch, fname=None):
+        super().__init__(vbox, version, arch)
+        revision = self.REVISION[version]
+        if int(version) > 39:
+            self.IMG = "Fedora-Cloud-Base-Generic.%s-%s-%s.qcow2"
+            self._img_fname = self.IMG % (arch, version, revision)
+        else:
+            self._img_fname = self.IMG % (version, revision, arch)
         self._img_url = self.URL % (version, arch, self._img_fname)
-        self._checksum_file = self.CHKS % (version, release, arch)
+        self._checksum_file = self.CHKS % (version, revision, arch)
         self._checksum_url = self.URL % (version, arch, self._checksum_file)
 
     def _get_checksum(self, fname):
@@ -1198,12 +1224,12 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
                       'realname': 'ubuntu',
                       'img_class': Ubuntu,
                       'amd64': 'amd64',
-                      'default_version': '22.04'},
+                      'default_version': '24.04'},
            'fedora': {'username': 'fedora',
                       'realname': 'fedora',
                       'img_class': Fedora,
                       'amd64': 'x86_64',
-                      'default_version': '39'},
+                      'default_version': '40'},
            'centos': {'username': 'centos',
                       'realname': 'centos',
                       'img_class': CentosStream,
@@ -1217,13 +1243,8 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
 
 
 def get_image_object(vbox, version, image='ubuntu', arch='amd64'):
-    release = None
-    if image == 'fedora':
-        release = FEDORA_RELEASE_MAP[version]
-    if image == 'debian':
-        release = DEBIAN_CODENAME_MAP[version]
     return DISTROS[image]['img_class'](vbox, version, DISTROS[image]['amd64'],
-                                       release, DISTROS[image].get('image'))
+                                       DISTROS[image].get('image'))
 
 
 class IsoImage:
@@ -1604,7 +1625,7 @@ def connect(args):
     return Run(cmd, False).returncode
 
 
-def _set_vmstate(name, state, guitype=None):
+def _set_vmstate(name, state, guitype=None, poweroff=False):
 
     vbox = VBoxManage(name)
     if not vbox.get_vm_info():
@@ -1621,16 +1642,18 @@ def _set_vmstate(name, state, guitype=None):
 
     if state == "start":
         vbox.poweron(guitype)
+    elif poweroff:
+        vbox.poweroff()
     else:
         vbox.acpipowerbutton()
 
 
 def vmstart(args):
-    _set_vmstate(args.name, 'start', args.type)
+    _set_vmstate(args.name, 'start', guitype=args.type)
 
 
 def vmstop(args):
-    _set_vmstate(args.name, 'stop')
+    _set_vmstate(args.name, 'stop', poweroff=args.poweroff)
 
 
 def main():
@@ -1748,6 +1771,8 @@ def main():
 
     stop = subparsers.add_parser('stop', help='stop VM')
     stop.add_argument('name', help='name or UUID of the VM')
+    stop.add_argument('-p', '--poweroff', action='store_true', help='poweroff '
+                      'machine instead of using ACPI power signal')
     stop.set_defaults(func=vmstop)
 
     completion = subparsers.add_parser('completion', help='generate shell '

pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "boxpy"
+dynamic = ["version"]
+authors = [
+    {name = "Roman Dobosz", email = "gryf73@gmail.com"}
+]
+license = {text = "GPLv3"}
+description = "Run Linux cloud image on top of VirtualBox using commandline tool"
+readme = "README.rst"
+requires-python = ">=3.8"
+keywords = ["vboxmanage", "virtualbox", "vm", "virtual machine", "automation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: End Users/Desktop",
+    "Topic :: Terminals",
+    "Topic :: Utilities",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3 :: Only"
+]
+dependencies = [
+    "pyyaml>=5.4.1",
+    "requests>=2.26.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/gryf/boxpy"
+
+[project.scripts]
+boxpy = "box:main"
+
+[tool.setuptools]
+py-modules = ["box"]
+
+[tool.setuptools.dynamic]
+version = {attr = "box.__version__"}
+
+[tool.distutils.bdist_wheel]
+universal = true

requirements.txt

@@ -1,2 +0,0 @@
-pyyaml>=5.4.1
-requests>=2.26.0