testcloud 0.11.6__tar.gz → 0.11.7__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: testcloud
-Version: 0.11.6
+Version: 0.11.7
 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.11.6 → testcloud-0.11.7}/docs/source/conf.py

@@ -55,7 +55,7 @@ copyright = "2016-2024, testCloud devs"
 # built documents.
 #
 # The short X.Y version.
-version = "0.11.6"
+version = "0.11.7"
 # The full version, including alpha/beta/rc tags.
 release = version
 

{testcloud-0.11.6 → testcloud-0.11.7}/testcloud/__init__.py

@@ -1,5 +1,5 @@
 # NOTE: if you update version, *make sure* to also update `docs/source/conf.py`
-__version__ = "0.11.6"
+__version__ = "0.11.7"
 
 import signal
 import sys

{testcloud-0.11.6 → testcloud-0.11.7}/testcloud/cli.py

@@ -573,7 +573,7 @@ def _remove_instance(args):
         sys.exit(1)
 
     try:
-        tc_instance.remove(autostop=args.force)
+        tc_instance.remove(autostop=args.force, keep_console_log=False)
     except TestcloudInstanceError as e:
         log.error(e)
         sys.exit(1)

{testcloud-0.11.6 → testcloud-0.11.7}/testcloud/config.py

@@ -100,6 +100,10 @@ class ConfigData(object):
 
     __DATA_DIR = "/var/lib/testcloud"
 
+    # This must point to location where virtlogd is
+    # permitted by SELinux to search
+    CONSOLE_LOG_DIR = "/var/lib/testcloud"
+
     @property
     def DATA_DIR(self):
         return self.__DATA_DIR

{testcloud-0.11.6 → testcloud-0.11.7}/testcloud/domain_configuration.py

@@ -4,12 +4,16 @@ import xml.dom.minidom
 import os
 import uuid
 import platform
+import subprocess
+import logging
 
 from testcloud.exceptions import TestcloudInstanceError
 from testcloud import config
 from testcloud import util
 from testcloud import image
 
+log = logging.getLogger("testcloud.domain_configuration")
+
 config_data = config.get_config()
 
 
@@ -311,6 +315,8 @@ class IOMMUConfiguration:
             model=self.model
         )
 
+def get_console_log_real_path(instance_uuid: str, suffix="console.log"):
+    return os.path.join(config_data.CONSOLE_LOG_DIR, f"{instance_uuid}-{suffix}")
 
 class DomainConfiguration:
     name: str
@@ -325,6 +331,7 @@ class DomainConfiguration:
     qemu_args: list[str]
     qemu_envs: dict[str, str]
     coreos: Optional[bool]
+    console_log_file: Optional[str]
 
     def __init__(self, name) -> None:
         config_data = config.get_config()
@@ -342,6 +349,7 @@ class DomainConfiguration:
         self.network_configuration = None
         self.network_devices = []
         self.tpm_configuration = None
+        self.console_log_file = None
         self.virtiofs_configuration = []
         self.iommu_configuration = None
         self.qemu_args = []
@@ -367,6 +375,14 @@ class DomainConfiguration:
             [device.generate() for device in self.network_devices + ([self.network_configuration] if self.network_configuration else [])]
         )
 
