feat: added test-cases for agentcube components #157
Conversation
Signed-off-by: Yash Israni <118755067+yashisrani@users.noreply.github.com>
volcano-sh-bot
requested review from
LiZhenCheng9527,
YaoZengzeng and
hzxuzhonghu
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @yashisrani, 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 improves the testing infrastructure and code quality of the AgentCube project by adding a substantial suite of new unit and integration tests. The changes focus on ensuring the robustness of critical components, from CLI flag parsing and configuration to Kubernetes resource management and API interactions. This effort aims to catch regressions early, enhance system stability, and move towards a higher standard of code coverage. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive unit tests for the agentcube components, significantly improving test coverage from 55% to 61%. The new tests cover flag parsing, config building, end-to-end API interactions, JWT management, client caching, garbage collection, and controller reconciliation logic across agentd, picod, router, and workload-manager. The addition of a hack/check-coverage.sh script also helps enforce a target coverage percentage. Overall, this is a valuable contribution to the project's stability and maintainability.
|
|
||
| // Verify deletion | ||
| err = fakeClient.Get(context.Background(), types.NamespacedName{Name: "test-ci", Namespace: "default"}, wp) | ||
| assert.True(t, err != nil && (isNotFound(err) || true)) // fake client returns error on not found |
There was a problem hiding this comment.
The condition (isNotFound(err) || true) will always evaluate to true, making the isNotFound(err) check ineffective. This means the test will pass even if isNotFound(err) returns false, hiding potential issues with error handling. It should likely just assert isNotFound(err) directly.
| assert.True(t, err != nil && (isNotFound(err) || true)) // fake client returns error on not found | |
| assert.True(t, isNotFound(err)) |
| patches := gomonkey.NewPatches() | ||
| defer patches.Reset() | ||
|
|
||
| patches.ApplyFunc(extractUserInfo, func(_ *gin.Context) (string, string, string, string) { | ||
| return "token", "ns", "sa", "sa-name" | ||
| }) | ||
|
|
||
| patches.ApplyMethod(reflect.TypeOf(s.k8sClient), "GetOrCreateUserK8sClient", func(_ *K8sClient, _, _, _ string) (*UserK8sClient, error) { | ||
| return &UserK8sClient{dynamicClient: nil}, nil | ||
| }) | ||
|
|
||
| patches.ApplyFunc(deleteSandbox, func(_ context.Context, _ dynamic.Interface, _, _ string) error { | ||
| return nil | ||
| }) | ||
| patches.ApplyFunc(deleteSandboxClaim, func(_ context.Context, _ dynamic.Interface, _, _ string) error { | ||
| return nil | ||
| }) | ||
|
|
||
| // Mock store to return a sandbox | ||
| s.storeClient = &httpFakeStore{ | ||
| sandbox: &types.SandboxInfo{ | ||
| Kind: types.AgentRuntimeKind, | ||
| SessionID: "sess-123", | ||
| SandboxNamespace: "default", | ||
| Name: "test-sb", | ||
| }, | ||
| } | ||
|
|
||
| w := httptest.NewRecorder() | ||
| req, _ := http.NewRequest("DELETE", "/v1/agent-runtime/sessions/sess-123", nil) | ||
| s.router.ServeHTTP(w, req) | ||
| assert.Equal(t, http.StatusOK, w.Code) | ||
| }) | ||
|
|
||
| t.Run("handleAgentRuntimeCreate", func(t *testing.T) { | ||
| patches := gomonkey.NewPatches() | ||
| defer patches.Reset() | ||
|
|
||
| patches.ApplyFunc(extractUserInfo, func(_ *gin.Context) (string, string, string, string) { | ||
| return "token", "ns", "sa", "sa-name" | ||
| }) | ||
|
|
||
| patches.ApplyMethod(reflect.TypeOf(s.k8sClient), "GetOrCreateUserK8sClient", func(_ *K8sClient, _, _, _ string) (*UserK8sClient, error) { | ||
| return &UserK8sClient{dynamicClient: nil}, nil | ||
| }) | ||
|
|
||
| patches.ApplyFunc(buildSandboxByAgentRuntime, func(_, _ string, _ *Informers) (*sandboxv1alpha1.Sandbox, *sandboxEntry, error) { | ||
| return &sandboxv1alpha1.Sandbox{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: "test-sb", Namespace: "default", UID: "uid-123"}, | ||
| }, &sandboxEntry{SessionID: "sess-123", Ports: []runtimev1alpha1.TargetPort{{Port: 8080}}}, nil | ||
| }) | ||
|
|
||
| // Mock WatchSandboxOnce | ||
| resultChan := make(chan SandboxStatusUpdate, 1) | ||
| resultChan <- SandboxStatusUpdate{Sandbox: &sandboxv1alpha1.Sandbox{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: "test-sb", Namespace: "default", UID: "uid-123"}, | ||
| }} | ||
| patches.ApplyMethod(reflect.TypeOf(s.sandboxController), "WatchSandboxOnce", func(_ *SandboxReconciler, _ context.Context, _, _ string) <-chan SandboxStatusUpdate { | ||
| return resultChan | ||
| }) | ||
| patches.ApplyMethod(reflect.TypeOf(s.sandboxController), "UnWatchSandbox", func(_ *SandboxReconciler, _, _ string) {}) | ||
|
|
||
| // Mock internal createSandbox call chain | ||
| patches.ApplyFunc(createSandbox, func(_ context.Context, _ dynamic.Interface, _ *sandboxv1alpha1.Sandbox) (*SandboxInfo, error) { | ||
| return &SandboxInfo{Name: "test-sb", Namespace: "default"}, nil | ||
| }) | ||
|
|
||
| patches.ApplyMethod(reflect.TypeOf(s.k8sClient), "GetSandboxPodIP", func(_ *K8sClient, _ context.Context, _, _, _ string) (string, error) { | ||
| return "10.0.0.1", nil | ||
| }) | ||
|
|
||
| body, _ := json.Marshal(types.CreateSandboxRequest{ | ||
| Namespace: "default", | ||
| Name: "test-agent", | ||
| }) | ||
|
|
||
| w := httptest.NewRecorder() | ||
| req, _ := http.NewRequest("POST", "/v1/agent-runtime", bytes.NewBuffer(body)) | ||
| req.Header.Set("Content-Type", "application/json") | ||
| s.router.ServeHTTP(w, req) | ||
|
|
||
| assert.Equal(t, http.StatusOK, w.Code) | ||
| assert.Contains(t, w.Body.String(), "sess-123") | ||
| }) | ||
|
|
||
| t.Run("handleCodeInterpreterCreate", func(t *testing.T) { | ||
| patches := gomonkey.NewPatches() | ||
| defer patches.Reset() | ||
|
|
||
| patches.ApplyFunc(extractUserInfo, func(_ *gin.Context) (string, string, string, string) { | ||
| return "token", "ns", "sa", "sa-name" | ||
| }) | ||
|
|
||
| patches.ApplyMethod(reflect.TypeOf(s.k8sClient), "GetOrCreateUserK8sClient", func(_ *K8sClient, _, _, _ string) (*UserK8sClient, error) { | ||
| return &UserK8sClient{dynamicClient: nil}, nil | ||
| }) | ||
|
|
||
| patches.ApplyFunc(buildSandboxByCodeInterpreter, func(_, _ string, _ *Informers) (*sandboxv1alpha1.Sandbox, *extensionsv1alpha1.SandboxClaim, *sandboxEntry, error) { | ||
| return &sandboxv1alpha1.Sandbox{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: "test-sb", Namespace: "default", UID: "uid-123"}, | ||
| }, nil, &sandboxEntry{SessionID: "sess-123", Ports: []runtimev1alpha1.TargetPort{{Port: 8080}}}, nil | ||
| }) | ||
|
|
||
| // Mock WatchSandboxOnce | ||
| resultChan := make(chan SandboxStatusUpdate, 1) | ||
| resultChan <- SandboxStatusUpdate{Sandbox: &sandboxv1alpha1.Sandbox{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: "test-sb", Namespace: "default", UID: "uid-123"}, | ||
| }} | ||
| patches.ApplyMethod(reflect.TypeOf(s.sandboxController), "WatchSandboxOnce", func(_ *SandboxReconciler, _ context.Context, _, _ string) <-chan SandboxStatusUpdate { | ||
| return resultChan | ||
| }) | ||
| patches.ApplyMethod(reflect.TypeOf(s.sandboxController), "UnWatchSandbox", func(_ *SandboxReconciler, _, _ string) {}) | ||
|
|
||
| // Mock internal createSandbox call chain | ||
| patches.ApplyFunc(createSandbox, func(_ context.Context, _ dynamic.Interface, _ *sandboxv1alpha1.Sandbox) (*SandboxInfo, error) { | ||
| return &SandboxInfo{Name: "test-sb", Namespace: "default"}, nil | ||
| }) | ||
|
|
||
| patches.ApplyMethod(reflect.TypeOf(s.k8sClient), "GetSandboxPodIP", func(_ *K8sClient, _ context.Context, _, _, _ string) (string, error) { | ||
| return "10.0.0.1", nil | ||
| }) | ||
|
|
||
| body, _ := json.Marshal(types.CreateSandboxRequest{ | ||
| Namespace: "default", | ||
| Name: "test-ci", | ||
| }) | ||
|
|
||
| w := httptest.NewRecorder() | ||
| req, _ := http.NewRequest("POST", "/v1/code-interpreter", bytes.NewBuffer(body)) | ||
| req.Header.Set("Content-Type", "application/json") | ||
| s.router.ServeHTTP(w, req) | ||
|
|
||
| assert.Equal(t, http.StatusOK, w.Code) | ||
| assert.Contains(t, w.Body.String(), "sess-123") | ||
| }) | ||
|
|
||
| t.Run("handleDeleteSandbox_NotFound", func(t *testing.T) { | ||
| patches := gomonkey.NewPatches() | ||
| defer patches.Reset() | ||
|
|
||
| // Mock store to return not found | ||
| s.storeClient = &httpFakeStore{sandbox: nil} |
There was a problem hiding this comment.
The extensive use of gomonkey to mock internal functions and methods in these HTTP handler tests makes them less robust and harder to maintain. Over-mocking can lead to tests that don't accurately reflect real-world behavior and can break easily if internal implementations change. Consider using more integrated testing approaches where possible, such as setting up a gin.Engine with actual dependencies (like a fake Kubernetes client or a custom fake store) rather than mocking every function call. This would allow for more realistic interaction testing and better verification of the handler's logic.
For example, instead of mocking extractUserInfo, you could set up the gin.Context with appropriate values that extractUserInfo would normally read. For GetOrCreateUserK8sClient, deleteSandbox, createSandbox, and GetSandboxPodIP, returning a fake.NewSimpleDynamicClient() or a mock object that can record calls and return configurable results would provide better fidelity.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #157 +/- ##
=======================================
Coverage ? 59.06%
=======================================
Files ? 29
Lines ? 2533
Branches ? 0
=======================================
Hits ? 1496
Misses ? 828
Partials ? 209
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| } | ||
| } | ||
|
|
||
| func TestConfigBuilding(t *testing.T) { |
There was a problem hiding this comment.
I think we should write UT to test core logic. Testing like this doesn't make any sense.
4 participants
fix: #88
Adds unit-test coverage for all four AgentCube CLI binaries (
agentd,picod,router,workload-manager) so that:./hack/check-coverage.shTest matrix
All packages PASS; the only failure is the aggregate gate (61.4 % < 70 %).
Notes
main()remains untested).pkg/*; these tests guard the entry-points.