feat: clean up env directory before save

This will add a `-c` `--clean` flag to the save command and ensure that the env directory is deleted if it exists.

Close overhangio#967

changelog.d/20240629_120748_codewithemad_cleanup_flag.md

@@ -0,0 +1 @@
+- 💥[Feature] Enhance your workflow with the new `-c` or `--clean` option for the `tutor config save` and `tutor dev|local|k8s launch` commands! This feature allows you to clean your environment before each save or launch, ensuring that all files and directories within the `env/` folder are deleted, providing you with a fresh environment each time. (by @CodeWithEmad)

tests/commands/test_config.py

@@ -17,6 +17,11 @@ def test_config_save(self) -> None:
         self.assertFalse(result.exception)
         self.assertEqual(0, result.exit_code)
 
+    def test_config_save_cleanup_env_dir(self) -> None:
+        result = self.invoke(["config", "save", "-c"])
+        self.assertFalse(result.exception)
+        self.assertEqual(0, result.exit_code)
+
     def test_config_save_interactive(self) -> None:
         result = self.invoke(["config", "save", "-i"])
         self.assertFalse(result.exception)

tests/test_config.py

@@ -48,7 +48,7 @@ def mock_prompt(*_args: None, **kwargs: str) -> str:
             with patch.object(click, "prompt", new=mock_prompt):
                 with patch.object(click, "confirm", new=mock_prompt):
                     config = tutor_config.load_minimal(rootdir)
-                    interactive.ask_questions(config)
+                    interactive.ask_questions(config, rootdir)
 
         self.assertIn("MYSQL_ROOT_PASSWORD", config)
         self.assertEqual(8, len(get_typed(config, "MYSQL_ROOT_PASSWORD", str)))

tutor/commands/compose.py

@@ -82,12 +82,20 @@ def job_runner(self, config: Config) -> ComposeTaskRunner:
 @click.option("-I", "--non-interactive", is_flag=True, help="Run non-interactively")
 @click.option("-p", "--pullimages", is_flag=True, help="Update docker images")
 @click.option("--skip-build", is_flag=True, help="Skip building Docker images")
+@click.option(
+    "-c",
+    "--clean",
+    "clean_env",
+    is_flag=True,
+    help="Remove everything in the env directory before save",
+)
 @click.pass_context
 def launch(
     context: click.Context,
     non_interactive: bool,
     pullimages: bool,
     skip_build: bool,
+    clean_env: bool,
 ) -> None:
     context_name = context.obj.NAME
     run_for_prod = False if context_name == "dev" else None
