Merge pull request #513 from upper/hotfix/refactor-tests-layout

Refactor test suite

Author: xiam

.travis.yml

@@ -9,9 +9,7 @@ env:
     - GOARCH=amd64
     - DB_HOST=127.0.0.1
   matrix:
-    - TEST_CMD="make db-up test" POSTGRESQL_VERSION=9 MYSQL_VERSION=5.7 MONGO_VERSION=3.2 MSSQL_VERSION=2017-GA-ubuntu
-    - TEST_CMD="make db-up test" POSTGRESQL_VERSION=10 MYSQL_VERSION=5.7 MONGO_VERSION=3.6 MSSQL_VERSION=2017-GDR-ubuntu
-    - TEST_CMD="make db-up test" POSTGRESQL_VERSION=11 MYSQL_VERSION=5 MONGO_VERSION=3 MSSQL_VERSION=latest
+    - TEST_CMD="make test"
     - TEST_CMD="make benchmark"
 
 notifications:

Makefile

@@ -1,37 +1,13 @@
 SHELL                 := /bin/bash
 
-MONGO_VERSION         ?= 3
-MYSQL_VERSION         ?= 5
-POSTGRES_VERSION      ?= 11
-MSSQL_VERSION         ?= 2017-latest-ubuntu
-
-DB_NAME               ?= upperio
-DB_USERNAME           ?= upperio_user
-DB_PASSWORD           ?= upperio//s3cr37
-
-BIND_HOST             ?= 127.0.0.1
-
-WRAPPER               ?= all
-DB_HOST               ?= 127.0.0.1
+PARALLEL_FLAGS        ?= --halt now,fail=1 --jobs=2 -v -u
 
 TEST_FLAGS            ?=
 
-PARALLEL_FLAGS        ?= --halt 2 -v
-
-export MONGO_VERSION
-export MYSQL_VERSION
-export POSTGRES_VERSION
-export MSSQL_VERSION
-
-export DB_USERNAME
-export DB_PASSWORD
-export DB_NAME
-export DB_HOST
-
-export BIND_HOST
-export WRAPPER
+export TEST_FLAGS
+export PARALLEL_FLAGS
 
-test: reset-db test-libs test-main test-adapters
+test: test-libs test-adapters
 
 benchmark-lib:
 	go test -v -benchtime=500ms -bench=. ./lib/...
@@ -48,43 +24,25 @@ test-internal:
 	go test -v ./internal/...
 
 test-libs:
-	parallel $(PARALLEL_FLAGS) -u \
+	parallel $(PARALLEL_FLAGS) \
 		"$(MAKE) test-{}" ::: \
 			lib \
 			internal
 
 test-adapters:
-	parallel $(PARALLEL_FLAGS) -u \
-		"$(MAKE) test-adapter-{}" ::: \
-			postgresql \
-			mysql \
-			sqlite \
-			mssql \
-			ql \
-			mongo
-
-test-main:
-	go test $(TEST_FLAGS) -v ./tests/...
-
-reset-db:
-	parallel $(PARALLEL_FLAGS) \
-		"$(MAKE) reset-db-{}" ::: \
-			postgresql \
-			mysql \
-			sqlite \
-			mssql \
-			ql \
-			mongo
+	for MAKEFILE in $$(grep -Rl test-extended */Makefile | sort -u); do \
+		ADAPTER=$$(dirname $$MAKEFILE); \
+		($(MAKE) test-adapter-$$ADAPTER || exit 1); \
+	done
 
 test-adapter-%:
-	($(MAKE) -C $* test || exit 1)
-
-reset-db-%:
-	($(MAKE) -C $* reset-db || exit 1)
+	($(MAKE) -C $* test-extended || exit 1)
 
-db-up:
-	docker-compose -p upper up -d && \
-	sleep 15
+test-generic:
+	export TEST_FLAGS="-run TestGeneric"; \
+	$(MAKE) test-adapters
 
-db-down:
-	docker-compose -p upper down
+goimports:
+	for FILE in $$(find -name "*.go" | grep -v vendor); do \
+		goimports -w $$FILE; \
+	done

collection.go

@@ -24,17 +24,17 @@ package db
 // Collection is an interface that defines methods useful for handling tables.
 type Collection interface {
 	// Insert inserts a new item into the collection, it accepts one argument
-	// that can be either a map or a struct. If the call suceeds, it returns the
-	// ID of the newly added element as an `interface{}` (the underlying type of
-	// this ID is unknown and depends on the database adapter). The ID returned
-	// by Insert() could be passed directly to Find() to retrieve the newly added
-	// element.
+	// that can be either a map or a struct. If the call succeeds, it returns the
+	// ID of the newly added element as an `interface{}` (the actual type of this
+	// ID depends on both the database adapter and the column that stores this
+	// ID). The ID returned by Insert() could be passed directly to Find() to
+	// retrieve the newly added element.
 	Insert(interface{}) (interface{}, error)
 
-	// InsertReturning is like Insert() but it updates the passed pointer to map
-	// or struct with the newly inserted element (and with automatic fields, like
-	// IDs, timestamps, etc). This is all done atomically within a transaction.
-	// If the database does not support transactions this method returns
+	// InsertReturning is like Insert() but it updates the passed map or struct
+	// with the newly inserted element (and with automatic fields, like IDs,
+	// timestamps, etc). This is all done atomically within a transaction.  If
+	// the database does not support transactions this method returns
 	// db.ErrUnsupported.
 	InsertReturning(interface{}) error
 

comparison.go

@@ -331,4 +331,4 @@ func toInterfaceArray(v interface{}) []interface{} {
 	return []interface{}{v}
 }
 
-var _ Comparison = &dbComparisonOperator{}
+var _ = Comparison(&dbComparisonOperator{})

compound.go

@@ -26,8 +26,8 @@ import (
 )
 
 // Compound represents an statement that has one or many sentences joined by by
-// an operator like "AND" or "OR". This is an exported interface but it's
-// rarely used directly, you may want to use the `db.And()` or `db.Or()`
+// an operator like "AND" or "OR". This is an exported interface but it was
+// designed for internal usage, you may want to use the `db.And()` or `db.Or()`
 // functions instead.
 type Compound interface {
 	// Sentences returns child sentences.
@@ -125,5 +125,7 @@ func defaultJoin(in ...Compound) []Compound {
 	return in
 }
 
-var _ = immutable.Immutable(&compound{})
-var _ Compound = Cond{}
+var (
+	_ = immutable.Immutable(&compound{})
+	_ = Compound(Cond{})
+)

cond.go

@@ -32,7 +32,7 @@ import (
 // Each entry of the map represents a condition (a column-value relation bound
 // by a comparison operator). The comparison operator is optional and can be
 // specified after the column name, if no comparison operator is provided the
-// equality is used.
+// equality operator is used as default.
 //
 // Examples:
 //

url.go renamed to connection_url.go

@@ -61,6 +61,7 @@ func NewConstraint(key interface{}, value interface{}) Constraint {
 	return constraint{k: key, v: value}
 }
 
-var _ Constraints = Cond{}
-
-var _ Constraint = &constraint{}
+var (
+	_ = Constraints(Cond{})
+	_ = Constraint(&constraint{})
+)

constraint.go

@@ -24,7 +24,7 @@ package db
 // Database is an interface that defines methods that must be satisfied by
 // all database adapters.
 type Database interface {
-	// Driver returns the underlying driver the wrapper uses.
+	// Driver returns the underlying driver the wrapper uses as an interface{}.
 	//
 	// In order to actually use the driver, the `interface{}` value needs to be
 	// casted into the appropriate type.

database.go

@@ -19,13 +19,10 @@
 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-// Package db (or upper-db) provides a common interface to work with different
-// data sources using adapters that wrap mature database drivers.
+// Package db (or upper-db) provides a common interface to work with a variety
+// of data sources using adapters that wrap mature database drivers.
 //
-// The main purpose of upper-db is to abstract common database operations and
-// encourage users perform advanced operations directly using the underlying
-// driver. upper-db supports the MySQL, PostgreSQL, SQLite and QL databases and
-// provides partial support (CRUD, no transactions) for MongoDB.
+// Install upper-db:
 //
 //  go get upper.io/db.v3
 //