Use an interface for sql.DB to make easier tests

Signed-off-by: David Pordomingo <[email protected]>

Author: dpordomingo

server/handler/query.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	"github.com/src-d/gitbase-playground/server/serializer"
+	"github.com/src-d/gitbase-playground/server/service"
 	"gopkg.in/bblfsh/sdk.v1/uast"
 
 	"github.com/go-sql-driver/mysql"
@@ -46,7 +47,7 @@ func genericVals(colTypes []string) []interface{} {
 
 // Query returns a function that forwards an SQL query to gitbase and returns
 // the rows as JSON
-func Query(db *sql.DB) RequestProcessFunc {
+func Query(db service.SQLDB) RequestProcessFunc {
 	return func(r *http.Request) (*serializer.Response, error) {
 		var queryRequest queryRequest
 		body, err := ioutil.ReadAll(r.Body)

server/handler/query_test.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/src-d/gitbase-playground/server/handler"
 	"github.com/src-d/gitbase-playground/server/serializer"
+	"github.com/src-d/gitbase-playground/server/service"
 
 	"github.com/kelseyhightower/envconfig"
 	"github.com/pressly/lg"
@@ -28,11 +29,11 @@ type appConfig struct {
 
 type QuerySuite struct {
 	suite.Suite
-	db      *sql.DB
+	db      service.SQLDB
 	handler http.Handler
 }
 
-func setupDB(require *require.Assertions) *sql.DB {
+func setupDB(require *require.Assertions) service.SQLDB {
 	var conf appConfig
 	envconfig.MustProcess("GITBASEPG", &conf)
 

server/handler/tables.go

@@ -1,15 +1,15 @@
 package handler
 
 import (
-	"database/sql"
 	"net/http"
 	"strings"
 
 	"github.com/src-d/gitbase-playground/server/serializer"
+	"github.com/src-d/gitbase-playground/server/service"
 )
 
 // Tables returns a function that calls /query with the SQL "SHOW TABLES"
-func Tables(db *sql.DB) RequestProcessFunc {
+func Tables(db service.SQLDB) RequestProcessFunc {
 	return func(r *http.Request) (*serializer.Response, error) {
 		req, _ := http.NewRequest("POST", "/query",
 			strings.NewReader(`{ "query": "SHOW TABLES" }`))

server/handler/tables_test.go

@@ -1,13 +1,13 @@
 package handler_test
 
 import (
-	"database/sql"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
 	"github.com/sirupsen/logrus"
 	"github.com/src-d/gitbase-playground/server/handler"
+	"github.com/src-d/gitbase-playground/server/service"
 
 	"github.com/pressly/lg"
 	"github.com/stretchr/testify/suite"
@@ -18,7 +18,7 @@ import (
 
 type TablesSuite struct {
 	suite.Suite
-	db      *sql.DB
+	db      service.SQLDB
 	handler http.Handler
 }
 

server/router.go

@@ -1,10 +1,10 @@
 package server
 
 import (
-	"database/sql"
 	"net/http"
 
 	"github.com/src-d/gitbase-playground/server/handler"
+	"github.com/src-d/gitbase-playground/server/service"
 
 	"github.com/go-chi/chi"
 	"github.com/go-chi/chi/middleware"
@@ -18,7 +18,7 @@ func Router(
 	logger *logrus.Logger,
 	static *handler.Static,
 	version string,
-	db *sql.DB,
+	db service.SQLDB,
 ) http.Handler {
 
 	// cors options

server/service/common.go

@@ -0,0 +1,9 @@
+package service
+
+import "database/sql"
+
+// SQLDB describes a *sql.DB
+type SQLDB interface {
+	Close() error
+	Query(query string, args ...interface{}) (*sql.Rows, error)
+}