Added more logging into editor and handling of invalid TOML files

Author: mvaltas

devcli/commands/edit.py

@@ -14,9 +14,11 @@ def run_editor(file: Path):
         """Open editor on file"""
         c_editor = ctx.obj["devcli.commands.edit.editor"]
         e_editor = os.getenv("EDITOR", "vim")
+        logger.info(f"env EDITOR={e_editor} config={c_editor}")
 
         # config first, env and last default
         editor = c_editor if c_editor else e_editor
+        logger.info(f"selected editor: {editor}")
 
         os.execvp(editor, [editor, file])
 
@@ -27,18 +29,23 @@ def open_editor(file: Path):
 
 
 @cli.command()
-def config(ctx: Context):
+def config(ctx: Context, dry: bool = False):
+    """ Opens the most specific configuration """
     editor = prep_editor(ctx)
     configs = ctx.obj.files()
+    logger.info(f"Found these configurations: {configs}")
     if not configs:
         cmd.stop("No configuration files were found.")
-
-    # last file is the most specific one
-    editor(configs[-1])
+    elif dry:
+        cmd.info(f"Will edit: {configs[-1]}")
+    else:
+        # last file is the most specific one
+        editor(configs[-1])
 
 
 @cli.command("command")
 def edit_command(ctx: Context, name: str):
+    """ Opens the command [name] for edit """
     editor = prep_editor(ctx)
     configs = ctx.obj.files()
     p = Path(configs[-1]).parent

devcli/config/config.py

@@ -35,10 +35,13 @@ def add_config(self, config_file: str | Path):
         if Path(config_file).is_file():
             with open(config_file) as file:
                 self.logger.debug(f"loading {config_file} data")
-                config_contents = toml.load(file)
-                self._audit[config_file] = copy.deepcopy(config_contents)
-                self.logger.debug(f"configuration contents: {config_contents}")
-                self.merge_update(self._config, config_contents)
+                try:
+                    config_contents = toml.load(file)
+                    self._audit[config_file] = copy.deepcopy(config_contents)
+                    self.logger.debug(f"configuration contents: {config_contents}")
+                    self.merge_update(self._config, config_contents)
+                except:
+                    self.logger.error(f"failed to load {config_file}, check syntax")
         else:
             self.logger.warning(f"{config_file} is not a file or does not exist")
 

tests/commands/test_edit.py

@@ -16,10 +16,10 @@ def setup(devcli_cmd):
 
 
 def test_edit_config_calls_editor(mock_exec):
-    result = edit("config")
+    edit("config")
     mock_exec.assert_called_once_with("nvim", ["nvim", ANY])
 
 
 def test_edit_command_calls_editor(mock_exec):
-    result = edit("command", "placeholder")
+    edit("command", "placeholder")
     mock_exec.assert_called_once_with("nvim", ["nvim", ANY])

tests/fixtures/invalid.toml

@@ -0,0 +1,4 @@
+[devcli]
+
+# value without quotes breaks TOML
+key = value

tests/test_conf.py

@@ -77,3 +77,8 @@ def test_files_returns_files_loaded():
     conf.add_config(spec_config)
     # and now it is listed in files()
     assert spec_config in conf.files()
+
+
+def test_handles_error_parsing_config():
+    invalid_config = project_root("tests/fixtures/invalid.toml")
+    conf.add_config(invalid_config)