test: add pods and descriptions dump #1519
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is required to get more information about the state of test case resources when a test fails. Signed-off-by: Roman Sysoev <roman.sysoev@flant.com>
Reviewer's GuideThis PR refactors the test failure dump mechanism by renaming and splitting the original SaveTestResources function into a new SaveTestCaseDump wrapper with dedicated helpers for resource, log, and description dumps (including namespace support), and updates all e2e tests to use the new API. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Consider creating the dumpPath directory if it doesn’t already exist before writing files to avoid write failures.
- There’s a lot of duplicated logic in SavePodLogs and SavePodDescriptions—extract the common pod iteration and file-writing code into a helper to reduce repetition.
- Inside the loops, error logging refers to the wrong variable (err) when cmd.Error occurs; make sure you’re printing the actual command error (cmd.Error()).
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider creating the dumpPath directory if it doesn’t already exist before writing files to avoid write failures.
- There’s a lot of duplicated logic in SavePodLogs and SavePodDescriptions—extract the common pod iteration and file-writing code into a helper to reduce repetition.
- Inside the loops, error logging refers to the wrong variable (err) when cmd.Error occurs; make sure you’re printing the actual command error (cmd.Error()).
## Individual Comments
### Comment 1
<location> `tests/e2e/util_test.go:796` </location>
<code_context>
+ pods := &corev1.PodList{}
+ err := GetObjects(kc.ResourcePod, pods, kc.GetOptions{Namespace: namespace, Labels: labels})
+ if err != nil {
+ GinkgoWriter.Printf("Failed to get PodList:\n%s\n", err)
+ }
+
</code_context>
<issue_to_address>
**suggestion (testing):** Consider adding a test for handling empty pod lists in SavePodLogs and SavePodDescriptions.
A test verifying the behavior when the pod list is empty will clarify expectations and aid future maintenance.
Suggested implementation:
```golang
import (
"testing"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
)
func TestSavePodLogs_EmptyPodList(t *testing.T) {
// Arrange
labels := map[string]string{"app": "test"}
additional := "additional"
namespace := "default"
dumpPath := "/tmp"
// Mock GetObjects to return an empty pod list
originalGetObjects := GetObjects
defer func() { GetObjects = originalGetObjects }()
GetObjects = func(resource string, obj interface{}, opts kc.GetOptions) error {
podList, ok := obj.(*corev1.PodList)
if ok {
podList.Items = []corev1.Pod{}
}
return nil
}
// Act
SavePodLogs(labels, additional, namespace, dumpPath)
// Assert
// No panic or error expected, logs should indicate empty pod list handled gracefully
// (You may want to check log output if your framework supports it)
}
func TestSavePodDescriptions_EmptyPodList(t *testing.T) {
// Arrange
labels := map[string]string{"app": "test"}
additional := "additional"
namespace := "default"
dumpPath := "/tmp"
// Mock GetObjects to return an empty pod list
originalGetObjects := GetObjects
defer func() { GetObjects = originalGetObjects }()
GetObjects = func(resource string, obj interface{}, opts kc.GetOptions) error {
podList, ok := obj.(*corev1.PodList)
if ok {
podList.Items = []corev1.Pod{}
}
return nil
}
// Act
SavePodDescriptions(labels, additional, namespace, dumpPath)
// Assert
// No panic or error expected, logs should indicate empty pod list handled gracefully
// (You may want to check log output if your framework supports it)
}
```
- If `SavePodDescriptions` does not exist or has a different signature, adjust the test accordingly.
- If you use a different mocking framework, adapt the mocking of `GetObjects` to your project's conventions.
- If your test suite uses Ginkgo or another BDD framework, you may want to use its test constructs instead of the standard `testing` package.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: Roman Sysoev <roman.sysoev@flant.com>
hardcoretime
force-pushed
the
test/add-pods-and-descriptions-dump
branch
from
af6f447 to
ea1dd02
Compare
diafour
reviewed
Oct 2, 2025
diafour
reviewed
Oct 2, 2025
Signed-off-by: Roman Sysoev <roman.sysoev@flant.com>
diafour
approved these changes
Oct 2, 2025
|
Workflow has started. The target step completed with status: failure. |
Isteb4k
pushed a commit
that referenced
this pull request
Oct 3, 2025
This is required to get more information about the state of test case resources when a test fails. Signed-off-by: Roman Sysoev <roman.sysoev@flant.com> (cherry picked from commit 0ed00cf)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Why do we need it, and what problem does it solve?
This is required to get more information about the state of test case resources when a test fails.
What is the expected result?
Checklist
Changelog entries