warlock-manager 2.2.0__tar.gz → 2.2.2__tar.gz

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warlock-manager
-Version: 2.2.0
+Version: 2.2.2
 Summary: Dependency library for game-server management applications.
 Author-email: Charlie Powell <cdp1337@bitsnbytes.dev>
 Maintainer-email: Charlie Powell <cdp1337@bitsnbytes.dev>

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "warlock-manager"
-version = "2.2.0"
+version = "2.2.2"
 description = "Dependency library for game-server management applications."
 readme = "README.md"
 requires-python = ">=3.10"

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager/apps/base_app.py

@@ -193,7 +193,7 @@ class BaseApp(ABC):
 		logging.warning('Invalid option: %s, not present in game configuration!' % option)
 		return ''
 
-	def option_value_updated(self, option: str, previous_value, new_value):
+	def option_value_updated(self, option: str, previous_value, new_value) -> bool | None:
 		"""
 		Handle any special actions needed when an option value is updated
 		:param option:
@@ -203,7 +203,7 @@ class BaseApp(ABC):
 		"""
 		pass
 
-	def set_option(self, option: str, value: str | int | bool):
+	def set_option(self, option: str, value: str | int | bool) -> bool:
 		"""
 		Set a configuration option in the game config
 		:param option:
@@ -211,19 +211,35 @@ class BaseApp(ABC):
 		:return:
 		"""
 		for config in self.configs.values():
-			if option in config.options:
+			opt = config.get_config(option)
+			if opt is not None:
+				# Convert input value to a _system_ value to ensure '0' matches False
+				new_value = opt.to_system_type(value)
 				previous_value = config.get_value(option)
-				if previous_value == value:
+				if previous_value == new_value:
 					# No change
-					return
+					return True
 
 				config.set_value(option, value)
 				config.save()
 
-				self.option_value_updated(option, previous_value, value)
-				return
+				# Allow the extending service to handle any special actions needed for this option update
+				post_result = self.option_value_updated(option, previous_value, new_value)
+				if post_result is True:
+					# Post-update either returned a successful operation or nothing at all, either is fine.
+					logging.info('Updated option %s to %s and ran post-update actions successfully' % (option, value))
+					return True
+				elif post_result is None:
+					logging.debug('Post-update returned None, this is fine as it indicates no post-actions taken')
+					logging.info('Updated option %s to %s' % (option, value))
+					return True
+				else:
+					# Post-update explictly returned False, this indicates a problem occurred.
+					logging.warning('Configuration saved, but unable to complete post-update actions!')
+					return False
 
 		logging.warning('Invalid option: %s, not present in game configuration!' % option)
+		return False
 
 	def get_option_options(self, option: str):
 		"""

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager/apps/steam_app.py

@@ -6,7 +6,8 @@ from abc import ABC
 import logging
 
 from .base_app import BaseApp
-from ..libs.cmd import Cmd
+from warlock_manager.libs.cmd import Cmd
+from warlock_manager.libs import utils
 
 
 def guess_steamcmd_path() -> str:
@@ -209,7 +210,12 @@ def steamcmd_parse_manifest(manifest_content):
 
 class SteamApp(BaseApp, ABC):
 	"""
-	Game application manager
+	Game application manager for Steam-based games
+
+	Expects the game to have the following configuration keys:
+
+	* Steam Branch - Branch to install the game from (default: public)
+	* Steam Branch Password - Password for the Steam branch (optional)
 	"""
 
 	def __init__(self):
@@ -262,7 +268,7 @@ class SteamApp(BaseApp, ABC):
 
 		# Run the steamcmd command
 		cmd = Cmd(command)
-		cmd.sudo(self.get_app_uid())
+		cmd.sudo(utils.get_app_uid())
 		cmd.is_cacheable()
 
 		# Output from command should be Steam manifest format, parse it
@@ -293,13 +299,38 @@ class SteamApp(BaseApp, ABC):
 
 		return list(info['depots']['branches'].keys())
 
+	def option_value_updated(self, option: str, previous_value, new_value):
+		"""
+		Handle any special actions needed when an option value is updated
+
+		:param option:
+		:param previous_value:
+		:param new_value:
+		:return:
+		"""
+		if option == 'Steam Branch':
+			# If the steam branch is updated, update the game binaries automatically.
+			self.update()
+
+	def get_option_options(self, option: str):
+		"""
+		Get the list of possible options for a configuration option
+		:param option:
+		:return:
+		"""
+		if option == 'Steam Branch':
+			# Steam branch should be pulled automatically from Steam
+			return self.get_steam_branches()
+		else:
+			return super().get_option_options(option)
+
 	def check_update_available(self) -> bool:
 		"""
 		Check if a SteamCMD update is available for this game
 
 		:return:
 		"""
-		app_manifest = os.path.join(self.get_app_directory(), 'AppFiles', 'steamapps', 'appmanifest_%s.acf' % self.steam_id)
+		app_manifest = os.path.join(utils.get_app_directory(), 'AppFiles', 'steamapps', 'appmanifest_%s.acf' % self.steam_id)
 
 		if not os.path.exists(app_manifest):
 			print(f"App manifest file {app_manifest} does not exist.", file=sys.stderr)
@@ -377,21 +408,24 @@ class SteamApp(BaseApp, ABC):
 		cmd = Cmd([
 			guess_steamcmd_path(),
 			'+force_install_dir',
-			os.path.join(self.get_app_directory(), 'AppFiles'),
+			os.path.join(utils.get_app_directory(), 'AppFiles'),
 			'+login',
 			'anonymous',
 			'+app_update',
 			self.steam_id,
 		])
-		cmd.sudo(self.get_app_uid())
+		cmd.sudo(utils.get_app_uid())
 		cmd.stream_output()
 
-		if self.steam_branch != 'public':
+		branch = self.get_option_value('Steam Branch')
+		branch_password = self.get_option_value('Steam Branch Password')
+
+		if branch != 'public':
 			cmd.append('-beta')
-			cmd.append(self.steam_branch)
-			if self.steam_branch_password != '':
+			cmd.append(branch)
+			if branch_password != '':
 				cmd.append('-betapassword')
-				cmd.append(self.steam_branch_password)
+				cmd.append(branch_password)
 
 		cmd.append('validate')
 		cmd.append('+quit')

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager/config/base_config.py

@@ -64,11 +64,11 @@ class BaseConfig(ABC):
 		:param value:
 		:return:
 		"""
-		if name not in self.options:
+		opt = self.get_config(name)
+		if opt is None:
 			print('Invalid option: %s, not available in configuration!' % (name, ), file=sys.stderr)
 			return ''
 
-		opt = self.options[name]
 		if opt.val_type == 'bool':
 			if value == '':
 				# Allow empty values to defer to default
@@ -117,18 +117,29 @@ class BaseConfig(ABC):
 		"""
 		pass
 
+	def get_config(self, name: str) -> ConfigKey | None:
+		"""
+		Get the raw configuration key object for the given name, or None if not found
+
+		:param name:
+		:return:
+		"""
+		if name in self.options:
+			return self.options[name]
+		else:
+			return None
+
 	def get_default(self, name: str) -> config_types:
 		"""
 		Get the default value of a configuration option
 		:param name:
 		:return:
 		"""
-		if name not in self.options:
+		opt = self.get_config(name)
+		if opt is None:
 			print('Invalid option: %s, not available in configuration!' % (name, ), file=sys.stderr)
 			return ''
 
-		opt = self.options[name]
-
 		return opt.to_system_type(opt.default)
 
 	def get_type(self, name: str) -> str:
@@ -138,11 +149,12 @@ class BaseConfig(ABC):
 		:param name:
 		:return:
 		"""
-		if name not in self.options:
+		opt = self.get_config(name)
+		if opt is None:
 			print('Invalid option: %s, not available in configuration!' % (name, ), file=sys.stderr)
 			return ''
 
-		return self.options[name].val_type
+		return opt.val_type
 
 	def get_help(self, name: str) -> str:
 		"""
@@ -151,11 +163,12 @@ class BaseConfig(ABC):
 		:param name:
 		:return:
 		"""
-		if name not in self.options:
+		opt = self.get_config(name)
+		if opt is None:
 			print('Invalid option: %s, not available in configuration!' % (name, ), file=sys.stderr)
 			return ''
 
-		return self.options[name].help
+		return opt.help
 
 	def get_options(self, name: str):
 		"""
@@ -164,11 +177,12 @@ class BaseConfig(ABC):
 		:param name:
 		:return:
 		"""
-		if name not in self.options:
+		opt = self.get_config(name)
+		if opt is None:
 			print('Invalid option: %s, not available in configuration!' % (name, ), file=sys.stderr)
 			return None
 
-		return self.options[name].options
+		return opt.options
 
 	def exists(self) -> bool:
 		"""

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager/libs/app_runner.py

@@ -506,10 +506,10 @@ def app_runner(game: BaseApp):
 		:return:
 		"""
 		if service and isinstance(service, BaseService):
-			service.set_option(option, value)
+			ret = service.set_option(option, value)
 		else:
-			game.set_option(option, value)
-		sys.exit(0)
+			ret = game.set_option(option, value)
+		sys.exit(0 if ret else 1)
 
 	if game.mod_handler is not None:
 		@app.command()

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager/services/base_service.py