@@ -96,7 +104,12 @@ def launch(
 
     # Upgrade has to run before configuration
     interactive_upgrade(context, not non_interactive, run_for_prod=run_for_prod)
-    interactive_configuration(context, not non_interactive, run_for_prod=run_for_prod)
+    interactive_configuration(
+        context,
+        not non_interactive,
+        run_for_prod=run_for_prod,
+        clean_environment=clean_env,
+    )
 
     config = tutor_config.load(context.obj.root)
 
@@ -187,12 +200,24 @@ def interactive_upgrade(
 
 
 def interactive_configuration(
-    context: click.Context, interactive: bool, run_for_prod: t.Optional[bool] = None
+    context: click.Context,
+    interactive: bool,
+    run_for_prod: t.Optional[bool] = None,
+    clean_environment: bool = False,
 ) -> None:
     click.echo(fmt.title("Interactive platform configuration"))
     config = tutor_config.load_minimal(context.obj.root)
     if interactive:
-        interactive_config.ask_questions(config, run_for_prod=run_for_prod)
+        interactive_config.ask_questions(
+            config,
+            context.obj.root,
+            run_for_prod=run_for_prod,
+            clean_environment=clean_environment,
+        )
+    else:
+        # Clean up in non-interactive mode
+        if clean_environment:
+            tutor_env.delete_env_dir(context.obj.root)
     tutor_config.save_config_file(context.obj.root, config)
     config = tutor_config.load_full(context.obj.root)
     tutor_env.save(context.obj.root, config)

tutor/commands/config.py

@@ -136,6 +136,13 @@ def _candidate_config_items(self) -> t.Iterable[tuple[str, ConfigValue]]:
 @click.option(
     "-e", "--env-only", "env_only", is_flag=True, help="Skip updating config.yml"
 )
+@click.option(
+    "-c",
+    "--clean",
+    "clean_env",
+    is_flag=True,
+    help="Remove everything in the env directory before save",
+)
 @click.pass_obj
 def save(
     context: Context,
@@ -145,10 +152,15 @@ def save(
     remove_vars: list[tuple[str, t.Any]],
     unset_vars: list[str],
     env_only: bool,
+    clean_env: bool,
 ) -> None:
     config = tutor_config.load_minimal(context.root)
     if interactive:
-        interactive_config.ask_questions(config)
+        interactive_config.ask_questions(
+            config, context.root, clean_environment=clean_env
+        )
+    if clean_env and not interactive:
+        env.delete_env_dir(context.root)
     if set_vars:
         for key, value in set_vars:
             config[key] = env.render_unknown(config, value)

tutor/commands/k8s.py

@@ -215,8 +215,17 @@ def k8s(context: click.Context) -> None:
 
 @click.command(help="Configure and run Open edX from scratch")
 @click.option("-I", "--non-interactive", is_flag=True, help="Run non-interactively")
+@click.option(
+    "-c",
+    "--clean",
+    "clean_env",
+    is_flag=True,
+    help="Remove everything in the env directory before save",
+)
 @click.pass_context
-def launch(context: click.Context, non_interactive: bool) -> None:
+def launch(
+    context: click.Context, non_interactive: bool, clean_env: bool = False
+) -> None:
     run_upgrade_from_release = tutor_env.should_upgrade_from_release(context.obj.root)
     if run_upgrade_from_release is not None:
         click.echo(fmt.title("Upgrading from an older release"))
@@ -228,7 +237,13 @@ def launch(context: click.Context, non_interactive: bool) -> None:
     click.echo(fmt.title("Interactive platform configuration"))
     config = tutor_config.load_minimal(context.obj.root)
     if not non_interactive:
-        interactive_config.ask_questions(config, run_for_prod=True)
+        interactive_config.ask_questions(
+            config, context.obj.root, run_for_prod=True, clean_environment=clean_env
+        )
+    else:
+        # Clean up in non-interactive mode
+        if clean_env:
+            tutor_env.delete_env_dir(context.obj.root)
     tutor_config.save_config_file(context.obj.root, config)
     config = tutor_config.load_full(context.obj.root)
     tutor_env.save(context.obj.root, config)

tutor/env.py

@@ -533,6 +533,20 @@ def root_dir(root: str) -> str:
     return os.path.abspath(root)
 
 
+def delete_env_dir(root: str) -> None:
+    env_path = base_dir(root)
+
+    try:
+        shutil.rmtree(env_path)
+        fmt.echo_alert(f"Removed existing Tutor environment at: {env_path}")
+    except PermissionError:
+        raise exceptions.TutorError(
+            f"Permission Denied while trying to remove existing Tutor environment at: {env_path}"
+        )
+    except FileNotFoundError:
+        fmt.echo_info(f"No existing Tutor environment to remove at: {env_path}")
+
+
 @hooks.Actions.PLUGIN_UNLOADED.add()
 def _delete_plugin_templates(plugin: str, root: str, _config: Config) -> None:
     """

tutor/interactive.py

@@ -7,14 +7,23 @@
 from .types import Config, get_typed
 
 
-def ask_questions(config: Config, run_for_prod: Optional[bool] = None) -> None:
+def ask_questions(
+    config: Config,
+    root: str,
+    run_for_prod: Optional[bool] = None,
+    clean_environment: bool = False,
+) -> None:
     """
     Interactively ask questions to collect configuration values from the user.
 
     Arguments:
         config: Existing (or minimal) configuration. Modified in-place.
         run_for_prod: Whether platform should be configured for production.
             If None, then ask the user.
+        clean_environment: Whether to clean environment before running.
+            defaults to False.
+    Returns:
+        None
     """
     defaults = tutor_config.get_defaults()
     if run_for_prod is None:
@@ -148,6 +157,17 @@ def ask_questions(config: Config, run_for_prod: Optional[bool] = None) -> None:
             config,
             defaults,
         )
+    if clean_environment:
+        run_clean = click.confirm(
+            fmt.question(
+                "The -c flag you provide will delete your existing Tutor environment. "
+                "Are you sure you want to do this?"
+            ),
+            prompt_suffix=" ",
+            default=True,
+        )
+        if run_clean:
+            env.delete_env_dir(root)
 
     hooks.Actions.CONFIG_INTERACTIVE.do(config)