Merge pull request #271 from ThePorgs/dev

Release 5.1.0

Author: Dramelac

exegol-images

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-__version__ = "5.0.2"
+__version__ = "5.1.0"
 
 
 class ConstantConfig:
@@ -11,7 +11,6 @@ class ConstantConfig:
     # Exegol documentation link
     landing: str = "https://exegol.com"
     documentation: str = "https://docs.exegol.com"
-    discord: str = "https://discord.gg/cXThyp7D6P"
     # OS Dir full root path of exegol project
     src_root_path_obj: Path = Path(__file__).parent.parent.parent.resolve()
     # Path of the entrypoint.sh

exegol-resources

@@ -34,6 +34,7 @@ def __init__(self) -> None:
         # Shell logging
         self.shell_logging_method: str = "asciinema"
         self.shell_logging_compress: bool = True
+        self.always_enable_shell_logging: bool = False
         # Desktop
         self.desktop_default_enable: bool = False
         self.desktop_default_localhost: bool = True
@@ -92,6 +93,9 @@ def _build_file_content(self) -> str:
     
     # Change the configuration of the shell logging functionality
     shell_logging:
+        # Always enable shell logging
+        always_enable: {self.always_enable_shell_logging}
+    
         #Choice of the method used to record the sessions (script or asciinema)
         logging_method: {self.shell_logging_method}
         
@@ -178,6 +182,7 @@ def _process_data(self) -> None:
         shell_logging_data = config_data.get("shell_logging", {})
         self.shell_logging_method = self._load_config_str(shell_logging_data, 'logging_method', self.shell_logging_method, choices=self.shell_logging_method_options)
         self.shell_logging_compress = self._load_config_bool(shell_logging_data, 'enable_log_compression', self.shell_logging_compress)
+        self.always_enable_shell_logging = self._load_config_bool(shell_logging_data, 'always_enable', self.always_enable_shell_logging)
 
         # Desktop section
         desktop_data = config_data.get("desktop", {})
@@ -213,6 +218,7 @@ def get_configs(self) -> List[str]:
             f"Auto-remove images: {boolFormatter(self.auto_remove_images)}",
             f"Auto-update fs: {boolFormatter(self.auto_update_workspace_fs)}",
             f"Default start shell: [blue]{self.default_start_shell}[/blue]",
+            f"Always enable Shell logging: [blue]{boolFormatter(self.always_enable_shell_logging)}[/blue]",
             f"Shell logging method: [blue]{self.shell_logging_method}[/blue]",
             f"Shell logging compression: {boolFormatter(self.shell_logging_compress)}",
             f"Desktop enabled by default: {boolFormatter(self.desktop_default_enable)}",

exegol/config/ConstantConfig.py

@@ -28,9 +28,9 @@ async def __aenter__(self) -> "ExegolProgress":
         try:
             super(ExegolProgress, self).__enter__()
             return self
-        except Exception:
+        except Exception as e:
             ConsoleLock.release()
-            raise
+            raise e
 
     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
         try:

exegol/config/UserConfig.py

@@ -13,9 +13,9 @@ async def __aenter__(self) -> "ExegolStatus":
         try:
             self.__enter__()
             return self
-        except Exception:
+        except Exception as e:
             ConsoleLock.release()
-            raise
+            raise e
 
     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
         try:

exegol/console/ExegolProgress.py

@@ -121,7 +121,7 @@ async def buildDockerImage(build_stream: Generator) -> None:
         logfile = None
         if ParametersManager().build_log is not None:
             # Opening log file in line buffering mode (1) to support tail -f [file]
-            logfile = open(ParametersManager().build_log, 'a', buffering=1)
+            logfile = open(ParametersManager().build_log, 'a', buffering=1, encoding="utf-8")
         # Follow stream
         for line in build_stream:
             stream_text = line.get("stream", '')

exegol/console/ExegolStatus.py

