Recent commits to derivepassphrase.git (695ac3fd833a1d50ba99f9539d668982bbd2bc00) https://git.schokokeks.org/derivepassphrase.git/tree/695ac3fd833a1d50ba99f9539d668982bbd2bc00 Recent commits feed provided by GitList. Manage health checks in centralized hypothesis settings as well Some of the tests that time out under coverage-based slow instrumentation time out during the data generation phase, not the actual test phase (i.e. trigger health check errors). The root cause is the same, and settings objects cannot be stacked, so amend the standard decorator for slow `hypothesis`-based tests, instead of introducing a new one. https://git.schokokeks.org/derivepassphrase.git/commit/695ac3fd833a1d50ba99f9539d668982bbd2bc00 software@the13thletter.info (Marco Ricci) Tue, 08 Oct 2024 13:57:21 +0200 695ac3fd833a1d50ba99f9539d668982bbd2bc00 Centralize settings for hypothesis deadline management Our unit tests run in multiple, very different environments, which leads to drastically different execution times, up to a slowdown factor of roughly 40 (test coverage, "timid" Python tracer). The `hypothesis` library however runs timing checks on each of its tests, indepedent of the available processing power and coverage instrumentation. As a result, some benign tests time out under these circumstances regardless. In the past, I've raised their execution deadline in an ad-hoc manner whenever this happens (or fixed the tests, if they weren't so benign). But instead of littering the test suite with one-time adjustments of deadlines, a more sensible approach is to use a test decorator that ensures a common extended deadline for tests that need it, only if they need it (i.e. run under coverage). So do that. (Sadly, because of how the settings decorator works, this must be applied function-wise, and cannot be stacked with other settings decorators.) Finally, if this deadline extension still doesn't help, then this usually means we are generating huge or expensive-to-evaluate inputs. So limit the size of some of the inputs (string length, recursion depth, size of passphrases to derive) to keep execution times better constrained. https://git.schokokeks.org/derivepassphrase.git/commit/3eabf0cd303c0e2e83a61a7c7835ee66b7fb5acf software@the13thletter.info (Marco Ricci) Tue, 08 Oct 2024 11:43:10 +0200 3eabf0cd303c0e2e83a61a7c7835ee66b7fb5acf Add changelog entry for key/phrase and falsy behavior changes Document the changes in 7d2f2b1bda31ead428d3c009772aaf3d2261d60c and 798ddc103c6c03835394733aeca128b970aacd06 in the changelog. https://git.schokokeks.org/derivepassphrase.git/commit/63053f40ef9487c6ede43eb863bbd9abe578e258 software@the13thletter.info (Marco Ricci) Tue, 08 Oct 2024 10:04:11 +0200 63053f40ef9487c6ede43eb863bbd9abe578e258 Align behavior with vault concerning falsy values in config The original vault(1) sometimes checks only for falsy values (in the JavaScript sense) for its configuration settings. `derivepassphrase` however uses strict type and value checks, and rejects falsy values of the wrong type. This behavior is a visible deviation from vault(1), and shall thus be removed. A new function, `_types.clean_up_falsy_vault_config_values`, normalizes falsy values in a vault configuration to their correct types, in-place. Running this on a potential vault configuration and then calling `_types.is_vault_config` should return the same validity results as vault(1) does. The new handling of falsy values invalidates most of the tests for validation errors, as `None`/`null` was a common way to generate an invalid setting. Instead, keep a master list of vault configurations that is used (perhaps filtered first) for all validation tests, and test the handling of falsy values by generating vault configurations with falsy value replacements from the master list (a custom `hypothesis` strategy). On that note, the existing `_types.validate_vault_config` has proved rather difficult to keep at 100% coverage with the new example vault configurations, because some of the error conditions are triggered elsewhere. Accordingly, instead of treating global and service-specific settings separately and quasi-duplicating all validation checks, unify them into a queue of settings dicts to check, only mildly adjusting for the very few differing keys between them. GitHub: Closes #17. https://git.schokokeks.org/derivepassphrase.git/commit/7d2f2b1bda31ead428d3c009772aaf3d2261d60c software@the13thletter.info (Marco Ricci) Tue, 08 Oct 2024 09:32:00 +0200 7d2f2b1bda31ead428d3c009772aaf3d2261d60c Align behavior with vault concerning key and phrase in config When both a key and a passphrase are specified in the vault configuration, vault(1) would unconditionally use the key, *unless* the command-line overrides this choice. `derivepassphrase` however always gave preference to the most "specific" configuration, and would error out if both key and passphrase were specified at the same specificity. While arguably more intuitive, this behavior is a visible deviation from vault(1), and shall thus be removed. Besides two instances of the `test_200_is_vault_config` in `tests.test_derivepassphrase_types`, this also flips the result of `test_205_service_phrase_if_key_in_global_config` in `tests.test_derivepassphrase_cli`. Because that flipped version needs extra mocking infrastructure – the `sign` function – and because that mock function already exists in another test (but local to that test), promote that mock function to global and shift it into the top-level `tests` module. Since we had to update the imports in `tests` anyway, we also purged `dpp.vault...` references in `tests.test_derivepassphrase_cli` in favor of `vault...`. https://git.schokokeks.org/derivepassphrase.git/commit/798ddc103c6c03835394733aeca128b970aacd06 software@the13thletter.info (Marco Ricci) Sat, 05 Oct 2024 23:30:07 +0200 798ddc103c6c03835394733aeca128b970aacd06 Tell MkDocs to ignore scriv's changelog snippets The master changelog file is included, of course, but we don't want MkDocs to bother with the single snippets (rendering them, generating warnings that they're not part of the navigation tree, etc.). https://git.schokokeks.org/derivepassphrase.git/commit/59082d1f81b629c4be67bdcce2977db289d7c3af software@the13thletter.info (Marco Ricci) Fri, 04 Oct 2024 10:55:32 +0200 59082d1f81b629c4be67bdcce2977db289d7c3af Update required Python version in the README This was forgotten while adding Python 3.9 support. https://git.schokokeks.org/derivepassphrase.git/commit/b0d6fe8ee3208a5c123e546aa931ce06306ad8f6 software@the13thletter.info (Marco Ricci) Thu, 03 Oct 2024 13:40:52 +0200 b0d6fe8ee3208a5c123e546aa931ce06306ad8f6 Relax hypothesis deadline for another slow-ish test The vault settings validation test keeps timing out on my older hardware, when running without the C tracer and at moderate power saving settings. I can only presume it would time out similarly on even lower-powered hardware, such as a Raspberry Pi. https://git.schokokeks.org/derivepassphrase.git/commit/7bd5c68e2b3448a44f2b0faeb3025e9974ed3fb6 software@the13thletter.info (Marco Ricci) Thu, 03 Oct 2024 13:30:36 +0200 7bd5c68e2b3448a44f2b0faeb3025e9974ed3fb6 Merge topic branch 'issue15-graceful-af_unix-degredation' into master * t/issue15-graceful-af_unix-degredation: Fail gracefully if UNIX domain socket support is unavailable GitHub: Closes #15. https://git.schokokeks.org/derivepassphrase.git/commit/ba27276a76a263a2d866bc55eca012f927c34877 software@the13thletter.info (Marco Ricci) Wed, 02 Oct 2024 20:35:24 +0200 ba27276a76a263a2d866bc55eca012f927c34877 Fail gracefully if UNIX domain socket support is unavailable To talk to the SSH agent, we currently require UNIX domain socket support, but not every Python on every system supports this (notably: Windows). If we detect such missing support, fail gracefully and with a useful error message, instead of a technical reason such as `AttributeError`. Besides the new failure modes that API consumers will need to handle, this results in one more observable change: socket objects passed to the `SSHAgentClient` constructor are now required to be already connected. The constructor will no longer prepare sockets it didn't create itself in any way. This new failure behavior also has consequences for the tests, which so far have naively assumed UNIX semantics and UNIX domain socket support. So change the testing machinery to automatically skip any test that involves constructing a custom SSH agent client *and* expecting that step to go well. Furthermore, since the "no support" constellation can be reasonably well simulated even on systems that *do* have UNIX domain socket support (via pytest's monkeypatching fixture), include explicit tests on the API and the CLI level for the "no support" constellation, in any case. https://git.schokokeks.org/derivepassphrase.git/commit/27f9bd183d7b124ddf137b536d1063dd64db3c66 software@the13thletter.info (Marco Ricci) Wed, 02 Oct 2024 19:26:30 +0200 27f9bd183d7b124ddf137b536d1063dd64db3c66