refactor(InstanceManager): rework

Signed-off-by: Dominik Willner <th33xitus@gmail.com>
This commit is contained in:
dw-0
2023-11-11 23:56:27 +01:00
parent 44ed3b6ddf
commit 68369753fd
5 changed files with 227 additions and 163 deletions

View File

@@ -17,7 +17,7 @@ from typing import List
from kiauh.instance_manager.base_instance import BaseInstance
from kiauh.modules.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
from kiauh.utils.constants import CURRENT_USER, SYSTEMD
from kiauh.utils.constants import SYSTEMD
from kiauh.utils.logger import Logger
from kiauh.utils.system_utils import create_directory
@@ -26,15 +26,10 @@ from kiauh.utils.system_utils import create_directory
class Klipper(BaseInstance):
@classmethod
def blacklist(cls) -> List[str]:
return ["None", "klipper", "mcu"]
return ["None", "mcu"]
def __init__(self, name: str):
super().__init__(
name=name,
prefix="klipper",
user=CURRENT_USER,
data_dir_name=self._get_data_dir_from_name(name),
)
def __init__(self, suffix: str = None):
super().__init__(instance_type=self, suffix=suffix)
self.klipper_dir = KLIPPER_DIR
self.env_dir = KLIPPER_ENV_DIR
self.cfg_file = f"{self.cfg_dir}/printer.cfg"
@@ -43,7 +38,7 @@ class Klipper(BaseInstance):
self.uds = f"{self.comms_dir}/klippy.sock"
def create(self) -> None:
Logger.print_info("Creating Klipper Instance")
Logger.print_info("Creating new Klipper Instance ...")
module_path = os.path.dirname(os.path.abspath(__file__))
service_template_path = os.path.join(module_path, "res", "klipper.service")
env_template_file_path = os.path.join(module_path, "res", "klipper.env")
@@ -69,7 +64,7 @@ class Klipper(BaseInstance):
def delete(self, del_remnants: bool) -> None:
service_file = self.get_service_file_name(extension=True)
service_file_path = self._get_service_file_path()
service_file_path = self.get_service_file_path()
Logger.print_info(f"Deleting Klipper Instance: {service_file}")
@@ -116,13 +111,6 @@ class Klipper(BaseInstance):
env_file.write(env_file_content)
Logger.print_ok(f"Env file created: {env_file_target}")
def get_service_file_name(self, extension=False) -> str:
name = "klipper" if self.name == self.prefix else self.prefix + "-" + self.name
return name if not extension else f"{name}.service"
def _get_service_file_path(self):
return f"{SYSTEMD}/{self.get_service_file_name(extension=True)}"
def _delete_klipper_remnants(self) -> None:
try:
Logger.print_info(f"Delete {self.klipper_dir} ...")
@@ -137,14 +125,6 @@ class Klipper(BaseInstance):
Logger.print_ok("Directories successfully deleted.")
def _get_data_dir_from_name(self, name: str) -> str:
if name == "klipper":
return "printer"
elif int(name.isdigit()):
return f"printer_{name}"
else:
return name
def _prep_service_file(self, service_template_path, env_file_path):
try:
with open(service_template_path, "r") as template_file:

View File

