README

DbCleaner

Build Status GoDoc Go Report Card

Clean database for testing, inspired by database_cleaner for Ruby. It uses flock syscall under the hood to make sure the test can runs in parallel without racing issues.

Basic usage

  • To get the package, execute:
go get gopkg.in/khaiql/dbcleaner.v2
  • To import this package, add the following line to your code:
import "gopkg.in/khaiql/dbcleaner.v2"
  • To install TestSuite:
go get github.com/stretchr/testify
  • For people who is using old version (v1.0), please change your import to
import "gopkg.in/khaiql/dbcleaner.v1"

Options

During running test suites, there might be deadlock when 2 suites try to acquire the same table. Dbcleaner tries to mitigate the issue by providing options for retry and panic when the deadlock couldn't be resolved after excessive retries.

type Options struct {
	Logger        logging.Logger
	LockTimeout   time.Duration
	NumberOfRetry int
	RetryInterval time.Duration
}

type Option func(opt *Options)

// SetLogger to an instance of logging.Logger, default to Noop
func SetLogger(logger logging.Logger) Option {
	return func(opt *Options) {
		opt.Logger = logger
	}
}

// SetLockTimeout sets timeout for locking operation, default to 10 seconds
func SetLockTimeout(d time.Duration) Option {
	return func(opt *Options) {
		opt.LockTimeout = d
	}
}

// SetNumberOfRetry sets max retries for acquire the table, default to 5 times
func SetNumberOfRetry(t int) Option {
	return func(opt *Options) {
		opt.NumberOfRetry = t
	}
}

// SetRetryInterval sets sleep duration between each retry, default to 10 seconds
func SetRetryInterval(d time.Duration) Option {
	return func(opt *Options) {
		opt.RetryInterval = d
	}
}

// SetLockFileDir sets directory for lock files
func SetLockFileDir(dir string) Option {
	return func(opt *Options) {
		opt.LockFileDir = dir
	}
}

cleaner := dbcleaner.New(SetNumberOfRetry(10), SetLockTimeout(5*time.Second))

Using with testify's suite

import (
	"testing"

  	"gopkg.in/khaiql/dbcleaner.v2"
  	"gopkg.in/khaiql/dbcleaner.v2/engine"
	"github.com/stretchr/testify/suite"
)

var Cleaner = dbcleaner.New()

type ExampleSuite struct {
	suite.Suite
}

func (suite *ExampleSuite) SetupSuite() {
  	// Init and set mysql cleanup engine
  	mysql := engine.NewMySQLEngine("YOUR_DB_DSN")
  	Cleaner.SetEngine(mysql)
}

func (suite *ExampleSuite) SetupTest() {
  	Cleaner.Acquire("users")
}

func (suite *ExampleSuite) TearDownTest() {
  	Cleaner.Clean("users")
}

func (suite *ExampleSuite) TestSomething() {
  	// Have some meaningful test
  	suite.Equal(true, true)
}

func TestRunSuite(t *testing.T) {
  	suite.Run(t, new(ExampleSuite))
}

Support drivers

  • postgres
  • mysql
  • sqlite3

Write cleaner for other drivers

Basically all drivers supported by database/sql package are also supported by dbcleaner. Check list of drivers: https://github.com/golang/go/wiki/SQLDrivers

For custom driver, implement your own engine.Engine interface and call SetEngine on dbcleaner.Cleaner instance.

License

MIT

Expand ▾ Collapse ▴

Documentation

Overview

    Package dbcleaner helps cleaning up database's tables upon unit test. With the help of https://github.com/stretchr/testify/tree/master/suite, we can easily acquire the tables using in the test in SetupTest or SetupSuite, and cleanup all data using TearDownTest or TearDownSuite

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	// ErrTableNeverLockBefore is paniced if calling Release on table that havent' been acquired before
    	ErrTableNeverLockBefore = errors.New("table has never been locked before")
    )

    Functions

    This section is empty.

    Types

    type DbCleaner

    type DbCleaner interface {
    	// SetEngine sets dbEngine, can be mysql, postgres...
    	SetEngine(dbEngine engine.Engine)
    
    	// Acquire will lock tables passed in params so data in the table would not be deleted by other test cases
    	Acquire(tables ...string)
    
    	// Clean calls Truncate the tables
    	Clean(tables ...string)
    
    	// Close calls corresponding method on dbEngine to release connection to db
    	Close() error
    }

      DbCleaner interface

      func New

      func New(opts ...Option) DbCleaner

        New returns a default Cleaner with Noop Engine. Call SetEngine to set an actual working engine

        type Option

        type Option func(opt *Options)

        func SetLockFileDir

        func SetLockFileDir(dir string) Option

          SetLockFileDir sets directory for lock files

          func SetLockTimeout

          func SetLockTimeout(d time.Duration) Option

            SetLockTimeout sets timeout for locking operation, default to 10 seconds

            func SetLogger

            func SetLogger(logger logging.Logger) Option

              SetLogger to an instance of logging.Logger, default to Noop

              func SetNumberOfRetry

              func SetNumberOfRetry(t int) Option

                SetNumberOfRetry sets max retries for acquire the table, default to 5 times

                func SetRetryInterval

                func SetRetryInterval(d time.Duration) Option

                  SetRetryInterval sets sleep duration between each retry, default to 10 seconds

                  type Options

                  type Options struct {
                  	Logger        logging.Logger
                  	LockTimeout   time.Duration
                  	NumberOfRetry int
                  	RetryInterval time.Duration
                  	LockFileDir   string
                  }

                    Options defines properties that dbEngine would use during trying to acquire and clean tables, including Logger: default to Noop LockTimeout: max duration while trying to acquire lock for a table NumberOfRetry: max number of retry when failed to acquire the table RetryInterval: sleep between each retry until reach NumberOfRetry

                    Directories

                    Path Synopsis
                    Package engine defines interface of an Engine.
                    Package engine defines interface of an Engine.