1
0
mirror of https://github.com/gryf/boxpy.git synced 2026-02-02 06:05:47 +01:00

4 Commits

Author SHA1 Message Date
14cd805e00 Bump the version.
Also, clean up raising exceptions.
2024-04-30 15:14:39 +02:00
86b02fca1b Keep image information right in the appropriate image subclass. 2024-04-30 15:14:13 +02:00
3d840de3ee Bump Debian, Fedora and Ubuntu versions.
Also, set Ubuntu latest LTS as default.
2024-04-30 15:10:03 +02:00
2a1a4cf40a Use pyproject.toml for installing box module. 2024-03-30 20:34:01 +01:00
4 changed files with 121 additions and 39 deletions

View File

@@ -29,25 +29,55 @@ Requirements
formats 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 How to run it
------------- -------------
First, make sure you fulfill the requirements; either by using packages from 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 .. code:: shell-session
$ python -m virtualenv .venv $ python -m virtualenv .venv
$ . .venv/bin/activate $ . .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 .. 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 .. code:: shell-session

71
box.py
View File

@@ -18,12 +18,10 @@ import requests
import yaml import yaml
__version__ = "1.9.2" __version__ = "1.10.0"
CACHE_DIR = os.environ.get('XDG_CACHE_HOME', os.path.expanduser('~/.cache')) CACHE_DIR = os.environ.get('XDG_CACHE_HOME', os.path.expanduser('~/.cache'))
CLOUD_IMAGE = "ci.iso" 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'} TYPE_MAP = {'HardDisk': 'disk', 'DVD': 'dvd', 'Floppy': 'floppy'}
DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora', DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora',
'centos': 'Centos Stream', 'debian': 'Debian'} 'centos': 'Centos Stream', 'debian': 'Debian'}
@@ -675,7 +673,7 @@ class VBoxManage:
dom = xml.dom.minidom.parse(path) dom = xml.dom.minidom.parse(path)
if len(dom.getElementsByTagName('HardDisk')) != 1: if len(dom.getElementsByTagName('HardDisk')) != 1:
# don't know what to do with multiple discs # don't know what to do with multiple discs
raise BoxError() raise BoxError
disk = dom.getElementsByTagName('HardDisk')[0] disk = dom.getElementsByTagName('HardDisk')[0]
location = disk.getAttribute('location') location = disk.getAttribute('location')
@@ -818,7 +816,8 @@ class VBoxManage:
self.uuid = line.split('UUID:')[1].strip() self.uuid = line.split('UUID:')[1].strip()
if not self.uuid: 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() port = conf.port if conf.port else self._find_unused_port()
@@ -841,14 +840,14 @@ class VBoxManage:
if Run(cmd).returncode != 0: if Run(cmd).returncode != 0:
LOG.fatal(f'Cannot modify VM "{self.name_or_uuid}"') LOG.fatal(f'Cannot modify VM "{self.name_or_uuid}"')
raise BoxVBoxFailure() raise BoxVBoxFailure
if conf.disable_nested == 'False': if conf.disable_nested == 'False':
if Run(['vboxmanage', 'modifyvm', self.name_or_uuid, if Run(['vboxmanage', 'modifyvm', self.name_or_uuid,
'--nested-hw-virt', 'on']).returncode != 0: '--nested-hw-virt', 'on']).returncode != 0:
LOG.fatal(f'Cannot set nested virtualization for VM ' LOG.fatal(f'Cannot set nested virtualization for VM '
f'"{self.name_or_uuid}"') f'"{self.name_or_uuid}"')
raise BoxVBoxFailure() raise BoxVBoxFailure
return self.uuid return self.uuid
@@ -884,7 +883,7 @@ class VBoxManage:
if Run(['vboxmanage', 'modifymedium', 'disk', src, '--resize', if Run(['vboxmanage', 'modifymedium', 'disk', src, '--resize',
str(size), '--move', fullpath]).returncode != 0: str(size), '--move', fullpath]).returncode != 0:
LOG.fatal('Resizing and moving image %s has failed', dst) LOG.fatal('Resizing and moving image %s has failed', dst)
raise BoxVBoxFailure() raise BoxVBoxFailure
return fullpath return fullpath
def storageattach(self, controller_name, port, type_, image): def storageattach(self, controller_name, port, type_, image):
@@ -908,7 +907,7 @@ class VBoxManage:
if Run(['vboxmanage', 'startvm', self.name_or_uuid, '--type', if Run(['vboxmanage', 'startvm', self.name_or_uuid, '--type',
type_]).returncode != 0: type_]).returncode != 0:
LOG.fatal('Failed to start: %s', self.name_or_uuid) LOG.fatal('Failed to start: %s', self.name_or_uuid)
raise BoxVBoxFailure() raise BoxVBoxFailure
def setextradata(self, key, val): def setextradata(self, key, val):
res = Run(['vboxmanage', 'setextradata', self.name_or_uuid, key, val]) res = Run(['vboxmanage', 'setextradata', self.name_or_uuid, key, val])
@@ -922,7 +921,7 @@ class VBoxManage:
if Run(['vboxmanage', 'modifyvm', self.name_or_uuid, f'--{nic}', if Run(['vboxmanage', 'modifyvm', self.name_or_uuid, f'--{nic}',
kind]).returncode != 0: kind]).returncode != 0:
LOG.fatal('Cannot modify VM "%s"', self.name_or_uuid) LOG.fatal('Cannot modify VM "%s"', self.name_or_uuid)
raise BoxVBoxFailure() raise BoxVBoxFailure
def is_port_in_use(self, port): def is_port_in_use(self, port):
used_ports = self._get_defined_ports() used_ports = self._get_defined_ports()
@@ -984,7 +983,7 @@ class Image:
IMG = "" IMG = ""
CHECKSUMTOOL = 'sha256sum' CHECKSUMTOOL = 'sha256sum'
def __init__(self, vbox, version, arch, release, fname=None): def __init__(self, vbox, version, arch, fname=None):
self.vbox = vbox self.vbox = vbox
self._tmp = tempfile.mkdtemp(prefix='boxpy_') self._tmp = tempfile.mkdtemp(prefix='boxpy_')
self._img_fname = fname self._img_fname = fname
@@ -1047,8 +1046,7 @@ class Image:
return True return True
fname = os.path.join(CACHE_DIR, self._img_fname) fname = os.path.join(CACHE_DIR, self._img_fname)
LOG.header('Downloading image %s from %s', self._img_fname, LOG.header('Downloading image %s', self._img_url)
self._img_url)
Run(['wget', '-q', self._img_url, '-O', fname]) Run(['wget', '-q', self._img_url, '-O', fname])
if not self._checksum(): if not self._checksum():
@@ -1060,15 +1058,15 @@ class Image:
return True return True
def _get_checksum(self, fname): def _get_checksum(self, fname):
raise NotImplementedError() raise NotImplementedError
class Ubuntu(Image): class Ubuntu(Image):
URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s" URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s"
IMG = "ubuntu-%s-server-cloudimg-%s.img" IMG = "ubuntu-%s-server-cloudimg-%s.img"
def __init__(self, vbox, version, arch, release, fname=None): def __init__(self, vbox, version, arch, fname=None):
super().__init__(vbox, version, arch, release) super().__init__(vbox, version, arch)
self._img_fname = self.IMG % (version, arch) self._img_fname = self.IMG % (version, arch)
self._img_url = self.URL % (version, self._img_fname) self._img_url = self.URL % (version, self._img_fname)
self._checksum_file = 'SHA256SUMS' self._checksum_file = 'SHA256SUMS'
@@ -1090,13 +1088,18 @@ class Debian(Image):
URL = "https://cloud.debian.org/images/cloud/%s/daily/latest/%s" URL = "https://cloud.debian.org/images/cloud/%s/daily/latest/%s"
IMG = "debian-%s-generic-%s-daily.qcow2" IMG = "debian-%s-generic-%s-daily.qcow2"
CHECKSUMTOOL = 'sha512sum' CHECKSUMTOOL = 'sha512sum'
CODENAME_MAP = {'13': 'trixie',
'12': 'bookworm',
'11': 'bullseye',
'10': 'buster'}
def __init__(self, vbox, version, arch, release, fname=None): def __init__(self, vbox, version, arch, fname=None):
super().__init__(vbox, version, arch, release) super().__init__(vbox, version, arch)
codename = self.CODENAME_MAP[version]
self._img_fname = self.IMG % (version, arch) 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_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): def _get_checksum(self, fname):
expected_sum = None expected_sum = None
@@ -1115,12 +1118,21 @@ class Fedora(Image):
"Cloud/%s/images/%s") "Cloud/%s/images/%s")
IMG = "Fedora-Cloud-Base-%s-%s.%s.qcow2" IMG = "Fedora-Cloud-Base-%s-%s.%s.qcow2"
CHKS = "Fedora-Cloud-%s-%s-%s-CHECKSUM" 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): def __init__(self, vbox, version, arch, fname=None):
super().__init__(vbox, version, arch, release) super().__init__(vbox, version, arch)
self._img_fname = self.IMG % (version, release, 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._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) self._checksum_url = self.URL % (version, arch, self._checksum_file)
def _get_checksum(self, fname): def _get_checksum(self, fname):
@@ -1198,12 +1210,12 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
'realname': 'ubuntu', 'realname': 'ubuntu',
'img_class': Ubuntu, 'img_class': Ubuntu,
'amd64': 'amd64', 'amd64': 'amd64',
'default_version': '22.04'}, 'default_version': '24.04'},
'fedora': {'username': 'fedora', 'fedora': {'username': 'fedora',
'realname': 'fedora', 'realname': 'fedora',
'img_class': Fedora, 'img_class': Fedora,
'amd64': 'x86_64', 'amd64': 'x86_64',
'default_version': '39'}, 'default_version': '40'},
'centos': {'username': 'centos', 'centos': {'username': 'centos',
'realname': 'centos', 'realname': 'centos',
'img_class': CentosStream, 'img_class': CentosStream,
@@ -1217,13 +1229,8 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
def get_image_object(vbox, version, image='ubuntu', arch='amd64'): 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'], return DISTROS[image]['img_class'](vbox, version, DISTROS[image]['amd64'],
release, DISTROS[image].get('image')) DISTROS[image].get('image'))
class IsoImage: class IsoImage:

47
pyproject.toml Normal file
View File

@@ -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

View File

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