Skip to content

chore: add dev adr for guidelines on writting test utilities + remove test_tools and full features from mithril-common #2653

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.

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Alenar
Copy link
Collaborator

@Alenar Alenar commented Jul 25, 2025

Content

This PR add a new Dev-Adr entries, "Guidelines for crate test utilities", and remove the test_tools and full features from mithril-common in order to enhance Rust compiler ability to reuse built artifacts.

Pre-submit checklist

  • Branch
    • Crates versions are updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Add ADR blog post or Dev ADR entry (if relevant)
    • No new TODOs introduced

Issue(s)

Closes #2662, Relates to #2580

@Alenar Alenar self-assigned this Jul 25, 2025
@Alenar Alenar added refactoring 🛠️ Code refactoring and enhancements testing 🔁 Something related to tests labels Jul 25, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes the test_tools and full features from mithril-common and adds guidelines for organizing test utilities, aimed at enhancing Rust compiler artifact reuse and reducing build times.

  • Remove test_tools and full feature flags from mithril-common to simplify feature management
  • Update all dependent crates to remove references to these features
  • Add new Dev ADR guidelines for organizing crate test utilities

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mithril-common/Cargo.toml Remove test_tools and full feature definitions
mithril-common/src/lib.rs Remove feature gates from test module
mithril-common/src/entities/block_range.rs Remove feature gate from test_extensions module
mithril-common/src/crypto_helper/cardano/key_certification.rs Remove feature gate from test_extensions module
mithril-common/Makefile Remove feature checking infrastructure
Multiple Cargo.toml files Remove test_tools and full feature references from dependencies
DEV-ADR.md Add new guidelines for organizing test utilities

Copy link

github-actions bot commented Jul 25, 2025

Test Results

    4 files  ±0    158 suites  ±0   24m 21s ⏱️ +36s
2 152 tests ±0  2 152 ✅ ±0  0 💤 ±0  0 ❌ ±0 
6 602 runs  ±0  6 602 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 2839572. ± Comparison against base commit 3657df1.

♻️ This comment has been updated with latest results.

@Alenar Alenar temporarily deployed to testing-preview July 25, 2025 15:14 — with GitHub Actions Inactive
@Alenar Alenar force-pushed the djo/2580/test-structure-adr+remove-test_tools_flag branch 2 times, most recently from 7bf987e to 20cfc71 Compare July 25, 2025 15:39
@input-output-hk input-output-hk deleted a comment from Copilot AI Jul 25, 2025
Copy link
Collaborator

@turmelclem turmelclem left a comment

Choose a reason for hiding this comment

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

LGTM 🏖️

@Alenar Alenar temporarily deployed to testing-preview July 25, 2025 15:49 — with GitHub Actions Inactive
@Alenar
Copy link
Collaborator Author

Alenar commented Jul 28, 2025

Todo:

  • Lead tech approval
  • if no changes asked: rebase, version bump and merge

Alenar added 2 commits July 31, 2025 15:24
This limit the available features of `mithril-common` to a minimum,
making it easier for rust compiler to reuse build artifacts.
@Alenar Alenar force-pushed the djo/2580/test-structure-adr+remove-test_tools_flag branch from 20cfc71 to 2839572 Compare July 31, 2025 13:24
@Alenar Alenar temporarily deployed to testing-preview July 31, 2025 13:34 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring 🛠️ Code refactoring and enhancements testing 🔁 Something related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove features test_tools and full from mithril-client
3 participants