test: Add unit tests for UI Model Update logic #17
Conversation
Introduce comprehensive unit tests for the main Bubbletea model (`internal/ui/Model`), ensuring correct state transitions and command generation upon receiving various messages. Includes mock implementations for: * Git client interaction * LLM provider API calls * Sub-models (`CommitView`, `PromptView`) The dependency `github.com/stretchr/objx` was added to support the test utilities.
Summary of ChangesHello @rm-hull, 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 significantly enhances the test coverage for the application's core UI model. By introducing a new suite of unit tests, it validates the model's behavior across various states and message types, ensuring the robustness and predictability of the user interface. The use of mocks for external services and sub-components allows for focused testing of the model's internal logic without relying on actual external interactions. 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
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Updates the assertion in the `TestModel_Update` for the `regenerateMsg` handler to verify that the command returned is the expected `textinput.Blink()` initialization command.
The tests for `Model.Update` handling `llmResultMsg` no longer require setting up and asserting calls on a mocked commit view. Instead, we now assert directly that the resulting command is of type `textarea.Blink()`, which confirms the state transition and command generation correctly occurred. This simplifies the test implementation.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive set of unit tests for the UI Model's update logic, which is a fantastic addition for ensuring the correctness of state transitions and command handling. The use of mocks for dependencies is well-implemented. I've provided a few suggestions to enhance the test structure for better isolation and maintainability, improve the robustness of the test mocks, and increase the precision of some assertions. Overall, this is a solid contribution to the project's test coverage.
| func TestModel_Update(t *testing.T) { | ||
| ctx := context.Background() | ||
| mockLLM := new(MockLLMProvider) | ||
| mockGit := new(MockGitClient) | ||
|
|
||
| // Common setup for InitialModel | ||
| initialModel := func() *Model { | ||
| // Explicitly use the types to avoid "imported and not used" warnings | ||
| var _ interfaces.GitClient = mockGit | ||
| var _ llmprovider.Provider = mockLLM | ||
| return InitialModel(ctx, mockLLM, mockGit, "system prompt", "user message") | ||
| } |
There was a problem hiding this comment.
The TestModel_Update function is quite long and contains repetitive setup code. Additionally, the mock instances (mockLLM, mockGit) are created once and shared across all sub-tests, which can lead to test interdependence and flaky tests.
A great way to solve both issues is to refactor this into a table-driven test. This would:
- Improve Readability & Maintainability: Consolidate test cases into a single, easy-to-scan table.
- Ensure Test Isolation: Allow for fresh mocks to be created for each test case within the
t.Runloop.
Here is an example of how you could structure it:
func TestModel_Update(t *testing.T) {
testCases := []struct {
name string
// ... setup fields
}{ /* ... test cases ... */ }
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
// Create fresh mocks here
mockLLM := new(MockLLMProvider)
mockGit := new(MockGitClient)
// Setup model and mocks based on tc fields
// Run test and assert
})
}
}Updates tests within `internal/ui/model_test.go`:
* Makes the mocked `commitView` update expectation explicit
when testing `Ctrl+C` handling.
* Removes redundant assertion on the updated model within
the spinner tick message test, focusing solely on validating
that a command is returned.
Refactor the `mockTeaModel` methods to safely retrieve return values from the underlying mocking framework (`m.Called`). This ensures the mock does not panic if expected arguments are missing or of the incorrect type, defaulting to `nil` or the mock receiver itself where appropriate.
Introduce comprehensive unit tests for the main Bubbletea model (
internal/ui/Model), ensuring correct state transitions and command generation upon receiving various messages.Includes mock implementations for:
CommitView,PromptView)The dependency
github.com/stretchr/objxwas added to support the test utilities.