@@ -169,7 +169,7 @@ class BaseService(ABC):
 		print('Invalid option: %s, not present in service configuration!' % option, file=sys.stderr)
 		return ''
 
-	def option_value_updated(self, option: str, previous_value, new_value):
+	def option_value_updated(self, option: str, previous_value, new_value) -> bool | None:
 		"""
 		Handle any special actions needed when an option value is updated
 
@@ -193,7 +193,7 @@ class BaseService(ABC):
 		print('Invalid option: %s, not present in service configuration!' % option, file=sys.stderr)
 		return 'Options'
 
-	def set_option(self, option: str, value: str | int | bool):
+	def set_option(self, option: str, value: str | int | bool) -> bool:
 		"""
 		Set a configuration option in the service config
 
@@ -202,21 +202,35 @@ class BaseService(ABC):
 		:return:
 		"""
 		for config in self.configs.values():
-			if option in config.options:
+			opt = config.get_config(option)
+			if opt is not None:
+				# Convert input value to a _system_ value to ensure '0' matches False
+				new_value = opt.to_system_type(value)
 				previous_value = config.get_value(option)
-				if previous_value == value and config.has_value(option):
+				if previous_value == new_value and config.has_value(option):
 					# No change
-					return
+					return True
 
 				config.set_value(option, value)
 				config.save()
 
 				# Allow the extending service to handle any special actions needed for this option update
-				self.option_value_updated(option, previous_value, value)
-				logging.info('Updated option %s to %s' % (option, value))
-				return
+				post_result = self.option_value_updated(option, previous_value, new_value)
+				if post_result is True:
+					# Post-update either returned a successful operation or nothing at all, either is fine.
+					logging.info('Updated option %s to %s and ran post-update actions successfully' % (option, value))
+					return True
+				elif post_result is None:
+					logging.debug('Post-update returned None, this is fine as it indicates no post-actions taken')
+					logging.info('Updated option %s to %s' % (option, value))
+					return True
+				else:
+					# Post-update explictly returned False, this indicates a problem occurred.
+					logging.warning('Configuration saved, but unable to complete post-update actions!')
+					return False
 
 		logging.warning('Invalid option: %s, not present in service configuration!' % option)
+		return False
 
 	def option_has_value(self, option: str) -> bool:
 		"""
@@ -360,7 +374,7 @@ class BaseService(ABC):
 		:return:
 		"""
 		code = Cmd(['systemctl', 'show', '-p', 'ExecMainStatus', self.service]).text[15:]
-		return int(code)
+		return -1 if code == '' else int(code)
 
 	@abstractmethod
 	def get_game_pid(self) -> int:
@@ -1169,14 +1183,15 @@ class BaseService(ABC):
 		"""
 		Get the backup directory for this game service, which is the directory that contains backups of the game files
 
-		If the game is registered as a multi-binary game, each service is contained within its own directory,
-		otherwise all instances share Backups.
+		All game services are contained in their own separate directory to make management easier.
 
 		:return:
 		"""
-		base = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), 'Backups')
-		if self.game.multi_binary:
-			base = os.path.join(base, self.service)
+		base = os.path.join(
+			os.path.dirname(os.path.realpath(sys.argv[0])),
+			'Backups',
+			self.service
+		)
 
 		return base
 
@@ -1212,6 +1227,18 @@ class BaseService(ABC):
 			'loader': self.get_loader(),
 		}
 
+	def build_environment_file(self):
+		"""
+		Build the environment file for this service
+
+		:return:
+		"""
+		with open(self._env_file, 'w') as f:
+			env = self.get_environment()
+			for key in env:
+				f.write('%s=%s\n' % (key, env[key]))
+		self.game.ensure_file_ownership(self._env_file)
+
 	def build_systemd_config(self):
 		"""
 		Build and save the systemd service file for this service
@@ -1234,12 +1261,8 @@ class BaseService(ABC):
 		logging.info('Created systemd service file for %s at %s' % (self.service, self._service_file))
 
 		# Save the environmental variable file for this service
-		with open(self._env_file, 'w') as f:
-			env = self.get_environment()
-			for key in env:
-				f.write('%s=%s\n' % (key, env[key]))
+		self.build_environment_file()
 		logging.info('Created environment file for %s at %s' % (self.service, self._env_file))
-		self.game.ensure_file_ownership(self._env_file)
 
 		# Grab the ports from this service and try to automatically update them to the next available port
 		# NOTICE, this will only check against services within this same game,

{warlock_manager-2.2.0 → warlock_manager-2.2.2}/warlock_manager.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warlock-manager
-Version: 2.2.0
+Version: 2.2.2
 Summary: Dependency library for game-server management applications.
 Author-email: Charlie Powell <cdp1337@bitsnbytes.dev>
 Maintainer-email: Charlie Powell <cdp1337@bitsnbytes.dev>