derivepassphrase.git

@@ -7,7 +7,7 @@ derivepassphrase-vault – derive a passphrase using the vault derivation scheme

 ## SYNOPSIS

 <pre>

-<code><b>derivepassphrase vault</b> [--phrase | --key] [--length <var>n</var>] [--repeat <var>n</var>] [--lower <var>n</var>] [--upper <var>n</var>] [--number <var>n</var>] [--space <var>n</var>] [--dash <var>n</var>] [--symbol <var>n</var>] <var>SERVICE</var></code>

+<code><b>derivepassphrase vault</b> [--phrase | --key] [--length <var>n</var>] [--repeat <var>n</var>] [--lower <var>n</var>] [--upper <var>n</var>] [--number <var>n</var>] [--space <var>n</var>] [--dash <var>n</var>] [--symbol <var>n</var>] [--print-notes-before | --print-notes-after] <var>SERVICE</var></code>

 <code><b>derivepassphrase vault</b> {--phrase | --key | … | --symbol <var>n</var>} … --config [--unset <var>setting</var> …] [--overwrite-existing | --merge-existing] [<var>SERVICE</var>]</code>

 <code><b>derivepassphrase vault</b> [--phrase | --key | … | --symbol <var>n</var>] … --config --notes [--unset <var>setting</var> …] [--overwrite-existing | --merge-existing] [--modern-editor-interface | --vault-legacy-editor-interface] <var>SERVICE</var></code>

 <code><b>derivepassphrase vault</b> {--delete <var>SERVICE</var> | --delete-globals | --clear}</code>

@@ -174,6 +174,11 @@ The compatibility and extension options modify the behavior to enable additional

     (vault(1) behaves as if `--vault-legacy-editor-interface` were always given.)

+<b>-</b><b>-print-notes-before</b> / <b>-</b><b>-print-notes-after</b>

+:   When deriving a passphrase, if the service has any service notes, print these notes before or after (<em>default</em>) the passphrase.

+

+    (<i>vault</i>(1) behaves as if `--print-notes-after` were always given.)

+

 ### Other Options

 <b>-</b><b>-debug</b>

@@ -20,6 +20,7 @@

 .Op Fl \-space Ar n

 .Op Fl \-dash Ar n

 .Op Fl \-symbol Ar n

+.Op Fl \-print\-notes\-before | Fl \-print\-notes\-after

 .Ar SERVICE

 .

 .Nm derivepassphrase vault

@@ -463,6 +464,18 @@ behaves as if

 .Fl \-vault\-legacy\-editor\-interface

 were always given.)

 .

+.It Fl \-print\-notes\-before No "" / "" Fl \-print\-notes\-after

+When deriving a passphrase, if the service has any service notes,

+print these notes before or after

+.Em ( default )

+the passphrase.

+.Pp

+.

+.Xr ( vault 1

+behaves as if

+.Fl \-print\-notes\-after

+were always given.)

+.

 .El

 .

 .Ss Other options

@@ -1112,6 +1112,16 @@ class Label(enum.Enum):

         'or the vault-like legacy one (default)',

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_HELP_TEXT = commented(

+        'The corresponding option is displayed as '

+        '"--print-notes-before / --print-notes-after", so you may want to '

+        'hint that the default (after) is the second of those options.',

+    )(

+        'Label :: Help text :: One-line description',

+        'print the service notes (if any) before or after (default) '

+        'the existing configuration',

+    )

+    """"""

     EXPORT_VAULT_FORMAT_METAVAR_FMT = commented(

         '',

@@ -602,6 +602,15 @@ def derivepassphrase_export_vault(

     ),

     cls=cli_machinery.CompatibilityOption,

 )

+@click.option(

+    '--print-notes-before/--print-notes-after',

+    'print_notes_before',

+    default=False,

+    help=_msg.TranslatedString(

+        _msg.Label.DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_HELP_TEXT

+    ),

+    cls=cli_machinery.CompatibilityOption,

+)

 @cli_machinery.version_option

 @cli_machinery.color_forcing_pseudo_option

 @cli_machinery.standard_logging_options

