Repository navigation
Expand file tree
/
Copy pathembedded_postgres.go
More file actions
759 lines (742 loc) · 22.3 KB
/
Copy pathembedded_postgres.go
File metadata and controls
759 lines (742 loc) · 22.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
// Package embeddedpostgres runs an isolated PostgreSQL server for tests.
// Production packages use only the Go standard library. PostgreSQL and the
// companion supervisor are native executables acquired separately.
package embeddedpostgres
import (
"bytes"
"context"
"crypto/rand"
"encoding/json"
"errors"
"fmt"
"io"
"maps"
"net"
"os"
"os/exec"
"path/filepath"
"runtime"
"sort"
"strconv"
"strings"
"sync"
"time"
"github.com/fergusstrange/embedded-postgres/v2/internal/filelock"
"github.com/fergusstrange/embedded-postgres/v2/internal/platform"
"github.com/fergusstrange/embedded-postgres/v2/internal/supervisor"
)
var (
ErrServerNotStarted = errors.New("server has not been started")
ErrServerAlreadyStarted = errors.New("server is already started")
ErrDataVersion = errors.New("persistent data belongs to a different PostgreSQL major version")
)
// EmbeddedPostgres serialises lifecycle transitions. Separate instances run in
// parallel and may share immutable binaries. Inspection methods serialise behind
// an in-flight Start or Close; StopContext bounds its caller's wait even then.
// Do not copy after first use.
type EmbeddedPostgres struct {
mu sync.Mutex
config Config
active *session
lastInfo InstanceInfo
lastErr error
lastLog string
}
type session struct {
supervisorPath string
instanceID string
info InstanceInfo
installation *Installation
lock *os.File
cmd *exec.Cmd
lease io.WriteCloser
exited chan struct{}
waitErr error
closed chan struct{}
cleanups []func(context.Context) error
logPath, passPath string
}
// NewDatabase constructs an instance without doing I/O. If supplied, the first
// config is used, preserving the v1 calling convention.
func NewDatabase(config ...Config) *EmbeddedPostgres {
c := DefaultConfig()
if len(config) > 0 {
c = config[0]
}
c.startParameters = maps.Clone(c.startParameters)
c.environment = append([]string(nil), c.environment...)
c = c.Hooks(c.hooks)
return &EmbeddedPostgres{config: c}
}
func (ep *EmbeddedPostgres) Start() error { return ep.StartContext(context.Background()) }
// StartContext starts a server whose lifetime is bound to ctx. Cancellation
// after readiness also closes the server, using an independent cleanup timeout.
func (ep *EmbeddedPostgres) StartContext(ctx context.Context) (err error) {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != nil {
return ErrServerAlreadyStarted
}
c := ep.config
if err = validateConfig(c); err != nil {
return err
}
if err = platform.ValidateIdentity(c.identity); err != nil {
return err
}
if c.identity != nil && c.socketDir != "" {
// Do not create a root-only ancestor around a chowned socket child.
if st, e := os.Stat(c.socketDir); e != nil || !st.IsDir() {
return fmt.Errorf("RunAs UnixSocket parent must be an existing directory: %s", c.socketDir)
}
}
start, cancel := context.WithTimeout(ctx, c.startTimeout)
defer cancel()
s := &session{closed: make(chan struct{}), instanceID: rand.Text()}
ep.active = s
ep.lastErr = nil
ep.lastLog = ""
defer func() {
if p := recover(); p != nil {
_ = ep.closeLocked(context.Background())
panic(p)
}
if err != nil {
err = errors.Join(err, ep.closeLocked(context.Background()))
ep.lastErr = err
}
}()
parent := c.storage.WorkDir
if parent == "" && c.identity != nil {
parent = "/tmp"
}
if parent != "" {
if err = os.MkdirAll(parent, 0755); err != nil {
return err
}
}
work, err := os.MkdirTemp(parent, "embedded-postgres-")
if err != nil {
return err
}
work, err = filepath.Abs(work)
if err != nil {
return err
}
s.info.WorkDir = work
s.logPath = filepath.Join(work, "postgres.log")
s.passPath = filepath.Join(work, "pgpass")
if err = platform.Own(work, c.identity); err != nil {
return err
}
if err = ownedFile(s.logPath, nil, c.identity); err != nil {
return err
}
provider := c.provider
if provider == nil {
if c.binariesPath != "" {
provider = LocalProvider(c.binariesPath)
} else {
provider = DownloadProvider{CacheDir: c.storage.CacheDir, BaseURL: c.repositoryURL}
}
}
s.installation, err = provider.Acquire(start, BinaryRequest{c.version, runtime.GOOS, runtime.GOARCH})
if err != nil {
return fmt.Errorf("acquire PostgreSQL: %w", err)
}
if s.installation == nil {
return errors.New("provider returned nil installation")
}
if err = validateInstallation(s.installation.Dir); err != nil {
return err
}
s.info.BinariesDir, err = filepath.Abs(s.installation.Dir)
if err != nil {
return err
}
if c.identity != nil {
copied := filepath.Join(work, "installation")
if err = copyInstallation(start, s.info.BinariesDir, copied); err != nil {
return err
}
s.info.BinariesDir = copied
}
helper, err := resolveSupervisor(start, c)
if err != nil {
return err
}
if c.identity != nil {
dest := filepath.Join(work, platform.Executable("supervisor"))
if err = copyFile(helper, dest, 0755); err != nil {
return err
}
helper = dest
}
s.supervisorPath = helper
version, err := ep.command(start, s, "postgres", "--version")
if err != nil {
return fmt.Errorf("PostgreSQL runtime unavailable (check native libraries and RunAs path access): %w", err)
}
major := strings.Split(string(c.version), ".")[0]
if !strings.Contains(string(version), " "+major+".") {
return fmt.Errorf("provider returned unexpected PostgreSQL version: %s", strings.TrimSpace(string(version)))
}
data := c.storage.DataDir
if data == "" {
data = filepath.Join(work, "data")
} else {
data, err = filepath.Abs(data)
if err != nil {
return err
}
}
s.info.DataDir = data
if err = os.MkdirAll(filepath.Dir(data), 0755); err != nil {
return err
}
s.lock, err = filelock.Acquire(start, data+".embedded-postgres.lock", true)
if err != nil {
return fmt.Errorf("lock data directory: %w", err)
}
fresh := false
if st, e := os.Lstat(data); os.IsNotExist(e) {
if err = os.Mkdir(data, 0700); err != nil {
return err
}
if err = platform.Own(data, c.identity); err != nil {
return err
}
fresh = true
} else if e != nil {
return e
} else if !st.IsDir() || st.Mode()&os.ModeSymlink != 0 {
return errors.New("data directory must be a real directory, not a symlink")
}
if !fresh {
entries, e := os.ReadDir(data)
if e != nil {
return e
}
fresh = len(entries) == 0
if !fresh {
v, e := os.ReadFile(filepath.Join(data, "PG_VERSION"))
if e != nil {
return fmt.Errorf("data directory is nonempty and not a PostgreSQL cluster: %w", e)
}
if strings.TrimSpace(string(v)) != major {
return fmt.Errorf("%w: found %s, requested %s", ErrDataVersion, strings.TrimSpace(string(v)), major)
}
}
}
if fresh {
pw := filepath.Join(work, "init-password")
if err = ownedFile(pw, []byte(c.password+"\n"), c.identity); err != nil {
return err
}
_, err = ep.command(start, s, "initdb", "-D", data, "-U", c.username, "--auth=scram-sha-256", "--pwfile="+pw, "--locale="+c.locale, "--encoding="+c.encoding)
removeErr := os.Remove(pw)
if err = errors.Join(err, removeErr); err != nil {
return fmt.Errorf("initialise PostgreSQL: %w", err)
}
}
if c.socketDir != "" {
if runtime.GOOS == "windows" {
return errors.New("unix sockets are not supported on Windows")
}
socketDir, e := filepath.Abs(c.socketDir)
if e != nil {
return e
}
if c.identity == nil {
if err = os.MkdirAll(socketDir, 0700); err != nil {
return err
}
}
// The parent is caller-owned; only the private socket child is removed.
socketDir, err = os.MkdirTemp(socketDir, "ep-")
if err != nil {
return err
}
s.cleanups = append(s.cleanups, func(context.Context) error { return os.RemoveAll(socketDir) })
if err = platform.Own(socketDir, c.identity); err != nil {
return err
}
c.socketDir = socketDir
}
for _, hook := range c.hooks.BeforeStart {
cleanup, e := hook(start, s.info)
if cleanup != nil {
s.cleanups = append(s.cleanups, cleanup)
}
if e != nil {
return fmt.Errorf("before-start hook: %w", e)
}
}
for attempt := 0; attempt < 5; attempt++ {
port := c.port
if port == 0 {
port, err = freePort()
if err != nil {
return err
}
}
s.info.Port = port
s.info.ConnectionURL = connectionURL(c, port)
if err = ownedFile(s.passPath, []byte("*:*:*:"+pgpass(c.username)+":"+pgpass(c.password)+"\n"), c.identity); err != nil {
return err
}
args := []string{"-D", data, "-p", fmt.Sprint(port), "-h", "127.0.0.1", "-c", "unix_socket_directories="}
if c.socketDir != "" {
args = []string{"-D", data, "-p", fmt.Sprint(port), "-h", "", "-c", "unix_socket_directories=" + c.socketDir}
}
args = append(args, "-c", "embedded_postgres.instance_id="+s.instanceID)
keys := make([]string, 0, len(c.startParameters))
for k := range c.startParameters {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
args = append(args, "-c", k+"="+c.startParameters[k])
}
err = ep.launch(start, s, helper, args)
if err == nil {
err = ep.ready(start, s, c)
}
if err == nil {
break
}
_ = ep.stopProcess(s)
logs := logTail(s.logPath)
if attempt == 4 || c.port != 0 || c.socketDir != "" || (!strings.Contains(string(logs), "Address already in use") && !strings.Contains(string(logs), "could not bind")) {
return err
}
if err = os.WriteFile(s.logPath, nil, 0600); err != nil {
return err
}
}
if err != nil {
return err
}
if fresh && c.database != "postgres" {
if _, err = ep.command(start, s, "createdb", "-w", "--maintenance-db="+withoutPassword(connectionURL(cWithDatabase(c, "postgres"), s.info.Port)), "--", c.database); err != nil {
return fmt.Errorf("create database: %w", err)
}
}
if _, err = ep.command(start, s, "psql", "-X", "-w", "-v", "ON_ERROR_STOP=1", "-d", withoutPassword(s.info.ConnectionURL), "-Atc", "SELECT 1"); err != nil {
return err
}
for _, hook := range c.hooks.Ready {
cleanup, e := hook(start, s.info)
if cleanup != nil {
s.cleanups = append(s.cleanups, cleanup)
}
if e != nil {
return fmt.Errorf("ready hook: %w", e)
}
}
ep.lastInfo = s.info
go func() {
select {
case <-ctx.Done():
_ = ep.closeSession(s)
case <-s.exited:
_ = ep.closeSession(s)
case <-s.closed:
}
}()
return nil
}
func (ep *EmbeddedPostgres) launch(ctx context.Context, s *session, helper string, args []string) error {
cmd, release, err := platform.Command(context.Background(), ep.config.identity, helper, "__supervise")
if err != nil {
return err
}
defer release()
cmd.Dir = s.info.WorkDir
cmd.Env = ep.environment(s)
lease, err := cmd.StdinPipe()
if err != nil {
return err
}
output, err := cmd.StdoutPipe()
if err != nil {
lease.Close()
return err
}
log, err := os.OpenFile(s.logPath, os.O_APPEND|os.O_WRONLY, 0600)
if err != nil {
lease.Close()
output.Close()
return err
}
defer log.Close()
cmd.Stderr = log
if err = cmd.Start(); err != nil {
lease.Close()
output.Close()
return err
}
s.cmd = cmd
s.lease = lease
s.exited = make(chan struct{})
s.waitErr = nil
go func() { s.waitErr = cmd.Wait(); close(s.exited) }()
req := supervisor.Request{Protocol: supervisor.Protocol, Binary: filepath.Join(s.info.BinariesDir, "bin", platform.Executable("postgres")), Args: args, DataDir: s.info.DataDir, LogPath: s.logPath, ShutdownTimeout: ep.config.stopTimeout}
if err = json.NewEncoder(lease).Encode(req); err != nil {
return err
}
event := make(chan error, 1)
go func() {
defer output.Close()
var e supervisor.Event
err := json.NewDecoder(output).Decode(&e)
if err == nil && (e.Protocol != supervisor.Protocol || e.PID <= 0) {
err = errors.New("invalid supervisor handshake")
}
event <- err
}()
select {
case err := <-event:
return err
case <-ctx.Done():
lease.Close()
return ctx.Err()
}
}
func (ep *EmbeddedPostgres) ready(ctx context.Context, s *session, c Config) error {
for {
select {
case <-s.exited:
return ep.failure(s, errors.New("supervisor exited during startup"))
default:
}
probe, cancel := context.WithTimeout(ctx, time.Second)
// An authenticated listener can be another test with identical credentials.
// Verify the launch-specific setting before accepting readiness.
output, err := ep.command(probe, s, "psql", "-X", "-w", "-d", withoutPassword(connectionURL(cWithDatabase(c, "postgres"), s.info.Port)), "-Atc", "SELECT current_setting('embedded_postgres.instance_id', true)")
cancel()
if err == nil && strings.TrimSpace(string(output)) != s.instanceID {
err = errors.New("listener belongs to a different PostgreSQL instance")
}
if err == nil {
return nil
}
if permanentConnectionError(string(output)) {
return ep.failure(s, err)
}
select {
case <-ctx.Done():
return ep.failure(s, errors.Join(ctx.Err(), err))
case <-s.exited:
return ep.failure(s, err)
case <-time.After(50 * time.Millisecond):
}
}
}
// libpq connection errors are text, not SQL result rows. Utilities run with C
// messages so authentication failures can be distinguished from startup retries.
func permanentConnectionError(output string) bool {
for _, message := range []string{"password authentication failed", "no password supplied", "no pg_hba.conf entry", "pg_hba.conf rejects connection"} {
if strings.Contains(output, message) {
return true
}
}
return strings.Contains(output, "FATAL: role ") && strings.Contains(output, " does not exist")
}
func (ep *EmbeddedPostgres) command(ctx context.Context, s *session, name string, args ...string) ([]byte, error) {
cmd, release, err := platform.Command(ctx, ep.config.identity, s.supervisorPath, "__command")
if err != nil {
return nil, err
}
defer release()
cmd.Dir = s.info.WorkDir
cmd.Env = append(ep.environment(s), "LC_ALL=C")
input, err := cmd.StdinPipe()
if err != nil {
return nil, err
}
defer input.Close()
cmd.Cancel = func() error { return input.Close() }
cmd.WaitDelay = ep.config.stopTimeout + 2*time.Second
var output bytes.Buffer
cmd.Stdout = &output
cmd.Stderr = &output
if err = cmd.Start(); err != nil {
return nil, err
}
req := supervisor.Request{Protocol: supervisor.Protocol, Binary: filepath.Join(s.info.BinariesDir, "bin", platform.Executable(name)), Args: args, DataDir: s.info.WorkDir}
if err = json.NewEncoder(input).Encode(req); err != nil {
input.Close()
_ = cmd.Wait()
return nil, err
}
err = cmd.Wait()
if err != nil {
return output.Bytes(), fmt.Errorf("%s: %w: %s", name, err, redact(output.String(), ep.config.password))
}
return output.Bytes(), nil
}
func (ep *EmbeddedPostgres) environment(s *session) []string {
env := []string{}
for _, v := range os.Environ() {
key, _, _ := strings.Cut(v, "=")
key = strings.ToUpper(key)
if strings.HasPrefix(key, "PG") || key == "HOME" || key == "TMPDIR" {
continue
}
env = append(env, v)
}
env = append(env, ep.config.environment...)
return append(env, "HOME="+s.info.WorkDir, "TMPDIR="+s.info.WorkDir, "PGPASSFILE="+s.passPath, "PGCONNECT_TIMEOUT=1")
}
// Stop preserves the v1 error when no server is active. Close is idempotent.
func (ep *EmbeddedPostgres) Stop() error {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active == nil {
return ErrServerNotStarted
}
return ep.closeLocked(context.Background())
}
// StopContext requests cleanup and bounds how long the caller waits. If ctx
// expires, bounded process shutdown and resource cleanup continue independently.
func (ep *EmbeddedPostgres) StopContext(ctx context.Context) error {
done := make(chan error, 1)
go func() {
// Acquiring the lifecycle lock is part of the bounded wait too. A stop
// requested during startup still completes after startup releases it.
ep.mu.Lock()
s := ep.active
ep.mu.Unlock()
if s == nil {
done <- ErrServerNotStarted
return
}
done <- ep.closeSession(s)
}()
select {
case err := <-done:
return err
case <-ctx.Done():
return ctx.Err()
}
}
func (ep *EmbeddedPostgres) Close() error {
ep.mu.Lock()
defer ep.mu.Unlock()
return ep.closeLocked(context.Background())
}
func (ep *EmbeddedPostgres) stopProcess(s *session) error {
if s.lease == nil {
return nil
}
_ = s.lease.Close()
select {
case <-s.exited:
case <-time.After(ep.config.stopTimeout + 2*time.Second):
// Only the supervisor owns PostgreSQL's process handle. Never reconstruct
// one from its handshake PID: that PID may already have been reused.
_ = s.cmd.Process.Kill()
<-s.exited
s.waitErr = errors.Join(s.waitErr, errors.New("supervisor did not respond to shutdown; force-terminated without confirming PostgreSQL cleanup"))
}
s.lease = nil
if s.waitErr != nil {
return ep.failure(s, s.waitErr)
}
return nil
}
func (ep *EmbeddedPostgres) closeLocked(_ context.Context) (err error) {
s := ep.active
if s == nil {
return nil
}
defer func() { ep.lastInfo = s.info; ep.active = nil; close(s.closed); ep.lastErr = err }()
err = ep.stopProcess(s)
cleanup, cancel := context.WithTimeout(context.Background(), ep.config.stopTimeout)
defer cancel()
var firstPanic any
call := func(fn func() error) (e error) {
defer func() {
if p := recover(); p != nil {
if firstPanic == nil {
firstPanic = p
}
e = fmt.Errorf("cleanup panicked: %v", p)
}
}()
return fn()
}
defer func() {
if firstPanic != nil {
panic(firstPanic)
}
}()
for i := len(s.cleanups) - 1; i >= 0; i-- {
err = errors.Join(err, call(func() error { return s.cleanups[i](cleanup) }))
}
ep.lastLog = redact(string(logTail(s.logPath)), ep.config.password)
if ep.config.logger != nil {
if b := ep.lastLog; len(b) > 0 {
err = errors.Join(err, call(func() error {
_, e := io.WriteString(ep.config.logger, b)
return e
}))
}
}
if s.lock != nil {
err = errors.Join(err, s.lock.Close())
}
if s.info.WorkDir != "" {
err = errors.Join(err, os.RemoveAll(s.info.WorkDir))
}
if s.installation != nil && s.installation.Release != nil {
err = errors.Join(err, call(s.installation.Release))
}
return err
}
// ConnectionURL returns the actual endpoint after Start succeeds.
func (ep *EmbeddedPostgres) ConnectionURL() string {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != nil {
return ep.active.info.ConnectionURL
}
return ep.lastInfo.ConnectionURL
}
func (ep *EmbeddedPostgres) GetConnectionURL() string { return ep.ConnectionURL() }
func (ep *EmbeddedPostgres) GetPort() uint32 {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != nil {
return ep.active.info.Port
}
return ep.lastInfo.Port
}
func (ep *EmbeddedPostgres) Info() InstanceInfo {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != nil {
return ep.active.info
}
return ep.lastInfo
}
func (ep *EmbeddedPostgres) failure(s *session, err error) error {
b := logTail(s.logPath)
return fmt.Errorf("%w\n%s", err, redact(string(b), ep.config.password))
}
func freePort() (uint32, error) {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
return 0, err
}
port := uint32(l.Addr().(*net.TCPAddr).Port)
return port, l.Close()
}
func ownedFile(path string, b []byte, id *User) error {
if err := os.WriteFile(path, b, 0600); err != nil {
return err
}
return platform.Own(path, id)
}
func pgpass(s string) string { return strings.NewReplacer("\\", "\\\\", ":", "\\:").Replace(s) }
func redact(s, password string) string {
if password != "" {
s = strings.ReplaceAll(s, password, "[redacted]")
}
return s
}
func cWithDatabase(c Config, d string) Config { c.database = d; return c }
func validateConfig(c Config) error {
if c.port > 65535 {
return errors.New("port must be 0..65535")
}
if c.startTimeout <= 0 || c.stopTimeout <= 0 || c.stopTimeout > time.Minute {
return errors.New("positive startup and shutdown timeouts required; shutdown maximum is one minute")
}
parts := strings.Split(string(c.version), ".")
if len(parts) < 2 || len(parts) > 3 {
return errors.New("invalid PostgreSQL version")
}
for _, p := range parts {
if _, err := strconv.ParseUint(p, 10, 32); err != nil {
return errors.New("invalid PostgreSQL version")
}
}
for _, s := range []string{c.database, c.username, c.password, c.locale, c.encoding} {
if s == "" || strings.ContainsAny(s, "\x00\r\n") {
return errors.New("database, user, password, locale and encoding must be nonempty and contain no NUL or newline")
}
}
for k, v := range c.startParameters {
switch strings.ToLower(k) {
case "port", "listen_addresses", "data_directory", "unix_socket_directories", "config_file", "hba_file", "ident_file", "external_pid_file", "embedded_postgres.instance_id":
return fmt.Errorf("%s is managed by the lifecycle; use its dedicated setting or a hook", k)
}
if k == "" || strings.ContainsAny(k, "=\x00\r\n") || strings.ContainsRune(v, 0) {
return errors.New("invalid PostgreSQL setting")
}
}
if c.provider != nil && (c.binariesPath != "" || c.repositoryURL != "") {
return errors.New("Provider cannot be combined with BinariesPath or BinaryRepositoryURL")
}
return nil
}
// Done closes when an instance has been fully cleaned up. Before Start it is already closed.
func (ep *EmbeddedPostgres) Done() <-chan struct{} {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != nil {
return ep.active.closed
}
done := make(chan struct{})
close(done)
return done
}
// Err reports the most recent lifecycle or unexpected-process error.
func (ep *EmbeddedPostgres) Err() error { ep.mu.Lock(); defer ep.mu.Unlock(); return ep.lastErr }
// Logs returns the recent server output with the configured password redacted.
// A bounded tail remains available after Close for test-failure diagnostics.
// Temporary files are still removed. Errors also include startup diagnostics.
func (ep *EmbeddedPostgres) Logs() string {
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active == nil {
return ep.lastLog
}
b := logTail(ep.active.logPath)
return redact(string(b), ep.config.password)
}
// logTail bounds memory even when a test produces large server logs.
func logTail(path string) []byte {
f, err := os.Open(path)
if err != nil {
return nil
}
defer f.Close()
st, err := f.Stat()
if err != nil {
return nil
}
if st.Size() > 32<<10 {
if _, err = f.Seek(-(32 << 10), io.SeekEnd); err != nil {
return nil
}
}
b, _ := io.ReadAll(io.LimitReader(f, 32<<10))
return b
}
// A delayed watcher from an old lifetime must never close a restarted instance.
func (ep *EmbeddedPostgres) closeSession(s *session) (err error) {
defer func() {
if p := recover(); p != nil {
err = fmt.Errorf("cleanup panicked: %v", p)
}
}()
ep.mu.Lock()
defer ep.mu.Unlock()
if ep.active != s {
return nil
}
return ep.closeLocked(context.Background())
}