Recent commits to derivepassphrase.git (e0810c5d6b0cf4f2549c8354bfe020c35b211c41)

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>

Move commands' `--help` tests out of transition group

2025-01-28T11:03:57+01:00

These tests aren't specific to the v1.0 transition, and if we still want
to keep them in some way or another, they should probably outlast v1.0.
</pre>

Make CLI testing helper functions, data and strategies public

2025-01-28T00:15:01+01:00

Make these helpers public in the sense that they get picked up by the
API documentation generator.
</pre>

Add hypothesis-based service name type tests for the "vault" module

2025-01-27T00:35:36+01:00

Check that equivalent service name strings, byte strings and byte arrays
all derive the same passphrases.
</pre>

Signal failed assumptions instead of passing tests in the "vault" module

2025-01-26T23:42:36+01:00

One hypothesis-enabled test function of the "vault" module tests that
the constructor accepts a given set of settings.  While the generator
attempts to yield only satisfiable settings, there are certain settings
that cannot derive a passphrase for one service name, but can derive one
for other names.  In these cases, the specific generated characters and
occurrence limitations together disallow all otherwise eligible
candidates for the next character.

Tests with such configurations should actually be skipped, but
hypothesis-based tests need different skip handling than normal
pytest-based tests.  Previously we would "fake" skipping by silently
returning early, which suggests that the test actually *passed*.  Now,
we use `hypothesis.assume` to signal to hypothesis to generate
a different datum instead.
</pre>

Document hypothesis examples for "vault" tests the proper way

2025-01-26T23:40:15+01:00

Use `hypothesis.example(...).via(...)` instead of source code comments.
</pre>

Rearrange hypothesis tests in the `vault` module

2025-01-26T20:10:35+01:00

Just like in 9db6c6591de054433ae98d59f7930364e7d03286 for the
`ssh_agent` tests, arrange the `vault` hypothesis tests so that they lie
next to the respective non-hypothesis test, if any.  Also rename and/or
renumber them as necessary.
</pre>

Rearrange hypothesis tests in the `ssh_agent` module

2025-01-26T16:34:47+01:00

Arrange the hypothesis tests so that they lie next to the respective
non-hypothesis test, if any, instead of bundling them all in the same
testing class.  By doing this, related tests are closer to each other,
if possible.  Use the hypothesis mark instead of the testing class if
filtering is required.

Additionally, since the helper functions `as_ssh_string`,
`canonicalize1` and `canonicalize2` now are visible in and assigned to
a broader context, give them proper docstrings.
</pre>

Add more hypothesis tests for the `ssh_agent` module

2025-01-26T16:21:45+01:00

Add more hypothesis tests for SSH string encoding and decoding, based on
David R. MacIver's articles.  Also document the explicit examples in the
proper way.
</pre>

Fix improper `re` escape pattern in `ssh_agent` tests

2025-01-26T16:17:09+01:00

</pre>