package rootmulti import ( "fmt" "testing" "github.com/stretchr/testify/require" abci "github.com/tendermint/tendermint/abci/types" "github.com/tendermint/tendermint/crypto/merkle" dbm "github.com/tendermint/tm-db" "github.com/cosmos/cosmos-sdk/store/iavl" "github.com/cosmos/cosmos-sdk/store/types" sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" ) func TestStoreType(t *testing.T) { db := dbm.NewMemDB() store := NewStore(db) store.MountStoreWithDB(types.NewKVStoreKey("store1"), types.StoreTypeIAVL, db) } func TestGetCommitKVStore(t *testing.T) { var db dbm.DB = dbm.NewMemDB() ms := newMultiStoreWithMounts(db, types.PruneSyncable) err := ms.LoadLatestVersion() require.Nil(t, err) key := ms.keysByName["store1"] store1 := ms.GetCommitKVStore(key) require.NotNil(t, store1) require.IsType(t, &iavl.Store{}, store1) store2 := ms.GetCommitStore(key) require.NotNil(t, store2) require.IsType(t, &iavl.Store{}, store2) } func TestStoreMount(t *testing.T) { db := dbm.NewMemDB() store := NewStore(db) key1 := types.NewKVStoreKey("store1") key2 := types.NewKVStoreKey("store2") dup1 := types.NewKVStoreKey("store1") require.NotPanics(t, func() { store.MountStoreWithDB(key1, types.StoreTypeIAVL, db) }) require.NotPanics(t, func() { store.MountStoreWithDB(key2, types.StoreTypeIAVL, db) }) require.Panics(t, func() { store.MountStoreWithDB(key1, types.StoreTypeIAVL, db) }) require.Panics(t, func() { store.MountStoreWithDB(dup1, types.StoreTypeIAVL, db) }) } func TestCacheMultiStoreWithVersion(t *testing.T) { var db dbm.DB = dbm.NewMemDB() ms := newMultiStoreWithMounts(db, types.PruneNothing) err := ms.LoadLatestVersion() require.Nil(t, err) commitID := types.CommitID{} checkStore(t, ms, commitID, commitID) k, v := []byte("wind"), []byte("blows") store1 := ms.getStoreByName("store1").(types.KVStore) store1.Set(k, v) cID := ms.Commit() require.Equal(t, int64(1), cID.Version) // require failure when given an invalid or pruned version _, err = ms.CacheMultiStoreWithVersion(cID.Version + 1) require.Error(t, err) // require a valid version can be cache-loaded cms, err := ms.CacheMultiStoreWithVersion(cID.Version) require.NoError(t, err) // require a valid key lookup yields the correct value kvStore := cms.GetKVStore(ms.keysByName["store1"]) require.NotNil(t, kvStore) require.Equal(t, kvStore.Get(k), v) // require we cannot commit (write) to a cache-versioned multi-store require.Panics(t, func() { kvStore.Set(k, []byte("newValue")) cms.Write() }) } func TestHashStableWithEmptyCommit(t *testing.T) { var db dbm.DB = dbm.NewMemDB() ms := newMultiStoreWithMounts(db, types.PruneNothing) err := ms.LoadLatestVersion() require.Nil(t, err) commitID := types.CommitID{} checkStore(t, ms, commitID, commitID) k, v := []byte("wind"), []byte("blows") store1 := ms.getStoreByName("store1").(types.KVStore) store1.Set(k, v) cID := ms.Commit() require.Equal(t, int64(1), cID.Version) hash := cID.Hash // make an empty commit, it should update version, but not affect hash cID = ms.Commit() require.Equal(t, int64(2), cID.Version) require.Equal(t, hash, cID.Hash) } func TestMultistoreCommitLoad(t *testing.T) { var db dbm.DB = dbm.NewMemDB() store := newMultiStoreWithMounts(db, types.PruneNothing) err := store.LoadLatestVersion() require.Nil(t, err) // New store has empty last commit. commitID := types.CommitID{} checkStore(t, store, commitID, commitID) // Make sure we can get stores by name. s1 := store.getStoreByName("store1") require.NotNil(t, s1) s3 := store.getStoreByName("store3") require.NotNil(t, s3) s77 := store.getStoreByName("store77") require.Nil(t, s77) // Make a few commits and check them. nCommits := int64(3) for i := int64(0); i < nCommits; i++ { commitID = store.Commit() expectedCommitID := getExpectedCommitID(store, i+1) checkStore(t, store, expectedCommitID, commitID) } // Load the latest multistore again and check version. store = newMultiStoreWithMounts(db, types.PruneNothing) err = store.LoadLatestVersion() require.Nil(t, err) commitID = getExpectedCommitID(store, nCommits) checkStore(t, store, commitID, commitID) // Commit and check version. commitID = store.Commit() expectedCommitID := getExpectedCommitID(store, nCommits+1) checkStore(t, store, expectedCommitID, commitID) // Load an older multistore and check version. ver := nCommits - 1 store = newMultiStoreWithMounts(db, types.PruneNothing) err = store.LoadVersion(ver) require.Nil(t, err) commitID = getExpectedCommitID(store, ver) checkStore(t, store, commitID, commitID) // XXX: commit this older version commitID = store.Commit() expectedCommitID = getExpectedCommitID(store, ver+1) checkStore(t, store, expectedCommitID, commitID) // XXX: confirm old commit is overwritten and we have rolled back // LatestVersion store = newMultiStoreWithMounts(db, types.PruneSyncable) err = store.LoadLatestVersion() require.Nil(t, err) commitID = getExpectedCommitID(store, ver+1) checkStore(t, store, commitID, commitID) } func TestMultistoreLoadWithUpgrade(t *testing.T) { var db dbm.DB = dbm.NewMemDB() store := newMultiStoreWithMounts(db, types.PruneNothing) err := store.LoadLatestVersion() require.Nil(t, err) // write some data in all stores k1, v1 := []byte("first"), []byte("store") s1, _ := store.getStoreByName("store1").(types.KVStore) require.NotNil(t, s1) s1.Set(k1, v1) k2, v2 := []byte("second"), []byte("restore") s2, _ := store.getStoreByName("store2").(types.KVStore) require.NotNil(t, s2) s2.Set(k2, v2) k3, v3 := []byte("third"), []byte("dropped") s3, _ := store.getStoreByName("store3").(types.KVStore) require.NotNil(t, s3) s3.Set(k3, v3) // do one commit commitID := store.Commit() expectedCommitID := getExpectedCommitID(store, 1) checkStore(t, store, expectedCommitID, commitID) ci, err := getCommitInfo(db, 1) require.NoError(t, err) require.Equal(t, int64(1), ci.Version) require.Equal(t, 3, len(ci.StoreInfos)) checkContains(t, ci.StoreInfos, []string{"store1", "store2", "store3"}) // Load without changes and make sure it is sensible store = newMultiStoreWithMounts(db, types.PruneNothing) err = store.LoadLatestVersion() require.Nil(t, err) commitID = getExpectedCommitID(store, 1) checkStore(t, store, commitID, commitID) // let's query data to see it was saved properly s2, _ = store.getStoreByName("store2").(types.KVStore) require.NotNil(t, s2) require.Equal(t, v2, s2.Get(k2)) // now, let's load with upgrades... restore, upgrades := newMultiStoreWithModifiedMounts(db, types.PruneNothing) err = restore.LoadLatestVersionAndUpgrade(upgrades) require.Nil(t, err) // s1 was not changed s1, _ = restore.getStoreByName("store1").(types.KVStore) require.NotNil(t, s1) require.Equal(t, v1, s1.Get(k1)) // store3 is mounted, but data deleted are gone s3, _ = restore.getStoreByName("store3").(types.KVStore) require.NotNil(t, s3) require.Nil(t, s3.Get(k3)) // data was deleted // store2 is no longer mounted st2 := restore.getStoreByName("store2") require.Nil(t, st2) // restore2 has the old data rs2, _ := restore.getStoreByName("restore2").(types.KVStore) require.NotNil(t, rs2) require.Equal(t, v2, rs2.Get(k2)) // store this migrated data, and load it again without migrations migratedID := restore.Commit() require.Equal(t, migratedID.Version, int64(2)) reload, _ := newMultiStoreWithModifiedMounts(db, types.PruneNothing) err = reload.LoadLatestVersion() require.Nil(t, err) require.Equal(t, migratedID, reload.LastCommitID()) // query this new store rl1, _ := reload.getStoreByName("store1").(types.KVStore) require.NotNil(t, rl1) require.Equal(t, v1, rl1.Get(k1)) rl2, _ := reload.getStoreByName("restore2").(types.KVStore) require.NotNil(t, rl2) require.Equal(t, v2, rl2.Get(k2)) // check commitInfo in storage ci, err = getCommitInfo(db, 2) require.NoError(t, err) require.Equal(t, int64(2), ci.Version) require.Equal(t, 3, len(ci.StoreInfos), ci.StoreInfos) checkContains(t, ci.StoreInfos, []string{"store1", "restore2", "store3"}) } func TestParsePath(t *testing.T) { _, _, err := parsePath("foo") require.Error(t, err) store, subpath, err := parsePath("/foo") require.NoError(t, err) require.Equal(t, store, "foo") require.Equal(t, subpath, "") store, subpath, err = parsePath("/fizz/bang/baz") require.NoError(t, err) require.Equal(t, store, "fizz") require.Equal(t, subpath, "/bang/baz") substore, subsubpath, err := parsePath(subpath) require.NoError(t, err) require.Equal(t, substore, "bang") require.Equal(t, subsubpath, "/baz") } func TestMultiStoreRestart(t *testing.T) { db := dbm.NewMemDB() pruning := types.PruningOptions{ KeepEvery: 3, SnapshotEvery: 6, } multi := newMultiStoreWithMounts(db, pruning) err := multi.LoadLatestVersion() require.Nil(t, err) initCid := multi.LastCommitID() k, v := "wind", "blows" k2, v2 := "water", "flows" k3, v3 := "fire", "burns" for i := 1; i < 3; i++ { // Set and commit data in one store. store1 := multi.getStoreByName("store1").(types.KVStore) store1.Set([]byte(k), []byte(fmt.Sprintf("%s:%d", v, i))) // ... and another. store2 := multi.getStoreByName("store2").(types.KVStore) store2.Set([]byte(k2), []byte(fmt.Sprintf("%s:%d", v2, i))) // ... and another. store3 := multi.getStoreByName("store3").(types.KVStore) store3.Set([]byte(k3), []byte(fmt.Sprintf("%s:%d", v3, i))) multi.Commit() cinfo, err := getCommitInfo(multi.db, int64(i)) require.NotNil(t, err) require.Equal(t, commitInfo{}, cinfo) } // Set and commit data in one store. store1 := multi.getStoreByName("store1").(types.KVStore) store1.Set([]byte(k), []byte(fmt.Sprintf("%s:%d", v, 3))) // ... and another. store2 := multi.getStoreByName("store2").(types.KVStore) store2.Set([]byte(k2), []byte(fmt.Sprintf("%s:%d", v2, 3))) multi.Commit() flushedCinfo, err := getCommitInfo(multi.db, 3) require.Nil(t, err) require.NotEqual(t, initCid, flushedCinfo, "CID is different after flush to disk") // ... and another. store3 := multi.getStoreByName("store3").(types.KVStore) store3.Set([]byte(k3), []byte(fmt.Sprintf("%s:%d", v3, 3))) multi.Commit() postFlushCinfo, err := getCommitInfo(multi.db, 4) require.NotNil(t, err) require.Equal(t, commitInfo{}, postFlushCinfo, "Commit changed after in-memory commit") multi = newMultiStoreWithMounts(db, pruning) err = multi.LoadLatestVersion() require.Nil(t, err) reloadedCid := multi.LastCommitID() require.Equal(t, flushedCinfo.CommitID(), reloadedCid, "Reloaded CID is not the same as last flushed CID") // Check that store1 and store2 retained date from 3rd commit store1 = multi.getStoreByName("store1").(types.KVStore) val := store1.Get([]byte(k)) require.Equal(t, []byte(fmt.Sprintf("%s:%d", v, 3)), val, "Reloaded value not the same as last flushed value") store2 = multi.getStoreByName("store2").(types.KVStore) val2 := store2.Get([]byte(k2)) require.Equal(t, []byte(fmt.Sprintf("%s:%d", v2, 3)), val2, "Reloaded value not the same as last flushed value") // Check that store3 still has data from last commit even though update happened on 2nd commit store3 = multi.getStoreByName("store3").(types.KVStore) val3 := store3.Get([]byte(k3)) require.Equal(t, []byte(fmt.Sprintf("%s:%d", v3, 2)), val3, "Reloaded value not the same as last flushed value") } func TestMultiStoreQuery(t *testing.T) { db := dbm.NewMemDB() multi := newMultiStoreWithMounts(db, types.PruneNothing) err := multi.LoadLatestVersion() require.Nil(t, err) k, v := []byte("wind"), []byte("blows") k2, v2 := []byte("water"), []byte("flows") // v3 := []byte("is cold") cid := multi.Commit() // Make sure we can get by name. garbage := multi.getStoreByName("bad-name") require.Nil(t, garbage) // Set and commit data in one store. store1 := multi.getStoreByName("store1").(types.KVStore) store1.Set(k, v) // ... and another. store2 := multi.getStoreByName("store2").(types.KVStore) store2.Set(k2, v2) // Commit the multistore. cid = multi.Commit() ver := cid.Version // Reload multistore from database multi = newMultiStoreWithMounts(db, types.PruneNothing) err = multi.LoadLatestVersion() require.Nil(t, err) // Test bad path. query := abci.RequestQuery{Path: "/key", Data: k, Height: ver} qres := multi.Query(query) require.EqualValues(t, sdkerrors.ErrUnknownRequest.ABCICode(), qres.Code) require.EqualValues(t, sdkerrors.ErrUnknownRequest.Codespace(), qres.Codespace) query.Path = "h897fy32890rf63296r92" qres = multi.Query(query) require.EqualValues(t, sdkerrors.ErrUnknownRequest.ABCICode(), qres.Code) require.EqualValues(t, sdkerrors.ErrUnknownRequest.Codespace(), qres.Codespace) // Test invalid store name. query.Path = "/garbage/key" qres = multi.Query(query) require.EqualValues(t, sdkerrors.ErrUnknownRequest.ABCICode(), qres.Code) require.EqualValues(t, sdkerrors.ErrUnknownRequest.Codespace(), qres.Codespace) // Test valid query with data. query.Path = "/store1/key" qres = multi.Query(query) require.EqualValues(t, 0, qres.Code) require.Equal(t, v, qres.Value) // Test valid but empty query. query.Path = "/store2/key" query.Prove = true qres = multi.Query(query) require.EqualValues(t, 0, qres.Code) require.Nil(t, qres.Value) // Test store2 data. query.Data = k2 qres = multi.Query(query) require.EqualValues(t, 0, qres.Code) require.Equal(t, v2, qres.Value) } //----------------------------------------------------------------------- // utils func newMultiStoreWithMounts(db dbm.DB, pruningOpts types.PruningOptions) *Store { store := NewStore(db) store.pruningOpts = pruningOpts store.MountStoreWithDB(types.NewKVStoreKey("store1"), types.StoreTypeIAVL, nil) store.MountStoreWithDB(types.NewKVStoreKey("store2"), types.StoreTypeIAVL, nil) store.MountStoreWithDB(types.NewKVStoreKey("store3"), types.StoreTypeIAVL, nil) return store } func newMultiStoreWithModifiedMounts(db dbm.DB, pruningOpts types.PruningOptions) (*Store, *types.StoreUpgrades) { store := NewStore(db) store.pruningOpts = pruningOpts store.MountStoreWithDB(types.NewKVStoreKey("store1"), types.StoreTypeIAVL, nil) store.MountStoreWithDB(types.NewKVStoreKey("restore2"), types.StoreTypeIAVL, nil) store.MountStoreWithDB(types.NewKVStoreKey("store3"), types.StoreTypeIAVL, nil) upgrades := &types.StoreUpgrades{ Renamed: []types.StoreRename{{ OldKey: "store2", NewKey: "restore2", }}, Deleted: []string{"store3"}, } return store, upgrades } func checkStore(t *testing.T, store *Store, expect, got types.CommitID) { require.Equal(t, expect, got) require.Equal(t, expect, store.LastCommitID()) } func checkContains(t testing.TB, info []storeInfo, wanted []string) { t.Helper() for _, want := range wanted { checkHas(t, info, want) } } func checkHas(t testing.TB, info []storeInfo, want string) { t.Helper() for _, i := range info { if i.Name == want { return } } t.Fatalf("storeInfo doesn't contain %s", want) } func getExpectedCommitID(store *Store, ver int64) types.CommitID { return types.CommitID{ Version: ver, Hash: hashStores(store.stores), } } func hashStores(stores map[types.StoreKey]types.CommitKVStore) []byte { m := make(map[string][]byte, len(stores)) for key, store := range stores { name := key.Name() m[name] = storeInfo{ Name: name, Core: storeCore{ CommitID: store.LastCommitID(), // StoreType: store.GetStoreType(), }, }.Hash() } return merkle.SimpleHashFromMap(m) }