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
|
package testserver
import (
"bytes"
"context"
"net"
"os"
"os/exec"
"path/filepath"
"sync"
"testing"
"time"
"github.com/pelletier/go-toml/v2"
"github.com/stretchr/testify/require"
gitalycfg "gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testcfg"
)
// PraefectServer encapsulates information of a running Praefect server.
type PraefectServer struct {
address string
shutdown func()
}
// Address is the address of the Praefect server.
func (ps PraefectServer) Address() string {
return ps.address
}
// Shutdown shuts the Praefect server down. This function is synchronous and waits for the server to
// exit.
func (ps PraefectServer) Shutdown() {
ps.shutdown()
}
// StartPraefect creates and runs a Praefect proxy. This server is created by running the external
// Praefect executable.
func StartPraefect(tb testing.TB, cfg config.Config) PraefectServer {
tb.Helper()
// We're precreating the Unix socket which we pass to Praefect. This closes a race where
// the Unix socket didn't yet exist when we tried to dial the Praefect server.
praefectServerSocket, err := net.Listen("unix", cfg.SocketPath)
require.NoError(tb, err)
testhelper.MustClose(tb, praefectServerSocket)
tb.Cleanup(func() { require.NoError(tb, os.RemoveAll(praefectServerSocket.Addr().String())) })
tempDir := testhelper.TempDir(tb)
configFilePath := filepath.Join(tempDir, "config.toml")
configFile, err := os.Create(configFilePath)
require.NoError(tb, err)
defer testhelper.MustClose(tb, configFile)
require.NoError(tb, toml.NewEncoder(configFile).Encode(&cfg))
require.NoError(tb, configFile.Sync())
binaryPath := testcfg.BuildPraefect(tb, gitalycfg.Cfg{
BinDir: tempDir,
})
// Redirect log output of the server to the Praefect server logger. This will cause us to write logs into a
// Praefect-specific logger.
logWriter := testhelper.NewLogger(tb, testhelper.WithLoggerName("praefect")).LogrusEntry().WithField("component", "praefect").Writer() //nolint:staticcheck
tb.Cleanup(func() { testhelper.MustClose(tb, logWriter) })
cmd := exec.Command(binaryPath, "-config", configFilePath)
var stderr bytes.Buffer
cmd.Stderr = &stderr
cmd.Stdout = logWriter
require.NoError(tb, cmd.Start())
var waitErr error
var waitOnce sync.Once
wait := func() error {
waitOnce.Do(func() {
waitErr = cmd.Wait()
})
return waitErr
}
praefectServer := PraefectServer{
address: "unix://" + praefectServerSocket.Addr().String(),
shutdown: func() {
_ = cmd.Process.Kill()
_ = wait()
},
}
tb.Cleanup(praefectServer.Shutdown)
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
defer cancel()
processExitedCh := make(chan error, 1)
go func() {
processExitedCh <- wait()
cancel()
}()
// Ensure this runs even if context ends in waitHealthy.
defer func() {
// Check if the process has exited. This must not happen given that we need it to be
// up in order to connect to it.
select {
case <-processExitedCh:
require.FailNowf(tb, "Praefect has died", "%s", stderr.String())
default:
}
select {
case <-ctx.Done():
switch ctx.Err() {
case context.DeadlineExceeded:
// Capture Praefect logs when waitHealthy takes too long.
require.FailNowf(tb, "Connecting to Praefect exceeded deadline", "%s", stderr.String())
}
default:
}
}()
waitHealthy(tb, ctx, praefectServer.Address(), cfg.Auth.Token)
return praefectServer
}
|
