[FAB-9102] Start CouchDB as needed in ledger tests

If the COUCHDB_ADDR environment variable is set, it should point to a
running instance of CouchdB to by used by tests. When the environment
variable is not set, an containerized instance of CouchDB will be
launched on an ephemeral port of the loopback adapter.

Change-Id: If9c7f7e2dc5fcc493f8409aee96667382be95353
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>
Signed-off-by: Will Lahti <wtlahti@us.ibm.com>

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

@@ -7,12 +7,14 @@ SPDX-License-Identifier: Apache-2.0
 package privacyenabledstate
 
 import (
+	"fmt"
 	"os"
 	"testing"
 	"time"
 
 	"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"
 )
@@ -70,16 +72,33 @@ func (env *LevelDBCommonStorageTestEnv) Cleanup() {
 
 // CouchDBCommonStorageTestEnv implements TestEnv interface for couchdb based storage
 type CouchDBCommonStorageTestEnv struct {
-	t         testing.TB
-	provider  DBProvider
-	openDbIds map[string]bool
+	t            testing.TB
+	provider     DBProvider
+	openDbIds    map[string]bool
+	couchCleanup func()
+}
+
+func (env *CouchDBCommonStorageTestEnv) setupCouch() string {
+	externalCouch, set := os.LookupEnv("COUCHDB_ADDR")
+	if set {
+		env.couchCleanup = func() {}
+		return externalCouch
+	}
+
+	couchDB := &runner.CouchDB{}
+	if err := couchDB.Start(); err != nil {
+		err := fmt.Errorf("failed to start couchDB: %s", err)
+		panic(err)
+	}
+	env.couchCleanup = func() { couchDB.Stop() }
+	return couchDB.Address()
 }
 
 // Init implements corresponding function from interface TestEnv
 func (env *CouchDBCommonStorageTestEnv) Init(t testing.TB) {
 	viper.Set("ledger.state.stateDatabase", "CouchDB")
-	// both vagrant and CI have couchdb configured at host "couchdb"
-	viper.Set("ledger.state.couchDBConfig.couchDBAddress", "couchdb:5984")
+	couchAddr := env.setupCouch()
+	viper.Set("ledger.state.couchDBConfig.couchDBAddress", couchAddr)
 	// Replace with correct username/password such as
 	// admin/admin if user security is enabled on couchdb.
 	viper.Set("ledger.state.couchDBConfig.username", "")
@@ -113,6 +132,7 @@ func (env *CouchDBCommonStorageTestEnv) Cleanup() {
 		statecouchdb.CleanupDB(id)
 	}
 	env.provider.Close()
+	env.couchCleanup()
 }
 
 func removeDBPath(t testing.TB) {

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

@@ -1,17 +1,7 @@
 /*
-Copyright IBM Corp. 2016, 2017 All Rights Reserved.
+Copyright IBM Corp. All Rights Reserved.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-		 http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+SPDX-License-Identifier: Apache-2.0
 */
 
 package statecouchdb
@@ -30,20 +20,26 @@ import (
 	"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb/commontests"
 	"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) {
+	os.Exit(testMain(m))
+}
 
+func testMain(m *testing.M) int {
 	// Read the core.yaml file for default config.
 	ledgertestutil.SetupCoreYAMLConfig()
 	viper.Set("peer.fileSystemPath", "/tmp/fabric/ledgertests/kvledger/txmgmt/statedb/statecouchdb")
 
 	// Switch to CouchDB
+	couchAddress, cleanup := couchDBSetup()
+	defer cleanup()
 	viper.Set("ledger.state.stateDatabase", "CouchDB")
+	defer viper.Set("ledger.state.stateDatabase", "goleveldb")
 
-	// both vagrant and CI have couchdb configured at host "couchdb"
-	viper.Set("ledger.state.couchDBConfig.couchDBAddress", "couchdb:5984")
+	viper.Set("ledger.state.couchDBConfig.couchDBAddress", couchAddress)
 	// Replace with correct username/password such as
 	// admin/admin if user security is enabled on couchdb.
 	viper.Set("ledger.state.couchDBConfig.username", "")
@@ -53,11 +49,21 @@ func TestMain(m *testing.M) {
 	viper.Set("ledger.state.couchDBConfig.requestTimeout", time.Second*35)
 
 	//run the actual test
-	result := m.Run()
+	return m.Run()
+}
 
-	//revert to default goleveldb
-	viper.Set("ledger.state.stateDatabase", "goleveldb")
-	os.Exit(result)
+func couchDBSetup() (addr string, cleanup func()) {
+	externalCouch, set := os.LookupEnv("COUCHDB_ADDR")
+	if set {
+		return externalCouch, func() {}
+	}
+
+	couchDB := &runner.CouchDB{}
+	if err := couchDB.Start(); err != nil {
+		err := fmt.Errorf("failed to start couchDB: %s", err)
+		panic(err)
+	}
+	return couchDB.Address(), func() { couchDB.Stop() }
 }
 
 func TestBasicRW(t *testing.T) {

core/ledger/util/couchdb/config_test.go

@@ -1,17 +1,7 @@
 /*
-Copyright IBM Corp. 2016 All Rights Reserved.
+Copyright IBM Corp. All Rights Reserved.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-		 http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+SPDX-License-Identifier: Apache-2.0
 */
 
 package couchdb
@@ -21,11 +11,14 @@ import (
 	"time"
 
 	"github.com/hyperledger/fabric/common/ledger/testutil"
+	"github.com/spf13/viper"
 )
 
 func TestGetCouchDBDefinition(t *testing.T) {
+	expectedAddress := viper.GetString("ledger.state.couchDBConfig.couchDBAddress")
+
 	couchDBDef := GetCouchDBDefinition()
-	testutil.AssertEquals(t, couchDBDef.URL, "couchdb:5984")
+	testutil.AssertEquals(t, couchDBDef.URL, expectedAddress)
 	testutil.AssertEquals(t, couchDBDef.Username, "")
 	testutil.AssertEquals(t, couchDBDef.Password, "")
 	testutil.AssertEquals(t, couchDBDef.MaxRetries, 3)

core/ledger/util/couchdb/couchdb_test.go

@@ -1,17 +1,7 @@
 /*
-Copyright IBM Corp. 2016, 2017 All Rights Reserved.
+Copyright IBM Corp. All Rights Reserved.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-		 http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+SPDX-License-Identifier: Apache-2.0
 */
 
 package couchdb
@@ -29,6 +19,7 @@ import (
 	"github.com/hyperledger/fabric/common/ledger/testutil"
 	"github.com/hyperledger/fabric/core/ledger/ledgerconfig"
 	ledgertestutil "github.com/hyperledger/fabric/core/ledger/testutil"
+	"github.com/hyperledger/fabric/integration/runner"
 	logging "github.com/op/go-logging"
 	"github.com/spf13/viper"
 )
@@ -67,14 +58,20 @@ type Asset struct {
 var assetJSON = []byte(`{"asset_name":"marble1","color":"blue","size":"35","owner":"jerry"}`)
 
 func TestMain(m *testing.M) {
+	os.Exit(testMain(m))
+}
+
+func testMain(m *testing.M) int {
 	// Read the core.yaml file for default config.
 	ledgertestutil.SetupCoreYAMLConfig()
 
 	// Switch to CouchDB
+	couchAddress, cleanup := couchDBSetup()
+	defer cleanup()
 	viper.Set("ledger.state.stateDatabase", "CouchDB")
+	defer viper.Set("ledger.state.stateDatabase", "goleveldb")
 
-	// both vagrant and CI have couchdb configured at host "couchdb"
-	viper.Set("ledger.state.couchDBConfig.couchDBAddress", "couchdb:5984")
+	viper.Set("ledger.state.couchDBConfig.couchDBAddress", couchAddress)
 	// Replace with correct username/password such as
 	// admin/admin if user security is enabled on couchdb.
 	viper.Set("ledger.state.couchDBConfig.username", "")
@@ -92,11 +89,21 @@ func TestMain(m *testing.M) {
 	couchDBDef = GetCouchDBDefinition()
 
 	//run the tests
-	result := m.Run()
+	return m.Run()
+}
+
+func couchDBSetup() (addr string, cleanup func()) {
+	externalCouch, set := os.LookupEnv("COUCHDB_ADDR")
+	if set {
+		return externalCouch, func() {}
+	}
 
-	//revert to default goleveldb
-	viper.Set("ledger.state.stateDatabase", "goleveldb")
-	os.Exit(result)
+	couchDB := &runner.CouchDB{}
+	if err := couchDB.Start(); err != nil {
+		err := fmt.Errorf("failed to start couchDB: %s", err)
+		panic(err)
+	}
+	return couchDB.Address(), func() { couchDB.Stop() }
 }
 
 func TestDBConnectionDef(t *testing.T) {
@@ -980,7 +987,7 @@ func TestIndexOperations(t *testing.T) {
 	for _, elem := range *listResult {
 		testutil.AssertEquals(t, elem.DesignDocument, "indexSizeSortDoc")
 		testutil.AssertEquals(t, elem.Name, "indexSizeSortName")
-		//ensure the index defintion is correct,  CouchDB 2.1.1 will also return "partial_filter_selector":{}
+		//ensure the index definition is correct,  CouchDB 2.1.1 will also return "partial_filter_selector":{}
 		testutil.AssertEquals(t, strings.Contains(elem.Definition, `"fields":[{"size":"desc"}]`), true)
 	}
 

unit-test/docker-compose.yml

@@ -14,6 +14,7 @@ unit-tests:
     - CORE_VM_DOCKER_ATTACHSTDOUT=true
     - VERBOSE
     - JOB_TYPE=${JOB_TYPE}
+    - COUCHDB_ADDR=couchdb:5984
   volumes:
     - /var/run/docker.sock:/var/run/docker.sock
     - ${GOPATH}/src/github.com/hyperledger/fabric:/opt/gopath/src/github.com/hyperledger/fabric