Skip to content

Add comments to TestAlluxioFileUtils_ReportSummary in pkg/ddc/alluxio… #6021

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
Kamin-y wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −1
Open

Add comments to TestAlluxioFileUtils_ReportSummary in pkg/ddc/alluxio… #6021

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
4 changes: 3 additions & 1 deletion pkg/ddc/alluxio/operations/base_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,9 @@ func TestAlluxioFileUtils_Du(t *testing.T) {
}
}

func TestAlluxioFileUtils_ReportSummary(t *testing.T) {
// TestAlluxioFileUtils_ReportSummary tests the AlluxioFileUtils.ReportSummary method
// for both failure and success cases by mocking the internal exec command.

@cheyang cheyang Jun 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Once the indentation is fixed, the wording is fine, but for consistency with the comments on TestAlluxioFileUtils_LoadMetaData and similar tests just below, you could keep the same two-line shape ("... tests the AlluxioFileUtils.X method / for both failure and success cases by mocking the internal exec command."). The current text already aligns with that pattern, so this is purely a polish suggestion.

func TestAlluxioFileUtils_ReportSummary(t *testing.T) {

@cheyang cheyang Jun 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

These three new lines all start with a leading tab, which pushes the // TestAlluxioFileUtils_ReportSummary ... doc comment and the func TestAlluxioFileUtils_ReportSummary(t *testing.T) { declaration off column 0. Top-level declarations in Go must not be indented; gofmt/goimports (and the project's lint/Project Check job) will reject this, and the resulting file mixes an indented signature with a non-indented body, which is jarring to read. Please drop the leading tab from all three added lines so the comment and func keyword start at column 0, matching the style used for the neighbouring TestAlluxioFileUtils_LoadMetadataWithoutTimeout and TestAlluxioFileUtils_LoadMetaData doc comments just below.

ExecCommon := func(a AlluxioFileUtils, command []string, verbose bool) (stdout string, stderr string, err error) {
return "Alluxio cluster summary", "", nil
}
Expand Down
Loading