+    def generate_serial_log_conf(self) -> str:
+        _serial_log_conf = ""
+        if self.console_log_file:
+            self._real_console_log_file = get_console_log_real_path(str(self.uuid))
+            _serial_log_conf = f'<log file="{self._real_console_log_file}" append="on"/>'
+
+        return _serial_log_conf
+
     def get_emulator(self) -> str:
         assert self.system_architecture is not None
         qemu_paths = [
@@ -431,6 +447,7 @@ class DomainConfiguration:
                 {storage_devices}
                 {network_configuraton}
                 <serial type='pty'>
+                    {serial_log_configuraton}
                     <target port='0'/>
                 </serial>
                 <console type='pty'>
@@ -459,6 +476,7 @@ class DomainConfiguration:
             emulator_path=self.get_emulator(),
             storage_devices=self.generate_storage_devices(),
             network_configuraton=self.generate_network_devices(),
+            serial_log_configuraton=self.generate_serial_log_conf(),
             tpm=self.tpm_configuration.generate() if self.tpm_configuration else "",
             virtiofs_head=self.generate_virtiofs_head() if self.virtiofs_configuration else "",
             virtiofs_device=self.generate_virtiofs_mounts() if self.virtiofs_configuration else "",
@@ -498,6 +516,7 @@ def _get_default_domain_conf(
     domain_configuration = DomainConfiguration(name)
     domain_configuration.cpu_count = vcpus
     domain_configuration.memory_size = ram * 1024
+    domain_configuration.console_log_file = "{}/console.log".format(domain_configuration.path)
 
     if desired_arch == "x86_64":
         domain_configuration.system_architecture = X86_64ArchitectureConfiguration(

{testcloud-0.11.6 → testcloud-0.11.7}/testcloud/instance.py

@@ -278,6 +278,34 @@ class Instance(object):
         # create the dirs needed for this instance
         try:
             self._create_dirs()
+            if self.domain_configuration.console_log_file:
+                # SELinux is quite picky where it permits virtlogd to write logs,
+                # ConfigData.CONSOLE_LOG_DIR must point to location where virtlogd
+                # is permitted by SELinux to search, create the actual log file
+                # in the CONSOLE_LOG_DIR and point symlink to it
+                console_log_real_path = get_console_log_real_path(str(self.domain_configuration.uuid))
+                log.debug("Creating console log symlink {} -> {}".format(self.domain_configuration.console_log_file, console_log_real_path))
+                os.symlink(console_log_real_path, self.domain_configuration.console_log_file)
+
+                # Create an empty log file beforehand so the file will be
+                # accessible to testcloud. Otherwise libvirt will create a file
+                # only accessible to root.
+                with open(console_log_real_path, 'w'):
+                    pass
+
+                # Change label of log file to virt_log_t and give root permission to write
+                # this allows virtlogd to write to log file when testcloud runs with
+                # qemu:///system connection and SELinux is in enforcing mode
+                chcon_result = subprocess.call(["chcon", "-t", "virt_log_t", console_log_real_path])
+                if chcon_result == 0:
+                    log.debug("Successfuly changed SELinux context of {}".format(console_log_real_path))
+                else:
+                    log.error("Error changing SELinux context of {}".format(console_log_real_path))
+                setfacl_result = subprocess.call(["setfacl", "-m" "u:root:rw", console_log_real_path])
+                if setfacl_result == 0:
+                    log.debug("Successfuly modified ACL of {}".format(console_log_real_path))
+                else:
+                    log.error("Error modifying ACL of {}".format(console_log_real_path))
         except PermissionError:
             raise TestcloudPermissionsError
         if not self.coreos:
@@ -736,7 +764,14 @@ class Instance(object):
                 "you have used a different connection?".format(self.name, self.connection)
             )
 
-    def remove(self, autostop=True):
+    def _remove_real_console_log(self):
+        # remove console log if it exists
+        console_log_real_path = get_console_log_real_path(self._get_domain().UUIDString())
+        if os.path.exists(console_log_real_path):
+            log.debug("Removing console log {}".format(console_log_real_path))
+            os.remove(console_log_real_path)
+
+    def remove(self, autostop=True, keep_console_log=True):
         """Remove an already stopped instance
 
         :param bool autostop: if the instance is running, stop it first
@@ -758,7 +793,8 @@ class Instance(object):
                     "Cannot remove running instance {}. Please stop the "
                     "instance before removing or use '-f' parameter.".format(self.name)
                 )
-
+        if not keep_console_log:
+            self._remove_real_console_log()
         self._remove_from_libvirt()
         self._remove_from_disk()
 

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

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