def testShouldRaiseValueErrorWhenNoSystemServiceUnitNameDefined(self) -> None:
config = Config()
try:
service_unit_name = config.get_system_service_unit_name()
except ValueError:
pass
else:
raise AssertionError("ValueError was not raised")
def testShouldRaiseValueErrorWhenNoServerTemplatePathDefined(self) -> None:
config = Config()
try:
service_unit_name = config.get_server_template_path()
except ValueError:
pass
else:
raise AssertionError("ValueError was not raised")
def testSystemServiceUnitNameShouldBeStrAndReturn(self) -> None:
config = Config()
expected_value = 'minecraft-server.service'
with mock.patch.dict(config.config, {'env': {'server_systemd_unit_name': expected_value}}):
self.assertEqual(config.get_system_service_unit_name(), expected_value)
self.assertIsInstance(
config.get_system_service_unit_name(),
str
)
def testServerTemplatePathShouldBeStrAndReturn(self) -> None:
config = Config()
expected_value = '/somewhere/is/template-path'
with mock.patch.dict(config.config, {'env': {'server_tpl_path': expected_value}}):
self.assertEqual(config.get_server_template_path(), expected_value)
self.assertIsInstance(
config.get_server_template_path(),
str
)
def testCfgPathShouldBePosixPath(self) -> None:
config = Config()
self.assertIsInstance(
config.get_cfg_file_path(),
PosixPath
)
def __init__(self) -> None:
self.__config = Config()
self.__current_server_name = self.__read_active_server_name()
class server_manager:
SECURE_SRV_LOCK_NAME='.mc-server-manager-secure.lock'
def __init__(self) -> None:
self.__config = Config()
self.__current_server_name = self.__read_active_server_name()
def check_if_server_exists(self, srv_name: str) -> bool:
if Path(
self.__config.get_servers_data_path(),
srv_name
).exists():
return True
return False
def is_server_running(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
if service.Unit.ActiveState == b'active':
return True
return False
print('Can\t read server state via Dbus!')
return False
def stop_server(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
try:
service.Unit.Stop(b"replace")
except Exception as e:
print(f"Can't stop server: {e}")
return False
return True
print('Can\t read server state via Dbus!')
return False
def start_server(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
try:
service.Unit.Start(b"replace")
except Exception as e:
print(f"Can't start server: {e}")
return False
# print(f'Server\'s state: {service.Unit.ActiveState}')
return True
print('Can\t read server state via Dbus!')
return False
def validate_server_name(self, srv_name: str) -> bool:
""" Method checks whether server name consists of allowed
characters only """
if len(srv_name) > 32:
return False
regexp = re.compile('[^0-9a-zA-Z_-]+')
if regexp.search(srv_name):
return False
return True
def get_srv_template_files(self) -> Any:
""" Method returns list of all files (top-level) and dirs
from a server template """
files = []
pathlist = Path(self.__config.get_server_template_path()).glob('*')
for path in pathlist:
files.append(str(path.name))
return files
def get_active_server_name(self) -> str:
"""
This method returns server that is currently set as active
"""
return self.__current_server_name
def __update_current_server_name(self, server_name:str = '') -> None:
"""
This method updates state information about server, which is
currently symlinked
"""
if server_name:
self.__current_server_name = server_name
else:
self.__current_server_name = self.__read_active_server_name()
def __read_active_server_name(self) -> str:
"""
This method guesses (basing on server.properties symlink) currently
active server name
"""
srv_symlink = Path(f'{self.__config.get_server_path()}/server.properties')
try:
srv_symlink_destination = srv_symlink.resolve(True)
# If symlink was not found then there is no active server
except FileNotFoundError:
return ''
except Exception as e:
print(f"Can't get active server name: {e}")
return ''
return str(srv_symlink_destination.parent.name)
def list_server_instances(self) -> Any:
"""
This method iterates over servers-data directory and
returns list of found servers.
"""
# TODO: verify whether each server's files are in sync with server
# template (nothing is missing)
srvs = []
pathlist = Path(self.__config.get_servers_data_path()).glob('*')
for path in pathlist:
secureFlag = Path(str(path), self.SECURE_SRV_LOCK_NAME).exists()
srvs.append({
'name': str(path.name),
'secured': secureFlag
})
return srvs
def create_new_version_symlinks(self, server_name: str) -> bool:
""" This method removes symlinks pointing at current server
version """
files = self.get_srv_template_files()
for file in files:
file_obj = Path(self.__config.get_server_path(), file)
if not file_obj.exists():
try:
server_path = f'{self.__config.get_servers_data_path()}/{server_name}/{file}'
# print(f'Creating symlink from {str(file_obj)} to {server_path}')
file_obj.symlink_to(server_path)
except Exception as e:
print(f"Cant't create symlink for {server_path}: {e}!")
return False
else:
print(f"Looks like symlink {str(file_obj)} already exist!")
return False
self.__update_current_server_name(server_name)
return True
def remove_current_version_symlinks(self) -> bool:
""" This method removes symlinks pointing at current server
version """
symlinks = self.get_srv_template_files()
# in case no symlinks found - probably 1st server being created
if not symlinks:
return True
for file in symlinks:
file_obj = Path(self.__config.get_server_path(), file)
try:
# print(f'Removing file {file_obj}')
file_obj.unlink(missing_ok = True)
except Exception as e:
print(f"Cant't remove dir {file}: {e}!")
return False
self.__update_current_server_name('none')
return True
def create_new_server_from_templ_dir(self, server_name: str) -> bool:
"""
This method creates a new server by copying template directory
into a new server-data/<server_name> dir
"""
try:
copytree(
src=self.__config.get_server_template_path(),
dst=f'{self.__config.get_servers_data_path()}/{server_name}'
)
except Exception as e:
print(f"Cant't create new server {server_name}: {e}!")
return False
return True
def is_server_secured(self, server_name: str) -> bool:
"""
This method checks whether server is secured or not. Secured server
may not be deleted.
"""
lock_file_path = f'{self.__config.get_servers_data_path()}/{server_name}/{self.SECURE_SRV_LOCK_NAME}'
if Path(lock_file_path).exists():
return True
return False
def secure_server_instance(self, server_name: str) -> bool:
"""
This method creates hidden file '.mc-server-manager-secure.lock'
inside of the <server_name> data directory in order to mark this
server instance as secured.
When secured mc-server-manager will not delete this server by any
means.
"""
try:
lock_file_path = f'{self.__config.get_servers_data_path()}/{server_name}/{self.SECURE_SRV_LOCK_NAME}'
with open(lock_file_path, "w") as file:
msg = [
'This is a security lock created by mc-server-manager.',
'While this file exists mc-server-manager will not allow',
'to delete this server instance.',
'If you delete this file mc-server-manager user will be',
'able to delete this server instance.'
]
file.write("\n".join(msg))
except Exception as e:
print(f"Cant't create server insrtance secure lock {lock_file_path}: {e}!")
return False
return True
def delete_server_instance(self, server_name: str) -> bool:
"""
Method deletes all data of server instance <server_name>.
Secured server instances will not be removed.
"""
server_path = f'{self.__config.get_servers_data_path()}/{server_name}'
# does this server instance exist at all?
if not Path(server_path).exists():
print('Can\'t remove this server instance - it doesn\'t exist!')
return False
# is this server instance secured?
if self.is_server_secured(server_name):
print('Can\'t remove this server instance - it is protected agains deletion!')
return False
try:
shutil.rmtree(server_path)
except Exception as e:
print(f'Can\'t remove this server instance data directory: {e}')
return False
return True
class server_manager:
def __init__(self) -> None:
self.__config = Config()
self.__current_server_name = self.__read_active_server_name()
def check_if_server_exists(self, srv_name: str) -> bool:
if Path(
self.__config.get_servers_data_path(),
srv_name
).exists():
return True
return False
def is_server_running(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
if service.Unit.ActiveState == b'active':
return True
return False
print('Can\t read server state via Dbus!')
return False
def stop_server(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
try:
service.Unit.Stop(b"replace")
except Exception as e:
print(f"Can't stop server: {e}")
return False
return True
print('Can\t read server state via Dbus!')
return False
def start_server(self) -> bool:
with DBus(user_mode=True) as bus, \
Unit(self.__config.get_system_service_unit_name(), \
bus=bus, _autoload=True) as service:
try:
service.Unit.Start(b"replace")
except Exception as e:
print(f"Can't start server: {e}")
return False
# print(f'Server\'s state: {service.Unit.ActiveState}')
return True
print('Can\t read server state via Dbus!')
return False
def validate_server_name(self, srv_name: str) -> bool:
""" Method checks whether server name consists of allowed
characters only """
if len(srv_name) > 32:
return False
regexp = re.compile('[^0-9a-zA-Z_-]+')
if regexp.search(srv_name):
return False
return True
def get_srv_template_files(self) -> Type[List]:
""" Method returns list of all files (top-level) and dirs
from a server template """
files = []
pathlist = Path(self.__config.get_server_template_path()).glob('*')
for path in pathlist:
files.append(str(path.name))
return files
def get_active_server_name(self) -> str:
"""
This method returns server that is currently set as active
"""
return self.__current_server_name
def __update_current_server_name(self, server_name:str = False) -> None:
"""
This method updates state information about server, which is
currently symlinked
"""
if server_name:
self.__current_server_name = server_name
else:
self.__current_server_name = self.__read_active_server_name()
def __read_active_server_name(self) -> str:
"""
This method guesses (basing on server.properties symlink) currently
active server name
"""
srv_symlink = Path(f'{self.__config.get_server_path()}/server.properties')
try:
srv_symlink_destination = srv_symlink.resolve(True)
# If symlink was not found then there is no active server
except FileNotFoundError:
return False
except Exception as e:
print(f"Can't get active server name: {e}")
return False
return str(srv_symlink_destination.parent.name)
def list_server_instances(self) -> Type[List]:
"""
This method iterates over servers-data directory and
returns list of found servers.
"""
# TODO: verify whether each server's files are in sync with server
# template (nothing is missing)
files = []
pathlist = Path(self.__config.get_servers_data_path()).glob('*')
for path in pathlist:
files.append(str(path.name))
return files
def create_new_version_symlinks(self, server_name: str) -> bool:
""" This method removes symlinks pointing at current server
version """
files = self.get_srv_template_files()
for file in files:
file_obj = Path(self.__config.get_server_path(), file)
if not file_obj.exists():
try:
server_path = f'{self.__config.get_servers_data_path()}/{server_name}/{file}'
# print(f'Creating symlink from {str(file_obj)} to {server_path}')
file_obj.symlink_to(server_path)
except Exception:
print(f"Cant't create symlink for {server_path}!")
return False
else:
print(f"Looks like symlink {str(file_obj)} already exist!")
return False
self.__update_current_server_name(server_name)
return True
def remove_current_version_symlinks(self) -> bool:
""" This method removes symlinks pointing at current server
version """
symlinks = self.get_srv_template_files()
# in case no symlinks found - probably 1st server being created
if not symlinks:
return True
for file in symlinks:
file_obj = Path(self.__config.get_server_path(), file)
try:
# print(f'Removing file {file_obj}')
file_obj.unlink(missing_ok = True)
except Exception:
print(f"Cant't remove dir {file}!")
return False
self.__update_current_server_name('none')
return True
def create_new_server_from_templ_dir(self, server_name: str) -> bool:
"""
This method creates a new server by copying template directory
into a new server-data/<server_name> dir
"""
try:
copytree(
src=self.__config.get_server_template_path(),
dst=f'{self.__config.get_servers_data_path()}/{server_name}'
)
except Exception as e:
print(f"Cant't create new server {server_name}: {e}!")
return False
return True