-
Notifications
You must be signed in to change notification settings - Fork 11
docs: align test DSL doc with current integration_test_lib interfaces #382
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
base: compatible
Are you sure you want to change the base?
docs: align test DSL doc with current integration_test_lib interfaces #382
Conversation
Summary of ChangesHello @Fibonacci747, 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 bringing the test DSL documentation up-to-date with the actual implementation of the Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request provides a much-needed update to the test DSL documentation, aligning it with the current implementation. The changes are clear and significantly improve the documentation's accuracy by removing outdated primitives and introducing the new Malleable_error.t-based DSL features. The addition of a note about the outdated examples is also a crucial clarification for users. I have a couple of minor suggestions to further enhance the document's clarity, but overall, this is an excellent and valuable contribution.
| type task | ||
| val task : (unit test -> unit test) -> task test | ||
| val stop : task -> unit test | ||
| val wait_for : t -> Wait_condition.t -> unit Malleable_error.t |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <!-- DSL DESIGN SECTION --> | ||
| #### Pseudo-code Examples | ||
|
|
||
| Note: The following examples reflect an earlier design proposal and do not match the current DSL API. They should be translated to use `Engine.Network_manager`/`Engine.Network` for orchestration and `Dsl.wait_for` with `Wait_condition` for synchronization. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This note is very important for preventing users from trying to use outdated examples. To make it more prominent and ensure it's not missed, consider using a blockquote and bolding the 'Note' label.
| Note: The following examples reflect an earlier design proposal and do not match the current DSL API. They should be translated to use `Engine.Network_manager`/`Engine.Network` for orchestration and `Dsl.wait_for` with `Wait_condition` for synchronization. | |
| > **Note**: The following examples reflect an earlier design proposal and do not match the current DSL API. They should be translated to use `Engine.Network_manager`/`Engine.Network` for orchestration and `Dsl.wait_for` with `Wait_condition` for synchronization. |
Update test DSL documentation in docs/test_dsl_spec.md to reflect the actual interfaces in src/lib/testing/integration_test_lib/intf.ml. The prior document described a design-phase DSL with primitives like spawn, destroy, task, stop, collect, and a multi-flag wait_for, which are not present in the current code. The DSL now operates in the Malleable_error.t context, provides section/section_hard, uses wait_for : t -> Wait_condition.t -> unit Malleable_error.t with explicit Wait_condition constructors and with_timeouts, and surfaces log error accumulation helpers. This change prevents misleading guidance, aligns examples and signatures conceptually with the implemented architecture using Engine, Network_manager, Event_router, and Network_state, and adds a disclaimer indicating that existing pseudo-code reflects an earlier design and should be translated to the current model.