implement env manager (#6)

* add EnvManager class

* holds all functions that are env file related

* integrates runner dependency resolution

* add integration and unit tests for EnvManager

Reviewed-on: local-it-infrastructure/e2e_tests#6
Co-authored-by: Daniel <d.brummerloh@gmail.com>
Co-committed-by: Daniel <d.brummerloh@gmail.com>

src/coordinator.py

@@ -1,78 +1,34 @@
-import shutil
 from pathlib import Path
 
-from dotenv import dotenv_values
 from loguru import logger
 
-from src.dirmanager import DirManager
-from src.env_file_helper import DependencyRule, EnvFile, sort_env_files_by_rule
+from src.dir_manager import DirManager
+from src.env_manager import EnvFile, EnvManager
 from src.html_helper import merge_html_files
 from src.runner import Runner
-from src.tests_authentik.runner_authentik import RunnerAuthentik
-from src.tests_nextcloud.runner_nextcloud import RunnerNextcloud
-from src.tests_wordpress.runner_wordpress import RunnerWordpress
+from src.runner_dict import RUNNER_DICT
 from src.utils import rmtree
 
-# Register all runners here. Each .env file with TYPE=authentik will be run with RunnerAuthentik
-RUNNER_DICT: dict[str, type[Runner]] = {
-    "authentik": RunnerAuthentik,
-    "wordpress": RunnerWordpress,
-    "nextcloud": RunnerNextcloud,
-}
-
 
 class Coordinator:
     def __init__(self, env_paths_list: list[Path], output_dir: Path, session_id: str) -> None:
+        # logging
         out_string = "".join([e.name + "\n" for e in env_paths_list])
         out_string += f"output_dir = {output_dir}\n"
         out_string += f"session_id = {session_id}"
         logger.info(f"initialize Coordinator instance with\nenv_paths_list =\n{out_string}")
 
         self.DIR = DirManager(output_dir=output_dir, session_id=session_id)
-        self.output_dir = output_dir
-        self.session_id = session_id
-
-        # parse env files
-        self.env_files: list[EnvFile] = self._getn_env_files_list(env_paths_list)
-        self.dependency_rules: list[DependencyRule] = self._get_dependency_rules(self.env_files)
-
-    @staticmethod
-    def _getn_env_files_list(env_paths: list[Path]) -> list[EnvFile]:
-        """Returns a list of EnvFile objects created from the given env files"""
-        env_files: list[EnvFile] = []
-        for env_path in env_paths:
-            assert env_path.is_file(), f"the env file {env_path} does not exist"
-            config: dict[str, str] = dotenv_values(env_path)  # type: ignore
-            assert "TYPE" in config, f"the env file {env_path} does not specify the required TYPE key."
-            env_type = config["TYPE"]
-            env_files.append(EnvFile(env_path=env_path, config=config, env_type=env_type))
-        return env_files
-
-    @staticmethod
-    def _get_dependency_rules(env_files: list[EnvFile]) -> list[DependencyRule]:
-        dependency_rules: list[DependencyRule] = []
-        for env_file in env_files:
-            child_runner_class = RUNNER_DICT[env_file.env_type]
-            for dependency in child_runner_class.dependencies:
-                dependency_rule = DependencyRule(child=child_runner_class.name, dependency=dependency.name)
-                dependency_rules.append(dependency_rule)
-        return dependency_rules
+        self.ENV = EnvManager(env_paths_list)
 
     def setup_test(self) -> None:
         logger.info("calling setup_test()")
         self.DIR.create_all_dirs()
-        self._copy_env_files()
-
-    def _copy_env_files(self) -> None:
-        """Copies all env files to STATES/env_files. Files will be renamed to their own TYPE value."""
-        env_files_dir = self.DIR.STATES / "env_files"
-        env_files_dir.mkdir(exist_ok=True)
-        for env_file in self.env_files:
-            shutil.copy(env_file.env_path, env_files_dir / env_file.env_type)
+        self.ENV.copy_env_files(self.DIR)
 
     def run_test(self) -> None:
         logger.info("calling run_test()")
-        self.runners: list[Runner] = self._load_runners(self.env_files)
+        self.runners: list[Runner] = self._load_runners(self.ENV.env_files)
         for runner in self.runners:
             runner.run_setups()
         for runner in self.runners:
@@ -87,7 +43,9 @@ class Coordinator:
         for env_file in env_files:
             RunnerClass = RUNNER_DICT[env_file.config["TYPE"]]
             runners.append(
-                RunnerClass(dotenv_path=env_file.env_path, output_dir=self.output_dir, session_id=self.session_id)
+                RunnerClass(
+                    dotenv_path=env_file.env_path, output_dir=self.DIR.output_dir, session_id=self.DIR.session_id
+                )
             )
         return runners