Skip to content

Commit 933b72f

Browse files
authored
pkg/scaffold/internal/testutil/test_util.go: scaffold unit test utilities (#738)
1 parent 77d4130 commit 933b72f

23 files changed

+67
-27
lines changed

pkg/scaffold/add_controller_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestAddController(t *testing.T) {
@@ -30,7 +32,7 @@ func TestAddController(t *testing.T) {
3032
}
3133

3234
if addControllerExp != buf.String() {
33-
diffs := diff(addControllerExp, buf.String())
35+
diffs := testutil.Diff(addControllerExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/addtoscheme_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestAddToScheme(t *testing.T) {
@@ -30,7 +32,7 @@ func TestAddToScheme(t *testing.T) {
3032
}
3133

3234
if addtoschemeExp != buf.String() {
33-
diffs := diff(addtoschemeExp, buf.String())
35+
diffs := testutil.Diff(addtoschemeExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/apis_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestApis(t *testing.T) {
@@ -26,7 +28,7 @@ func TestApis(t *testing.T) {
2628
}
2729

2830
if apisExp != buf.String() {
29-
diffs := diff(apisExp, buf.String())
31+
diffs := testutil.Diff(apisExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/build_dockerfile_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestDockerfile(t *testing.T) {
@@ -26,7 +28,7 @@ func TestDockerfile(t *testing.T) {
2628
}
2729

2830
if dockerfileExp != buf.String() {
29-
diffs := diff(dockerfileExp, buf.String())
31+
diffs := testutil.Diff(dockerfileExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/cmd_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestCmd(t *testing.T) {
@@ -26,7 +28,7 @@ func TestCmd(t *testing.T) {
2628
}
2729

2830
if cmdExp != buf.String() {
29-
diffs := diff(cmdExp, buf.String())
31+
diffs := testutil.Diff(cmdExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/controller_kind_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestControllerKind(t *testing.T) {
@@ -30,7 +32,7 @@ func TestControllerKind(t *testing.T) {
3032
}
3133

3234
if controllerKindExp != buf.String() {
33-
diffs := diff(controllerKindExp, buf.String())
35+
diffs := testutil.Diff(controllerKindExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/controller_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestController(t *testing.T) {
@@ -26,7 +28,7 @@ func TestController(t *testing.T) {
2628
}
2729

2830
if controllerExp != buf.String() {
29-
diffs := diff(controllerKindExp, buf.String())
31+
diffs := testutil.Diff(controllerKindExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/cr_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestCr(t *testing.T) {
@@ -30,7 +32,7 @@ func TestCr(t *testing.T) {
3032
}
3133

3234
if crExp != buf.String() {
33-
diffs := diff(crExp, buf.String())
35+
diffs := testutil.Diff(crExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/crd_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestCRD(t *testing.T) {
@@ -30,7 +32,7 @@ func TestCRD(t *testing.T) {
3032
}
3133

3234
if crdExp != buf.String() {
33-
diffs := diff(crdExp, buf.String())
35+
diffs := testutil.Diff(crdExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/doc_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestDoc(t *testing.T) {
@@ -30,7 +32,7 @@ func TestDoc(t *testing.T) {
3032
}
3133

3234
if docExp != buf.String() {
33-
diffs := diff(docExp, buf.String())
35+
diffs := testutil.Diff(docExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/gitignore_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestGitignore(t *testing.T) {
@@ -26,7 +28,7 @@ func TestGitignore(t *testing.T) {
2628
}
2729

2830
if gitignoreExp != buf.String() {
29-
diffs := diff(gitignoreExp, buf.String())
31+
diffs := testutil.Diff(gitignoreExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/go_test_script_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestGoTestScript(t *testing.T) {
@@ -26,7 +28,7 @@ func TestGoTestScript(t *testing.T) {
2628
}
2729

2830
if goTestScriptExp != buf.String() {
29-
diffs := diff(goTestScriptExp, buf.String())
31+
diffs := testutil.Diff(goTestScriptExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/gopkgtoml_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestGopkgtoml(t *testing.T) {
@@ -26,7 +28,7 @@ func TestGopkgtoml(t *testing.T) {
2628
}
2729

2830
if gopkgtomlExp != buf.String() {
29-
diffs := diff(gopkgtomlExp, buf.String())
31+
diffs := testutil.Diff(gopkgtomlExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/util.go renamed to pkg/scaffold/internal/testutil/test_util.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
// Modified from github.com/kubernetes-sigs/controller-tools/pkg/util/util.go
1616

17-
package scaffold
17+
package testutil
1818

1919
import (
2020
"bytes"
@@ -24,7 +24,7 @@ import (
2424
"github.com/sergi/go-diff/diffmatchpatch"
2525
)
2626

27-
func diff(a, b string) string {
27+
func Diff(a, b string) string {
2828
dmp := diffmatchpatch.New()
2929

3030
wSrc, wDst, warray := dmp.DiffLinesToRunes(a, b)

pkg/scaffold/operator_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestOperator(t *testing.T) {
@@ -26,7 +28,7 @@ func TestOperator(t *testing.T) {
2628
}
2729

2830
if operatorExp != buf.String() {
29-
diffs := diff(operatorExp, buf.String())
31+
diffs := testutil.Diff(operatorExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/register_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestRegister(t *testing.T) {
@@ -30,7 +32,7 @@ func TestRegister(t *testing.T) {
3032
}
3133

3234
if registerExp != buf.String() {
33-
diffs := diff(registerExp, buf.String())
35+
diffs := testutil.Diff(registerExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

pkg/scaffold/role_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestRole(t *testing.T) {
@@ -26,7 +28,7 @@ func TestRole(t *testing.T) {
2628
}
2729

2830
if roleExp != buf.String() {
29-
diffs := diff(roleExp, buf.String())
31+
diffs := testutil.Diff(roleExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/rolebinding_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestRoleBinding(t *testing.T) {
@@ -26,7 +28,7 @@ func TestRoleBinding(t *testing.T) {
2628
}
2729

2830
if rolebindingExp != buf.String() {
29-
diffs := diff(rolebindingExp, buf.String())
31+
diffs := testutil.Diff(rolebindingExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/service_account_test.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ package scaffold
1717
import (
1818
"testing"
1919

20-
"github.com/sergi/go-diff/diffmatchpatch"
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
2121
)
2222

2323
func TestServiceAccount(t *testing.T) {
@@ -28,9 +28,8 @@ func TestServiceAccount(t *testing.T) {
2828
}
2929

3030
if serviceAccountExp != buf.String() {
31-
dmp := diffmatchpatch.New()
32-
diffs := diffmatchpatch.New().DiffMain(serviceAccountExp, buf.String(), false)
33-
t.Fatalf("expected vs actual differs. Red text is missing and green text is extra.\n%v", dmp.DiffPrettyText(diffs))
31+
diffs := testutil.Diff(serviceAccountExp, buf.String())
32+
t.Fatalf("expected vs actual differs.\n%v", diffs)
3433
}
3534
}
3635

pkg/scaffold/test_framework_dockerfile_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestTestFrameworkDockerfile(t *testing.T) {
@@ -26,7 +28,7 @@ func TestTestFrameworkDockerfile(t *testing.T) {
2628
}
2729

2830
if testFrameworkDockerfileExp != buf.String() {
29-
diffs := diff(testFrameworkDockerfileExp, buf.String())
31+
diffs := testutil.Diff(testFrameworkDockerfileExp, buf.String())
3032
t.Fatalf("expected vs actual differs.\n%v", diffs)
3133
}
3234
}

pkg/scaffold/test_pod_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ package scaffold
1717
import (
1818
"testing"
1919

20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
2021
"github.com/operator-framework/operator-sdk/pkg/test"
2122
)
2223

@@ -32,7 +33,7 @@ func TestPodTest(t *testing.T) {
3233
}
3334

3435
if testPodExp != buf.String() {
35-
diffs := diff(testPodExp, buf.String())
36+
diffs := testutil.Diff(testPodExp, buf.String())
3637
t.Fatalf("expected vs actual differs.\n%v", diffs)
3738
}
3839
}

pkg/scaffold/types_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ package scaffold
1616

1717
import (
1818
"testing"
19+
20+
"github.com/operator-framework/operator-sdk/pkg/scaffold/internal/testutil"
1921
)
2022

2123
func TestTypes(t *testing.T) {
@@ -30,7 +32,7 @@ func TestTypes(t *testing.T) {
3032
}
3133

3234
if typesExp != buf.String() {
33-
diffs := diff(typesExp, buf.String())
35+
diffs := testutil.Diff(typesExp, buf.String())
3436
t.Fatalf("expected vs actual differs.\n%v", diffs)
3537
}
3638
}

0 commit comments

Comments
 (0)