opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: add postgres template caching for tests (#15336)

Browse Source 
This PR is the first in a series aimed at closing
[#15109](https://github.com/coder/coder/issues/15109).

### Changes

- **Template Database Creation:**  
`dbtestutil.Open` now has the ability to create a template database if
none is provided via `DB_FROM`. The template database’s name is derived
from a hash of the migration files, ensuring that it can be reused
across tests and is automatically updated whenever migrations change.

- **Optimized Database Handling:**  
Previously, `dbtestutil.Open` would spin up a new container for each
test when `DB_FROM` was unset. Now, it first checks for an active
PostgreSQL instance on `localhost:5432`. If none is found, it creates a
single container that remains available for subsequent tests,
eliminating repeated container startups.

These changes address the long individual test times (10+ seconds)
reported by some users, likely due to the time Docker took to start and
complete migrations.
This commit is contained in:
Hugo Dutka
2024-11-04 17:23:31 +01:00
committed by GitHub
parent 1c29944862
commit 1bfa7d42e8
15 changed files with 641 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/database/pubsub/pubsub_linux_test.go
+7 -12
View File
@@ -40,9 +40,8 @@ func TestPubsub(t *testing.T) {
defer cancelFunc()
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
connectionURL, closePg, err := dbtestutil.Open()
connectionURL, err := dbtestutil.Open(t)
require.NoError(t, err)
defer closePg()
db, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
defer db.Close()
@@ -69,9 +68,8 @@ func TestPubsub(t *testing.T) {
ctx, cancelFunc := context.WithCancel(context.Background())
defer cancelFunc()
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
connectionURL, closePg, err := dbtestutil.Open()
connectionURL, err := dbtestutil.Open(t)
require.NoError(t, err)
defer closePg()
db, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
defer db.Close()
@@ -85,9 +83,8 @@ func TestPubsub(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
connectionURL, closePg, err := dbtestutil.Open()
connectionURL, err := dbtestutil.Open(t)
require.NoError(t, err)
defer closePg()
db, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
defer db.Close()
@@ -122,9 +119,8 @@ func TestPubsub_ordering(t *testing.T) {
defer cancelFunc()
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
connectionURL, closePg, err := dbtestutil.Open()
connectionURL, err := dbtestutil.Open(t)
require.NoError(t, err)
defer closePg()
db, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
defer db.Close()
@@ -167,7 +163,7 @@ const disconnectTestPort = 26892
func TestPubsub_Disconnect(t *testing.T) {
// we always use a Docker container for this test, even in CI, since we need to be able to kill
// postgres and bring it back on the same port.
connectionURL, closePg, err := dbtestutil.OpenContainerized(disconnectTestPort)
connectionURL, closePg, err := dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{Port: disconnectTestPort})
require.NoError(t, err)
defer closePg()
db, err := sql.Open("postgres", connectionURL)
@@ -238,7 +234,7 @@ func TestPubsub_Disconnect(t *testing.T) {
// restart postgres on the same port --- since we only use LISTEN/NOTIFY it doesn't
// matter that the new postgres doesn't have any persisted state from before.
_, closeNewPg, err := dbtestutil.OpenContainerized(disconnectTestPort)
_, closeNewPg, err := dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{Port: disconnectTestPort})
require.NoError(t, err)
defer closeNewPg()
@@ -305,7 +301,7 @@ func TestMeasureLatency(t *testing.T) {
newPubsub := func() (pubsub.Pubsub, func()) {
ctx, cancel := context.WithCancel(context.Background())
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
connectionURL, closePg, err := dbtestutil.Open()
connectionURL, err := dbtestutil.Open(t)
require.NoError(t, err)
db, err := sql.Open("postgres", connectionURL)
require.NoError(t, err)
@@ -315,7 +311,6 @@ func TestMeasureLatency(t *testing.T) {
return ps, func() {
_ = ps.Close()
_ = db.Close()
closePg()
cancel()
}
}