Recent commits to derivepassphrase.git (623f749ed8245822f7b00520bd4096d008673685)

Split off cli_helpers and cli_machinery internal modules

2025-01-29T22:23:26+01:00

Split off the `logging` and `click` support code (the "machinery") and
the command-specific helper functions (the "helpers") into separate
modules under `derivepassphrase._internals`.  Change all functions,
classes and attributes within those new modules to be public with
respect to the module, since the module itself is already non-public.

Also document all previously undocumented classes and functions:
`cli_helpers.ORIGIN`, `cli_helpers.check_for_misleading_passphrase`,
`cli_helpers.key_to_phrase` and `cli_helpers.print_config_as_sh_script`.
Add a better default value (`cli_helpers.default_error_callback`) for
the `error_callback` parameter of `cli_helpers.key_to_phrase`, and
document that too.  Finally, since the shell completion parts are now
split across two modules, add an explicit TODO to the
`cli_machinery.ZshComplete` class to add context.
</pre>

Move CLI messages module into a new `_internals` subpackage

2025-01-29T20:34:40+01:00

Also adjust the headings in the development build of the documentation
to clearly mark internal documentation as internal.

(The absolute imports within the CLI messages module make the move
itself relatively painless: only the callers need to be adjusted to the
new path.)
</pre>

Merge topic branch 'vault-module-api' into master

2025-01-29T16:35:02+01:00

* t/vault-module-api:
  Document API changes in the vault module
  Adjust coverage on vault tests for error-only code paths
  Adjust docstrings for vault "symbol" character class
  Make the vault UUID and CHARSETS attributes public
  Let `Vault` accept Buffer-type values wherever it accepts bytes
</pre>

Document API changes in the vault module

2025-01-29T16:34:22+01:00

</pre>

Adjust coverage on vault tests for error-only code paths

2025-01-29T15:36:12+01:00

Code paths in the tests that only do error handling due to factors
beyond their control (here: unsatisfied hypothesis assumptions, or
re-raising the error) should not be counted towards coverage.
</pre>

Adjust docstrings for vault "symbol" character class

2025-01-29T15:33:36+01:00

The "dash" class is a subset of "symbol", so we can't talk about "all
hitherto unlisted ASCII printable characters", but should list the
exceptions explicitly.
</pre>

Make the vault UUID and CHARSETS attributes public

2025-01-29T15:28:07+01:00

They are constants, they are not priviledged information, and having to
keep indirectly referring to them instead of directly is rather
irritating.
</pre>

Let `Vault` accept Buffer-type values wherever it accepts bytes

2025-01-29T15:07:21+01:00

Any method that accepts `bytes` and `bytearray` now also accepts
arbitrary Buffer-type classes such as `memoryview` and `array.array`.
The return values (mostly `bytes`, sometimes `bytearray`) remain
unchanged.
</pre>

Merge topic branch 'equivalent-hmac-keys' into master

2025-01-28T14:30:28+01:00

* t/equivalent-hmac-keys:
  Document the vault "interchangable passphrases" artefact in the changelog
  Reformat "vault" tests
  Document the vault "interchangable passphrases" artefact as an FAQ
  Detect (and test for) pairs of interchangable vault passphrases
  Add hypothesis-based test for service name dependence of derived passphrases
</pre>

Merge topic branch 'documentation-fixes' into master

2025-01-28T14:30:21+01:00

* t/documentation-fixes: (24 commits)
  Move commands' `--help` tests out of transition group
  Make CLI testing helper functions, data and strategies public
  Add hypothesis-based service name type tests for the "vault" module
  Signal failed assumptions instead of passing tests in the "vault" module
  Document hypothesis examples for "vault" tests the proper way
  Rearrange hypothesis tests in the `vault` module
  Rearrange hypothesis tests in the `ssh_agent` module
  Add more hypothesis tests for the `ssh_agent` module
  Fix improper `re` escape pattern in `ssh_agent` tests
  Add hypothesis tests for the `exporter` module
  Add hypothesis tests for the `sequin` module
  Remove use of the monkeypatch test fixture in favor of the context manager
  Prefilter some hypothesis candidate lists before sampling
  Add a "flaky" hypothesis profile to find flaky tests
  Fix test output on PyPy 3.9 due to differing error message texts
  Move repetitive hypothesis strategy definition to separate functions
  Explicitly test JS truthiness of NaN
  Allow test key suitability check to be dependent on the connected agent
  Make multiple private test attributes and functions public
  Add hypothesis inventory to documentation
  ...
</pre>