-
Notifications
You must be signed in to change notification settings - Fork 669
/
compose.go
301 lines (263 loc) · 9.07 KB
/
compose.go
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
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package antithesis
import (
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"github.com/compose-spec/compose-go/types"
"gopkg.in/yaml.v3"
"github.com/ava-labs/avalanchego/config"
"github.com/ava-labs/avalanchego/tests/fixture/tmpnet"
"github.com/ava-labs/avalanchego/utils/constants"
"github.com/ava-labs/avalanchego/utils/logging"
"github.com/ava-labs/avalanchego/utils/perms"
)
const bootstrapIndex = 0
var (
errTargetPathEnvVarNotSet = errors.New("TARGET_PATH environment variable not set")
errImageTagEnvVarNotSet = errors.New("IMAGE_TAG environment variable not set")
errAvalancheGoEvVarNotSet = errors.New("AVALANCHEGO_PATH environment variable not set")
errPluginDirEnvVarNotSet = errors.New("AVALANCHEGO_PLUGIN_DIR environment variable not set")
)
// Creates docker compose configuration for an antithesis test setup. Configuration is via env vars to
// simplify usage by main entrypoints. If the provided network includes a subnet, the initial DB state for
// the subnet will be created and written to the target path. The runtimePluginDir should be set if the node
// image used for the test setup uses a path other than the default (~/.avalanchego/plugins).
func GenerateComposeConfig(network *tmpnet.Network, baseImageName string, runtimePluginDir string) error {
targetPath := os.Getenv("TARGET_PATH")
if len(targetPath) == 0 {
return errTargetPathEnvVarNotSet
}
imageTag := os.Getenv("IMAGE_TAG")
if len(imageTag) == 0 {
return errImageTagEnvVarNotSet
}
// Subnet testing requires creating an initial db state for the bootstrap node
if len(network.Subnets) > 0 {
avalancheGoPath := os.Getenv(tmpnet.AvalancheGoPathEnvName)
if len(avalancheGoPath) == 0 {
return errAvalancheGoEvVarNotSet
}
// Plugin dir configured here is only used for initializing the bootstrap db.
pluginDir := os.Getenv(tmpnet.AvalancheGoPluginDirEnvName)
if len(pluginDir) == 0 {
return errPluginDirEnvVarNotSet
}
bootstrapVolumePath, err := getBootstrapVolumePath(targetPath)
if err != nil {
return fmt.Errorf("failed to get bootstrap volume path: %w", err)
}
if err := initBootstrapDB(network, avalancheGoPath, pluginDir, bootstrapVolumePath); err != nil {
return fmt.Errorf("failed to initialize db volumes: %w", err)
}
}
nodeImageName := fmt.Sprintf("%s-node:%s", baseImageName, imageTag)
workloadImageName := fmt.Sprintf("%s-workload:%s", baseImageName, imageTag)
if err := initComposeConfig(network, nodeImageName, workloadImageName, targetPath, runtimePluginDir); err != nil {
return fmt.Errorf("failed to generate compose config: %w", err)
}
return nil
}
// Initialize the given path with the docker compose configuration (compose file and
// volumes) needed for an Antithesis test setup.
func initComposeConfig(
network *tmpnet.Network,
nodeImageName string,
workloadImageName string,
targetPath string,
pluginDir string,
) error {
// Generate a compose project for the specified network
project, err := newComposeProject(network, nodeImageName, workloadImageName, pluginDir)
if err != nil {
return fmt.Errorf("failed to create compose project: %w", err)
}
absPath, err := filepath.Abs(targetPath)
if err != nil {
return fmt.Errorf("failed to convert target path to absolute path: %w", err)
}
if err := os.MkdirAll(absPath, perms.ReadWriteExecute); err != nil {
return fmt.Errorf("failed to create target path %q: %w", absPath, err)
}
// Write the compose file
bytes, err := yaml.Marshal(&project)
if err != nil {
return fmt.Errorf("failed to marshal compose project: %w", err)
}
composePath := filepath.Join(targetPath, "docker-compose.yml")
if err := os.WriteFile(composePath, bytes, perms.ReadWrite); err != nil {
return fmt.Errorf("failed to write genesis: %w", err)
}
// Create the volume paths
for _, service := range project.Services {
for _, volume := range service.Volumes {
volumePath := filepath.Join(absPath, volume.Source)
if err := os.MkdirAll(volumePath, perms.ReadWriteExecute); err != nil {
return fmt.Errorf("failed to create volume path %q: %w", volumePath, err)
}
}
}
return nil
}
// Create a new docker compose project for an antithesis test setup
// for the provided network configuration.
func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadImageName string, pluginDir string) (*types.Project, error) {
networkName := "avalanche-testnet"
baseNetworkAddress := "10.0.20"
services := make(types.Services, len(network.Nodes)+1)
uris := make(CSV, len(network.Nodes))
var (
bootstrapIP string
bootstrapIDs string
)
for i, node := range network.Nodes {
address := fmt.Sprintf("%s.%d", baseNetworkAddress, 3+i)
tlsKey, err := node.Flags.GetStringVal(config.StakingTLSKeyContentKey)
if err != nil {
return nil, err
}
tlsCert, err := node.Flags.GetStringVal(config.StakingCertContentKey)
if err != nil {
return nil, err
}
signerKey, err := node.Flags.GetStringVal(config.StakingSignerKeyContentKey)
if err != nil {
return nil, err
}
env := types.Mapping{
config.NetworkNameKey: constants.LocalName,
config.LogLevelKey: logging.Debug.String(),
config.LogDisplayLevelKey: logging.Trace.String(),
config.HTTPHostKey: "0.0.0.0",
config.PublicIPKey: address,
config.StakingTLSKeyContentKey: tlsKey,
config.StakingCertContentKey: tlsCert,
config.StakingSignerKeyContentKey: signerKey,
}
// Set a non-default plugin dir if provided
if len(pluginDir) > 0 {
env[config.PluginDirKey] = pluginDir
}
// Apply configuration appropriate to a test network
for k, v := range tmpnet.DefaultTestFlags() {
switch value := v.(type) {
case string:
env[k] = value
case bool:
env[k] = strconv.FormatBool(value)
default:
return nil, fmt.Errorf("unable to convert unsupported type %T to string", v)
}
}
serviceName := getServiceName(i)
volumes := []types.ServiceVolumeConfig{
{
Type: types.VolumeTypeBind,
Source: fmt.Sprintf("./volumes/%s/logs", serviceName),
Target: "/root/.avalanchego/logs",
},
}
trackSubnets, err := node.Flags.GetStringVal(config.TrackSubnetsKey)
if err != nil {
return nil, err
}
if len(trackSubnets) > 0 {
env[config.TrackSubnetsKey] = trackSubnets
if i == bootstrapIndex {
// DB volume for bootstrap node will need to initialized with the subnet
volumes = append(volumes, types.ServiceVolumeConfig{
Type: types.VolumeTypeBind,
Source: fmt.Sprintf("./volumes/%s/db", serviceName),
Target: "/root/.avalanchego/db",
})
}
}
if i == 0 {
bootstrapIP = address + ":9651"
bootstrapIDs = node.NodeID.String()
} else {
env[config.BootstrapIPsKey] = bootstrapIP
env[config.BootstrapIDsKey] = bootstrapIDs
}
// The env is defined with the keys and then converted to env
// vars because only the keys are available as constants.
env = keyMapToEnvVarMap(env)
services[i+1] = types.ServiceConfig{
Name: serviceName,
ContainerName: serviceName,
Hostname: serviceName,
Image: nodeImageName,
Volumes: volumes,
Environment: env.ToMappingWithEquals(),
Networks: map[string]*types.ServiceNetworkConfig{
networkName: {
Ipv4Address: address,
},
},
}
// Collect URIs for the workload container
uris[i] = fmt.Sprintf("http://%s:9650", address)
}
workloadEnv := types.Mapping{
config.EnvVarName(EnvPrefix, URIsKey): uris.String(),
}
chainIDs := CSV{}
for _, subnet := range network.Subnets {
for _, chain := range subnet.Chains {
chainIDs = append(chainIDs, chain.ChainID.String())
}
}
if len(chainIDs) > 0 {
workloadEnv[config.EnvVarName(EnvPrefix, ChainIDsKey)] = chainIDs.String()
}
workloadName := "workload"
services[0] = types.ServiceConfig{
Name: workloadName,
ContainerName: workloadName,
Hostname: workloadName,
Image: workloadImageName,
Environment: workloadEnv.ToMappingWithEquals(),
Networks: map[string]*types.ServiceNetworkConfig{
networkName: {
Ipv4Address: baseNetworkAddress + ".129",
},
},
}
return &types.Project{
Networks: types.Networks{
networkName: types.NetworkConfig{
Driver: "bridge",
Ipam: types.IPAMConfig{
Config: []*types.IPAMPool{
{
Subnet: baseNetworkAddress + ".0/24",
},
},
},
},
},
Services: services,
}, nil
}
// Convert a mapping of avalanche config keys to a mapping of env vars
func keyMapToEnvVarMap(keyMap types.Mapping) types.Mapping {
envVarMap := make(types.Mapping, len(keyMap))
for key, val := range keyMap {
envVar := config.EnvVarName(config.EnvPrefix, key)
envVarMap[envVar] = val
}
return envVarMap
}
// Retrieve the service name for a node at the given index. Common to
// GenerateComposeConfig and InitDBVolumes to ensure consistency
// between db volumes configuration and volume paths.
func getServiceName(index int) string {
baseName := "avalanche"
if index == 0 {
return baseName + "-bootstrap-node"
}
return fmt.Sprintf("%s-node-%d", baseName, index)
}