@@ -55,41 +55,30 @@ from kiauh.utils.system_utils import (
def run_klipper_setup(install: bool) -> None:
instance_manager = InstanceManager(Klipper)
instance_list = instance_manager.get_instances()
instance_list = instance_manager.instances
instances_installed = len(instance_list)
is_klipper_installed = check_klipper_installation(instance_manager)
is_klipper_installed = instances_installed > 0
if not install and not is_klipper_installed:
Logger.print_warn("Klipper not installed!")
return
if install:
add_additional = handle_existing_instances(instance_manager)
add_additional = handle_existing_instances(instance_list)
if is_klipper_installed and not add_additional:
Logger.print_info(EXIT_KLIPPER_SETUP)
return
install_klipper(instance_manager)
install_klipper(instance_manager, instance_list)
if not install:
if instances_installed == 1:
remove_single_instance(instance_manager)
remove_single_instance(instance_manager, instance_list)
else:
remove_multi_instance(instance_manager)
remove_multi_instance(instance_manager, instance_list)
def check_klipper_installation(instance_manager: InstanceManager) -> bool:
instance_list = instance_manager.get_instances()
instances_installed = len(instance_list)
if instances_installed < 1:
return False
return True
def handle_existing_instances(instance_manager: InstanceManager) -> bool:
instance_list = instance_manager.get_instances()
def handle_existing_instances(instance_list: List[Klipper]) -> bool:
instance_count = len(instance_list)
if instance_count > 0:
@@ -100,9 +89,9 @@ def handle_existing_instances(instance_manager: InstanceManager) -> bool:
return True
def install_klipper(instance_manager: InstanceManager) -> None:
instance_list = instance_manager.get_instances()
def install_klipper(
instance_manager: InstanceManager, instance_list: List[Klipper]
) -> None:
print_select_instance_count_dialog()
question = f"Number of{' additional' if len(instance_list) > 0 else ''} Klipper instances to set up"
install_count = get_number_input(question, 1, default=1, allow_go_back=True)
@@ -110,7 +99,7 @@ def install_klipper(instance_manager: InstanceManager) -> None:
Logger.print_info(EXIT_KLIPPER_SETUP)
return
instance_names = set_instance_names(instance_list, install_count)
instance_names = set_instance_suffix(instance_list, install_count)
if instance_names is None:
Logger.print_info(EXIT_KLIPPER_SETUP)
return
@@ -119,11 +108,9 @@ def install_klipper(instance_manager: InstanceManager) -> None:
setup_klipper_prerequesites()
convert_single_to_multi = (
True
if len(instance_list) == 1
and instance_list[0].name is None
len(instance_list) == 1
and instance_list[0].suffix is None
and install_count >= 1
else False
)
for name in instance_names:
@@ -131,7 +118,7 @@ def install_klipper(instance_manager: InstanceManager) -> None:
handle_single_to_multi_conversion(instance_manager, name)
convert_single_to_multi = False
else:
instance_manager.set_current_instance(Klipper(name=name))
instance_manager.current_instance = Klipper(suffix=name)
instance_manager.create_instance()
instance_manager.enable_instance()
@@ -181,19 +168,17 @@ def install_klipper_packages(klipper_dir: Path) -> None:
install_system_packages(packages)
def set_instance_names(instance_list, install_count: int) -> List[Union[str, None]]:
def set_instance_suffix(
instance_list: List[Klipper], install_count: int
) -> List[Union[str, None]]:
instance_count = len(instance_list)
# new single instance install
if instance_count == 0 and install_count == 1:
return ["klipper"]
return [None]
# convert single instance install to multi install
elif (
instance_count == 1
and instance_list[0].name == "klipper"
and install_count >= 1
):
elif instance_count == 1 and install_count >= 1 and instance_list[0].suffix is None:
return handle_convert_single_to_multi_instance_names(install_count)
# new multi instance install
@@ -207,10 +192,11 @@ def set_instance_names(instance_list, install_count: int) -> List[Union[str, Non
)
def remove_single_instance(instance_manager: InstanceManager) -> None:
instance_list = instance_manager.get_instances()
def remove_single_instance(
instance_manager: InstanceManager, instance_list: List[Klipper]
) -> None:
try:
instance_manager.set_current_instance(instance_list[0])
instance_manager.current_instance = instance_list[0]
instance_manager.stop_instance()
instance_manager.disable_instance()
instance_manager.delete_instance(del_remnants=True)
@@ -220,8 +206,9 @@ def remove_single_instance(instance_manager: InstanceManager) -> None:
return
def remove_multi_instance(instance_manager: InstanceManager) -> None:
instance_list = instance_manager.get_instances()
def remove_multi_instance(
instance_manager: InstanceManager, instance_list: List[Klipper]
) -> None:
print_instance_overview(instance_list, show_index=True, show_select_all=True)
options = [str(i) for i in range(len(instance_list))]
@@ -235,7 +222,7 @@ def remove_multi_instance(instance_manager: InstanceManager) -> None:
elif selection == "a".lower():
Logger.print_info("Removing all Klipper instances ...")
for instance in instance_list:
instance_manager.set_current_instance(instance)
instance_manager.current_instance = instance
instance_manager.stop_instance()
instance_manager.disable_instance()
instance_manager.delete_instance(del_remnants=True)
@@ -244,7 +231,7 @@ def remove_multi_instance(instance_manager: InstanceManager) -> None:
Logger.print_info(
f"Removing Klipper instance: {instance.get_service_file_name()}"
)
instance_manager.set_current_instance(instance)
instance_manager.current_instance = instance
instance_manager.stop_instance()
instance_manager.disable_instance()
instance_manager.delete_instance(del_remnants=False)
@@ -259,7 +246,6 @@ def update_klipper() -> None:
return
instance_manager = InstanceManager(Klipper)
instance_manager.get_instances()
instance_manager.stop_all_instance()
cm = ConfigManager()

View File

@@ -35,10 +35,10 @@ def assign_custom_names(
instance_names = []
exclude = Klipper.blacklist()
# if an instance_list is provided, exclude all existing instance names
# if an instance_list is provided, exclude all existing instance suffixes
if instance_list is not None:
for instance in instance_list:
exclude.append(instance.name)
exclude.append(instance.suffix)
for i in range(instance_count + install_count):
question = f"Enter name for instance {i + 1}"
@@ -93,14 +93,14 @@ def handle_existing_multi_instance_names(
def handle_single_to_multi_conversion(
instance_manager: InstanceManager, name: str
) -> None:
instance_list = instance_manager.get_instances()
instance_manager.set_current_instance(instance_list[0])
old_data_dir_name = instance_manager.get_instances()[0].data_dir
instance_list = instance_manager.instances
instance_manager.current_instance = instance_list[0]
old_data_dir_name = instance_manager.instances[0].data_dir
instance_manager.stop_instance()
instance_manager.disable_instance()
instance_manager.delete_instance(del_remnants=False)
instance_manager.set_current_instance(Klipper(name=name))
new_data_dir_name = instance_manager.get_current_instance().data_dir
instance_manager.current_instance = Klipper(suffix=name)
new_data_dir_name = instance_manager.current_instance.data_dir
try:
os.rename(old_data_dir_name, new_data_dir_name)
except OSError as e:
@@ -175,12 +175,12 @@ def handle_disruptive_system_packages() -> None:
def has_custom_names(instance_list: List[Klipper]) -> bool:
pattern = re.compile("^\d+$")
for instance in instance_list:
if not pattern.match(instance.name):
if not pattern.match(instance.suffix):
return True
return False
def get_highest_index(instance_list: List[Klipper]) -> int:
indices = [int(instance.name.split("-")[-1]) for instance in instance_list]
indices = [int(instance.suffix.split("-")[-1]) for instance in instance_list]
return max(indices)