feat: add test database setup and teardown for end-to-end tests, ensuring unique and non-ephemeral ports
This commit is contained in:
1 parent
184769d60f
commit
1dc87a06c8
18 files changed
+184
-37
No files matched your search
@@ -412,10 +412,17 @@ describeDb("auth API against a real database", () => {
|
||||
expect(created.status).toBe(201);
|
||||
|
||||
// Delivery depends on these existing: a mailbox with no Junk folder used
|
||||
// to fail the spam path outright.
|
||||
const folders = await query<{ special_use: string }>(
|
||||
`SELECT special_use FROM folders WHERE mailbox_id = $1`, [created.body.id]);
|
||||
expect(folders.map((f) => f.special_use).sort()).toEqual(
|
||||
// to fail the spam path outright, and one with no Reports folder files
|
||||
// every delivered DMARC and TLS-RPT report into the inbox instead.
|
||||
//
|
||||
// Asserted on the name rather than the special-use role: IMAP defines no
|
||||
// role for Reports, so its role is NULL and a list of roles cannot say
|
||||
// whether the folder is there.
|
||||
const folders = await query<{ name: string; special_use: string | null }>(
|
||||
`SELECT name, special_use FROM folders WHERE mailbox_id = $1`, [created.body.id]);
|
||||
expect(folders.map((f) => f.name).sort()).toEqual(
|
||||
["Archive", "Drafts", "INBOX", "Junk", "Reports", "Sent", "Trash"]);
|
||||
expect(folders.map((f) => f.special_use).filter(Boolean).sort()).toEqual(
|
||||
["archive", "drafts", "inbox", "junk", "sent", "trash"]);
|
||||
|
||||
const audit = await get("/api/v1/admin/audit", admin);
|
||||
|
||||
@@ -30,7 +30,7 @@ func TestAntispamAntivirusEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54338).
|
||||
Port(15438).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -38,7 +38,7 @@ func TestAntispamAntivirusEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54338/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15438/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -30,7 +30,7 @@ func TestDkimRotationLeavesAUsableKey(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54349).
|
||||
Port(15449).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -38,7 +38,7 @@ func TestDkimRotationLeavesAUsableKey(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:54349/postgres?sslmode=disable")
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:15449/postgres?sslmode=disable")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -21,7 +21,7 @@ func TestDnsSyncAndSystemAliasesEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54336).
|
||||
Port(15436).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -29,7 +29,7 @@ func TestDnsSyncAndSystemAliasesEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54336/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15436/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -31,7 +31,7 @@ func TestEventStreamPushesDeliveredMail(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54348).
|
||||
Port(15448).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -39,7 +39,7 @@ func TestEventStreamPushesDeliveredMail(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:54348/postgres?sslmode=disable")
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:15448/postgres?sslmode=disable")
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
}
|
||||
|
||||
@@ -35,7 +35,7 @@ func TestF2CompleteSuiteEndToEnd(t *testing.T) {
|
||||
// 1. Embedded Postgres Setup
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54335).
|
||||
Port(15435).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -43,7 +43,7 @@ func TestF2CompleteSuiteEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54335/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15435/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -80,7 +80,7 @@ func TestPhase3CompleteEndToEnd(t *testing.T) {
|
||||
// Initialize embedded PostgreSQL
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54340).
|
||||
Port(15440).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -88,7 +88,7 @@ func TestPhase3CompleteEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54340/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15440/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -25,7 +25,7 @@ func TestHttpServicesEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54337).
|
||||
Port(15437).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -33,7 +33,7 @@ func TestHttpServicesEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54337/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15437/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -30,7 +30,7 @@ func TestImapCoreEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54330). // distinct from the SMTP E2E test's 54329, so both can run concurrently
|
||||
Port(15430). // distinct from the SMTP E2E test's 15429, so both can run concurrently
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -38,7 +38,7 @@ func TestImapCoreEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54330/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15430/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect: %v", err)
|
||||
|
||||
@@ -30,7 +30,7 @@ func TestImapIdleAndCondStoreEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54331). // distinct port for concurrent e2e test execution
|
||||
Port(15431). // distinct port for concurrent e2e test execution
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -38,7 +38,7 @@ func TestImapIdleAndCondStoreEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54331/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15431/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect: %v", err)
|
||||
|
||||
@@ -28,7 +28,7 @@ func TestManageSieveEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54333). // distinct port for ManageSieve e2e test execution
|
||||
Port(15433). // distinct port for ManageSieve e2e test execution
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -36,7 +36,7 @@ func TestManageSieveEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54333/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15433/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect: %v", err)
|
||||
|
||||
@@ -33,7 +33,7 @@ func TestOutboundQueueEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54339).
|
||||
Port(15439).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -41,7 +41,7 @@ func TestOutboundQueueEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54339/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15439/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -29,7 +29,7 @@ func TestPop3EndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54332). // distinct port for POP3 e2e test execution
|
||||
Port(15432). // distinct port for POP3 e2e test execution
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -37,7 +37,7 @@ func TestPop3EndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54332/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15432/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect: %v", err)
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
package e2e
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Every embedded Postgres in this package binds a fixed port, and those ports
|
||||
// must sit below the kernel's ephemeral range.
|
||||
//
|
||||
// They did not. All sixteen were inside 32768-60999, which is the range Linux
|
||||
// draws source ports from for outgoing connections. Nothing in this repository
|
||||
// was listening on them - the kernel simply handed one out to some unrelated
|
||||
// connection at the moment a test tried to bind it, and that test died with
|
||||
// "process already listening on port 54340". It is a race, so it failed rarely
|
||||
// and never in the same place twice, which is exactly what makes it expensive.
|
||||
//
|
||||
// This test reads the ports out of the source rather than from a list someone
|
||||
// has to remember to update: the next person adding an e2e test gets told here
|
||||
// instead of by a red build a week later.
|
||||
|
||||
// ephemeralFloor is the lowest port Linux will hand out as a source port
|
||||
// (net.ipv4.ip_local_port_range). Staying below it means the kernel will never
|
||||
// allocate one of these behind our back.
|
||||
const ephemeralFloor = 32768
|
||||
|
||||
var portPattern = regexp.MustCompile(`Port\((\d+)\)`)
|
||||
|
||||
func TestEmbeddedPostgresPortsAreOutsideTheEphemeralRange(t *testing.T) {
|
||||
entries, err := filepath.Glob("*_test.go")
|
||||
if err != nil {
|
||||
t.Fatalf("glob: %v", err)
|
||||
}
|
||||
|
||||
found := 0
|
||||
for _, name := range entries {
|
||||
source, err := os.ReadFile(name)
|
||||
if err != nil {
|
||||
t.Fatalf("read %s: %v", name, err)
|
||||
}
|
||||
for _, match := range portPattern.FindAllStringSubmatch(string(source), -1) {
|
||||
port, err := strconv.Atoi(match[1])
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
found++
|
||||
if port >= ephemeralFloor {
|
||||
t.Errorf("%s binds port %d, which is inside the kernel's ephemeral "+
|
||||
"range (>= %d): the kernel can hand it to an unrelated connection "+
|
||||
"and this test will fail intermittently with "+
|
||||
"\"process already listening\". Pick a port below %d.",
|
||||
name, port, ephemeralFloor, ephemeralFloor)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if found == 0 {
|
||||
t.Fatal("no embedded Postgres ports found; this test is no longer checking anything")
|
||||
}
|
||||
}
|
||||
|
||||
// Two tests sharing a port would collide every time rather than intermittently.
|
||||
func TestEmbeddedPostgresPortsAreUnique(t *testing.T) {
|
||||
entries, _ := filepath.Glob("*_test.go")
|
||||
|
||||
seen := map[int]string{}
|
||||
for _, name := range entries {
|
||||
source, err := os.ReadFile(name)
|
||||
if err != nil {
|
||||
t.Fatalf("read %s: %v", name, err)
|
||||
}
|
||||
for _, match := range portPattern.FindAllStringSubmatch(string(source), -1) {
|
||||
port, _ := strconv.Atoi(match[1])
|
||||
if previous, taken := seen[port]; taken {
|
||||
t.Errorf("port %d is bound by both %s and %s", port, previous, name)
|
||||
}
|
||||
seen[port] = name
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The port in the connection string has to be the one the server was started
|
||||
// on, or the test connects to whatever else happens to be there.
|
||||
func TestEachTestConnectsToThePortItStarted(t *testing.T) {
|
||||
entries, _ := filepath.Glob("*_test.go")
|
||||
|
||||
for _, name := range entries {
|
||||
source, err := os.ReadFile(name)
|
||||
if err != nil {
|
||||
t.Fatalf("read %s: %v", name, err)
|
||||
}
|
||||
text := string(source)
|
||||
matches := portPattern.FindAllStringSubmatch(text, -1)
|
||||
if len(matches) != 1 {
|
||||
continue
|
||||
}
|
||||
port := matches[0][1]
|
||||
if strings.Contains(text, "postgres://") && !strings.Contains(text, "localhost:"+port) {
|
||||
t.Errorf("%s starts Postgres on port %s but its connection string points "+
|
||||
"somewhere else", name, port)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -43,7 +43,7 @@ func TestInboundSMTPEndToEnd(t *testing.T) {
|
||||
// --- 1. Real Postgres via embedded binaries ---------------------------
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54329).
|
||||
Port(15429).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -51,7 +51,7 @@ func TestInboundSMTPEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54329/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15429/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect: %v", err)
|
||||
|
||||
@@ -37,7 +37,7 @@ func TestSubmissionEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54344).
|
||||
Port(15444).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -45,7 +45,7 @@ func TestSubmissionEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
dbURL := "postgres://postgres:postgres@localhost:54344/postgres?sslmode=disable"
|
||||
dbURL := "postgres://postgres:postgres@localhost:15444/postgres?sslmode=disable"
|
||||
pool, err := postgres.NewPool(ctx, dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
|
||||
@@ -58,7 +58,7 @@ func TestWebmailApiEndToEnd(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54346).
|
||||
Port(15446).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -66,7 +66,7 @@ func TestWebmailApiEndToEnd(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:54346/postgres?sslmode=disable")
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:15446/postgres?sslmode=disable")
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
}
|
||||
@@ -258,7 +258,7 @@ func TestWebmailApiRejectsCrossMailboxAccess(t *testing.T) {
|
||||
|
||||
runtimeDir := t.TempDir()
|
||||
pg := embeddedpostgres.NewDatabase(embeddedpostgres.DefaultConfig().
|
||||
Port(54347).
|
||||
Port(15447).
|
||||
RuntimePath(runtimeDir).
|
||||
StartTimeout(120 * time.Second))
|
||||
if err := pg.Start(); err != nil {
|
||||
@@ -266,7 +266,7 @@ func TestWebmailApiRejectsCrossMailboxAccess(t *testing.T) {
|
||||
}
|
||||
defer pg.Stop()
|
||||
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:54347/postgres?sslmode=disable")
|
||||
pool, err := postgres.NewPool(ctx, "postgres://postgres:postgres@localhost:15447/postgres?sslmode=disable")
|
||||
if err != nil {
|
||||
t.Fatalf("connect pool: %v", err)
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user