Recent commits to derivepassphrase.git (f76e05eff8a52e7287461c56995b329bc09ffb79)

Clean up testing machinery (types, helper functions)

2024-09-02T01:23:14+02:00

- Submit all input to, and read all output from, `click`-based
  command-line interfaces via the textual streams.  This includes the
  `.stdout`/`.output` and `.stderr` properties of a test runner result,
  and the input to the command-line call.

- Write a new `typing.NamedTuple`-based interface for collecting the
  test runner result in a readable fashion, because the
  `click.testing.Result` `repr` output is really unhelpful.  This also
  allows to define a higher-level API to check whether a `click`
  application ran successfully, with certain expected output, or whether
  it ran unsuccessfully, with certain expected error output.

- Annotate all pytest `monkeypatch` fixtures as `pytest.MonkeyPatch`.
</pre>

Remove `click` handling of command-line "path" arguments

2024-09-01T18:08:20+02:00

Stop using the `click` facilities to run checks on command-line
arguments or option values that are to be treated as paths; treat them
like normal strings instead.  `click`'s path checking functionality
misdiagnoses its own failure cases, is racy, and does not document its
own raciness.

Instead, use `click`'s `open_file` function to handle the standard
streams (an actual useful feature), and use bog-standard operating
system calls for everything else.  As an added bonus, this makes writing
unit tests much easier, because we no longer have to work around
`click`'s functionality and can use simpler counterexamples/failure
cases.

This change was originally prompted by a silently failing test, which
did not test the expected error message because it was subject to
translation, so `click` could silently sidestep the whole code under
test.  We now test for the operating system-provided error message
directly, via standard operating system facilities that are integrated
into the translation/locale system.
</pre>

Add man page for `derivepassphrase_export`

2024-09-01T16:46:57+02:00

The help text/docstring was missing a mention of which configuration
formats are supported, which has now been added.
</pre>

Streamline documentation file structure and linking

2024-09-01T16:27:34+02:00

Use the "index page" functionality and the unpruned navigation list from
MkDocs/Material, and use the module autorefs on the documentation overview
page.
</pre>

Add exporter modules to the documentation

2024-09-01T16:19:55+02:00

The two exporter submodules `storeroom` and `vault_native` are short
enough and thematically related, so they are placed on a common page
"Exporters for vault".
</pre>

Add vault_native exporter function and module docstrings

2024-09-01T16:13:48+02:00

Add an all-in-one exporter function to the
`derivepassphrase.exporter.vault_native` module, similar to the function
in the `derivepassphrase.exporter.storeroom` module. These two functions
now define the public API of the respective module, and the other
visible names are considered non-public (though documented, because they
explain the inner workings of the respective exporters).  The module
docstrings have been appropriately expanded, and the tests have been
adapted and expanded for the new function.
</pre>

Rename `vault_v03_and_below` submodule to `vault_native`

2024-09-01T15:01:07+02:00

</pre>

Support text string services names in Vault internal API

2024-09-01T14:55:36+02:00

</pre>

Fix the docstring of the vault native v0.2 exporter class

2024-09-01T14:28:13+02:00

The previous docstring was accidentally copy-pasted from the v0.3 class.
</pre>

Rename `derivepassphrase.vault` test file to match naming convention

2024-09-01T14:00:30+02:00

</pre>