MM-8602: KV Store Json helper tweaks (#11502)

* move kv helpers to helpers_kv*.go

* change KVGetJSON return signature

Return a boolean and an error, to clearly indicate if no value was found and thus no value unmarshalled into the target interface.

Also fix an issue with CompareAndSet to allow an oldValue of nil (i.e.
expected to be unset).

* add missing license

* tweak documentation

* document KVSetWithExpiryJSON minimum version
Этот коммит содержится в:
Jesse Hallam
2019-07-05 17:33:39 -03:00
коммит произвёл GitHub
родитель c34942afec
Коммит 620d941b6e
7 изменённых файлов: 311 добавлений и 244 удалений

Просмотреть файл

@@ -153,179 +153,3 @@ func TestEnsureBot(t *testing.T) {
})
})
}
func TestKVGetJSON(t *testing.T) {
setupAPI := func() *plugintest.API {
return &plugintest.API{}
}
t.Run("KVGet error", func(t *testing.T) {
p := &plugin.HelpersImpl{}
api := setupAPI()
api.On("KVGet", plugin.BOT_USER_KEY).Return(nil, &model.AppError{})
p.API = api
var dat map[string]interface{}
err := p.KVGetJSON(plugin.BOT_USER_KEY, dat)
api.AssertExpectations(t)
assert.NotNil(t, err)
assert.Nil(t, dat)
})
t.Run("Malformed JSON", func(t *testing.T) {
key := "test-key"
p := &plugin.HelpersImpl{}
api := setupAPI()
api.On("KVGet", key).Return([]byte(`{{:}"val-a": 10}`), nil)
p.API = api
var dat map[string]interface{}
err := p.KVGetJSON(key, &dat)
api.AssertExpectations(t)
assert.NotNil(t, err)
assert.Nil(t, dat)
})
t.Run("Valid parameters passed (happy-path)", func(t *testing.T) {
key := "test-key"
p := &plugin.HelpersImpl{}
api := setupAPI()
api.On("KVGet", key).Return([]byte(`{"val-a": 10}`), nil)
p.API = api
var dat map[string]interface{}
err := p.KVGetJSON(key, &dat)
api.AssertExpectations(t)
assert.Nil(t, err)
assert.Equal(t, map[string]interface{}{
"val-a": float64(10),
}, dat)
})
}
func TestKVSetJSON(t *testing.T) {
key := "test-key"
setupAPI := func() *plugintest.API {
return &plugintest.API{}
}
t.Run("JSON Marshal error", func(t *testing.T) {
api := setupAPI()
api.AssertNotCalled(t, "KVSet")
p := &plugin.HelpersImpl{API: api}
err := p.KVSetJSON(key, func() { return })
api.AssertExpectations(t)
assert.NotNil(t, err)
})
t.Run("Valid parameters passed (Happy-path)", func(t *testing.T) {
api := setupAPI()
api.On("KVSet", key, []byte(`{"val-a":10}`)).Return(nil)
p := &plugin.HelpersImpl{API: api}
err := p.KVSetJSON(key, map[string]interface{}{
"val-a": float64(10),
})
api.AssertExpectations(t)
assert.Nil(t, err)
})
}
func TestKVCompareAndSetJSON(t *testing.T) {
key := "test-key"
setupAPI := func() *plugintest.API {
return &plugintest.API{}
}
t.Run("old value JSON marshal error", func(t *testing.T) {
api := setupAPI()
api.AssertNotCalled(t, "KVCompareAndSet")
p := &plugin.HelpersImpl{API: api}
ok, err := p.KVCompareAndSetJSON(key, func() { return }, map[string]interface{}{})
api.AssertExpectations(t)
assert.Equal(t, false, ok)
assert.NotNil(t, err)
})
t.Run("new value JSON marshal error", func(t *testing.T) {
api := setupAPI()
api.AssertNotCalled(t, "KVCompareAndSet")
p := &plugin.HelpersImpl{API: api}
ok, err := p.KVCompareAndSetJSON(key, map[string]interface{}{}, func() { return })
api.AssertExpectations(t)
assert.Equal(t, false, ok)
assert.NotNil(t, err)
})
t.Run("Valid parameters passed (happy-path)", func(t *testing.T) {
api := setupAPI()
api.On("KVCompareAndSet", key, []byte(`{"val-a":10}`), []byte(`{"val-b":20}`)).Return(false, nil)
p := &plugin.HelpersImpl{API: api}
ok, err := p.KVCompareAndSetJSON(key, map[string]interface{}{
"val-a": 10,
}, map[string]interface{}{
"val-b": 20,
})
api.AssertExpectations(t)
assert.Equal(t, false, ok)
assert.Nil(t, err)
})
}
func TestKVSetWithExpiryJSON(t *testing.T) {
key := "test-key"
setupAPI := func() *plugintest.API {
return &plugintest.API{}
}
t.Run("JSON Marshal error", func(t *testing.T) {
api := setupAPI()
api.AssertNotCalled(t, "KVSetWithExpiry")
p := &plugin.HelpersImpl{API: api}
err := p.KVSetWithExpiryJSON(key, func() { return }, 100)
api.AssertExpectations(t)
assert.NotNil(t, err)
})
t.Run("valid parameters passed (happy-path)", func(t *testing.T) {
api := setupAPI()
api.On("KVSetWithExpiry", key, []byte(`{"val-a":10}`), int64(100)).Return(nil)
p := &plugin.HelpersImpl{API: api}
err := p.KVSetWithExpiryJSON(key, map[string]interface{}{
"val-a": float64(10),
}, 100)
api.AssertExpectations(t)
assert.Nil(t, err)
})
}