package db import ( "database/sql" "errors" "fmt" "os" "strings" "sync" "github.com/golang-migrate/migrate/v4" "github.com/hashicorp/boundary/internal/db/migrations" "github.com/hashicorp/go-hclog" "github.com/hashicorp/go-multierror" "github.com/jinzhu/gorm" "github.com/lib/pq" "github.com/ory/dockertest/v3" ) type DbType int const ( UnknownDB DbType = 0 Postgres DbType = 1 ) func (db DbType) String() string { return [...]string{ "unknown", "postgres", }[db] } // Open a database connection which is long-lived. // You need to call Close() on the returned gorm.DB func Open(dbType DbType, connectionUrl string) (*gorm.DB, error) { db, err := gorm.Open(dbType.String(), connectionUrl) if err != nil { return nil, fmt.Errorf("unable to open database: %w", err) } return db, nil } // Migrate a database schema func Migrate(connectionUrl string, migrationsDirectory string) error { if connectionUrl == "" { return errors.New("connection url is unset") } if _, err := os.Stat(migrationsDirectory); os.IsNotExist(err) { return errors.New("error migrations directory does not exist") } // run migrations m, err := migrate.New(fmt.Sprintf("file://%s", migrationsDirectory), connectionUrl) if err != nil { return fmt.Errorf("unable to create migrations: %w", err) } if err := m.Up(); err != nil && err != migrate.ErrNoChange { return fmt.Errorf("unable to run migrations: %w", err) } return nil } // InitDbInDocker initializes the data store within docker or an existing func InitDbInDocker(dialect string) (cleanup func() error, retURL, container string, err error) { c, url, container, err := StartDbInDocker(dialect) if err != nil { return func() error { return nil }, "", "", fmt.Errorf("could not start docker: %w", err) } if _, err := InitStore(dialect, c, url); err != nil { return func() error { return nil }, "", "", fmt.Errorf("error initializing store: %w", err) } return c, url, container, nil } var ( mx = sync.Mutex{} ) // StartDbInDocker func StartDbInDocker(dialect string) (cleanup func() error, retURL, container string, err error) { // TODO: Debug what part of this method is actually causing race condition issues with our test and fix. mx.Lock() defer mx.Unlock() pool, err := dockertest.NewPool("") if err != nil { return func() error { return nil }, "", "", fmt.Errorf("could not connect to docker: %w", err) } var resource *dockertest.Resource var url string switch dialect { case "postgres": resource, err = pool.Run("postgres", "12", []string{"POSTGRES_PASSWORD=password", "POSTGRES_DB=boundary"}) url = "postgres://postgres:password@localhost:%s?sslmode=disable" default: panic(fmt.Sprintf("unknown dialect %q", dialect)) } if err != nil { return func() error { return nil }, "", "", fmt.Errorf("could not start resource: %w", err) } cleanup = func() error { return cleanupDockerResource(pool, resource) } url = fmt.Sprintf(url, resource.GetPort("5432/tcp")) if err := pool.Retry(func() error { db, err := sql.Open(dialect, url) if err != nil { return fmt.Errorf("error opening %s dev container: %w", dialect, err) } if err := db.Ping(); err != nil { return err } defer db.Close() return nil }); err != nil { return func() error { return nil }, "", "", fmt.Errorf("could not connect to docker: %w", err) } return cleanup, url, resource.Container.Name, nil } // InitStore will execute the migrations needed to initialize the store. It // returns true if migrations actually ran; false if we were already current. func InitStore(dialect string, cleanup func() error, url string) (bool, error) { var mErr *multierror.Error // run migrations source, err := migrations.NewMigrationSource(dialect) if err != nil { mErr = multierror.Append(mErr, fmt.Errorf("error creating migration driver: %w", err)) if cleanup != nil { if err := cleanup(); err != nil { mErr = multierror.Append(mErr, fmt.Errorf("error cleaning up from creating driver: %w", err)) } } return false, mErr.ErrorOrNil() } m, err := migrate.NewWithSourceInstance("httpfs", source, url) if err != nil { mErr = multierror.Append(mErr, fmt.Errorf("error creating migrations: %w", err)) if cleanup != nil { if err := cleanup(); err != nil { mErr = multierror.Append(mErr, fmt.Errorf("error cleaning up from creating migrations: %w", err)) } } return false, mErr.ErrorOrNil() } if err := m.Up(); err != nil { if err == migrate.ErrNoChange { return false, nil } mErr = multierror.Append(mErr, fmt.Errorf("error running migrations: %w", err)) if cleanup != nil { if err := cleanup(); err != nil { mErr = multierror.Append(mErr, fmt.Errorf("error cleaning up from running migrations: %w", err)) } } return false, mErr.ErrorOrNil() } return true, mErr.ErrorOrNil() } // cleanupDockerResource will clean up the dockertest resources (postgres) func cleanupDockerResource(pool *dockertest.Pool, resource *dockertest.Resource) error { var err error for i := 0; i < 10; i++ { err = pool.Purge(resource) if err == nil { return nil } } if strings.Contains(err.Error(), "No such container") { return nil } return fmt.Errorf("Failed to cleanup local container: %s", err) } func GetGormLogFormatter(log hclog.Logger) func(values ...interface{}) (messages []interface{}) { return func(values ...interface{}) (messages []interface{}) { if len(values) > 2 && values[0].(string) == "log" { switch values[2].(type) { case *pq.Error: log.Trace("error from database adapter", "location", values[1], "error", values[2]) } return nil } return nil } } type gormLogger struct { logger hclog.Logger } func (g gormLogger) Print(values ...interface{}) { formatted := gorm.LogFormatter(values...) if formatted == nil { return } // Our formatter should elide anything we don't want so this should never // happen, panic if so so we catch/fix panic("unhandled error case") } func GetGormLogger(log hclog.Logger) gormLogger { return gormLogger{logger: log} }