Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat: implement certificate chain builder for tests #1999

Merged
merged 16 commits into from
Oct 17, 2024
Merged

Feat: implement certificate chain builder for tests #1999

merged 16 commits into from
Oct 17, 2024

Conversation

jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Oct 11, 2024 •
edited
Loading

Content

This PR includes the implementation of a Certificate Chain Builder for tests:

  • This part of the code is now more readable and maintainable
  • The certificate chains allows alteration of the genesis and standard certificates with closures
  • The computation of the number of signers per epoch is now configurable with a closure

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested

@jpraynaud jpraynaud self-assigned this Oct 11, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 11, 2024 •
edited
Loading

Test Results

    4 files  ± 0     55 suites  ±0   10m 26s ⏱️ +58s
1 368 tests +13  1 368 ✅ +13  0 💤 ±0  0 ❌ ±0 
1 576 runs  +13  1 576 ✅ +13  0 💤 ±0  0 ❌ ±0 

Results for commit 335ee13. ± Comparison against base commit d1ce9a3.

♻️ This comment has been updated with latest results.

@jpraynaud jpraynaud force-pushed the jpraynaud/refactor-certificate-chain-test-setup branch 4 times, most recently from 732212c to bf2b315 Compare October 15, 2024 14:18
@jpraynaud jpraynaud marked this pull request as ready for review October 15, 2024 15:13
dlachaume
dlachaume approved these changes Oct 16, 2024
View reviewed changes
Copy link
Collaborator

@dlachaume dlachaume left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀, thanks for the tool, it will make testing cases on the certificate chain much easier 🙏.

Just a comment regarding the exposure of data in the certificate_chain_builder module.
It seems that we could set the following traits to private visibility:

  • GenesisCertificateProcessorFunc
  • StandardCertificateProcessorFunc
  • TotalSignersPerEpochProcessorFunc

The CertificateChainBuilderContext struct could also switch to private by adding a #[cfg(test)] attribute on the with_genesis_certificate_processor and with_standard_certificate_processor functions.

Do you think it could be a good idea?

mithril-common/src/test_utils/certificate_chain_builder.rs Outdated Show resolved Hide resolved
mithril-common/src/test_utils/certificate_chain_builder.rs Outdated Show resolved Hide resolved
sfauvel
sfauvel approved these changes Oct 16, 2024
View reviewed changes
Copy link
Collaborator

@sfauvel sfauvel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mithril-common/src/test_utils/certificate_chain_builder.rs Outdated Show resolved Hide resolved
Alenar
Alenar approved these changes Oct 16, 2024
View reviewed changes
Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jpraynaud
feat: implement a certificate chain builder for tests
facae4f
@jpraynaud
refactor: use CertificateChainBuilder in crypto helper tests setup
0d19ddd
@jpraynaud
feat: add support for certificate chain alteration in CertificateChai…
c6b5bda 
…nBuilder
@jpraynaud
refactor: simplify chain alteration processor in CertificateChainBuilder
3819759
@jpraynaud
refactor: enhance CertificateChainBuilder implementation
d255561
@jpraynaud
feat: add support for number of signers per epoch processor in Certif…
a944266 
…icateChainBuilder
@jpraynaud
feat: enhance tests for CertificateChainBuilder
91ce6a5
@jpraynaud
refactor: make CertificateChainBuilderContext compute seed protocol m…
391ac54 
…essage
@jpraynaud
feat: CertificateChainBuilderContext checks if current certificate is…
e013fcd 
… last in chain
@jpraynaud
fix: avoid unneeded computation of fixtures in CertificateChainBuilder
fb13267
@jpraynaud
refactor: epochs sequence computation in CertificateChainBuilder
f6ed39b
@jpraynaud
refactor: make epochs and certificate index sequences easier to under…
9b63c01 
…stand

By splitting the epochs sequence in:
- (epoch) sequence which is the list of epochs used when creating internal artifacts
- (certificate_index, epoch) sequence which is explicitely used to create the final certificate chain.
@jpraynaud jpraynaud force-pushed the jpraynaud/refactor-certificate-chain-test-setup branch from bf2b315 to 9b63c01 Compare October 16, 2024 13:49
@jpraynaud
Copy link
Member Author

Just a comment regarding the exposure of data in the certificate_chain_builder module. It seems that we could set the following traits to private visibility:

  • GenesisCertificateProcessorFunc
  • StandardCertificateProcessorFunc
  • TotalSignersPerEpochProcessorFunc

You're right. Done ✔️

The CertificateChainBuilderContext struct could also switch to private by adding a #[cfg(test)] attribute on the with_genesis_certificate_processor and with_standard_certificate_processor functions.

Do you think it could be a good idea?

The usage of #[cfg(test)] is not possible as we will use this builder in other crates.
Also the CertificateChainBuilderContext should keep its field public as they give valuable information when altering the certificate chain

@jpraynaud
refactor: change visibility of processor function types
22c9b78 
And add a factory for the 'CertificateChainBuilderContext'.
@jpraynaud jpraynaud merged commit 3908e8a into main Oct 17, 2024
48 checks passed
@jpraynaud jpraynaud deleted the jpraynaud/refactor-certificate-chain-test-setup branch October 17, 2024 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Alenar Alenar Alenar approved these changes

@sfauvel sfauvel sfauvel approved these changes

@dlachaume dlachaume dlachaume approved these changes

Assignees

@jpraynaud jpraynaud

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jpraynaud @Alenar @sfauvel @dlachaume