mv DB's loc. constructor code to a single place

Currently, we construct the path of various DBs and stores
in many places within the ledger component. This is risky
as we need to ensure that the same postfix is used during
a path construction at all places. Hence, in this CR, we
move this logic to a common place.

FAB-16126 #done

Change-Id: I04b24f85d64b5867200316add3cd6423cc3e8da3
Signed-off-by: senthil <cendhu@gmail.com>

Author: cendhu

core/ledger/kvledger/drop_dbs.go

@@ -8,7 +8,6 @@ package kvledger
 
 import (
 	"os"
-	"path/filepath"
 
 	"github.com/pkg/errors"
 )
@@ -39,27 +38,27 @@ func dropDBs(rootFSPath string) error {
 }
 
 func dropStateLevelDB(rootFSPath string) error {
-	stateLeveldbPath := filepath.Join(rootFSPath, "stateLeveldb")
+	stateLeveldbPath := StateDBPath(rootFSPath)
 	logger.Infof("Dropping StateLevelDB at location [%s] ...if present", stateLeveldbPath)
 	return os.RemoveAll(stateLeveldbPath)
 }
 
 func dropConfigHistoryDB(rootFSPath string) error {
-	configHistoryDBPath := filepath.Join(rootFSPath, "configHistory")
+	configHistoryDBPath := ConfigHistoryDBPath(rootFSPath)
 	logger.Infof("Dropping ConfigHistoryDB at location [%s]", configHistoryDBPath)
 	err := os.RemoveAll(configHistoryDBPath)
 	return errors.Wrapf(err, "error removing the ConfigHistoryDB located at %s", configHistoryDBPath)
 }
 
 func dropBookkeeperDB(rootFSPath string) error {
-	bookkeeperDBPath := filepath.Join(rootFSPath, "bookkeeper")
+	bookkeeperDBPath := BookkeeperDBPath(rootFSPath)
 	logger.Infof("Dropping BookkeeperDB at location [%s]", bookkeeperDBPath)
 	err := os.RemoveAll(bookkeeperDBPath)
 	return errors.Wrapf(err, "error removing the BookkeeperDB located at %s", bookkeeperDBPath)
 }
 
 func dropHistoryDB(rootFSPath string) error {
-	historyDBPath := filepath.Join(rootFSPath, "historyLeveldb")
+	historyDBPath := HistoryDBPath(rootFSPath)
 	logger.Infof("Dropping HistoryDB at location [%s] ...if present", historyDBPath)
 	return os.RemoveAll(historyDBPath)
 }

core/ledger/kvledger/kv_ledger_provider.go

@@ -9,7 +9,6 @@ package kvledger
 import (
 	"bytes"
 	"fmt"
-	"path/filepath"
 
 	"github.com/golang/protobuf/proto"
 	"github.com/hyperledger/fabric/common/ledger/util/leveldbhelper"
@@ -56,7 +55,7 @@ type Provider struct {
 // NewProvider instantiates a new Provider.
 // This is not thread-safe and assumed to be synchronized by the caller
 func NewProvider(initializer *ledger.Initializer) (*Provider, error) {
-	fileLockPath := filepath.Join(initializer.Config.RootFSPath, "fileLock")
+	fileLockPath := fileLockPath(initializer.Config.RootFSPath)
 	fileLock := leveldbhelper.NewFileLock(fileLockPath)
 	if err := fileLock.Lock(); err != nil {
 		return nil, errors.Wrap(err, "as another peer node command is executing,"+
@@ -67,29 +66,29 @@ func NewProvider(initializer *ledger.Initializer) (*Provider, error) {
 	p.initializer = initializer
 	p.fileLock = fileLock
 	// initialize the ID store (inventory of chainIds/ledgerIds)
-	idStore := openIDStore(filepath.Join(p.initializer.Config.RootFSPath, "ledgerProvider"))
+	idStore := openIDStore(ledgerProviderPath(p.initializer.Config.RootFSPath))
 	p.idStore = idStore
 	// initialize ledger storage
 	privateData := &pvtdatastorage.PrivateDataConfig{
 		PrivateDataConfig: initializer.Config.PrivateDataConfig,
-		StorePath:         filepath.Join(initializer.Config.RootFSPath, "pvtdataStore"),
+		StorePath:         PvtDataStorePath(p.initializer.Config.RootFSPath),
 	}
 	ledgerStoreProvider := ledgerstorage.NewProvider(
-		p.initializer.Config.RootFSPath,
+		BlockStorePath(p.initializer.Config.RootFSPath),
 		privateData,
 		p.initializer.MetricsProvider,
 	)
 	p.ledgerStoreProvider = ledgerStoreProvider
 	if initializer.Config.HistoryDBConfig.Enabled {
 		// Initialize the history database (index for history of values by key)
 		historydbProvider := history.NewDBProvider(
-			filepath.Join(p.initializer.Config.RootFSPath, "historyLeveldb"),
+			HistoryDBPath(p.initializer.Config.RootFSPath),
 		)
 		p.historydbProvider = historydbProvider
 	}
 	// initialize config history for chaincode
 	configHistoryMgr := confighistory.NewMgr(
-		filepath.Join(p.initializer.Config.RootFSPath, "configHistory"),
+		ConfigHistoryDBPath(p.initializer.Config.RootFSPath),
 		initializer.DeployedChaincodeInfoProvider,
 	)
 	p.configHistoryMgr = configHistoryMgr
@@ -108,12 +107,12 @@ func NewProvider(initializer *ledger.Initializer) (*Provider, error) {
 	p.stateListeners = stateListeners
 
 	p.bookkeepingProvider = bookkeeping.NewProvider(
-		filepath.Join(p.initializer.Config.RootFSPath, "bookkeeper"),
+		BookkeeperDBPath(p.initializer.Config.RootFSPath),
 	)
 	var err error
 	stateDB := &privacyenabledstate.StateDBConfig{
 		StateDBConfig: initializer.Config.StateDBConfig,
-		LevelDBPath:   filepath.Join(initializer.Config.RootFSPath, "stateLeveldb"),
+		LevelDBPath:   StateDBPath(p.initializer.Config.RootFSPath),
 	}
 	p.vdbProvider, err = privacyenabledstate.NewCommonStorageDBProvider(
 		p.bookkeepingProvider,

core/ledger/kvledger/kv_ledger_provider_test.go

@@ -331,9 +331,9 @@ func TestLedgerBackup(t *testing.T) {
 
 	// remove the statedb, historydb, and block indexes (they are supposed to be auto created during opening of an existing ledger)
 	// and rename the originalPath to restorePath
-	assert.NoError(t, os.RemoveAll(filepath.Join(originalPath, "stateLeveldb")))
-	assert.NoError(t, os.RemoveAll(filepath.Join(originalPath, "historyLeveldb")))
-	assert.NoError(t, os.RemoveAll(filepath.Join(originalPath, "chains", fsblkstorage.IndexDir)))
+	assert.NoError(t, os.RemoveAll(StateDBPath(originalPath)))
+	assert.NoError(t, os.RemoveAll(HistoryDBPath(originalPath)))
+	assert.NoError(t, os.RemoveAll(filepath.Join(BlockStorePath(originalPath), fsblkstorage.IndexDir)))
 	assert.NoError(t, os.Rename(originalPath, restorePath))
 
 	// Instantiate the ledger from restore environment and this should behave exactly as it would have in the original environment

core/ledger/kvledger/ledger_filepath.go

@@ -0,0 +1,48 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package kvledger
+
+import (
+	"path/filepath"
+)
+
+func fileLockPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "fileLock")
+}
+
+func ledgerProviderPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "ledgerProvider")
+}
+
+// BlockStorePath returns the absolute path of block storage
+func BlockStorePath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "chains")
+}
+
+// PvtDataStorePath returns the absolute path of pvtdata storage
+func PvtDataStorePath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "pvtdataStore")
+}
+
+// StateDBPath returns the absolute path of state level DB
+func StateDBPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "stateLeveldb")
+}
+
+// HistoryDBPath returns the absolute path of history DB
+func HistoryDBPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "historyLeveldb")
+}
+
+// ConfigHistoryDBPath returns the absolute path of configHistory DB
+func ConfigHistoryDBPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "configHistory")
+}
+
+// BookkeeperDBPath return the absolute path of bookkeeper DB
+func BookkeeperDBPath(rootFSPath string) string {
+	return filepath.Join(rootFSPath, "bookkeeper")
+}

