Add templater support for rendering commit signatures #4853

pylbrecht · 2024-11-13T19:50:47Z

These changes are continuing the work of #3141.
I took over its changes and rebased them on latest main.

This work is required for #4747, as it lays the foundation for writing CLI tests for jj sign.

Checklist

If applicable:

I have updated CHANGELOG.md
I have updated the documentation (README.md, docs/, demos/)
~~I have updated the config schema (cli/src/config-schema.json)~~
I have added tests to cover my changes

bnjmnt4n · 2024-12-20T07:37:12Z

Is there anything blocking this PR? It seems to be in a functional state.

pylbrecht · 2024-12-20T08:37:33Z

Is there anything blocking this PR? It seems to be in a functional state.

Well, since I simply materialized the changes from @julienvincent and @necauqua, there are still two things missing:

printing hints about dropped commit signatures 9eaea83
docs 739ddf2

Regarding printing hints about dropped signatures, I reached out for help (#4712 (comment), #4712 (comment)).

Maybe we could merge without the hints (and create a new issue to track that missing piece to be implemented later)? Then I would focus on getting the docs ready.

bnjmnt4n · 2024-12-20T08:59:13Z

Based on the PR title, I would presume that this PR is focused mainly on being able to display commit signatures. So it seems fine to me if printing hints about dropped commit signatures is shifted to a different issue/PR, since it isn't directly related to displaying commit signatures.

pylbrecht · 2024-12-20T09:17:51Z

Sounds good to me.
I will get the PR ready and if nobody objects until then, we can merge without the hints.

pylbrecht · 2024-12-24T06:55:00Z

I pushed a slightly modified version of 739ddf2. However, I believe it was planned to add a builtin_log_compact_with_sig, which looks like this for good signatures (fancy checkmarks):

    Rebased 1 descendant commits
    Working copy now at: rlvkpnrz b162855d (empty) (no description set)
    Parent commit      : qpvuntsm [✓︎] 5aab9df2 (empty) init
    Commit was signed: qpvuntsm [✓︎] 5aab9df2 (empty) init

https://github.com/jj-vcs/jj/pull/3142/files#diff-edf6d251f71a7d4a3b3b8cf73345ea16e6dc7691ed1b98a1811d5709cbe011d2R47-R50)

@necauqua, originally this was your work, I think. Was it planned to add builtin_log_compact_with_sig?
(I cross-read a bunch of issues / PRs in the past, but I am too tired right now to recollect the facts coming out of all the discussions.)

pylbrecht · 2024-12-24T07:26:32Z

@julienvincent, I added you as co-author to the commits.
However the email from your Github profile does not seem to be the one you used for Google's CLA, which makes the cla/google job fail on CI.

Would you like to provide the email address you used to sign the CLA, so I can add you as a co-author?

julienvincent · 2024-12-24T08:30:48Z

Thanks for attribution - I just went ahead and signed the CLA for the email address you used.

I reran the check which is now passing 👍🏻

lib/tests/test_gpg.rs

pylbrecht · 2025-01-03T14:46:07Z

All right, not daring to mention the words "final" or "last", but this is ready for review again.
Also, feel free to just react with a 👍 to this comment. Then I will merge it as is.

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. Co-authored-by: julienvincent <[email protected]>

We need to provide a value for the `display` attribute to assert against in upcoming tests, which verify signature templates.

docs/templates.md

@necauqua

Disclaimer: this is the work of @necauqua and @julienvincent (see jj-vcs#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\" ``` Thankfully, @yuja pointed out that libgit2 appends a trailing newline (see bfb7613). Co-authored-by: necauqua <[email protected]> Co-authored-by: julienvincent <[email protected]>

pylbrecht · 2025-01-04T08:42:38Z

@yuja, thanks again!
I seem to no longer have write access to the repo; not sure it that came with the recent maintainer announcement. In any case, you have the honors of merging.

yuja · 2025-01-04T08:55:15Z

I seem to no longer have write access to the repo; not sure it that came with the recent maintainer announcement.

Oh, the invitation email might be missing or filtered as spam. Mine was received on "Dec 20, 2024", so it would be expired anyway.

cc @martinvonz

martinvonz · 2025-01-04T12:15:36Z

I've sent a new invitation now, @pylbrecht

Cryptographic signature support in templates was added in c99c97c (#4853), but has to be manually configured. This adds some defaults to the built-in config. Instead of having separate `builtin_*_with_sig` aliases, this adds to the aliases that actually format commits. Since signature verification is slow, this is disabled by default. To enable it, override the `should_show_cryptographic_signature()` template alias like so: [template-aliases] 'should_show_cryptographic_signature()' = 'true' 'format_short_cryptographic_signature(signature)' = ... 'format_detailed_cryptographic_signature(signature)' = ... Note that the two formatting functions take `Option<CryptographicSignature>`, not `CryptographicSignature`. This allows you to display a custom message if a signature is not found, but will emit an error if you do not check for signature presence. [template-aliases] 'format_detailed_cryptographic_signature(signature)' = ''' if(signature, "message if present", "message if missing", ) '''

Cryptographic signature support in templates was added in c99c97c (#4853), but has to be manually configured. This adds some defaults to the built-in config. Instead of having separate `builtin_*_with_sig` aliases, this adds to the aliases that actually format commits. Since signature verification is slow, this is disabled by default. To enable it, override the `should_show_cryptographic_signature()` template alias like so: [ui] show-cryptographic-signatures = true [template-aliases] 'format_short_cryptographic_signature(signature)' = ... 'format_detailed_cryptographic_signature(signature)' = ... Note that the two formatting functions take `Option<CryptographicSignature>`, not `CryptographicSignature`. This allows you to display a custom message if a signature is not found, but will emit an error if you do not check for signature presence. [template-aliases] 'format_detailed_cryptographic_signature(signature)' = ''' if(signature, "message if present", "message if missing", ) '''

Cryptographic signature support in templates was added in c99c97c (#4853), but has to be manually configured. This adds some defaults to the built-in config. Instead of having separate `builtin_*_with_sig` aliases, this adds to the aliases that actually format commits. Since signature verification is slow, this is disabled by default. To enable it, override `ui.show-cryptographic-signatures`: [ui] show-cryptographic-signatures = true [template-aliases] 'format_short_cryptographic_signature(signature)' = ... 'format_detailed_cryptographic_signature(signature)' = ... Note that the two formatting functions take `Option<CryptographicSignature>`, not `CryptographicSignature`. This allows you to display a custom message if a signature is not found, but will emit an error if you do not check for signature presence. [template-aliases] 'format_detailed_cryptographic_signature(signature)' = ''' if(signature, "message if present", "message if missing", ) '''

pylbrecht force-pushed the jj-sign/display branch 15 times, most recently from 760fda2 to b000597 Compare November 20, 2024 05:33

pylbrecht force-pushed the jj-sign/display branch 4 times, most recently from d1a1a72 to 4e6ba53 Compare November 23, 2024 19:12

bnjmnt4n mentioned this pull request Dec 20, 2024

FR: Add a command for signing commits (when signing.sign-all = false) #4712

Open

pylbrecht force-pushed the jj-sign/display branch from 4e6ba53 to f4d1de5 Compare December 24, 2024 06:38

pylbrecht force-pushed the jj-sign/display branch 2 times, most recently from b59be44 to 8a8e8b5 Compare December 24, 2024 07:18

pylbrecht force-pushed the jj-sign/display branch 4 times, most recently from 64de0ae to 48b66cf Compare January 3, 2025 13:53

pylbrecht commented Jan 3, 2025

View reviewed changes

lib/tests/test_gpg.rs Outdated Show resolved Hide resolved

pylbrecht requested a review from yuja January 3, 2025 14:46

pylbrecht force-pushed the jj-sign/display branch from 48b66cf to 3a91ed9 Compare January 4, 2025 06:30

sign: move TestSigningBackend to lib

058bbf9

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. Co-authored-by: julienvincent <[email protected]>

pylbrecht force-pushed the jj-sign/display branch from 3a91ed9 to 57de8e8 Compare January 4, 2025 07:54

sign: provide display in TestSigningBackend

c742237

We need to provide a value for the `display` attribute to assert against in upcoming tests, which verify signature templates.

pylbrecht force-pushed the jj-sign/display branch 2 times, most recently from 49cf42a to 61467cc Compare January 4, 2025 08:07

pylbrecht changed the title ~~Display commit signatures~~ Add templater support for rendering commit signatures Jan 4, 2025

yuja approved these changes Jan 4, 2025

View reviewed changes

docs/templates.md Outdated Show resolved Hide resolved

pylbrecht force-pushed the jj-sign/display branch from 61467cc to d8bffee Compare January 4, 2025 08:27

pylbrecht merged commit c99c97c into jj-vcs:main Jan 4, 2025
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add templater support for rendering commit signatures #4853

Add templater support for rendering commit signatures #4853

pylbrecht commented Nov 13, 2024 •

edited

Loading

bnjmnt4n commented Dec 20, 2024

pylbrecht commented Dec 20, 2024

bnjmnt4n commented Dec 20, 2024

pylbrecht commented Dec 20, 2024

pylbrecht commented Dec 24, 2024

pylbrecht commented Dec 24, 2024

julienvincent commented Dec 24, 2024

pylbrecht commented Jan 3, 2025

pylbrecht commented Jan 4, 2025

yuja commented Jan 4, 2025

martinvonz commented Jan 4, 2025

Add templater support for rendering commit signatures #4853

Add templater support for rendering commit signatures #4853

Conversation

pylbrecht commented Nov 13, 2024 • edited Loading

Checklist

bnjmnt4n commented Dec 20, 2024

pylbrecht commented Dec 20, 2024

bnjmnt4n commented Dec 20, 2024

pylbrecht commented Dec 20, 2024

pylbrecht commented Dec 24, 2024

pylbrecht commented Dec 24, 2024

julienvincent commented Dec 24, 2024

pylbrecht commented Jan 3, 2025

pylbrecht commented Jan 4, 2025

yuja commented Jan 4, 2025

martinvonz commented Jan 4, 2025

pylbrecht commented Nov 13, 2024 •

edited

Loading