Commits on Nov 23, 2024

1. sign: move TestSigningBackend to lib …

   We need to make `TestSigningBackend` available for cli tests, as we will
   add cli tests for signing related functionality (templates for
   displaying commit signatures, `jj sign`) in upcoming commits.

   

   pylbrecht committed Nov 23, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for dec683b
   • Browse repository at this point

   Copy the full SHA

   dec683b View commit details

   Browse the repository at this point in the history

2. sign: Add templater methods to show signature info …

   Disclaimer: this is the work of @necauqua and @julienvincent (see
   martinvonz#3141). I simply materialized the changes by rebasing them on latest
   `main` and making the necessary adjustments to pass CI.
   
   ---
   
   I had to fix an issue in `TestSignatureBackend::sign()`.
   
   The following test was failing:
   ```
   ---- test_signature_templates::test_signature_templates stdout ----
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Snapshot Summary ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   Snapshot: signature_templates
   Source: cli/tests/test_signature_templates.rs:28
   ────────────────────────────────────────────────────────────────────────────────
   Expression: stdout
   ────────────────────────────────────────────────────────────────────────────────
   -old snapshot
   +new results
   ────────────┬───────────────────────────────────────────────────────────────────
       0     0 │ @  Commit ID: 05ac066d05701071af20e77506a0f2195194cbc9
       1     1 │ │  Change ID: qpvuntsmwlqtpsluzzsnyyzlmlwvmlnu
       2     2 │ │  Author: Test User <[email protected]> (2001-02-03 08:05:07)
       3     3 │ │  Committer: Test User <[email protected]> (2001-02-03 08:05:07)
       4       │-│  Signature: Good test signature
             4 │+│  Signature: Bad test signature
       5     5 │ │
       6     6 │ │      (no description set)
       7     7 │ │
       8     8 │ ◆  Commit ID: 0000000000000000000000000000000000000000
   ────────────┴───────────────────────────────────────────────────────────────────
   ```
   
   Print debugging revealed that the signature was bad, because of a
   missing trailing `\n` in `TestSignatureBackend::sign()`.
   
   ```diff
   diff --git a/lib/src/test_signing_backend.rs b/lib/src/test_signing_backend.rs
   index d47fef1086..0ba249e358 100644
   --- a/lib/src/test_signing_backend.rs
   +++ b/lib/src/test_signing_backend.rs
   @@ -59,6 +59,8 @@
            let key = (!key.is_empty()).then_some(std::str::from_utf8(key).unwrap().to_owned());
   
            let sig = self.sign(data, key.as_deref())?;
   +        dbg!(&std::str::from_utf8(&signature).unwrap());
   +        dbg!(&std::str::from_utf8(&sig).unwrap());
            if sig == signature {
                Ok(Verification::new(
                    SigStatus::Good,
   ```
   
   ```
   [lib/src/test_signing_backend.rs:62:9] &std::str::from_utf8(&signature).unwrap() = \"--- JJ-TEST-SIGNATURE ---\\nKEY: \\n5300977ff3ecda4555bd86d383b070afac7b7459c07f762af918943975394a8261d244629e430c8554258904f16dd9c18d737f8969f2e7d849246db0d93cc004\\n\"
   [lib/src/test_signing_backend.rs:63:9] &std::str::from_utf8(&sig).unwrap() = \"--- JJ-TEST-SIGNATURE ---\\nKEY: \\n5300977ff3ecda4555bd86d383b070afac7b7459c07f762af918943975394a8261d244629e430c8554258904f16dd9c18d737f8969f2e7d849246db0d93cc004\"
   ```
   
   I still have no idea, where in the call chain that trailing `\n` is
   added to `signature`. I tried to retrace `signature`'s steps. However,
   it seemed to be returned from `TestSignatureBackend::sign()`, which was
   even more mind-boggling to me since `sig` is also returned from
   `TestSignatureBackend::sign()`. How can they be different?

   

   necauqua authored and pylbrecht committed Nov 23, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for 4e6ba53
   • Browse repository at this point

   Copy the full SHA

   4e6ba53 View commit details

   Browse the repository at this point in the history