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
|
package testcfg
import (
"os"
"path/filepath"
"runtime"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v15/internal/helper/perm"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
)
// UnconfiguredSocketPath is used to bypass config validation errors
// when building the configuration. The socket path is now known yet
// at the time of building the configuration and is substituted later
// when the service is actually spun up.
const UnconfiguredSocketPath = "it is a stub to bypass Validate method"
// Option is a configuration option for the builder.
type Option func(*GitalyCfgBuilder)
// WithBase allows use cfg as a template for start building on top of.
// override parameter signals if settings of the cfg can be overridden or not
// (if setting has a default value it is considered "not configured" and can be
// set despite flag value).
func WithBase(cfg config.Cfg) Option {
return func(builder *GitalyCfgBuilder) {
builder.cfg = cfg
}
}
// WithStorages allows to configure list of storages under this gitaly instance.
// All storages will have a test repository by default.
func WithStorages(name string, names ...string) Option {
return func(builder *GitalyCfgBuilder) {
builder.storages = append([]string{name}, names...)
}
}
// WithPackObjectsCacheEnabled enables the pack object cache.
func WithPackObjectsCacheEnabled() Option {
return func(builder *GitalyCfgBuilder) {
builder.packObjectsCacheEnabled = true
}
}
// NewGitalyCfgBuilder returns gitaly configuration builder with configured set of options.
func NewGitalyCfgBuilder(opts ...Option) GitalyCfgBuilder {
cfgBuilder := GitalyCfgBuilder{}
for _, opt := range opts {
opt(&cfgBuilder)
}
return cfgBuilder
}
// GitalyCfgBuilder automates creation of the gitaly configuration and filesystem structure required.
type GitalyCfgBuilder struct {
cfg config.Cfg
storages []string
packObjectsCacheEnabled bool
}
// Build setups required filesystem structure, creates and returns configuration of the gitaly service.
func (gc *GitalyCfgBuilder) Build(tb testing.TB) config.Cfg {
tb.Helper()
cfg := gc.cfg
if cfg.SocketPath == "" {
cfg.SocketPath = UnconfiguredSocketPath
}
root := testhelper.TempDir(tb)
if cfg.BinDir == "" {
cfg.BinDir = filepath.Join(root, "bin.d")
require.NoError(tb, os.Mkdir(cfg.BinDir, perm.SharedDir))
}
if cfg.Ruby.Dir == "" {
_, currentFile, _, ok := runtime.Caller(0)
require.True(tb, ok, "could not get caller info")
cfg.Ruby.Dir = filepath.Join(filepath.Dir(currentFile), "../../../ruby")
}
if cfg.Logging.Dir == "" {
logDir := testhelper.CreateTestLogDir(tb)
if len(logDir) != 0 {
cfg.Logging.Dir = logDir
} else {
cfg.Logging.Dir = filepath.Join(root, "log.d")
require.NoError(tb, os.Mkdir(cfg.Logging.Dir, perm.SharedDir))
}
}
if cfg.GitlabShell.Dir == "" {
cfg.GitlabShell.Dir = filepath.Join(root, "shell.d")
require.NoError(tb, os.Mkdir(cfg.GitlabShell.Dir, perm.SharedDir))
}
if cfg.RuntimeDir == "" {
cfg.RuntimeDir = filepath.Join(root, "runtime.d")
require.NoError(tb, os.Mkdir(cfg.RuntimeDir, perm.PrivateDir))
require.NoError(tb, os.Mkdir(cfg.InternalSocketDir(), perm.SharedDir))
}
if len(cfg.Storages) != 0 && len(gc.storages) != 0 {
require.FailNow(tb, "invalid configuration build setup: fix storages configured")
}
if len(cfg.Storages) == 0 {
storagesDir := filepath.Join(root, "storages.d")
require.NoError(tb, os.Mkdir(storagesDir, perm.SharedDir))
if len(gc.storages) == 0 {
gc.storages = []string{"default"}
}
// creation of the required storages (empty storage directories)
cfg.Storages = make([]config.Storage, len(gc.storages))
for i, storageName := range gc.storages {
storagePath := filepath.Join(storagesDir, storageName)
require.NoError(tb, os.MkdirAll(storagePath, perm.SharedDir))
cfg.Storages[i].Name = storageName
cfg.Storages[i].Path = storagePath
}
}
cfg.PackObjectsCache.Enabled = gc.packObjectsCacheEnabled
// Ignore the gitconfig so that tests aren't impacted by any configuration the user happens
// to have lying around.
cfg.Git.IgnoreGitconfig = true
// The tests don't require GitLab API to be accessible, but as it is required to pass
// validation, so the artificial values are set to pass.
if cfg.Gitlab.URL == "" {
cfg.Gitlab.URL = "https://test.stub.gitlab.com"
}
if cfg.Gitlab.SecretFile == "" {
cfg.Gitlab.SecretFile = filepath.Join(root, "gitlab", "http.secret")
require.NoError(tb, os.MkdirAll(filepath.Dir(cfg.Gitlab.SecretFile), perm.SharedDir))
require.NoError(tb, os.WriteFile(cfg.Gitlab.SecretFile, nil, perm.PublicFile))
}
require.NoError(tb, cfg.Validate())
return cfg
}
// Build creates a minimal configuration setup.
func Build(tb testing.TB, opts ...Option) config.Cfg {
cfgBuilder := NewGitalyCfgBuilder(opts...)
return cfgBuilder.Build(tb)
}
|
