BUG: Wrong path edited when running config -e (#5685)

As per #5652, `beet --config <path> config -e` edited the default config
path, even though that's not the config that would be used by beets.

It seems like this was the result of a deliberate short-circuit in
[`_raw_main()`](https://github.com/Alch-Emi/beets/blob/c2de6feada5c84d8bd0235969d551b6a4fce1277/beets/ui/__init__.py#L1832).
The short-circuit prevents malformed configs from causing a crash before
opening the editor, but also prevents the setup function from loading
the custom config at all.

The solution used here is to just expose the CLI options to
`edit_config()`, so that it can use the custom config path if its set. I
also suspect that the branch in
[`config_func()`](https://github.com/Alch-Emi/beets/blob/c2de6feada5c84d8bd0235969d551b6a4fce1277/beets/ui/commands.py#L2354)
which is getting short circuited is actually unreachable, but I left it
in with a note just in case.

Fixes #5652

## To Do

- [x] ~~Documentation~~ (N/A)
- [X] Changelog
- [X] Tests

Author: henry-oberholtzer

beets/ui/__init__.py

@@ -1601,7 +1601,7 @@ def parse_csl_callback(
     ):
         from beets.ui.commands.config import config_edit
 
-        return config_edit()
+        return config_edit(options)
 
     test_lib = bool(lib)
     subcommands, lib = _setup(options, lib)

beets/ui/commands/config.py

@@ -30,7 +30,10 @@ def config_func(lib, opts, args):
 
     # Open in editor.
     elif opts.edit:
-        config_edit()
+        # Note:  This branch *should* be unreachable
+        # since the normal flow should be short-circuited
+        # by the special case in ui._raw_main
+        config_edit(opts)
 
     # Dump configuration.
     else:
@@ -41,11 +44,11 @@ def config_func(lib, opts, args):
             print("Empty configuration")
 
 
-def config_edit():
+def config_edit(cli_options):
     """Open a program to edit the user configuration.
     An empty config file is created if no existing config file exists.
     """
-    path = config.user_config_path()
+    path = cli_options.config or config.user_config_path()
     editor = editor_command()
     try:
         if not os.path.isfile(path):

docs/changelog.rst

@@ -29,6 +29,8 @@ Bug fixes:
   audio-features endpoint, the plugin logs a warning once and skips audio
   features for all remaining tracks in the session, avoiding unnecessary API
   calls and rate limit exhaustion.
+- Running `beet --config <mypath> config -e` now edits `<mypath>` rather than
+  the default config path. :bug:`5652`
 - :doc:`plugins/lyrics`: Accepts strings for lyrics sources (previously only
   accepted a list of strings). :bug:`5962`
 

test/ui/commands/test_config.py

@@ -128,3 +128,11 @@ def test_edit_invalid_config_file(self):
         with patch("os.execlp") as execlp:
             self.run_command("config", "-e")
         execlp.assert_called_once_with("myeditor", "myeditor", self.config_path)
+
+    def test_edit_config_with_custom_config_path(self):
+        os.environ["EDITOR"] = "myeditor"
+        with patch("os.execlp") as execlp:
+            self.run_command("--config", self.cli_config_path, "config", "-e")
+        execlp.assert_called_once_with(
+            "myeditor", "myeditor", self.cli_config_path
+        )