core/ledger/kvledger/reset.go

@@ -6,16 +6,14 @@ SPDX-License-Identifier: Apache-2.0
 package kvledger
 
 import (
-	"path/filepath"
-
 	"github.com/hyperledger/fabric/common/ledger/blkstorage/fsblkstorage"
 	"github.com/hyperledger/fabric/common/ledger/util/leveldbhelper"
 	"github.com/pkg/errors"
 )
 
 // ResetAllKVLedgers resets all ledger to the genesis block.
 func ResetAllKVLedgers(rootFSPath string) error {
-	fileLockPath := filepath.Join(rootFSPath, "fileLock")
+	fileLockPath := fileLockPath(rootFSPath)
 	fileLock := leveldbhelper.NewFileLock(fileLockPath)
 	if err := fileLock.Lock(); err != nil {
 		return errors.Wrap(err, "as another peer node command is executing,"+
@@ -37,20 +35,20 @@ func ResetAllKVLedgers(rootFSPath string) error {
 
 // LoadPreResetHeight returns the prereset height of all ledgers.
 func LoadPreResetHeight(rootFSPath string) (map[string]uint64, error) {
-	blockstorePath := filepath.Join(rootFSPath, "chains")
+	blockstorePath := BlockStorePath(rootFSPath)
 	logger.Infof("Loading prereset height from path [%s]", blockstorePath)
 	return fsblkstorage.LoadPreResetHeight(blockstorePath)
 }
 
 // ClearPreResetHeight removes the prereset height recorded in the file system.
 func ClearPreResetHeight(rootFSPath string) error {
-	blockstorePath := filepath.Join(rootFSPath, "chains")
+	blockstorePath := BlockStorePath(rootFSPath)
 	logger.Infof("Clearing off prereset height files from path [%s]", blockstorePath)
 	return fsblkstorage.ClearPreResetHeight(blockstorePath)
 }
 
 func resetBlockStorage(rootFSPath string) error {
-	blockstorePath := filepath.Join(rootFSPath, "chains")
+	blockstorePath := BlockStorePath(rootFSPath)
 	logger.Infof("Resetting BlockStore to genesis block at location [%s]", blockstorePath)
 	return fsblkstorage.ResetBlockStore(blockstorePath)
 }

core/ledger/kvledger/rollback.go

@@ -7,24 +7,22 @@ SPDX-License-Identifier: Apache-2.0
 package kvledger
 
 import (
-	"path/filepath"
-
 	"github.com/hyperledger/fabric/common/ledger/util/leveldbhelper"
 	"github.com/hyperledger/fabric/core/ledger/ledgerstorage"
 	"github.com/pkg/errors"
 )
 
 // RollbackKVLedger rollbacks a ledger to a specified block number
 func RollbackKVLedger(rootFSPath, ledgerID string, blockNum uint64) error {
-	fileLockPath := filepath.Join(rootFSPath, "fileLock")
+	fileLockPath := fileLockPath(rootFSPath)
 	fileLock := leveldbhelper.NewFileLock(fileLockPath)
 	if err := fileLock.Lock(); err != nil {
 		return errors.Wrap(err, "as another peer node command is executing,"+
 			" wait for that command to complete its execution or terminate it before retrying")
 	}
 	defer fileLock.Unlock()
 
-	blockstorePath := filepath.Join(rootFSPath, "chains")
+	blockstorePath := BlockStorePath(rootFSPath)
 	if err := ledgerstorage.ValidateRollbackParams(blockstorePath, ledgerID, blockNum); err != nil {
 		return err
 	}

core/ledger/kvledger/tests/env.go

@@ -17,6 +17,7 @@ import (
 	"github.com/hyperledger/fabric/common/metrics/disabled"
 	"github.com/hyperledger/fabric/core/common/privdata"
 	"github.com/hyperledger/fabric/core/ledger"
+	"github.com/hyperledger/fabric/core/ledger/kvledger"
 	"github.com/hyperledger/fabric/core/ledger/ledgermgmt"
 	"github.com/hyperledger/fabric/core/scc/lscc"
 	"github.com/hyperledger/fabric/msp"
@@ -166,23 +167,23 @@ func (e *env) getLedgerRootPath() string {
 }
 
 func (e *env) getLevelstateDBPath() string {
-	return filepath.Join(e.initializer.Config.RootFSPath, "stateLeveldb")
+	return kvledger.StateDBPath(e.initializer.Config.RootFSPath)
 }
 
 func (e *env) getBlockIndexDBPath() string {
-	return filepath.Join(e.initializer.Config.RootFSPath, "chains", fsblkstorage.IndexDir)
+	return filepath.Join(kvledger.BlockStorePath(e.initializer.Config.RootFSPath), fsblkstorage.IndexDir)
 }
 
 func (e *env) getConfigHistoryDBPath() string {
-	return filepath.Join(e.initializer.Config.RootFSPath, "configHistory")
+	return kvledger.ConfigHistoryDBPath(e.initializer.Config.RootFSPath)
 }
 
 func (e *env) getHistoryDBPath() string {
-	return filepath.Join(e.initializer.Config.RootFSPath, "historyLeveldb")
+	return kvledger.HistoryDBPath(e.initializer.Config.RootFSPath)
 }
 
 func (e *env) getBookkeeperDBPath() string {
-	return filepath.Join(e.initializer.Config.RootFSPath, "bookkeeper")
+	return kvledger.BookkeeperDBPath(e.initializer.Config.RootFSPath)
 }
 
 func populateMissingsWithTestDefaults(t *testing.T, initializer *ledgermgmt.Initializer) {

core/ledger/kvledger/tests/reset_test.go

@@ -8,7 +8,6 @@ package tests
 
 import (
 	"fmt"
-	"path/filepath"
 	"testing"
 
 	"github.com/hyperledger/fabric/common/ledger/blkstorage/fsblkstorage"
@@ -172,7 +171,7 @@ func TestResetLedgerWithoutDroppingDBs(t *testing.T) {
 	env.closeLedgerMgmt()
 
 	// Reset All kv ledgers
-	blockstorePath := filepath.Join(env.initializer.Config.RootFSPath, "chains")
+	blockstorePath := kvledger.BlockStorePath(env.initializer.Config.RootFSPath)
 	err := fsblkstorage.ResetBlockStore(blockstorePath)
 	assert.NoError(t, err)
 	rebuildable := rebuildableStatedb | rebuildableBookkeeper | rebuildableConfigHistory | rebuildableHistoryDB

core/ledger/ledgerstorage/store.go

@@ -7,7 +7,6 @@ SPDX-License-Identifier: Apache-2.0
 package ledgerstorage
 
 import (
-	"path/filepath"
 	"sync"
 	"sync/atomic"
 
@@ -50,12 +49,12 @@ var attrsToIndex = []blkstorage.IndexableAttr{
 }
 
 // NewProvider returns the handle to the provider
-func NewProvider(storeDir string, conf *pvtdatastorage.PrivateDataConfig, metricsProvider metrics.Provider) *Provider {
+func NewProvider(blockStoreDir string, conf *pvtdatastorage.PrivateDataConfig, metricsProvider metrics.Provider) *Provider {
 	// Initialize the block storage
 	indexConfig := &blkstorage.IndexConfig{AttrsToIndex: attrsToIndex}
 	blockStoreProvider := fsblkstorage.NewProvider(
 		fsblkstorage.NewConf(
-			filepath.Join(storeDir, "chains"),
+			blockStoreDir,
 			maxBlockFileSize,
 		),
 		indexConfig,