Skip to content
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

Jump to bottom

refactor: rename valtest_test and testutils_test imports #5343

Closed
wants to merge 1 commit into from
Closed

refactor: rename valtest_test and testutils_test imports #5343

Show file tree
Hide file tree
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: 2 additions & 2 deletions api/internal/generators/secret_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
. "sigs.k8s.io/kustomize/api/internal/generators"
"sigs.k8s.io/kustomize/api/kv"
"sigs.k8s.io/kustomize/api/loader"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
Copy link
Contributor

@natasha41575 natasha41575 Sep 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

So if you go to the package where these test helpers are defined, the name of the package is actually valtest_test. I think this is pretty standard for test packages (so that it gets compiled separately from the main package).

I'm not really sure it matters whether we name the import valtest or valtest_test - kind of seems like we are trying to decide between using the package name or the directory name. To me using the actual package name valtest_test seems to make more sense.

I think what does matter is that we choose one pattern and stick to it, so I'd be inclined to leave it as valtest_test since that seems to have been the convention so far. Again I really don't think it matters too much so I could be convinced otherwise if someone feels there is a strong reason to change it.

Copy link
Member Author

Choose a reason for hiding this comment

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

This makes sense to me. I'll close this for the time being, as I mainly opened so we could discuss.

/close

"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)
Expand Down Expand Up @@ -209,7 +209,7 @@ immutable: true
[]byte{0xff, 0xfd})
kvLdr := kv.NewLoader(
loader.NewFileLoaderAtRoot(fSys),
valtest_test.MakeFakeValidator())
valtest.MakeFakeValidator())

for n := range testCases {
tc := testCases[n]
Expand Down
4 changes: 2 additions & 2 deletions api/internal/plugins/loader/loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"sigs.k8s.io/kustomize/api/provider"
"sigs.k8s.io/kustomize/api/resmap"
kusttest_test "sigs.k8s.io/kustomize/api/testutils/kusttest"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)
Expand Down Expand Up @@ -73,7 +73,7 @@ func TestLoader(t *testing.T) {
t.Fatal("expect non-nil loader")
}
_, err = pLdr.LoadGenerators(
fLdr, valtest_test.MakeFakeValidator(), generatorConfigs)
fLdr, valtest.MakeFakeValidator(), generatorConfigs)
if err != nil {
t.Fatal(err)
}
Expand Down
4 changes: 2 additions & 2 deletions api/internal/target/maker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
fLdr "sigs.k8s.io/kustomize/api/loader"
"sigs.k8s.io/kustomize/api/provider"
"sigs.k8s.io/kustomize/api/resmap"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)
Expand Down Expand Up @@ -42,7 +42,7 @@ func makeKustTargetWithRf(
pc := types.DisabledPluginConfig()
return target.NewKustTarget(
ldr,
valtest_test.MakeFakeValidator(),
valtest.MakeFakeValidator(),
rf,
pLdr.NewLoader(pc, rf, fSys))
}
4 changes: 2 additions & 2 deletions api/kv/kv_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import (

"github.com/stretchr/testify/require"
ldr "sigs.k8s.io/kustomize/api/loader"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)

func makeKvLoader(fSys filesys.FileSystem) *loader {
return &loader{
ldr: ldr.NewFileLoaderAtRoot(fSys),
validator: valtest_test.MakeFakeValidator()}
validator: valtest.MakeFakeValidator()}
}

func TestKeyValuesFromLines(t *testing.T) {
Expand Down
6 changes: 3 additions & 3 deletions api/resmap/factory_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
"sigs.k8s.io/kustomize/api/loader"
. "sigs.k8s.io/kustomize/api/resmap"
resmaptest_test "sigs.k8s.io/kustomize/api/testutils/resmaptest"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
"sigs.k8s.io/kustomize/kyaml/yaml"
Expand Down Expand Up @@ -124,7 +124,7 @@ func TestNewFromConfigMaps(t *testing.T) {
if err != nil {
t.Fatal(err)
}
kvLdr := kv.NewLoader(ldr, valtest_test.MakeFakeValidator())
kvLdr := kv.NewLoader(ldr, valtest.MakeFakeValidator())
testCases := []testCase{
{
description: "construct config map from env",
Expand Down Expand Up @@ -250,7 +250,7 @@ func TestNewResMapFromSecretArgs(t *testing.T) {
actual, err := rmF.NewResMapFromSecretArgs(
kv.NewLoader(
loader.NewFileLoaderAtRoot(fSys),
valtest_test.MakeFakeValidator()), secrets)
valtest.MakeFakeValidator()), secrets)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
Expand Down
6 changes: 3 additions & 3 deletions api/testutils/kusttest/harnessenhanced.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
fLdr "sigs.k8s.io/kustomize/api/loader"
"sigs.k8s.io/kustomize/api/provider"
"sigs.k8s.io/kustomize/api/resmap"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)
Expand Down Expand Up @@ -163,7 +163,7 @@ func (th *HarnessEnhanced) LoadAndRunGeneratorWithBuildAnnotations(
th.t.Fatalf("Err: %v", err)
}
g, err := th.pl.LoadGenerator(
th.ldr, valtest_test.MakeFakeValidator(), res)
th.ldr, valtest.MakeFakeValidator(), res)
if err != nil {
th.t.Fatalf("Err: %v", err)
}
Expand Down Expand Up @@ -220,7 +220,7 @@ func (th *HarnessEnhanced) RunTransformerFromResMap(
th.t.Fatalf("Err: %v", err)
}
g, err := th.pl.LoadTransformer(
th.ldr, valtest_test.MakeFakeValidator(), transConfig)
th.ldr, valtest.MakeFakeValidator(), transConfig)
if err != nil {
return nil, err
}
Expand Down
78 changes: 39 additions & 39 deletions kustomize/commands/edit/add/addmetadata_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kustomize/v5/commands/internal/kustfile"
testutils_test "sigs.k8s.io/kustomize/kustomize/v5/commands/internal/testutils"
testutils "sigs.k8s.io/kustomize/kustomize/v5/commands/internal/testutils"
"sigs.k8s.io/kustomize/kyaml/filesys"
)

func makeKustomization(t *testing.T) *types.Kustomization {
t.Helper()
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
testutils.WriteTestKustomization(fSys)
kf, err := kustfile.NewKustomizationFile(fSys)
assert.NoError(t, err)
m, err := kf.Read()
Expand All @@ -42,7 +42,7 @@ func TestRunAddAnnotation(t *testing.T) {

func TestAddAnnotationNoArgs(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeHappyMapValidator(t)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
err := cmd.Execute()
v.VerifyNoCall()
Expand All @@ -52,19 +52,19 @@ func TestAddAnnotationNoArgs(t *testing.T) {

func TestAddAnnotationInvalidFormat(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeSadMapValidator(t)
v := valtest.MakeSadMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"whatever:whatever"}
err := cmd.RunE(cmd, args)
v.VerifyCall()
assert.Error(t, err)
assert.Equal(t, valtest_test.SAD, err.Error())
assert.Equal(t, valtest.SAD, err.Error())
}

func TestAddAnnotationManyArgs(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"k1:v1,k2:v2,k3:v3,k4:v5"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -73,8 +73,8 @@ func TestAddAnnotationManyArgs(t *testing.T) {

func TestAddAnnotationValueQuoted(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"k1:\"v1\""}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -83,8 +83,8 @@ func TestAddAnnotationValueQuoted(t *testing.T) {

func TestAddAnnotationValueWithColon(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"k1:\"v1:v2\""}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -93,8 +93,8 @@ func TestAddAnnotationValueWithColon(t *testing.T) {

func TestAddAnnotationValueWithComma(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
value := "{\"k1\":\"v1\",\"k2\":\"v2\"}"
args := []string{"test:" + value}
Expand All @@ -107,7 +107,7 @@ func TestAddAnnotationValueWithComma(t *testing.T) {

func TestAddAnnotationNoKey(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeHappyMapValidator(t)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{":nokey"}
err := cmd.RunE(cmd, args)
Expand All @@ -118,8 +118,8 @@ func TestAddAnnotationNoKey(t *testing.T) {

func TestAddAnnotationTooManyColons(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"key:v1:v2"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -128,8 +128,8 @@ func TestAddAnnotationTooManyColons(t *testing.T) {

func TestAddAnnotationNoValue(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"no:,value"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -138,8 +138,8 @@ func TestAddAnnotationNoValue(t *testing.T) {

func TestAddAnnotationMultipleArgs(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"this:annotation", "has:spaces"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -148,22 +148,22 @@ func TestAddAnnotationMultipleArgs(t *testing.T) {

func TestAddAnnotationForce(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddAnnotation(fSys, v.Validator)
args := []string{"key:foo"}
assert.NoError(t, cmd.RunE(cmd, args))
v.VerifyCall()
// trying to add the same annotation again should not work
args = []string{"key:bar"}
v = valtest_test.MakeHappyMapValidator(t)
v = valtest.MakeHappyMapValidator(t)
cmd = newCmdAddAnnotation(fSys, v.Validator)
err := cmd.RunE(cmd, args)
v.VerifyCall()
assert.Error(t, err)
assert.Equal(t, "annotation key already in kustomization file", err.Error())
// but trying to add it with --force should
v = valtest_test.MakeHappyMapValidator(t)
v = valtest.MakeHappyMapValidator(t)
cmd = newCmdAddAnnotation(fSys, v.Validator)
err = cmd.Flag("force").Value.Set("true")
require.NoError(t, err)
Expand All @@ -186,7 +186,7 @@ func TestRunAddLabel(t *testing.T) {

func TestAddLabelNoArgs(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeHappyMapValidator(t)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
err := cmd.Execute()
v.VerifyNoCall()
Expand All @@ -196,20 +196,20 @@ func TestAddLabelNoArgs(t *testing.T) {

func TestAddLabelInvalidFormat(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeSadMapValidator(t)
v := valtest.MakeSadMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{"exclamation!:point"}
err := cmd.RunE(cmd, args)
v.VerifyCall()
assert.Error(t, err)
if err.Error() != valtest_test.SAD {
if err.Error() != valtest.SAD {
t.Errorf("incorrect error: %v", err.Error())
}
}

func TestAddLabelNoKey(t *testing.T) {
fSys := filesys.MakeFsInMemory()
v := valtest_test.MakeHappyMapValidator(t)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{":nokey"}
err := cmd.RunE(cmd, args)
Expand All @@ -222,8 +222,8 @@ func TestAddLabelNoKey(t *testing.T) {

func TestAddLabelTooManyColons(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{"key:v1:v2"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -232,8 +232,8 @@ func TestAddLabelTooManyColons(t *testing.T) {

func TestAddLabelNoValue(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{"no,value:"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -242,8 +242,8 @@ func TestAddLabelNoValue(t *testing.T) {

func TestAddLabelMultipleArgs(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{"this:input", "has:spaces"}
assert.NoError(t, cmd.RunE(cmd, args))
Expand All @@ -252,22 +252,22 @@ func TestAddLabelMultipleArgs(t *testing.T) {

func TestAddLabelForce(t *testing.T) {
fSys := filesys.MakeFsInMemory()
testutils_test.WriteTestKustomization(fSys)
v := valtest_test.MakeHappyMapValidator(t)
testutils.WriteTestKustomization(fSys)
v := valtest.MakeHappyMapValidator(t)
cmd := newCmdAddLabel(fSys, v.Validator)
args := []string{"key:foo"}
assert.NoError(t, cmd.RunE(cmd, args))
v.VerifyCall()
// trying to add the same label again should not work
args = []string{"key:bar"}
v = valtest_test.MakeHappyMapValidator(t)
v = valtest.MakeHappyMapValidator(t)
cmd = newCmdAddLabel(fSys, v.Validator)
err := cmd.RunE(cmd, args)
v.VerifyCall()
assert.Error(t, err)
assert.Equal(t, "label key already in kustomization file", err.Error())
// but trying to add it with --force should
v = valtest_test.MakeHappyMapValidator(t)
v = valtest.MakeHappyMapValidator(t)
cmd = newCmdAddLabel(fSys, v.Validator)
err = cmd.Flag("force").Value.Set("true")
require.NoError(t, err)
Expand Down
4 changes: 2 additions & 2 deletions kustomize/commands/edit/add/configmap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/stretchr/testify/assert"
"sigs.k8s.io/kustomize/api/kv"
"sigs.k8s.io/kustomize/api/loader"
valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
valtest "sigs.k8s.io/kustomize/api/testutils/valtest"
"sigs.k8s.io/kustomize/api/types"
"sigs.k8s.io/kustomize/kyaml/filesys"
)
Expand All @@ -20,7 +20,7 @@ func TestNewAddConfigMapIsNotNil(t *testing.T) {
fSys,
kv.NewLoader(
loader.NewFileLoaderAtCwd(fSys),
valtest_test.MakeFakeValidator()),
valtest.MakeFakeValidator()),
nil))
}

Expand Down
Loading
Loading