-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
stub.go
60 lines (48 loc) · 1.63 KB
/
stub.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
Copyright 2023 The Vitess Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package vipertest
import (
"testing"
"github.com/spf13/viper"
"github.com/stretchr/testify/assert"
"vitess.io/vitess/go/viperutil"
"vitess.io/vitess/go/viperutil/internal/value"
)
// Stub stubs out a given value to use the passed-in viper to retrieve its
// config value for testing purposes. It returns a function to undo this,
// resetting the Value to whatever registry (Static, or Dynamic) it was
// originally bound to.
//
// It fails the test if a caller attempts to stub the same value multiple times
// to a particular viper.
func Stub[T any](t *testing.T, v *viper.Viper, val viperutil.Value[T]) func() {
t.Helper()
if !assert.False(t, v.InConfig(val.Key()), "value for key %s already stubbed", val.Key()) {
return func() {}
}
var base *value.Base[T]
switch val := val.(type) {
case *value.Static[T]:
base = val.Base
case *value.Dynamic[T]:
base = val.Base
default:
assert.Fail(t, "value %+v does not support stubbing", val)
return func() {}
}
oldGet := base.BoundGetFunc
base.BoundGetFunc = base.GetFunc(v)
return func() {
base.BoundGetFunc = oldGet
}
}