Test Files Pass CI Despite Improper Indentation

[nmn3m]

Issue

PR #[2749] passed CI checks despite containing improper indentation in test files. Current linting configuration doesn't catch indentation issues in test files.

Example

# From horizontalpodautoscaler_test.go
        # TYPE kube_horizontalpodautoscaler_spec_min_replicas gauge
                # TYPE kube_horizontalpodautoscaler_spec_target_metric gauge
    # TYPE kube_horizontalpodautoscaler_status_condition gauge

Solution

• Update .golangci.yml to enable whitespace linting for test files
• Add CI check for consistent test file indentation
• Add style check to make lint command

Impact

• Maintains consistent codebase style
• Catches formatting issues before merge

[k8s-ci-robot]

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[nmn3m]

/assign @nmn3m

[nmn3m]

@rexagod

Note

It seems this issue can’t be solved purely with golangci-lint, since the indentation problem is inside raw string literals in test files and not Go code itself.

Question

Do you have any suggestion on how we can enforce consistent formatting for these cases?

[mrueg]

I see it as well in https://github.com/kubernetes/kube-state-metrics/blob/main/internal/store/endpointslice_test.go#L160

Most likely this check needs to be improved:

kube-state-metrics/internal/store/testutils.go

Line 42 in 941c683

func (testCase *generateMetricsTestCase) run() error {

kube-state-metrics/internal/store/testutils.go

Line 62 in 941c683

func compareOutput(expected, actual string) error {

[nmn3m]

@mrueg

While investigating endpointslice_test.go, I noticed that test files often mix tabs and spaces in multiline Want strings.
Although tests pass (compareOutput() strips whitespace), this makes the code less readable and inconsistent.

What would you suggest as the best way to address this?

• Handle it as part of a broader style standardization effort
• Or take another approach you recommend?

[mrueg]

@nmn3m probably we need to change

kube-state-metrics/internal/store/testutils.go

Line 152 in 941c683

trimmedLine = strings.TrimSpace(l)

and use strings.trimLeft(l," ") instead?

[nmn3m]

Thanks for the suggestion @mrueg!
I went with strings.TrimLeft(l, " \t") instead of just " " so that both spaces and tabs are handled consistently. That solved the test failures we were seeing due to mixed indentation.