mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
65db7a71b7
- Adds dbtestutil.WithTimezone(tz) to allow setting the timezone for a test database. - Modifies our test database setup code to pick a consistently weird timezone for the database. - Adds the facility randtz.Name() to pick a random timezone which is consistent across subtests (via sync.Once). - Adds a linter rule to warn against setting the test database timezone to UTC.
113 lines
2.9 KiB
Go
113 lines
2.9 KiB
Go
package dbtestutil
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"net/url"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbfake"
|
|
"github.com/coder/coder/v2/coderd/database/postgres"
|
|
"github.com/coder/coder/v2/coderd/database/pubsub"
|
|
)
|
|
|
|
// WillUsePostgres returns true if a call to NewDB() will return a real, postgres-backed Store and Pubsub.
|
|
func WillUsePostgres() bool {
|
|
return os.Getenv("DB") != ""
|
|
}
|
|
|
|
type options struct {
|
|
fixedTimezone string
|
|
}
|
|
|
|
type Option func(*options)
|
|
|
|
// WithTimezone sets the database to the defined timezone.
|
|
func WithTimezone(tz string) Option {
|
|
return func(o *options) {
|
|
o.fixedTimezone = tz
|
|
}
|
|
}
|
|
|
|
func NewDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub) {
|
|
t.Helper()
|
|
|
|
var o options
|
|
for _, opt := range opts {
|
|
opt(&o)
|
|
}
|
|
|
|
db := dbfake.New()
|
|
ps := pubsub.NewInMemory()
|
|
if WillUsePostgres() {
|
|
connectionURL := os.Getenv("CODER_PG_CONNECTION_URL")
|
|
if connectionURL == "" {
|
|
var (
|
|
err error
|
|
closePg func()
|
|
)
|
|
connectionURL, closePg, err = postgres.Open()
|
|
require.NoError(t, err)
|
|
t.Cleanup(closePg)
|
|
}
|
|
|
|
if o.fixedTimezone == "" {
|
|
// To make sure we find timezone-related issues, we set the timezone
|
|
// of the database to a non-UTC one.
|
|
// The below was picked due to the following properties:
|
|
// - It has a non-UTC offset
|
|
// - It has a fractional hour UTC offset
|
|
// - It includes a daylight savings time component
|
|
o.fixedTimezone = "Canada/Newfoundland"
|
|
}
|
|
dbName := dbNameFromConnectionURL(t, connectionURL)
|
|
setDBTimezone(t, connectionURL, dbName, o.fixedTimezone)
|
|
|
|
sqlDB, err := sql.Open("postgres", connectionURL)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_ = sqlDB.Close()
|
|
})
|
|
db = database.New(sqlDB)
|
|
|
|
ps, err = pubsub.New(context.Background(), sqlDB, connectionURL)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_ = ps.Close()
|
|
})
|
|
}
|
|
|
|
return db, ps
|
|
}
|
|
|
|
// setRandDBTimezone sets the timezone of the database to the given timezone.
|
|
// Note that the updated timezone only comes into effect on reconnect, so we
|
|
// create our own connection for this and close the DB after we're done.
|
|
func setDBTimezone(t testing.TB, dbURL, dbname, tz string) {
|
|
t.Helper()
|
|
|
|
sqlDB, err := sql.Open("postgres", dbURL)
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
_ = sqlDB.Close()
|
|
}()
|
|
|
|
// nolint: gosec // This unfortunately does not work with placeholders.
|
|
_, err = sqlDB.Exec(fmt.Sprintf("ALTER DATABASE %s SET TIMEZONE TO %q", dbname, tz))
|
|
require.NoError(t, err, "failed to set timezone for database")
|
|
}
|
|
|
|
// dbNameFromConnectionURL returns the database name from the given connection URL,
|
|
// where connectionURL is of the form postgres://user:pass@host:port/dbname
|
|
func dbNameFromConnectionURL(t testing.TB, connectionURL string) string {
|
|
u, err := url.Parse(connectionURL)
|
|
require.NoError(t, err)
|
|
return strings.TrimPrefix(u.Path, "/")
|
|
}
|