@@ -33,7 +33,7 @@ def ImageCompleter(prefix: str, parsed_args: Namespace, **kwargs) -> Tuple[str,
             data = [img_cache.name for img_cache in DataCache().get_images_data().data if img_cache.source == "remote"]
         else:
             data = [img_cache.name for img_cache in DataCache().get_images_data().data]
-    except Exception as e:
+    except Exception:
         data = []
     if len(data) == 0:
         # Fallback with default data if the cache is not initialized yet

exegol/console/TUI.py

@@ -1,4 +1,6 @@
-from exegol.console.cli.ExegolCompleter import HybridContainerImageCompleter, VoidCompleter, BuildProfileCompleter
+from typing import Optional
+
+from exegol.console.cli.ExegolCompleter import HybridContainerImageCompleter, VoidCompleter, BuildProfileCompleter, ImageCompleter
 from exegol.console.cli.actions.Command import Command, Option, GroupArg
 from exegol.console.cli.actions.GenericParameters import ContainerCreation, ContainerSpawnShell, ContainerMultiSelector, ContainerSelector, ImageSelector, ImageMultiSelector, ContainerStart
 from exegol.manager.ExegolManager import ExegolManager
@@ -148,14 +150,56 @@ def __init__(self) -> None:
 
         self._usages = {
             "Install or update interactively an exegol image": "exegol update",
-            "Install or update the [bright_blue]full[/bright_blue] image": "exegol update [bright_blue]full[/bright_blue]"
+            "Install or update the [bright_blue]full[/bright_blue] image": "exegol update [bright_blue]full[/bright_blue]",
         }
 
     def __call__(self, *args, **kwargs):
         logger.debug("Running update module")
         return ExegolManager.update
 
 
+class Upgrade(Command, ContainerMultiSelector):
+    """Upgrade an Exegol container"""
+
+    def __init__(self) -> None:
+        Command.__init__(self)
+        ContainerMultiSelector.__init__(self, self.groupArgs)
+
+        self.force_mode = Option("-F", "--force",
+                                 dest="force_mode",
+                                 action="store_true",
+                                 help="Upgrade container without interactive user confirmation.")
+
+        self.no_backup = Option("--no-backup",
+                                dest="no_backup",
+                                action="store_true",
+                                help="Remove the outdated container after the upgrade instead of renaming it.")
+
+        self.image_tag: Optional[Option] = Option("--image",
+                                                  dest="image_tag",
+                                                  action="store",
+                                                  help="Upgrade the container to another Exegol image using its tag",
+                                                  completer=ImageCompleter)
+
+        # Create group parameter for container selection
+        self.groupArgs.append(GroupArg({"arg": self.image_tag, "required": False},
+                                       {"arg": self.no_backup, "required": False},
+                                       {"arg": self.force_mode, "required": False},
+                                       title="[bold cyan]Upgrade[/bold cyan] [blue]specific options[/blue]"))
+
+        self._usages = {
+            "Upgrade an exegol container": "exegol upgrade",
+            "Upgrade the [blue]ctf[/blue] container": "exegol upgrade [blue]ctf[/blue]",
+            "Upgrade the [blue]test[/blue] container to the [bright_blue]full[/bright_blue] image": "exegol upgrade --image [bright_blue]full[/bright_blue] [blue]test[/blue]",
+            "Upgrade [blue]lab[/blue] and [blue]test[/blue] containers without interactive user confirmation": "exegol upgrade -F [blue]lab[/blue] [blue]test[/blue]",
+            "Upgrade every outdated container": "exegol upgrade --all",
+        }
+
+    def __call__(self, *args, **kwargs):
+        logger.debug("Running upgrade module")
+        return ExegolManager.upgrade
+
+
 class Uninstall(Command, ImageMultiSelector):
     """Remove Exegol [default not bold]image(s)[/default not bold]"""
 

exegol/console/cli/ExegolCompleter.py

@@ -64,9 +64,20 @@ def __init__(self, groupArgs: List[GroupArg]):
                                 "If the container already exists, the variable will be present only in the current shell",
                            completer=EnvironCompleter)
 
+        self.capabilities = Option("--cap",
+                                   dest="capabilities",
+                                   metavar='CAPABILITY',  # Do not display available choices
+                                   action="append",
+                                   default=[],
+                                   choices={"NET_ADMIN", "NET_BROADCAST", "SYS_MODULE", "SYS_PTRACE", "SYS_RAWIO",
+                                            "SYS_ADMIN", "LINUX_IMMUTABLE", "MAC_ADMIN", "SYSLOG", "ALL"},
+                                   help="[orange3](dangerous)[/orange3] Capabilities allow to add [orange3]specific[/orange3] privileges to the container "
+                                        "(e.g. need to mount volumes, perform low-level operations on the network, etc).")
+
         # Create group parameter for container options at start
         groupArgs.append(GroupArg({"arg": self.envs, "required": False},
-                                  title="[blue]Container start options[/blue]"))
+                                  {"arg": self.capabilities, "required": False},
+                                  title=f"[blue]Container creation or start options[/blue]"))
 
 
 class ContainerSpawnShell(ContainerStart):
@@ -103,7 +114,7 @@ def __init__(self, groupArgs: List[GroupArg]):
         groupArgs.append(GroupArg({"arg": self.log, "required": False},
                                   {"arg": self.log_method, "required": False},
                                   {"arg": self.log_compress, "required": False},
-                                  title="[blue]Container creation Shell logging options[/blue]"))
+                                  title="[blue]Container shell logging options[/blue]"))
 
         ContainerStart.__init__(self, groupArgs)
 
@@ -219,15 +230,6 @@ def __init__(self, groupArgs: List[GroupArg]):
                                action="store",
                                help="Set a custom hostname to the exegol container (default: exegol-<name>)",
                                completer=VoidCompleter)
-        self.capabilities = Option("--cap",
-                                   dest="capabilities",
-                                   metavar='CAP',  # Do not display available choices
-                                   action="append",
-                                   default=[],
-                                   choices={"NET_ADMIN", "NET_BROADCAST", "SYS_MODULE", "SYS_PTRACE", "SYS_RAWIO",
-                                            "SYS_ADMIN", "LINUX_IMMUTABLE", "MAC_ADMIN", "SYSLOG"},
-                                   help="[orange3](dangerous)[/orange3] Capabilities allow to add [orange3]specific[/orange3] privileges to the container "
-                                        "(e.g. need to mount volumes, perform low-level operations on the network, etc).")
         self.privileged = Option("--privileged",
                                  dest="privileged",
                                  action="store_true",
@@ -252,7 +254,6 @@ def __init__(self, groupArgs: List[GroupArg]):
                                   {"arg": self.volumes, "required": False},
                                   {"arg": self.ports, "required": False},
                                   {"arg": self.hostname, "required": False},
-                                  {"arg": self.capabilities, "required": False},
                                   {"arg": self.privileged, "required": False},
                                   {"arg": self.devices, "required": False},
                                   {"arg": self.X11, "required": False},
@@ -267,13 +268,13 @@ def __init__(self, groupArgs: List[GroupArg]):
                           dest="vpn",
                           default=None,
                           action="store",
-                          help="Setup an OpenVPN connection at the container creation (example: --vpn /home/user/vpn/conf.ovpn)",
+                          help="Setup an OpenVPN (.ovpn) or WireGuard (.conf) connection at the container creation (example: --vpn /home/user/vpn/client.ovpn)",
                           completer=FilesCompleter(["ovpn"], directories=True))
         self.vpn_auth = Option("--vpn-auth",
                                dest="vpn_auth",
                                default=None,
                                action="store",
-                               help="Enter the credentials with a file (first line: username, second line: password) to establish the VPN connection automatically (example: --vpn-auth /home/user/vpn/auth.txt)")
+                               help="Enter the credentials with a file (first line: username, second line: password) to establish the OpenVPN connection automatically (example: --vpn-auth /home/user/vpn/auth.txt)")
 
         groupArgs.append(GroupArg({"arg": self.vpn, "required": False},
                                   {"arg": self.vpn_auth, "required": False},
@@ -294,4 +295,4 @@ def __init__(self, groupArgs: List[GroupArg]):
                                      completer=DesktopConfigCompleter)
         groupArgs.append(GroupArg({"arg": self.desktop, "required": False},
                                   {"arg": self.desktop_config, "required": False},
-                                  title="[blue]Container creation Desktop options[/blue] [spring_green1](beta)[/spring_green1]"))
+                                  title="[blue]Container creation Desktop options[/blue]"))