Accept on/off values for --use-keyring

changelog.md

@@ -6,6 +6,7 @@ Features
 * Let the `--dsn` argument accept literal DSNs as well as aliases.
 * Accept `--character-set` as an alias for `--charset` at the CLI.
 * Add SSL/TLS version to `status` output.
+* More liberally accept `on`/`off` values for `true`/`false`, and vice versa.
 
 
 Bug Fixes

mycli/main.py

@@ -1725,9 +1725,9 @@ def get_last_query(self) -> str | None:
 @click.option(
     '--use-keyring',
     'use_keyring_cli_opt',
-    type=click.Choice(['true', 'false', 'reset']),
+    type=str,
     default=None,
-    help='Store and retrieve passwords from the system keyring: true/false/reset.',
+    help='Store and retrieve passwords from the system keyring: on/off/reset.',
 )
 @click.option("--checkup", is_flag=True, help="Run a checkup on your config file.")
 @click.pass_context
@@ -2070,7 +2070,11 @@ def get_password_from_file(password_file: str | None) -> str | None:
         use_keyring = str_to_bool(mycli.config['main'].get('use_keyring', 'False'))
         reset_keyring = False
     else:
-        use_keyring = str_to_bool(use_keyring_cli_opt)
+        try:
+            use_keyring = str_to_bool(use_keyring_cli_opt)
+        except ValueError:
+            click.secho('Unknown value for --use_keyring', err=True, fg='red')
+            sys.exit(1)
         reset_keyring = False
 
     # todo: removeme after a period of transition

test/test_main.py

@@ -930,6 +930,61 @@ def run_query(self, query, new_line=True):
     )
 
 
+def test_keyring_arg(monkeypatch):
+    # Setup classes to mock mycli.main.MyCli
+    class Formatter:
+        format_name = None
+
+    class Logger:
+        def debug(self, *args, **args_dict):
+            pass
+
+        def warning(self, *args, **args_dict):
+            pass
+
+    class MockMyCli:
+        config = {
+            'main': {},
+            'alias_dsn': {},
+        }
+
+        def __init__(self, **args):
+            self.logger = Logger()
+            self.destructive_warning = False
+            self.main_formatter = Formatter()
+            self.redirect_formatter = Formatter()
+            self.ssl_mode = 'auto'
+            self.my_cnf = {'client': {}, 'mysqld': {}}
+
+        def connect(self, **args):
+            MockMyCli.connect_args = args
+
+        def run_query(self, query, new_line=True):
+            pass
+
+    import mycli.main
+
+    monkeypatch.setattr(mycli.main, 'MyCli', MockMyCli)
+    runner = CliRunner()
+
+    result = runner.invoke(mycli.main.cli, args=['--use-keyring', 'True'])
+    assert result.exit_code == 0, result.output + ' ' + str(result.exception)
+    assert MockMyCli.connect_args['use_keyring'] is True
+
+    result = runner.invoke(mycli.main.cli, args=['--use-keyring', 'on'])
+    assert result.exit_code == 0, result.output + ' ' + str(result.exception)
+    assert MockMyCli.connect_args['use_keyring'] is True
+
+    result = runner.invoke(mycli.main.cli, args=['--use-keyring', 'off'])
+    assert result.exit_code == 0, result.output + ' ' + str(result.exception)
+    assert MockMyCli.connect_args['use_keyring'] is False
+
+    result = runner.invoke(mycli.main.cli, args=['--use-keyring', 'Reset'])
+    assert result.exit_code == 0, result.output + ' ' + str(result.exception)
+    assert MockMyCli.connect_args['use_keyring'] is True
+    assert MockMyCli.connect_args['reset_keyring'] is True
+
+
 def test_ssh_config(monkeypatch):
     # Setup classes to mock mycli.main.MyCli
     class Formatter: