Skip to content

Commit

Permalink
test: refactor asserts
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandear authored and sagikazarmark committed Oct 4, 2023
1 parent 3d006fe commit c292b55
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 36 deletions.
2 changes: 1 addition & 1 deletion flags_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestBindFlagValueSet(t *testing.T) {
})

for name, expected := range mutatedTestValues {
assert.Equal(t, Get(name), expected)
assert.Equal(t, expected, Get(name))
}
}

Expand Down
10 changes: 3 additions & 7 deletions overrides_test.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package viper

import (
"fmt"
"strings"
"testing"

Expand Down Expand Up @@ -148,10 +147,9 @@ func deepCheckValue(assert *assert.Assertions, v *Viper, l layer, keys []string,

// loop through map
var m map[string]any
err := false
for _, k := range keys {
if val == nil {
assert.Fail(fmt.Sprintf("%s is not a map[string]any", ms))
assert.Failf("%s is not a map[string]any", ms)
return
}

Expand All @@ -162,13 +160,11 @@ func deepCheckValue(assert *assert.Assertions, v *Viper, l layer, keys []string,
case map[string]any:
m = val
default:
assert.Fail(fmt.Sprintf("%s is not a map[string]any", ms))
assert.Failf("%s is not a map[string]any", ms)
return
}
ms = ms + "[\"" + k + "\"]"
val = m[k]
}
if !err {
assert.Equal(value, val)
}
assert.Equal(value, val)
}
45 changes: 17 additions & 28 deletions viper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import (
"path/filepath"
"reflect"
"runtime"
"sort"
"strings"
"sync"
"testing"
Expand Down Expand Up @@ -737,7 +736,7 @@ func TestEnvSubConfig(t *testing.T) {
func TestAllKeys(t *testing.T) {
initConfigs()

ks := sort.StringSlice{
ks := []string{
"title",
"author.bio",
"author.e-mail",
Expand Down Expand Up @@ -841,11 +840,7 @@ func TestAllKeys(t *testing.T) {
"name_dotenv": "Cake",
}

allkeys := sort.StringSlice(AllKeys())
allkeys.Sort()
ks.Sort()

assert.Equal(t, ks, allkeys)
assert.ElementsMatch(t, ks, AllKeys())
assert.Equal(t, all, AllSettings())
}

Expand All @@ -860,11 +855,7 @@ func TestAllKeysWithEnv(t *testing.T) {
t.Setenv("ID", "13")
t.Setenv("FOO_BAR", "baz")

expectedKeys := sort.StringSlice{"id", "foo.bar"}
expectedKeys.Sort()
keys := sort.StringSlice(v.AllKeys())
keys.Sort()
assert.Equal(t, expectedKeys, keys)
assert.ElementsMatch(t, []string{"id", "foo.bar"}, v.AllKeys())
}

func TestAliasesOfAliases(t *testing.T) {
Expand Down Expand Up @@ -1528,7 +1519,7 @@ func TestWrongDirsSearchNotFound(t *testing.T) {
v.AddConfigPath(`thispathaintthere`)

err := v.ReadInConfig()
assert.Equal(t, reflect.TypeOf(ConfigFileNotFoundError{"", ""}), reflect.TypeOf(err))
assert.IsType(t, err, ConfigFileNotFoundError{"", ""})

// Even though config did not load and the error might have
// been ignored by the client, the default still loads
Expand Down Expand Up @@ -1583,12 +1574,10 @@ func TestSub(t *testing.T) {
assert.Equal(t, (*Viper)(nil), subv)

subv = v.Sub("clothing")
assert.Equal(t, subv.parents[0], "clothing")
assert.Equal(t, []string{"clothing"}, subv.parents)

subv = v.Sub("clothing").Sub("pants")
assert.Equal(t, len(subv.parents), 2)
assert.Equal(t, subv.parents[0], "clothing")
assert.Equal(t, subv.parents[1], "pants")
assert.Equal(t, []string{"clothing", "pants"}, subv.parents)
}

var hclWriteExpected = []byte(`"foos" = {
Expand Down Expand Up @@ -2399,7 +2388,7 @@ func TestParseNested(t *testing.T) {
t.Fatalf("unable to decode into struct, %v", err)
}

assert.Equal(t, 1, len(items))
assert.Len(t, items, 1)
assert.Equal(t, 100*time.Millisecond, items[0].Delay)
assert.Equal(t, 200*time.Millisecond, items[0].Nested.Delay)
}
Expand All @@ -2421,11 +2410,11 @@ func newViperWithConfigFile(t *testing.T) (*Viper, string) {
watchDir := t.TempDir()
configFile := path.Join(watchDir, "config.yaml")
err := os.WriteFile(configFile, []byte("foo: bar\n"), 0o640)
require.Nil(t, err)
require.NoError(t, err)
v := New()
v.SetConfigFile(configFile)
err = v.ReadInConfig()
require.Nil(t, err)
require.NoError(t, err)
require.Equal(t, "bar", v.Get("foo"))
return v, configFile
}
Expand All @@ -2434,11 +2423,11 @@ func newViperWithSymlinkedConfigFile(t *testing.T) (*Viper, string, string) {
watchDir := t.TempDir()
dataDir1 := path.Join(watchDir, "data1")
err := os.Mkdir(dataDir1, 0o777)
require.Nil(t, err)
require.NoError(t, err)
realConfigFile := path.Join(dataDir1, "config.yaml")
t.Logf("Real config file location: %s\n", realConfigFile)
err = os.WriteFile(realConfigFile, []byte("foo: bar\n"), 0o640)
require.Nil(t, err)
require.NoError(t, err)
// now, symlink the tm `data1` dir to `data` in the baseDir
os.Symlink(dataDir1, path.Join(watchDir, "data"))
// and link the `<watchdir>/datadir1/config.yaml` to `<watchdir>/config.yaml`
Expand All @@ -2449,7 +2438,7 @@ func newViperWithSymlinkedConfigFile(t *testing.T) (*Viper, string, string) {
v := New()
v.SetConfigFile(configFile)
err = v.ReadInConfig()
require.Nil(t, err)
require.NoError(t, err)
require.Equal(t, "bar", v.Get("foo"))
return v, watchDir, configFile
}
Expand Down Expand Up @@ -2480,7 +2469,7 @@ func TestWatchFile(t *testing.T) {
err = os.WriteFile(configFile, []byte("foo: baz\n"), 0o640)
wg.Wait()
// then the config value should have changed
require.Nil(t, err)
require.NoError(t, err)
assert.Equal(t, "baz", v.Get("foo"))
})

Expand All @@ -2500,16 +2489,16 @@ func TestWatchFile(t *testing.T) {
// when link to another `config.yaml` file
dataDir2 := path.Join(watchDir, "data2")
err := os.Mkdir(dataDir2, 0o777)
require.Nil(t, err)
require.NoError(t, err)
configFile2 := path.Join(dataDir2, "config.yaml")
err = os.WriteFile(configFile2, []byte("foo: baz\n"), 0o640)
require.Nil(t, err)
require.NoError(t, err)
// change the symlink using the `ln -sfn` command
err = exec.Command("ln", "-sfn", dataDir2, path.Join(watchDir, "data")).Run()
require.Nil(t, err)
require.NoError(t, err)
wg.Wait()
// then
require.Nil(t, err)
require.NoError(t, err)
assert.Equal(t, "baz", v.Get("foo"))
})
}
Expand Down

0 comments on commit c292b55

Please sign in to comment.