Skip to content

This PR is to add comments to mockExecCommandInContainerForTotalStorageBytes in pkg/ddc/alluxio/ufs_test.go #5815

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.

Sign up for GitHub

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

Open
camellia-sad wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

This PR is to add comments to mockExecCommandInContainerForTotalStorageBytes in pkg/ddc/alluxio/ufs_test.go #5815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions pkg/ddc/alluxio/ufs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,16 @@ var _ = Describe("AlluxioEngine UFS related tests", func() {
})
})

// mockExecCommandInContainerForTotalStorageBytes mocks command execution output for total storage bytes.
// This helper returns a fixed stdout payload that mimics the "du"-style summary used by tests.
//
// Parameters:
// - none
//
// Returns:
// - stdout (string): Mocked command output including file count, folder count, and folder size.
// - stderr (string): Empty string because this mock simulates successful execution.
// - err (error): Always nil for the success-path test scenario.
Comment on lines +388 to +397
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 28, 2026

Choose a reason for hiding this comment

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

medium

The added documentation contains a technical inaccuracy and follows a non-idiomatic style for Go.

  1. Technical Inaccuracy: The comment describes the payload as mimicking a "du"-style summary. However, the mocked output format (File Count, Folder Count, Folder Size) corresponds to the alluxio fs count command, not du.
  2. Documentation Style: The use of explicit "Parameters" and "Returns" sections is not standard in Go doc comments. These should be simplified into concise prose as per Go conventions.
Suggested change
// mockExecCommandInContainerForTotalStorageBytes mocks command execution output for total storage bytes.
// This helper returns a fixed stdout payload that mimics the "du"-style summary used by tests.
//
// Parameters:
// - none
//
// Returns:
// - stdout (string): Mocked command output including file count, folder count, and folder size.
// - stderr (string): Empty string because this mock simulates successful execution.
// - err (error): Always nil for the success-path test scenario.
// mockExecCommandInContainerForTotalStorageBytes mocks command execution output for total storage bytes.
//
// This helper returns a fixed stdout payload that mimics the "count" summary used by tests.
// It returns a mocked stdout string containing file count, folder count, and folder size,
// along with an empty stderr and a nil error.

func mockExecCommandInContainerForTotalStorageBytes() (stdout string, stderr string, err error) {
r := `File Count Folder Count Folder Size
50000 1000 6706560319`
Expand Down
Loading