Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Allow indented YAML in tests #4272

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.

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

Merged
cbandy merged 2 commits into CrunchyData:main from cbandy:indent-yaml
Sep 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
59 changes: 58 additions & 1 deletion internal/testing/cmp/cmp.go
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ func MarshalMatches(actual any, expected string) Comparison {
if err != nil {
return func() gotest.Result { return gotest.ResultFromError(err) }
}
return gotest.DeepEqual(string(b), strings.Trim(expected, "\t\n")+"\n")
return gotest.DeepEqual(string(b), dedentLines(
strings.TrimLeft(strings.TrimRight(expected, "\t\n"), "\n"), 2,
))
}

// Regexp succeeds if value contains any match of the regular expression.
Expand All @@ -89,3 +91,58 @@ func MarshalMatches(actual any, expected string) Comparison {
func Regexp[RE *regexp.Regexp | ~string](regex RE, value string) Comparison {
return gotest.Regexp(regex, value)
}

var leadingTabs = regexp.MustCompile(`^\t+`)

// dedentLines finds the shortest leading whitespace of every line in data and then removes it from every line.
// When tabWidth is positive, leading tabs are converted to spaces first.
func dedentLines(data string, tabWidth int) string {
if len(data) < 1 {
return ""
}

var lines = make([]string, 0, 20)
var lowest, highest string

for line := range strings.Lines(data) {
tabs := leadingTabs.FindString(line)

// Replace any leading tabs with spaces when tabWidth is positive.
// NOTE: [strings.Repeat] has a fast-path for spaces.
if need := tabWidth * len(tabs); need > 0 {
line = strings.Repeat(" ", need) + line[len(tabs):]
}

switch {
case lowest == "", highest == "":
lowest, highest = line, line

case len(strings.TrimSpace(line)) > 0:
lowest = min(lowest, line)
highest = max(highest, line)
}

lines = append(lines, line)
}

// This treats one tab the same as one space.
// That is, it expects all lines to be indented using spaces or using tabs; not both.
if width := func() int {
for i := range lowest {
if (lowest[i] != ' ' && lowest[i] != '\t') || lowest[i] != highest[i] {
return i
}
}
return len(lowest)
}(); width > 0 {
for i := range lines {
if len(lines[i]) > width {
lines[i] = lines[i][width:]
} else {
lines[i] = "\n"
}
}
}

return strings.TrimSuffix(strings.Join(lines, ""), "\n") + "\n"
}
66 changes: 66 additions & 0 deletions internal/testing/cmp/cmp_test.go
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// Copyright 2021 - 2025 Crunchy Data Solutions, Inc.
//
// SPDX-License-Identifier: Apache-2.0

package cmp

import (
"fmt"
"testing"

"gotest.tools/v3/assert"
)

func TestDedentLines(t *testing.T) {
for _, tc := range []struct {
width int
input string
expected string
}{
// empty stays that way
{width: 0, input: "", expected: ""},
{width: 1, input: "", expected: ""},
{width: 2, input: "", expected: ""},

// adds a missing newline
{input: "\n", expected: "\n"},
{input: "x", expected: "x\n"},
{input: "x\n", expected: "x\n"},
{input: "x\n\n", expected: "x\n\n"},

// width does not affect whats removed
{width: 2, input: "x", expected: "x\n"},
{width: 2, input: "\tx", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},

// positive width changes tabs to spaces
{width: 0, input: "\t\t~\n\t~\n", expected: "\t~\n~\n"},
{width: 1, input: "\t\t~\n\t~\n", expected: " ~\n~\n"},
{width: 2, input: "\t\t~\n\t~\n", expected: " ~\n~\n"},

// width does not affect spaces
{width: 0, input: " ~\n ~\n", expected: " ~\n~\n"},
{width: 1, input: " ~\n ~\n", expected: " ~\n~\n"},
{width: 2, input: " ~\n ~\n", expected: " ~\n~\n"},

// smallest indent can be anywhere
{input: " ~\n ~\n ~\n", expected: "~\n ~\n ~\n"},
{input: " ~\n ~\n ~\n", expected: " ~\n~\n ~\n"},
{input: " ~\n ~\n ~\n", expected: " ~\n ~\n~\n"},

// entirely whitespace becomes newline
{input: " ", expected: "\n"},
{input: " ", expected: "\n"},
{input: "\t", expected: "\n"},
{input: "\t\t", expected: "\n"},

// blank lines preserved
{input: " ~\n\n ~\n", expected: "~\n\n~\n"},
} {
t.Run(fmt.Sprintf("%v:%#v", tc.width, tc.input), func(t *testing.T) {
assert.DeepEqual(t, dedentLines(tc.input, tc.width), tc.expected)
})
}
}
136 changes: 136 additions & 0 deletions pkg/apis/postgres-operator.crunchydata.com/v1beta1/cmp_test.go
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
// Copyright 2021 - 2025 Crunchy Data Solutions, Inc.
//
// SPDX-License-Identifier: Apache-2.0

package v1beta1_test

import (
"fmt"
"regexp"
"strings"
"testing"

"gotest.tools/v3/assert"
"gotest.tools/v3/assert/cmp"
"sigs.k8s.io/yaml"
)

// MarshalsTo converts x to YAML and compares that to y.
func MarshalsTo[T []byte | string](x any, y T) cmp.Comparison {
b, err := yaml.Marshal(x)
if err != nil {
return func() cmp.Result { return cmp.ResultFromError(err) }
}
return cmp.DeepEqual(string(b), dedentLines(
strings.TrimLeft(strings.TrimRight(string(y), "\t\n"), "\n"), 2,
))
}

var leadingTabs = regexp.MustCompile(`^\t+`)

// dedentLines finds the shortest leading whitespace of every line in data and then removes it from every line.
// When tabWidth is positive, leading tabs are converted to spaces first.
func dedentLines(data string, tabWidth int) string {
if len(data) < 1 {
return ""
}

var lines = make([]string, 0, 20)
var lowest, highest string

for line := range strings.Lines(data) {
tabs := leadingTabs.FindString(line)

// Replace any leading tabs with spaces when tabWidth is positive.
// NOTE: [strings.Repeat] has a fast-path for spaces.
if need := tabWidth * len(tabs); need > 0 {
line = strings.Repeat(" ", need) + line[len(tabs):]
}

switch {
case lowest == "", highest == "":
lowest, highest = line, line

case len(strings.TrimSpace(line)) > 0:
lowest = min(lowest, line)
highest = max(highest, line)
}

lines = append(lines, line)
}

// This treats one tab the same as one space.
// That is, it expects all lines to be indented using spaces or using tabs; not both.
if width := func() int {
for i := range lowest {
if (lowest[i] != ' ' && lowest[i] != '\t') || lowest[i] != highest[i] {
return i
}
}
return len(lowest)
}(); width > 0 {
for i := range lines {
if len(lines[i]) > width {
lines[i] = lines[i][width:]
} else {
lines[i] = "\n"
}
}
}

return strings.TrimSuffix(strings.Join(lines, ""), "\n") + "\n"
}

func TestDedentLines(t *testing.T) {
for _, tc := range []struct {
width int
input string
expected string
}{
// empty stays that way
{width: 0, input: "", expected: ""},
{width: 1, input: "", expected: ""},
{width: 2, input: "", expected: ""},

// adds a missing newline
{input: "\n", expected: "\n"},
{input: "x", expected: "x\n"},
{input: "x\n", expected: "x\n"},
{input: "x\n\n", expected: "x\n\n"},

// width does not affect whats removed
{width: 2, input: "x", expected: "x\n"},
{width: 2, input: "\tx", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},
{width: 2, input: " x", expected: "x\n"},

// positive width changes tabs to spaces
{width: 0, input: "\t\t~\n\t~\n", expected: "\t~\n~\n"},
{width: 1, input: "\t\t~\n\t~\n", expected: " ~\n~\n"},
{width: 2, input: "\t\t~\n\t~\n", expected: " ~\n~\n"},

// width does not affect spaces
{width: 0, input: " ~\n ~\n", expected: " ~\n~\n"},
{width: 1, input: " ~\n ~\n", expected: " ~\n~\n"},
{width: 2, input: " ~\n ~\n", expected: " ~\n~\n"},

// smallest indent can be anywhere
{input: " ~\n ~\n ~\n", expected: "~\n ~\n ~\n"},
{input: " ~\n ~\n ~\n", expected: " ~\n~\n ~\n"},
{input: " ~\n ~\n ~\n", expected: " ~\n ~\n~\n"},

// entirely whitespace becomes newline
{input: " ", expected: "\n"},
{input: " ", expected: "\n"},
{input: "\t", expected: "\n"},
{input: "\t\t", expected: "\n"},

// blank lines preserved
{input: " ~\n\n ~\n", expected: "~\n\n~\n"},
} {
t.Run(fmt.Sprintf("%v:%#v", tc.width, tc.input), func(t *testing.T) {
assert.DeepEqual(t, dedentLines(tc.input, tc.width), tc.expected)
})
}
}
Loading
Loading

AltStyle によって変換されたページ (->オリジナル) /