Skip to content

Make the HeaderInfo constructor public for mockability in tests#404

Merged
jadamcrain merged 1 commit intomainfrom
public-header-info-constructor
Oct 3, 2025
Merged

Make the HeaderInfo constructor public for mockability in tests#404
jadamcrain merged 1 commit intomainfrom
public-header-info-constructor

Conversation

@jadamcrain
Copy link
Member

This was referenced in #384

@gemini-code-assist
Copy link

Summary of Changes

Hello @jadamcrain, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the testability of the HeaderInfo structure. By exposing its constructor, it becomes significantly easier to create mock HeaderInfo objects within unit tests. This is a crucial step for isolating and testing components that depend on HeaderInfo, ensuring that tests can run independently and reliably without being tied to complex internal construction logic.

Highlights

  • HeaderInfo Constructor: The constructor for the HeaderInfo structure has been made public by adding a full initializer. This change directly addresses the need for improved mockability of HeaderInfo in tests.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request introduces a change to the read_handler.rs file in the ffi/dnp3-schema directory by adding a full initializer to the header_info struct. This change aims to enhance mockability in tests by making the constructor public.

)?
.doc("Information about the object header and specific variation")?
.end_fields()?
.add_full_initializer("init")?

Choose a reason for hiding this comment

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

medium

Adding a full initializer to the header_info struct enhances its usability and testability. This is a good change to improve the API.
Consider adding documentation to the initializer to explain its purpose and usage.

Suggested change
.add_full_initializer("init")?
.add_full_initializer("init")? // Add a full initializer for easy object construction

@jadamcrain jadamcrain merged commit 5b3cdc9 into main Oct 3, 2025
30 checks passed
@jadamcrain jadamcrain deleted the public-header-info-constructor branch October 3, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments