derivepassphrase.git

@@ -340,20 +340,48 @@ def derivepassphrase_export_vault(

 # =====

-def _config_filename() -> str | bytes | pathlib.Path:

-    """Return the filename of the configuration file.

+def _config_filename(

+    subsystem: str | None = 'settings',

+) -> str | bytes | pathlib.Path:

+    """Return the filename of the configuration file for the subsystem.

+

+    The (implicit default) file is currently named `settings.json`,

+    located within the configuration directory as determined by the

+    `DERIVEPASSPHRASE_PATH` environment variable, or by

+    [`click.get_app_dir`][] in POSIX mode.  Depending on the requested

+    subsystem, this will usually be a different file within that

+    directory.

-    The file is currently named `settings.json`, located within the

-    configuration directory as determined by the `DERIVEPASSPHRASE_PATH`

-    environment variable, or by [`click.get_app_dir`][] in POSIX

-    mode.

+    Args:

+        subsystem:

+            Name of the configuration subsystem whose configuration

+            filename to return.  If not given, return the old filename

+            from before the subcommand migration.  If `None`, return the

+            configuration directory instead.

+

+    Raises:

+        AssertionError:

+            An unknown subsystem was passed.

+

+    Deprecated:

+        Since v0.2.0: The implicit default subsystem and the old

+        configuration filename are deprecated, and will be removed in v1.0.

+        The subsystem will be mandatory to specify.

     """

     path: str | bytes | pathlib.Path

     path = os.getenv(PROG_NAME.upper() + '_PATH') or click.get_app_dir(

         PROG_NAME, force_posix=True

     )

-    return os.path.join(path, 'settings.json')

+    match subsystem:

+        case None:

+            return path

+        case 'vault' | 'settings':

+            filename = f'{subsystem}.json'

+        case _:  # pragma: no cover

+            msg = f'Unknown configuration subsystem: {subsystem!r}'

+            raise AssertionError(msg)

+    return os.path.join(path, filename)

 def _load_config() -> _types.VaultConfig:

@@ -375,7 +403,7 @@ def _load_config() -> _types.VaultConfig:

             config.

     """

-    filename = _config_filename()

+    filename = _config_filename(subsystem='vault')

     with open(filename, 'rb') as fileobj:

         data = json.load(fileobj)

     if not _types.is_vault_config(data):

@@ -383,6 +411,43 @@ def _load_config() -> _types.VaultConfig:

     return data

+def _migrate_and_load_old_config() -> (

+    tuple[_types.VaultConfig, OSError | None]

+):

+    """Load and migrate a vault(1)-compatible config.

+

+    The (old) filename is obtained via

+    [`derivepassphrase.cli._config_filename`][].  This must be an

+    unencrypted JSON file.  After loading, the file is migrated to the new

+    standard filename.

+

+    Returns:

+        The vault settings, and an optional exception encountered during

+        migration.  See [`derivepassphrase.types.VaultConfig`][] for

+        details on the former.

+

+    Raises:

+        OSError:

+            There was an OS error accessing the old file.

+        ValueError:

+            The data loaded from the file is not a vault(1)-compatible

+            config.

+

+    """

+    new_filename = _config_filename(subsystem='vault')

+    old_filename = _config_filename()

+    with open(old_filename, 'rb') as fileobj:

+        data = json.load(fileobj)

+    if not _types.is_vault_config(data):

+        raise ValueError(_INVALID_VAULT_CONFIG)

+    try:

+        os.replace(old_filename, new_filename)

+    except OSError as exc:

+        return data, exc

+    else:

+        return data, None

+

+

 def _save_config(config: _types.VaultConfig, /) -> None:

     """Save a vault(1)-compatible config to the application directory.

@@ -403,7 +468,7 @@ def _save_config(config: _types.VaultConfig, /) -> None:

     """

     if not _types.is_vault_config(config):

         raise ValueError(_INVALID_VAULT_CONFIG)

-    filename = _config_filename()

+    filename = _config_filename(subsystem='vault')

     filedir = os.path.dirname(os.path.abspath(filename))

     try:

         os.makedirs(filedir, exist_ok=False)

@@ -1203,8 +1268,36 @@ def derivepassphrase_vault(  # noqa: C901,PLR0912,PLR0913,PLR0914,PLR0915

     def get_config() -> _types.VaultConfig:

         try:

             return _load_config()

+        except FileNotFoundError:

+            try:

+                backup_config, exc = _migrate_and_load_old_config()

             except FileNotFoundError:

                 return {'services': {}}

+            old_name = os.path.basename(_config_filename())

+            new_name = os.path.basename(_config_filename(subsystem='vault'))

+            click.echo(

+                (

+                    f'{PROG_NAME}: Using deprecated v0.1-style config file '

+                    f'{old_name!r}, instead of v0.2-style {new_name!r}.  '

+                    f'Support for v0.1-style config filenames will be '

+                    f'removed in v1.0.'

+                ),

+                err=True,

+            )

+            if isinstance(exc, OSError):

+                click.echo(

+                    (

+                        f'{PROG_NAME}: Warning: Failed to migrate to '

+                        f'{new_name!r}: {exc.strerror}: {exc.filename!r}'

+                    ),

+                    err=True,

+                )

+            else:

+                click.echo(

+                    f'{PROG_NAME}: Successfully migrated to {new_name!r}.',

+                    err=True,

+                )

+            return backup_config

         except OSError as e:

             err(f'Cannot load config: {e.strerror}: {e.filename!r}')

         except Exception as e:  # noqa: BLE001

@@ -552,7 +552,8 @@ def isolated_config(

         monkeypatch.setenv('HOME', os.getcwd())

         monkeypatch.setenv('USERPROFILE', os.getcwd())

         monkeypatch.delenv(env_name, raising=False)

-        os.makedirs(os.path.dirname(cli._config_filename()), exist_ok=True)

+        config_dir = cli._config_filename(subsystem=None)

+        os.makedirs(config_dir, exist_ok=True)

         yield

@@ -563,7 +564,8 @@ def isolated_vault_config(

     config: Any,

 ) -> Iterator[None]:

     with isolated_config(monkeypatch=monkeypatch, runner=runner):

-        with open(cli._config_filename(), 'w', encoding='UTF-8') as outfile:

+        config_filename = cli._config_filename(subsystem='vault')

+        with open(config_filename, 'w', encoding='UTF-8') as outfile:

             json.dump(config, outfile)

         yield

@@ -620,10 +620,10 @@ class TestCLI:

         # We also might as well use `isolated_config` instead.

         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

             with open(

-                cli._config_filename(), 'w', encoding='UTF-8'

+                cli._config_filename(subsystem='vault'), 'w', encoding='UTF-8'

             ) as outfile:

                 print('This string is not valid JSON.', file=outfile)

-            dname = os.path.dirname(cli._config_filename())

+            dname = cli._config_filename(subsystem=None)

             _result = runner.invoke(

                 cli.derivepassphrase_vault,

                 ['--import', os.fsdecode(dname)],

@@ -641,7 +641,7 @@ class TestCLI:

         runner = click.testing.CliRunner(mix_stderr=False)

         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

             with contextlib.suppress(FileNotFoundError):

-                os.remove(cli._config_filename())

+                os.remove(cli._config_filename(subsystem='vault'))

             _result = runner.invoke(

                 cli.derivepassphrase_vault,

                 ['--export', '-'],

@@ -676,8 +676,8 @@ class TestCLI:

         runner = click.testing.CliRunner(mix_stderr=False)

         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

             with contextlib.suppress(FileNotFoundError):

-                os.remove(cli._config_filename())

-            os.makedirs(cli._config_filename())

+                os.remove(cli._config_filename(subsystem='vault'))

+            os.makedirs(cli._config_filename(subsystem='vault'))

             _result = runner.invoke(

                 cli.derivepassphrase_vault,

                 ['--export', '-'],

@@ -695,7 +695,7 @@ class TestCLI:

     ) -> None:

         runner = click.testing.CliRunner(mix_stderr=False)

         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

-            dname = os.path.dirname(cli._config_filename())

+            dname = cli._config_filename(subsystem=None)

             _result = runner.invoke(

                 cli.derivepassphrase_vault,

                 ['--export', os.fsdecode(dname)],

@@ -750,7 +750,9 @@ contents go here

             )

             result = tests.ReadableResult.parse(_result)

             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config = json.load(infile)

             assert config == {

                 'global': {'phrase': 'abc'},

@@ -774,7 +776,9 @@ contents go here

             )

             result = tests.ReadableResult.parse(_result)

             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config = json.load(infile)

             assert config == {'global': {'phrase': 'abc'}, 'services': {}}

@@ -795,7 +799,9 @@ contents go here

             )

             result = tests.ReadableResult.parse(_result)

             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config = json.load(infile)

             assert config == {

                 'global': {'phrase': 'abc'},

@@ -821,7 +827,9 @@ contents go here

             assert result.error_exit(

                 error='user aborted request'

             ), 'expected known error message'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config = json.load(infile)

             assert config == {'global': {'phrase': 'abc'}, 'services': {}}

@@ -888,7 +896,9 @@ contents go here

             )

             result = tests.ReadableResult.parse(_result)

             assert result.clean_exit(), 'expected clean exit'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config = json.load(infile)

             assert (

                 config == result_config

@@ -1015,7 +1025,7 @@ contents go here

             config={'global': {'phrase': 'abc'}, 'services': {}},

         ):

             tests.make_file_readonly(

-                cli._config_filename(),

+                cli._config_filename(subsystem='vault'),

                 try_race_free_implementation=try_race_free_implementation,

             )

             _result = runner.invoke(

@@ -1118,7 +1128,9 @@ contents go here

                 result.stderr == 'Passphrase:'

             ), 'program unexpectedly failed?!'

             assert os_makedirs_called, 'os.makedirs has not been called?!'

-            with open(cli._config_filename(), encoding='UTF-8') as infile:

+            with open(

+                cli._config_filename(subsystem='vault'), encoding='UTF-8'

+            ) as infile:

                 config_readback = json.load(infile)

             assert config_readback == {

                 'global': {'phrase': 'abc'},

@@ -1283,7 +1295,38 @@ contents go here

 class TestCLIUtils:

-    def test_100_save_bad_config(

+    @pytest.mark.parametrize(

+        'config',

+        [

+            {'global': {'phrase': 'my passphrase'}, 'services': {}},

+            {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'phrase': 'my passphrase'}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},

+            },

+        ],

+    )

+    def test_100_load_config(

+        self, monkeypatch: pytest.MonkeyPatch, config: Any

+    ) -> None:

+        runner = click.testing.CliRunner()

+        with tests.isolated_vault_config(

+            monkeypatch=monkeypatch, runner=runner, config=config

+        ):

+            config_filename = cli._config_filename(subsystem='vault')

+            with open(config_filename, encoding='UTF-8') as fileobj:

+                assert json.load(fileobj) == config

+            assert cli._load_config() == config

+

+    def test_110_save_bad_config(

         self, monkeypatch: pytest.MonkeyPatch

     ) -> None:

         runner = click.testing.CliRunner()

@@ -1295,7 +1338,7 @@ class TestCLIUtils:

         ):

             cli._save_config(None)  # type: ignore[arg-type]

-    def test_101_prompt_for_selection_multiple(self) -> None:

+    def test_111_prompt_for_selection_multiple(self) -> None:

         @click.command()

         @click.option('--heading', default='Our menu:')

         @click.argument('items', nargs=-1)

@@ -1370,7 +1413,7 @@ Your selection? (1-10, leave empty to abort):\x20

 """  # noqa: E501

         ), 'expected known output'

-    def test_102_prompt_for_selection_single(self) -> None:

+    def test_112_prompt_for_selection_single(self) -> None:

         @click.command()

         @click.option('--item', default='baked beans')

         @click.argument('prompt')

@@ -1415,7 +1458,7 @@ Boo.

 """

         ), 'expected known output'

-    def test_103_prompt_for_passphrase(

+    def test_113_prompt_for_passphrase(

         self, monkeypatch: pytest.MonkeyPatch

     ) -> None:

         monkeypatch.setattr(

@@ -1480,7 +1523,9 @@ Boo.

                 assert result.clean_exit(

                     empty_stderr=True

                 ), 'expected clean exit'

-                with open(cli._config_filename(), encoding='UTF-8') as infile:

+                with open(

+                    cli._config_filename(subsystem='vault'), encoding='UTF-8'

+                ) as infile:

                     config_readback = json.load(infile)

                 assert config_readback == result_config

@@ -1611,6 +1656,127 @@ class TestCLITransition:

             empty_stderr=True, output='Use NUMBER=0, e.g. "--symbol 0"'

         ), 'expected clean exit, and option group epilog in help text'

+    @pytest.mark.parametrize(

+        'config',

+        [

+            {'global': {'phrase': 'my passphrase'}, 'services': {}},

+            {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'phrase': 'my passphrase'}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},

+            },

+        ],

+    )

+    def test_110_load_config_backup(

+        self, monkeypatch: pytest.MonkeyPatch, config: Any

+    ) -> None:

+        runner = click.testing.CliRunner()

+        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

+            config_filename = cli._config_filename()

+            with open(config_filename, 'w', encoding='UTF-8') as fileobj:

+                print(json.dumps(config, indent=2), file=fileobj)

+            assert cli._migrate_and_load_old_config()[0] == config

+

+    @pytest.mark.parametrize(

+        'config',

+        [

+            {'global': {'phrase': 'my passphrase'}, 'services': {}},

+            {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'phrase': 'my passphrase'}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},

+            },

+        ],

+    )

+    def test_111_migrate_config(

+        self, monkeypatch: pytest.MonkeyPatch, config: Any

+    ) -> None:

+        runner = click.testing.CliRunner()

+        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

+            config_filename = cli._config_filename()

+            with open(config_filename, 'w', encoding='UTF-8') as fileobj:

+                print(json.dumps(config, indent=2), file=fileobj)

+            assert cli._migrate_and_load_old_config() == (config, None)

+

+    @pytest.mark.parametrize(

+        'config',

+        [

+            {'global': {'phrase': 'my passphrase'}, 'services': {}},

+            {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'phrase': 'my passphrase'}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64}},

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},

+            },

+        ],

+    )

+    def test_112_migrate_config_error(

+        self, monkeypatch: pytest.MonkeyPatch, config: Any

+    ) -> None:

+        runner = click.testing.CliRunner()

+        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

+            config_filename = cli._config_filename()

+            with open(config_filename, 'w', encoding='UTF-8') as fileobj:

+                print(json.dumps(config, indent=2), file=fileobj)

+            os.mkdir(cli._config_filename(subsystem='vault'))

+            config2, err = cli._migrate_and_load_old_config()

+            assert config2 == config

+            assert isinstance(err, OSError)

+            assert err.errno == errno.EISDIR

+

+    @pytest.mark.parametrize(

+        'config',

+        [

+            {'global': '', 'services': {}},

+            {'global': 0, 'services': {}},

+            {

+                'global': {'phrase': 'abc'},

+                'services': False,

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': True,

+            },

+            {

+                'global': {'phrase': 'abc'},

+                'services': None,

+            },

+        ],

+    )

+    def test_113_migrate_config_error_bad_config_value(

+        self, monkeypatch: pytest.MonkeyPatch, config: Any

+    ) -> None:

+        runner = click.testing.CliRunner()

+        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

+            config_filename = cli._config_filename()

+            with open(config_filename, 'w', encoding='UTF-8') as fileobj:

+                print(json.dumps(config, indent=2), file=fileobj)

+            with pytest.raises(ValueError, match=cli._INVALID_VAULT_CONFIG):

+                cli._migrate_and_load_old_config()

+

     def test_200_forward_export_vault_path_parameter(

         self, monkeypatch: pytest.MonkeyPatch

     ) -> None:

@@ -1671,3 +1837,78 @@ class TestCLITransition:

             assert (

                 c not in result.output

             ), f'derived password contains forbidden character {c!r}'

+

+    def test_300_export_using_old_config_file(

+        self,

+        monkeypatch: pytest.MonkeyPatch,

+    ) -> None:

+        runner = click.testing.CliRunner(mix_stderr=False)

+        with tests.isolated_config(

+            monkeypatch=monkeypatch,

+            runner=runner,

+        ):

+            with open(

+                cli._config_filename(), 'w', encoding='UTF-8'

+            ) as fileobj:

+                print(

+                    json.dumps(

+                        {'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS}},

+                        indent=2,

+                    ),

+                    file=fileobj,

+                )

+            _result = runner.invoke(

+                cli.derivepassphrase_vault,

+                ['--export', '-'],

+                catch_exceptions=False,

+            )

+        result = tests.ReadableResult.parse(_result)

+        assert result.clean_exit(), 'expected clean exit'

+        assert (

+            'v0.1-style config file' in result.stderr

+        ), 'expected known warning message in stderr'

+        assert (

+            'Successfully migrated to ' in result.stderr

+        ), 'expected known warning message in stderr'

+

+    def test_300a_export_using_old_config_file_migration_error(

+        self,

+        monkeypatch: pytest.MonkeyPatch,

+    ) -> None:

+        runner = click.testing.CliRunner(mix_stderr=False)

+        with tests.isolated_config(

+            monkeypatch=monkeypatch,

+            runner=runner,

+        ):

+            with open(

+                cli._config_filename(), 'w', encoding='UTF-8'

+            ) as fileobj:

+                print(

+                    json.dumps(

+                        {'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS}},

+                        indent=2,

+                    ),

+                    file=fileobj,

+                )

+

+            def raiser(*_args: Any, **_kwargs: Any) -> None:

+                raise OSError(

+                    errno.EACCES,

+                    os.strerror(errno.EACCES),

+                    cli._config_filename(subsystem='vault'),

+                )

+

+            monkeypatch.setattr(os, 'replace', raiser)

+            _result = runner.invoke(

+                cli.derivepassphrase_vault,

+                ['--export', '-'],

+                catch_exceptions=False,

+            )

+        result = tests.ReadableResult.parse(_result)

+        assert result.clean_exit(), 'expected clean exit'

+        assert (

+            'v0.1-style config file' in result.stderr

+        ), 'expected known warning message in stderr'

+        assert (

+            'Warning: Failed to migrate to ' in result.stderr

+        ), 'expected known warning message in stderr'