[FAB-10025] Simplify test env clean up for statecouchdb

Change-Id: Ica96783947f3fb6b7e695b818e78d63b021fb6b6
Signed-off-by: ping40 <norberthu30@gmail.com>

Author: ping40

core/ledger/kvledger/txmgmt/privacyenabledstate/db_test.go

@@ -13,19 +13,22 @@ import (
 	"testing"
 
 	"github.com/golang/protobuf/proto"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
+
 	"github.com/hyperledger/fabric/common/ledger/testutil"
 	"github.com/hyperledger/fabric/core/common/ccprovider"
 	"github.com/hyperledger/fabric/core/ledger/cceventmgmt"
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb"
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/version"
 	"github.com/hyperledger/fabric/core/ledger/util"
 	"github.com/hyperledger/fabric/protos/common"
-	"github.com/spf13/viper"
-	"github.com/stretchr/testify/assert"
 )
 
 func TestMain(m *testing.M) {
 	viper.Set("peer.fileSystemPath", "/tmp/fabric/ledgertests/kvledger/txmgmt/privacyenabledstate")
+	// Disable auto warm to avoid error logs when the couchdb database has been dropped
+	viper.Set("ledger.state.couchDBConfig.autoWarmIndexes", false)
 	os.Exit(m.Run())
 }
 