@@ -639,6 +648,7 @@ def derivepassphrase_vault(  # noqa: C901,PLR0912,PLR0913,PLR0914,PLR0915

     unset_settings: Sequence[str] = (),

     export_as: Literal['json', 'sh'] = 'json',

     modern_editor_interface: bool = False,

+    print_notes_before: bool = False,

 ) -> None:

     """Derive a passphrase using the vault(1) derivation scheme.

@@ -738,6 +748,10 @@ def derivepassphrase_vault(  # noqa: C901,PLR0912,PLR0913,PLR0914,PLR0915

             whether editing notes uses a modern editor interface

             (supporting comments and aborting) or a vault(1)-compatible

             legacy editor interface (WYSIWYG notes contents).

+        print_notes_before:

+            Command-line arguments `--print-notes-before` (True) and

+            `--print-notes-after` (False).  Controls whether the service

+            notes (if any) are printed before the passphrase, or after.

     """  # noqa: DOC501

     logger = logging.getLogger(PROG_NAME)

@@ -1510,13 +1524,13 @@ def derivepassphrase_vault(  # noqa: C901,PLR0912,PLR0913,PLR0914,PLR0915

                 )

                 raise click.UsageError(str(err_msg))

             kwargs.pop('key', '')

-            service_notes = (

-                f'\n{settings["notes"]}\n\n' if 'notes' in settings else ''

-            )

+            service_notes = settings.get('notes', '').strip()

             result = vault.Vault(**kwargs).generate(service)

-            if service_notes.strip():

-                click.echo(service_notes, err=True, color=ctx.color)

+            if print_notes_before and service_notes.strip():

+                click.echo(f'{service_notes}\n', err=True, color=ctx.color)

             click.echo(result.decode('ASCII'), color=ctx.color)

+            if not print_notes_before and service_notes.strip():

+                click.echo(f'\n{service_notes}\n', err=True, color=ctx.color)

 if __name__ == '__main__':

@@ -641,6 +641,8 @@ class Parametrize(types.SimpleNamespace):

                     '--export-as',

                     '--modern-editor-interface',

                     '--vault-legacy-editor-interface',

+                    '--print-notes-before',

+                    '--print-notes-after',

                 }),

                 id='derivepassphrase-vault',

             ),

@@ -2470,6 +2472,62 @@ class TestCLI:

             'expected error exit and known error message'

         )

+    @pytest.mark.parametrize(

+        ['notes_placement', 'placement_args'],

+        [

+            pytest.param('after', ['--print-notes-after'], id='after'),

+            pytest.param('before', ['--print-notes-before'], id='before'),

+        ],

+    )

+    @hypothesis.given(

+        notes=strategies.text(

+            strategies.characters(

+                min_codepoint=32, max_codepoint=126, include_characters='\n'

+            ),

+            min_size=1,

+            max_size=512,

+        ).filter(str.strip),

+    )

+    def test_215_notes_placement(

+        self,

+        notes_placement: Literal['before', 'after'],

+        placement_args: list[str],

+        notes: str,

+    ) -> None:

+        maybe_notes = {'notes': notes.strip()} if notes.strip() else {}

+        vault_config = {

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

+            'services': {

+                DUMMY_SERVICE: {**maybe_notes, **DUMMY_CONFIG_SETTINGS}

+            },

+        }

+        result_phrase = DUMMY_RESULT_PASSPHRASE.decode('ascii')

+        expected = (

+            f'{notes}\n\n{result_phrase}\n'

+            if notes_placement == 'before'

+            else f'{result_phrase}\n\n{notes}\n\n'

+        )

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

+        # TODO(the-13th-letter): Rewrite using parenthesized

+        # with-statements.

+        # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

+        with contextlib.ExitStack() as stack:

+            monkeypatch = stack.enter_context(pytest.MonkeyPatch.context())

+            stack.enter_context(

+                tests.isolated_vault_config(

+                    monkeypatch=monkeypatch,

+                    runner=runner,

+                    vault_config=vault_config,

+                )

+            )

+            result_ = runner.invoke(

+                cli.derivepassphrase_vault,

+                [*placement_args, '--', DUMMY_SERVICE],

+                catch_exceptions=False,

+            )

+            result = tests.ReadableResult.parse(result_)

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

+

     @pytest.mark.parametrize(

         'modern_editor_interface', [False, True], ids=['legacy', 'modern']

     )