Replace buit-in dbcleaner with fabric8-common's one (#789)

replace built-in db_cleaner with common's one also: - remove logrus and gorm as they already come with `fabric8-common` - remove unused ("stanza") dependencies in Gopkg.toml fixes #788 Signed-off-by: Xavier Coulon <[email protected]>
fabric8-services · Feb 21, 2019 · e8328fe · e8328fe
1 parent 90bcc79
commit e8328fe
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 162 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -49,10 +49,6 @@ required = [
   "github.com/gojuno/minimock/cmd/minimock"
 ]
 
-[[constraint]]
-  name = "github.com/ajg/form"
-  version = "1.5.0"
-
 [[constraint]]
   name = "github.com/dgrijalva/jwt-go"
   version = "3.0.0"
@@ -61,10 +57,6 @@ required = [
   name = "github.com/goadesign/goa"
   version = "1.3.0"
 
-[[constraint]]
-  name = "github.com/jinzhu/gorm"
-  version = "1.9.1"
-
 [[constraint]]
   name = "github.com/lib/pq"
   version = "1.0.0"
@@ -77,10 +69,6 @@ required = [
   name = "github.com/satori/go.uuid"
   version = "1.2.0"
 
-[[constraint]]
-  name = "github.com/sirupsen/logrus"
-  version = "0.11.2"
-
 [[constraint]]
   name = "github.com/stretchr/testify"
   version = "1.2.1"
@@ -111,7 +99,7 @@ required = [
 
 [[constraint]]
   name = "github.com/fabric8-services/fabric8-common"
-  revision = "a85e65e22cfc18d7c2004317d340ad328ca8dcd1"
+  revision = "988ec38ba27dc10cc955f19cce227e7cd8d58528"
 
 [[constraint]]
   name = "github.com/jstemmer/go-junit-report"
@@ -125,10 +113,6 @@ required = [
   name = "github.com/getsentry/raven-go"
   revision = "563b81fc02b75d664e54da31f787c2cc2186780b"
 
-[[constraint]]
-name = "github.com/dnaeon/go-vcr"
-revision= "9d71b8a6df86e00127f96bc8dabc09856ab8afdb"
-
 [[constraint]]
   name = "github.com/gojuno/minimock"
   revision = "a5502dd2746ee6fc3fd58ad83d701d25e14d68d1"
@@ -137,10 +121,6 @@ revision= "9d71b8a6df86e00127f96bc8dabc09856ab8afdb"
   go-tests = true
   unused-packages = true
 
-[[constraint]]
-  name = "github.com/fsnotify/fsnotify"
-  version = "1.4.7"
-
 [[constraint]]
   name = "gopkg.in/h2non/gock.v1"
   version = "1.0.12"
diff --git a/application/application_db_calls_bench_test.go b/application/application_db_calls_bench_test.go
@@ -8,10 +8,10 @@ import (
 	"golang.org/x/net/context"
 
 	"github.com/fabric8-services/fabric8-auth/gormsupport"
-	"github.com/fabric8-services/fabric8-auth/gormsupport/cleaner"
 	gormbench "github.com/fabric8-services/fabric8-auth/gormtestsupport/benchmark"
 	"github.com/fabric8-services/fabric8-auth/migration"
 	testsupport "github.com/fabric8-services/fabric8-auth/test"
+	"github.com/fabric8-services/fabric8-common/test/suite"
 
 	account "github.com/fabric8-services/fabric8-auth/authentication/account/repository"
 	"github.com/jinzhu/gorm"
@@ -27,7 +27,7 @@ type Identity struct {
 
 type BenchDbOperations struct {
 	gormbench.DBBenchSuite
-	clean    func()
+	clean    func() error
 	repo     account.IdentityRepository
 	ctx      context.Context
 	dbPq     *sql.DB
@@ -55,7 +55,7 @@ func (s *BenchDbOperations) SetupSuite() {
 }
 
 func (s *BenchDbOperations) SetupBenchmark() {
-	s.clean = cleaner.DeleteCreatedEntities(s.DB)
+	s.clean = suite.DeleteCreatedEntities(s.DB, s.Configuration)
 	s.repo = account.NewIdentityRepository(s.DB)
 
 	s.identity = &account.Identity{

diff --git a/application/transaction/transaction_bench_test.go b/application/transaction/transaction_bench_test.go
@@ -12,10 +12,10 @@ import (
 	"github.com/fabric8-services/fabric8-auth/application/transaction"
 	account "github.com/fabric8-services/fabric8-auth/authentication/account/repository"
 	"github.com/fabric8-services/fabric8-auth/gormapplication"
-	"github.com/fabric8-services/fabric8-auth/gormsupport/cleaner"
 	gormbench "github.com/fabric8-services/fabric8-auth/gormtestsupport/benchmark"
 	"github.com/fabric8-services/fabric8-auth/migration"
 	testsupport "github.com/fabric8-services/fabric8-auth/test"
+	testsuite "github.com/fabric8-services/fabric8-common/test/suite"
 )
 
 type BenchTransactional struct {

diff --git a/configuration/configuration.go b/configuration/configuration.go
@@ -14,7 +14,7 @@ import (
 	"github.com/pkg/errors"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
-	"gopkg.in/yaml.v2"
+	yaml "gopkg.in/yaml.v2"
 )
 
 // String returns the current configuration as a string
@@ -40,22 +40,23 @@ const (
 	//
 	//------------------------------------------------------------------------------------------------------------------
 
-	varHTTPAddress                     = "http.address"
-	varMetricsHTTPAddress              = "metrics.http.address"
-	varDeveloperModeEnabled            = "developer.mode.enabled"
-	varCleanTestDataEnabled            = "clean.test.data"
-	varDBLogsEnabled                   = "enable.db.logs"
-	varNotApprovedRedirect             = "notapproved.redirect"
-	varHeaderMaxLength                 = "header.maxlength"
-	varUsersListLimit                  = "users.listlimit"
-	defaultConfigFile                  = "config.yaml"
-	varValidRedirectURLs               = "redirect.valid"
-	varLogLevel                        = "log.level"
-	varLogJSON                         = "log.json"
-	varEmailVerifiedRedirectURL        = "email.verify.url"
-	varInvitationAcceptedRedirectURL   = "invitation.accepted.url"
-	varInternalUsersEmailAddressSuffix = "internal.users.email.address.domain"
-	varIgnoreEmailInProd               = "ignore.email.prod"
+	varHTTPAddress                         = "http.address"
+	varMetricsHTTPAddress                  = "metrics.http.address"
+	varDeveloperModeEnabled                = "developer.mode.enabled"
+	varCleanTestDataEnabled                = "clean.test.data"
+	varCleanTestDataErrorReportingRequired = "error.reporting.required"
+	varDBLogsEnabled                       = "enable.db.logs"
+	varNotApprovedRedirect                 = "notapproved.redirect"
+	varHeaderMaxLength                     = "header.maxlength"
+	varUsersListLimit                      = "users.listlimit"
+	defaultConfigFile                      = "config.yaml"
+	varValidRedirectURLs                   = "redirect.valid"
+	varLogLevel                            = "log.level"
+	varLogJSON                             = "log.json"
+	varEmailVerifiedRedirectURL            = "email.verify.url"
+	varInvitationAcceptedRedirectURL       = "invitation.accepted.url"
+	varInternalUsersEmailAddressSuffix     = "internal.users.email.address.domain"
+	varIgnoreEmailInProd                   = "ignore.email.prod"
 
 	//------------------------------------------------------------------------------------------------------------------
 	//
@@ -570,6 +571,8 @@ func (c *ConfigurationData) setConfigDefaults() {
 
 	// By default, test data should be cleaned from DB, unless explicitely said otherwise.
 	c.v.SetDefault(varCleanTestDataEnabled, true)
+	// By default, error should be reported while cleaning test data from DB.
+	c.v.SetDefault(varCleanTestDataErrorReportingRequired, true)
 	// By default, DB logs are not output in the console
 	c.v.SetDefault(varDBLogsEnabled, false)
 
@@ -744,6 +747,11 @@ func (c *ConfigurationData) IsCleanTestDataEnabled() bool {
 	return c.v.GetBool(varCleanTestDataEnabled)
 }
 
+// IsCleanTestDataErrorReportingRequired returns `true` if there is any error while cleaning test data after each test. (default: true)
+func (c *ConfigurationData) IsCleanTestDataErrorReportingRequired() bool {
+	return c.v.GetBool(varCleanTestDataErrorReportingRequired)
+}
+
 // IsDBLogsEnabled returns `true` if the DB logs (ie, SQL queries) should be output in the console. (default: false)
 func (c *ConfigurationData) IsDBLogsEnabled() bool {
 	return c.v.GetBool(varDBLogsEnabled)

diff --git a/gormsupport/cleaner/db_clean.go b/gormsupport/cleaner/db_clean.go