@@ -179,7 +182,7 @@ func testGetStateMultipleKeys(t *testing.T, env TestEnv) {
 func TestGetStateRangeScanIterator(t *testing.T) {
 	for _, env := range testEnvs {
 		t.Run(env.GetName(), func(t *testing.T) {
-			testGetStateMultipleKeys(t, env)
+			testGetStateRangeScanIterator(t, env)
 		})
 	}
 }

core/ledger/kvledger/txmgmt/privacyenabledstate/test_exports.go

@@ -12,13 +12,13 @@ import (
 	"testing"
 	"time"
 
-	"github.com/hyperledger/fabric/core/ledger/kvledger/bookkeeping"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
 
+	"github.com/hyperledger/fabric/core/ledger/kvledger/bookkeeping"
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb/statecouchdb"
 	"github.com/hyperledger/fabric/core/ledger/ledgerconfig"
 	"github.com/hyperledger/fabric/integration/runner"
-	"github.com/spf13/viper"
-	"github.com/stretchr/testify/assert"
 )
 
 // TestEnv - an interface that a test environment implements
@@ -80,7 +80,6 @@ type CouchDBCommonStorageTestEnv struct {
 	t                 testing.TB
 	provider          DBProvider
 	bookkeeperTestEnv *bookkeeping.TestEnv
-	openDbIds         map[string]bool
 	couchCleanup      func()
 }
 
@@ -118,14 +117,12 @@ func (env *CouchDBCommonStorageTestEnv) Init(t testing.TB) {
 	assert.NoError(t, err)
 	env.t = t
 	env.provider = dbProvider
-	env.openDbIds = make(map[string]bool)
 }
 
 // GetDBHandle implements corresponding function from interface TestEnv
 func (env *CouchDBCommonStorageTestEnv) GetDBHandle(id string) DB {
 	db, err := env.provider.GetDBHandle(id)
 	assert.NoError(env.t, err)
-	env.openDbIds[id] = true
 	return db
 }
 
@@ -136,9 +133,9 @@ func (env *CouchDBCommonStorageTestEnv) GetName() string {
 
 // Cleanup implements corresponding function from interface TestEnv
 func (env *CouchDBCommonStorageTestEnv) Cleanup() {
-	for id := range env.openDbIds {
-		statecouchdb.CleanupDB(id)
-	}
+	csdbProvider, _ := env.provider.(*CommonStorageDBProvider)
+	statecouchdb.CleanupDB(env.t, csdbProvider.VersionedDBProvider)
+
 	env.bookkeeperTestEnv.Cleanup()
 	env.provider.Close()
 	env.couchCleanup()

core/ledger/kvledger/txmgmt/statedb/statecouchdb/statecouchdb_test.go

@@ -13,6 +13,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/spf13/viper"
+
 	"github.com/hyperledger/fabric/common/flogging"
 	"github.com/hyperledger/fabric/common/ledger/testutil"
 	"github.com/hyperledger/fabric/core/common/ccprovider"
@@ -21,7 +23,6 @@ import (
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/version"
 	ledgertestutil "github.com/hyperledger/fabric/core/ledger/testutil"
 	"github.com/hyperledger/fabric/integration/runner"
-	"github.com/spf13/viper"
 )
 
 func TestMain(m *testing.M) {
@@ -49,6 +50,9 @@ func testMain(m *testing.M) int {
 	viper.Set("ledger.state.couchDBConfig.maxRetries", 3)
 	viper.Set("ledger.state.couchDBConfig.maxRetriesOnStartup", 10)
 	viper.Set("ledger.state.couchDBConfig.requestTimeout", time.Second*35)
+	// Disable auto warm to avoid error logs when the couchdb database has been dropped
+	viper.Set("ledger.state.couchDBConfig.autoWarmIndexes", false)
+
 	flogging.SetModuleLevel("statecouchdb", "debug")
 	//run the actual test
 	return m.Run()
@@ -70,140 +74,82 @@ func couchDBSetup() (addr string, cleanup func()) {
 
 func TestBasicRW(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testbasicrw_")
-	env.Cleanup("testbasicrw_ns")
-	env.Cleanup("testbasicrw_ns1")
-	env.Cleanup("testbasicrw_ns2")
-	defer env.Cleanup("testbasicrw_")
-	defer env.Cleanup("testbasicrw_ns")
-	defer env.Cleanup("testbasicrw_ns1")
-	defer env.Cleanup("testbasicrw_ns2")
+	defer env.Cleanup()
 	commontests.TestBasicRW(t, env.DBProvider)
 
 }
 
 func TestMultiDBBasicRW(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testmultidbbasicrw_")
-	env.Cleanup("testmultidbbasicrw_ns1")
-	env.Cleanup("testmultidbbasicrw2_")
-	env.Cleanup("testmultidbbasicrw2_ns1")
-	defer env.Cleanup("testmultidbbasicrw_")
-	defer env.Cleanup("testmultidbbasicrw_ns1")
-	defer env.Cleanup("testmultidbbasicrw2_")
-	defer env.Cleanup("testmultidbbasicrw2_ns1")
+	defer env.Cleanup()
 	commontests.TestMultiDBBasicRW(t, env.DBProvider)
 
 }
 
 func TestDeletes(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testdeletes_")
-	env.Cleanup("testdeletes_ns")
-	defer env.Cleanup("testdeletes_")
-	defer env.Cleanup("testdeletes_ns")
+	defer env.Cleanup()
 	commontests.TestDeletes(t, env.DBProvider)
 }
 
 func TestIterator(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testiterator_")
-	env.Cleanup("testiterator_ns1")
-	env.Cleanup("testiterator_ns2")
-	env.Cleanup("testiterator_ns3")
-	defer env.Cleanup("testiterator_")
-	defer env.Cleanup("testiterator_ns1")
-	defer env.Cleanup("testiterator_ns2")
-	defer env.Cleanup("testiterator_ns3")
+	defer env.Cleanup()
 	commontests.TestIterator(t, env.DBProvider)
 }
 
 // The following tests are unique to couchdb, they are not used in leveldb
 //  query test
 func TestQuery(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testquery_")
-	env.Cleanup("testquery_ns1")
-	env.Cleanup("testquery_ns2")
-	env.Cleanup("testquery_ns3")
-	defer env.Cleanup("testquery_")
-	defer env.Cleanup("testquery_ns1")
-	defer env.Cleanup("testquery_ns2")
-	defer env.Cleanup("testquery_ns3")
+	defer env.Cleanup()
 	commontests.TestQuery(t, env.DBProvider)
 }
 
 func TestGetStateMultipleKeys(t *testing.T) {
 
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testgetmultiplekeys_")
-	env.Cleanup("testgetmultiplekeys_ns1")
-	env.Cleanup("testgetmultiplekeys_ns2")
-	defer env.Cleanup("testgetmultiplekeys_")
-	defer env.Cleanup("testgetmultiplekeys_ns1")
-	defer env.Cleanup("testgetmultiplekeys_ns2")
+	defer env.Cleanup()
 	commontests.TestGetStateMultipleKeys(t, env.DBProvider)
 }
 
 func TestGetVersion(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testgetversion_")
-	env.Cleanup("testgetversion_ns")
-	env.Cleanup("testgetversion_ns2")
-	defer env.Cleanup("testgetversion_")
-	defer env.Cleanup("testgetversion_ns")
-	defer env.Cleanup("testgetversion_ns2")
+	defer env.Cleanup()
 	commontests.TestGetVersion(t, env.DBProvider)
 }
 
 func TestSmallBatchSize(t *testing.T) {
 	viper.Set("ledger.state.couchDBConfig.maxBatchUpdateSize", 2)
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testsmallbatchsize_")
-	env.Cleanup("testsmallbatchsize_ns1")
-	defer env.Cleanup("testsmallbatchsize_")
-	defer env.Cleanup("testsmallbatchsize_ns1")
+	defer env.Cleanup()
 	defer viper.Set("ledger.state.couchDBConfig.maxBatchUpdateSize", 1000)
 	commontests.TestSmallBatchSize(t, env.DBProvider)
 }
 
 func TestBatchRetry(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testbatchretry_")
-	env.Cleanup("testbatchretry_ns")
-	env.Cleanup("testbatchretry_ns1")
-	defer env.Cleanup("testbatchretry_")
-	defer env.Cleanup("testbatchretry_ns")
-	defer env.Cleanup("testbatchretry_ns1")
+	defer env.Cleanup()
 	commontests.TestBatchWithIndividualRetry(t, env.DBProvider)
 }
 
 func TestValueAndMetadataWrites(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testvalueandmetadata_")
-	env.Cleanup("testvalueandmetadata_ns1")
-	env.Cleanup("testvalueandmetadata_ns2")
-	defer env.Cleanup("testvalueandmetadata_")
-	defer env.Cleanup("testvalueandmetadata_ns1")
-	defer env.Cleanup("testvalueandmetadata_ns2")
+	defer env.Cleanup()
 	commontests.TestValueAndMetadataWrites(t, env.DBProvider)
 }
 
 func TestPaginatedRangeQuery(t *testing.T) {
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testpaginatedrangequery_")
-	env.Cleanup("testpaginatedrangequery_ns1")
-	defer env.Cleanup("testpaginatedrangequery_")
-	defer env.Cleanup("testpaginatedrangequery_ns1")
+	defer env.Cleanup()
 	commontests.TestPaginatedRangeQuery(t, env.DBProvider)
 }
 
 // TestUtilityFunctions tests utility functions
 func TestUtilityFunctions(t *testing.T) {
 
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testutilityfunctions_")
-	defer env.Cleanup("testutilityfunctions_")
+	defer env.Cleanup()
 
 	db, err := env.DBProvider.GetDBHandle("testutilityfunctions")
 	testutil.AssertNoError(t, err, "")
@@ -250,8 +196,7 @@ func TestUtilityFunctions(t *testing.T) {
 func TestInvalidJSONFields(t *testing.T) {
 
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testinvalidfields_")
-	defer env.Cleanup("testinvalidfields_")
+	defer env.Cleanup()
 
 	db, err := env.DBProvider.GetDBHandle("testinvalidfields")
 	testutil.AssertNoError(t, err, "")
@@ -309,12 +254,7 @@ func TestDebugFunctions(t *testing.T) {
 func TestHandleChaincodeDeploy(t *testing.T) {
 
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testinit_")
-	env.Cleanup("testinit_ns1")
-	env.Cleanup("testinit_ns2")
-	defer env.Cleanup("testinit_")
-	defer env.Cleanup("testinit_ns1")
-	defer env.Cleanup("testinit_ns2")
+	defer env.Cleanup()
 
 	db, err := env.DBProvider.GetDBHandle("testinit")
 	testutil.AssertNoError(t, err, "")
@@ -422,8 +362,7 @@ func TestTryCastingToJSON(t *testing.T) {
 func TestHandleChaincodeDeployErroneousIndexFile(t *testing.T) {
 	channelName := "ch1"
 	env := NewTestVDBEnv(t)
-	env.Cleanup(channelName)
-	defer env.Cleanup(channelName)
+	defer env.Cleanup()
 	db, err := env.DBProvider.GetDBHandle(channelName)
 	testutil.AssertNoError(t, err, "")
 	db.Open()
@@ -480,10 +419,7 @@ func printCompositeKeys(keys []*statedb.CompositeKey) string {
 func TestPaginatedQuery(t *testing.T) {
 
 	env := NewTestVDBEnv(t)
-	env.Cleanup("testpaginatedquery_")
-	env.Cleanup("testpaginatedquery_ns1")
-	defer env.Cleanup("testpaginatedquery_")
-	defer env.Cleanup("testpaginatedquery_ns1")
+	defer env.Cleanup()
 
 	db, err := env.DBProvider.GetDBHandle("testpaginatedquery")
 	testutil.AssertNoError(t, err, "")

core/ledger/kvledger/txmgmt/statedb/statecouchdb/statecouchdb_test_export.go

@@ -6,11 +6,11 @@ SPDX-License-Identifier: Apache-2.0
 package statecouchdb
 
 import (
-	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb"
-	"github.com/hyperledger/fabric/core/ledger/util/couchdb"
 )
 
 // TestVDBEnv provides a couch db backed versioned db for testing
@@ -30,19 +30,24 @@ func NewTestVDBEnv(t testing.TB) *TestVDBEnv {
 }
 
 // Cleanup drops the test couch databases and closes the db provider
-func (env *TestVDBEnv) Cleanup(dbName string) {
+func (env *TestVDBEnv) Cleanup() {
 	env.t.Logf("Cleaningup TestVDBEnv")
+	CleanupDB(env.t, env.DBProvider)
+
 	env.DBProvider.Close()
-	CleanupDB(dbName)
 }
 
-// CleanupDB drops the test couch databases
-func CleanupDB(dbName string) {
-	//create a new connection
-	couchDBDef := couchdb.GetCouchDBDefinition()
-	couchInstance, _ := couchdb.CreateCouchInstance(couchDBDef.URL, couchDBDef.Username, couchDBDef.Password,
-		couchDBDef.MaxRetries, couchDBDef.MaxRetriesOnStartup, couchDBDef.RequestTimeout, couchDBDef.CreateGlobalChangesDB)
-	db := couchdb.CouchDatabase{CouchInstance: couchInstance, DBName: strings.ToLower(dbName)}
-	//drop the test database
-	db.DropDatabase()
+func CleanupDB(t testing.TB, dbProvider statedb.VersionedDBProvider) {
+	couchdbProvider, _ := dbProvider.(*VersionedDBProvider)
+	for _, v := range couchdbProvider.databases {
+		if _, err := v.metadataDB.DropDatabase(); err != nil {
+			assert.Failf(t, "DropDatabase %s fails. err: %v", v.metadataDB.DBName, err)
+		}
+
+		for _, db := range v.namespaceDBs {
+			if _, err := db.DropDatabase(); err != nil {
+				assert.Failf(t, "DropDatabase %s fails. err: %v", db.DBName, err)
+			}
+		}
+	}
 }