[FAB-2487] Cleanup couchdb name translation logic

This CR cleansup the translation logic in the couch specific code.
After adding more restriction on the channel name in the
CR - https://gerrit.hyperledger.org/r/#/c/10535, the only
transformation required is to replace all the occurences of '.'
to '_'.

Change-Id: I7b74b892de3b2a6b8a024c720baecfcc97df132f
Signed-off-by: manish <[email protected]>

Author: manish-sethi

core/ledger/kvledger/txmgmt/txmgr/lockbasedtxmgr/txmgr_test.go

@@ -278,27 +278,27 @@ func TestIterator(t *testing.T) {
 	for _, testEnv := range testEnvs {
 		t.Logf("Running test for TestEnv = %s", testEnv.getName())
 
-		testLedgerID := "testiterator_1"
+		testLedgerID := "testiterator.1"
 		testEnv.init(t, testLedgerID)
 		testIterator(t, testEnv, 10, 2, 7)
 		testEnv.cleanup()
 
-		testLedgerID = "testiterator_2"
+		testLedgerID = "testiterator.2"
 		testEnv.init(t, testLedgerID)
 		testIterator(t, testEnv, 10, 1, 11)
 		testEnv.cleanup()
 
-		testLedgerID = "testiterator_3"
+		testLedgerID = "testiterator.3"
 		testEnv.init(t, testLedgerID)
 		testIterator(t, testEnv, 10, 0, 0)
 		testEnv.cleanup()
 
-		testLedgerID = "testiterator_4"
+		testLedgerID = "testiterator.4"
 		testEnv.init(t, testLedgerID)
 		testIterator(t, testEnv, 10, 5, 0)
 		testEnv.cleanup()
 
-		testLedgerID = "testiterator_5"
+		testLedgerID = "testiterator.5"
 		testEnv.init(t, testLedgerID)
 		testIterator(t, testEnv, 10, 0, 5)
 		testEnv.cleanup()
@@ -608,7 +608,7 @@ func TestValidateKey(t *testing.T) {
 	nonUTF8Key := string([]byte{0xff, 0xff})
 	dummyValue := []byte("dummyValue")
 	for _, testEnv := range testEnvs {
-		testLedgerID := "TestValidateKey"
+		testLedgerID := "test.validate.key"
 		testEnv.init(t, testLedgerID)
 		txSimulator, _ := testEnv.getTxMgr().NewTxSimulator()
 		err := txSimulator.SetState("ns1", nonUTF8Key, dummyValue)

core/ledger/util/couchdb/couchdb_test.go

@@ -256,7 +256,7 @@ func TestDBBadDatabaseName(t *testing.T) {
 			couchDBDef.MaxRetries, couchDBDef.MaxRetriesOnStartup, couchDBDef.RequestTimeout)
 		testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to create couch instance"))
 		_, dberr := CreateCouchDatabase(*couchInstance, "testDB")
-		testutil.AssertNoError(t, dberr, fmt.Sprintf("Error when testing a valid database name"))
+		testutil.AssertError(t, dberr, "Error should have been thrown for an invalid db name")
 
 		//create a new instance and database object using a valid database name letters and numbers
 		couchInstance, err = CreateCouchInstance(couchDBDef.URL, couchDBDef.Username, couchDBDef.Password,
@@ -270,20 +270,19 @@ func TestDBBadDatabaseName(t *testing.T) {
 			couchDBDef.MaxRetries, couchDBDef.MaxRetriesOnStartup, couchDBDef.RequestTimeout)
 		testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to create couch instance"))
 		_, dberr = CreateCouchDatabase(*couchInstance, "test1234~!@#$%^&*()[]{}.")
-		testutil.AssertNoError(t, dberr, fmt.Sprintf("Error when testing a valid database name"))
+		testutil.AssertError(t, dberr, "Error should have been thrown for an invalid db name")
 
 		//create a new instance and database object using a invalid database name - too long	/*
 		couchInstance, err = CreateCouchInstance(couchDBDef.URL, couchDBDef.Username, couchDBDef.Password,
 			couchDBDef.MaxRetries, couchDBDef.MaxRetriesOnStartup, couchDBDef.RequestTimeout)
 		testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to create couch instance"))
-		_, dberr = CreateCouchDatabase(*couchInstance, "A12345678901234567890123456789012345678901234"+
+		_, dberr = CreateCouchDatabase(*couchInstance, "a12345678901234567890123456789012345678901234"+
 			"56789012345678901234567890123456789012345678901234567890123456789012345678901234567890"+
 			"12345678901234567890123456789012345678901234567890123456789012345678901234567890123456"+
 			"78901234567890123456789012345678901234567890")
 		testutil.AssertError(t, dberr, fmt.Sprintf("Error should have been thrown for invalid database name"))
 
 	}
-
 }
 
 func TestDBBadConnection(t *testing.T) {

core/ledger/util/couchdb/couchdbutil.go

@@ -25,7 +25,7 @@ import (
 	"time"
 )
 
-var validNamePattern = `^[a-z][a-z0-9_$(),+/-]+`
+var expectedChannelNamePattern = `[a-z][a-z0-9.-]*`
 var maxLength = 249
 
 //CreateCouchInstance creates a CouchDB instance
@@ -142,44 +142,28 @@ func CreateSystemDatabasesIfNotExist(couchInstance CouchInstance) error {
 //_, $, (, ), +, -, and / are allowed. Must begin with a letter.
 //
 //Restictions have already been applied to the database name from Orderer based on
-//restrictions required by Kafka
+//restrictions required by Kafka and couchDB (except a '.' char). The databaseName
+// passed in here is expected to follow `[a-z][a-z0-9.-]*` pattern.
 //
-//The validation will validate upper case, the string will be lower cased
-//Replace any characters not allowed in CouchDB with an "_"
-//Check for a leading letter, if not present, the prepend "db_"
+//This validation will simply check whether the database name matches the above pattern and will replace
+// all occurence of '.' by '-'. This will not cause collisions in the trnasformed named
 func mapAndValidateDatabaseName(databaseName string) (string, error) {
-
 	// test Length
 	if len(databaseName) <= 0 {
 		return "", fmt.Errorf("Database name is illegal, cannot be empty")
 	}
 	if len(databaseName) > maxLength {
 		return "", fmt.Errorf("Database name is illegal, cannot be longer than %d", maxLength)
 	}
-
-	//force the name to all lowercase
-	databaseName = strings.ToLower(databaseName)
-
-	//Replace any characters not allowed in CouchDB with an "_"
-	replaceString := regexp.MustCompile(`[^a-z0-9_$(),+/-]`)
-
-	//Set up the replace pattern for special characters
-	validatedDatabaseName := replaceString.ReplaceAllString(databaseName, "_")
-
-	//if the first character is not a letter, then prepend "db_"
-	testLeadingLetter := regexp.MustCompile("^[a-z]")
-	isLeadingLetter := testLeadingLetter.MatchString(validatedDatabaseName)
-	if !isLeadingLetter {
-		validatedDatabaseName = "db_" + validatedDatabaseName
+	re, err := regexp.Compile(expectedChannelNamePattern)
+	if err != nil {
+		return "", err
 	}
-
-	//create the expression for valid characters
-	validString := regexp.MustCompile(validNamePattern)
-
-	// Illegal characters
-	matched := validString.MatchString(validatedDatabaseName)
-	if !matched {
-		return "", fmt.Errorf("Database name '%s' contains illegal characters", validatedDatabaseName)
+	matched := re.FindString(databaseName)
+	if len(matched) != len(databaseName) {
+		return "", fmt.Errorf("databaseName '%s' does not matches pattern '%s'", databaseName, expectedChannelNamePattern)
 	}
-	return validatedDatabaseName, nil
+	// replace all '.' to '_'. The databaseName passed in will never contain an '_'. So, this translation will not cause collisions
+	databaseName = strings.Replace(databaseName, ".", "_", -1)
+	return databaseName, nil
 }

core/ledger/util/couchdb/couchdbutil_test.go

@@ -84,35 +84,29 @@ func TestCreateCouchDBSystemDBs(t *testing.T) {
 
 }
 func TestDatabaseMapping(t *testing.T) {
-
 	//create a new instance and database object using a database name mixed case
-	databaseName, err := mapAndValidateDatabaseName("testDB")
-	testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to map database name"))
-	testutil.AssertEquals(t, databaseName, "testdb")
-
-	//create a new instance and database object using a database name with numerics
-	databaseName, err = mapAndValidateDatabaseName("test1234DB")
-	testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to map database name"))
-	testutil.AssertEquals(t, databaseName, "test1234db")
+	_, err := mapAndValidateDatabaseName("testDB")
+	testutil.AssertError(t, err, "Error expected because the name contains capital letters")
 
 	//create a new instance and database object using a database name with special characters
-	databaseName, err = mapAndValidateDatabaseName("test1234_$(),+-/~!@#%^&*[]{}.")
-	testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to map database name"))
-	testutil.AssertEquals(t, databaseName, "test1234_$(),+-/_____________")
+	_, err = mapAndValidateDatabaseName("test1234_1")
+	testutil.AssertError(t, err, "Error expected because the name contains illegal chars")
 
 	//create a new instance and database object using a database name with special characters
-	databaseName, err = mapAndValidateDatabaseName("5test1234")
-	testutil.AssertNoError(t, err, fmt.Sprintf("Error when trying to map database name"))
-	testutil.AssertEquals(t, databaseName, "db_5test1234")
+	_, err = mapAndValidateDatabaseName("5test1234")
+	testutil.AssertError(t, err, "Error expected because the name starts with a number")
 
 	//create a new instance and database object using an empty string
 	_, err = mapAndValidateDatabaseName("")
 	testutil.AssertError(t, err, fmt.Sprintf("Error should have been thrown for an invalid name"))
 
-	_, err = mapAndValidateDatabaseName("A12345678901234567890123456789012345678901234" +
+	_, err = mapAndValidateDatabaseName("a12345678901234567890123456789012345678901234" +
 		"56789012345678901234567890123456789012345678901234567890123456789012345678901234567890" +
 		"12345678901234567890123456789012345678901234567890123456789012345678901234567890123456" +
 		"78901234567890123456789012345678901234567890")
 	testutil.AssertError(t, err, fmt.Sprintf("Error should have been thrown for an invalid name"))
 
+	transformedName, err := mapAndValidateDatabaseName("test.my.db-1")
+	testutil.AssertNoError(t, err, "")
+	testutil.AssertEquals(t, transformedName, "test_my_db-1")
 }