Skip to content

feat(coderd/database/dbtestutil): set default database timezone to non-UTC in unit tests #9672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Sep 15, 2023
Merged

feat(coderd/database/dbtestutil): set default database timezone to non-UTC in unit tests #9672

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
355b16b
feat(coderd/database/dbtestutil): set a random timezone in the db
johnstcn Sep 13, 2023
986db8b
remove check for tz after set
johnstcn Sep 14, 2023
fc3ba52
clitest: fix timestamp regex to match non-UTC timezones
johnstcn Sep 14, 2023
b3c559a
set fixed timezone in some existing unit tests
johnstcn Sep 14, 2023
f57dc9d
fixup! set fixed timezone in some existing unit tests
johnstcn Sep 14, 2023
d3d1274
fix timezone bug in ActivityBumpWorkspace query
johnstcn Sep 14, 2023
9f1f5c6
refactor to separate package, allow specifying tz
johnstcn Sep 14, 2023
7c2ff2f
set db timezone to canada/newfoundland by default
johnstcn Sep 14, 2023
eecfcdb
test activity bump in multiple timezones
johnstcn Sep 14, 2023
d327131
remove unnecessary IN TIME ZONE UTC in activitybump query
johnstcn Sep 14, 2023
7680984
clarify use of multiple timezones in test
johnstcn Sep 14, 2023
d051bbb
remove deprecation and add linter rule
johnstcn Sep 14, 2023
da059dc
fix typo
johnstcn Sep 14, 2023
0d425ba
bump allowed withinDuration for TestWorkpaceActivityBump
johnstcn Sep 14, 2023
d97ff2f
make Test_ActivityBumpWorkspace more flake-resistant
johnstcn Sep 14, 2023
f18c6b5
replace conditional sleep with a slower unconditional sleep that shou…
johnstcn Sep 14, 2023
5a8aa8b
modify logic slightly in TestWorkspaceActivityBump from "deadline mus…
johnstcn Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor to separate package, allow specifying tz
  • Loading branch information
@johnstcn
johnstcn committed Sep 14, 2023
commit 9f1f5c65a21925e9529bb6f8e3b40e51d4644641
34 changes: 15 additions & 19 deletions coderd/database/dbtestutil/db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (

"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbfake"
"github.com/coder/coder/v2/coderd/database/dbtestutil/randtz"
"github.com/coder/coder/v2/coderd/database/postgres"
"github.com/coder/coder/v2/coderd/database/pubsub"
)
Expand All @@ -23,17 +24,18 @@ func WillUsePostgres() bool {
}

type options struct {
fixedTimezone bool
fixedTimezone string
}

type Option func(*options)

// WithFixedTimezone disables the random timezone setting for the database.
// WithTimezone sets the database to the defined timezone instead of
// to a random one.
//
// DEPRECATED: If you need to use this, you may have a timezone-related bug.
func WithFixedTimezone() Option {
// Deprecated: If you need to use this, you may have a timezone-related bug.
func WithTimezone(tz string) Option {
return func(o *options) {
o.fixedTimezone = true
o.fixedTimezone = tz
}
}

Expand All @@ -59,11 +61,13 @@ func NewDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub) {
t.Cleanup(closePg)
}

if !o.fixedTimezone {
// To make sure we find timezone-related issues, we set the timezone of the database to a random one.
dbName := dbNameFromConnectionURL(t, connectionURL)
setRandDBTimezone(t, connectionURL, dbName)
if o.fixedTimezone == "" {
// To make sure we find timezone-related issues, we set the timezone
// of the database to a random one.
o.fixedTimezone = randtz.Name(t)
}
dbName := dbNameFromConnectionURL(t, connectionURL)
setDBTimezone(t, connectionURL, dbName, o.fixedTimezone)

sqlDB, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
Expand All @@ -83,7 +87,7 @@ func NewDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub) {
}

// setRandDBTimezone sets the timezone of the database to the given timezone.
func setRandDBTimezone(t testing.TB, dbURL, dbname string) {
func setDBTimezone(t testing.TB, dbURL, dbname, tz string) {
t.Helper()

sqlDB, err := sql.Open("postgres", dbURL)
Expand All @@ -94,15 +98,7 @@ func setRandDBTimezone(t testing.TB, dbURL, dbname string) {
_ = sqlDB.Close()
}()

// Pick a random timezone. We can simply pick from pg_timezone_names.
var tz string
err = sqlDB.QueryRow("SELECT name FROM pg_timezone_names ORDER BY RANDOM() LIMIT 1").Scan(&tz)
require.NoError(t, err)

// Set the timezone for the database.
t.Logf("setting timezone of database %q to %q", dbname, tz)
// We apparently can't use placeholders here, sadly.
// nolint: gosec // This is not user input and this is only executed in tests
// nolint: gosec // This unfortunately does not work with placeholders.
_, err = sqlDB.Exec(fmt.Sprintf("ALTER DATABASE %s SET TIMEZONE TO %q", dbname, tz))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

self-review: I hate this but it appears necessary.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine in tests, IMO. It's an unfortunate limitation of some PostgreSQL queries.

require.NoError(t, err, "failed to set timezone for database")
}
Expand Down
Loading