Add settings validation at startup

Added validation to check mandatory settings are set and verify the Palworld server executable exists before the application starts. This prevents runtime errors from missing configuration.

The validation checks for required settings like server executable path and admin password, and conditionally validates web password when the web server is enabled. It also verifies that the server executable file actually exists at the specified path.

Refactored test code to use a reusable utility method for creating temporary server executable files, making the tests cleaner and more maintainable.

Author: kevinnio

src/main.py

@@ -37,7 +37,15 @@
     # read settings if settings.json exists
     settings_path = os.path.join(os.path.dirname(__file__), "settings.json")
     settings.readSettings(settings_path)
-    
+
+    # Validate settings at startup
+    try:
+        settings.validate_settings()
+    except ValueError as e:
+        logging.error(f"Settings validation failed: {e}")
+        logging.error("Please fix the settings and try again.")
+        exit(1)
+
     # Create instances of managers
     auto_start_manager = None
 
@@ -53,18 +61,18 @@
         exit()
 
     palworld_controller = PalWorldController(client)
-    
+
     # Start the background server info update thread only if server is running
     server_running = palworld_controller.is_palworld_process_running()
     if server_running:
         palworld_controller.start_server_info_update_thread()
 
     if not server_running and settings.autoStart:
         auto_start_manager = AutoStartManager(palworld_controller)
-        
+
         palworld_controller.set_on_server_started_callback(auto_start_manager.stop_listen_thread)
         palworld_controller.set_on_server_stopped_callback(auto_start_manager.listen_palworld_access)
-        
+
         auto_start_manager.listen_palworld_access()
 
     if settings.useWebServer:

src/settings.py

@@ -92,8 +92,7 @@ def __setitem__(self, key, value):
 
     def readSettings(self, file_path):
         file_data = None
-        file_loaded = False
-        
+
         try:
             with open(file_path, 'r') as file:
                 file_data = json.load(file)
@@ -114,7 +113,7 @@ def readSettings(self, file_path):
         if not self.settings.get('sessionSecretKey'):
             self.settings['sessionSecretKey'] = secrets.token_hex(32)
             setattr(self, 'sessionSecretKey', self.settings['sessionSecretKey'])
-            
+
             # Save the generated key back to the settings file
             try:
                 with open(file_path, 'r') as file:
@@ -126,10 +125,36 @@ def readSettings(self, file_path):
             except Exception as e:
                 logging.warning(f"Could not save auto-generated sessionSecretKey to file: {e}")
 
-        # Validation: ensure no setting is None (excluding sessionSecretKey which is auto-generated)
-        missing = [k for k, v in self.settings.items() if v is None]
-        if missing:
-            raise ValueError(f"The following settings areq REQUIRED: {missing}")
+    def validate_settings(self):
+        """Validate that mandatory settings are set and server executable exists.
+
+        Raises:
+            ValueError: If mandatory settings are missing or server executable doesn't exist.
+        """
+        errors = []
+
+        # Check mandatory settings
+        if not self.settings.get('palworldServerExePath'):
+            errors.append("palworldServerExePath is required")
+
+        if not self.settings.get('palworldServerAdminPassword'):
+            errors.append("palworldServerAdminPassword is required")
+
+        # Check webPassword only if web server is enabled
+        if self.settings.get('useWebServer', True) and not self.settings.get('webPassword'):
+            errors.append("webPassword is required when useWebServer is enabled")
+
+        # Check that server executable exists
+        server_exe_path = self.settings.get('palworldServerExePath')
+        if server_exe_path:
+            if not os.path.exists(server_exe_path):
+                errors.append(f"Palworld server executable does not exist at: {server_exe_path}")
+            elif not os.path.isfile(server_exe_path):
+                errors.append(f"Palworld server path is not a file: {server_exe_path}")
+
+        if errors:
+            error_message = "Settings validation failed:\n" + "\n".join(f"  - {error}" for error in errors)
+            raise ValueError(error_message)
 
     def get_git_hash(self):
         """Return the current git commit hash.