|
| 1 | +package etcdtest |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "crypto/rand" |
| 6 | + "encoding/hex" |
| 7 | + "fmt" |
| 8 | + "time" |
| 9 | + |
| 10 | + "github.com/ory/dockertest/v3" |
| 11 | + "github.com/ory/dockertest/v3/docker" |
| 12 | + "github.com/sirupsen/logrus" |
| 13 | + v3 "go.etcd.io/etcd/client/v3" |
| 14 | +) |
| 15 | + |
| 16 | +const ( |
| 17 | + imageName = "quay.io/coreos/etcd" |
| 18 | + imageTag = "v3.5.13" |
| 19 | + |
| 20 | + containerAutoKill = 120 * time.Second |
| 21 | +) |
| 22 | + |
| 23 | +func StartEtcd(pool *dockertest.Pool) (client *v3.Client, teardown func(), err error) { |
| 24 | + teardown = func() {} |
| 25 | + |
| 26 | + resource, err := pool.RunWithOptions(&dockertest.RunOptions{ |
| 27 | + Repository: imageName, |
| 28 | + Tag: imageTag, |
| 29 | + Env: []string{ |
| 30 | + "ALLOW_NONE_AUTHENTICATION=true", |
| 31 | + "ETCD_LISTEN_CLIENT_URLS=http://0.0.0.0:2379", |
| 32 | + "ETCD_ADVERTISE_CLIENT_URLS=http://0.0.0.0:2379", |
| 33 | + }, |
| 34 | + }, func(config *docker.HostConfig) { |
| 35 | + // set AutoRemove to true so that stopped container goes away by itself |
| 36 | + config.AutoRemove = true |
| 37 | + config.RestartPolicy = docker.RestartPolicy{Name: "no"} |
| 38 | + }) |
| 39 | + |
| 40 | + if err != nil { |
| 41 | + return nil, teardown, fmt.Errorf("failed to start etcd: %w", err) |
| 42 | + } |
| 43 | + |
| 44 | + // 2024/04/14: Expire() _never_ returns an error |
| 45 | + _ = resource.Expire(uint(containerAutoKill.Seconds())) |
| 46 | + |
| 47 | + log := logrus.StandardLogger().WithField("method", "StartEtcd") |
| 48 | + |
| 49 | + client, err = v3.New(v3.Config{ |
| 50 | + Endpoints: []string{fmt.Sprintf("localhost:%s", resource.GetPort("2379/tcp"))}, |
| 51 | + }) |
| 52 | + if err != nil { |
| 53 | + return nil, teardown, fmt.Errorf("failed to create v3 client: %w", err) |
| 54 | + } |
| 55 | + |
| 56 | + teardown = func() { |
| 57 | + if err := pool.Purge(resource); err != nil { |
| 58 | + log.WithError(err).Errorf("failed to cleanup etcd resource") |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + err = pool.Retry(func() error { |
| 63 | + ctx, cancel := context.WithTimeout(context.Background(), time.Second) |
| 64 | + defer cancel() |
| 65 | + |
| 66 | + _, err = client.Get(ctx, "__startup_test") |
| 67 | + return err |
| 68 | + }) |
| 69 | + if err != nil { |
| 70 | + return nil, teardown, fmt.Errorf("failed waiting for stable connection: %w", err) |
| 71 | + } |
| 72 | + |
| 73 | + return client, teardown, nil |
| 74 | +} |
| 75 | + |
| 76 | +func StartEtcdCluster(pool *dockertest.Pool, size int, autoRemove bool) (client *v3.Client, nodes []*dockertest.Resource, teardown func(), err error) { |
| 77 | + teardown = func() {} |
| 78 | + |
| 79 | + if size%2 == 0 { |
| 80 | + return nil, nil, teardown, fmt.Errorf("must specify an odd number of size") |
| 81 | + } |
| 82 | + |
| 83 | + clusterName, err := randClusterName() |
| 84 | + if err != nil { |
| 85 | + return nil, nil, teardown, fmt.Errorf("failed to generate cluster name: %w", err) |
| 86 | + } |
| 87 | + |
| 88 | + log := logrus.StandardLogger().WithFields(logrus.Fields{ |
| 89 | + "method": "StartEtcdCluster", |
| 90 | + "cluster": clusterName, |
| 91 | + }) |
| 92 | + |
| 93 | + network, err := pool.CreateNetwork(fmt.Sprintf("%s-network", clusterName)) |
| 94 | + if err != nil { |
| 95 | + return nil, nil, teardown, fmt.Errorf("failed to create network: %w", err) |
| 96 | + } |
| 97 | + |
| 98 | + cleanupNetwork := func() { |
| 99 | + if err := pool.RemoveNetwork(network); err != nil { |
| 100 | + log.WithError(err).Errorf("failed to remove network") |
| 101 | + } |
| 102 | + } |
| 103 | + |
| 104 | + teardown = func() { |
| 105 | + cleanupNetwork() |
| 106 | + } |
| 107 | + |
| 108 | + cluster := fmt.Sprintf("%s-0=http://%s-0:2380", clusterName, clusterName) |
| 109 | + for i := 1; i < size; i++ { |
| 110 | + cluster += fmt.Sprintf(",%s-%d=http://%s-%d:2380", clusterName, i, clusterName, i) |
| 111 | + } |
| 112 | + |
| 113 | + containers := make([]*dockertest.Resource, size) |
| 114 | + for i := 0; i < size; i++ { |
| 115 | + peerURL := fmt.Sprintf("http://%s-%d:2380", clusterName, i) |
| 116 | + containers[i], err = pool.RunWithOptions(&dockertest.RunOptions{ |
| 117 | + Repository: imageName, |
| 118 | + Tag: imageTag, |
| 119 | + Name: fmt.Sprintf("%s-%d", clusterName, i), |
| 120 | + Networks: []*dockertest.Network{network}, |
| 121 | + Env: []string{ |
| 122 | + "ALLOW_NONE_AUTHENTICATION=true", |
| 123 | + "ETCD_NAME=" + fmt.Sprintf("%s-%d", clusterName, i), |
| 124 | + "ETCD_LISTEN_CLIENT_URLS=http://0.0.0.0:2379", |
| 125 | + "ETCD_ADVERTISE_CLIENT_URLS=http://0.0.0.0:2379", |
| 126 | + "ETCD_INITIAL_CLUSTER=" + cluster, |
| 127 | + "ETCD_INITIAL_ADVERTISE_PEER_URLS=" + peerURL, |
| 128 | + "ETCD_LISTEN_PEER_URLS=http://0.0.0.0:2380", |
| 129 | + }, |
| 130 | + }, func(config *docker.HostConfig) { |
| 131 | + config.AutoRemove = autoRemove |
| 132 | + config.RestartPolicy = docker.RestartPolicy{Name: "no"} |
| 133 | + }) |
| 134 | + |
| 135 | + if err != nil { |
| 136 | + return nil, nil, teardown, fmt.Errorf("failed to start etcd-%d: %w", i, err) |
| 137 | + } |
| 138 | + } |
| 139 | + |
| 140 | + teardown = func() { |
| 141 | + for _, c := range containers { |
| 142 | + if err := pool.Purge(c); err != nil { |
| 143 | + log.WithError(err).Errorf("failed to cleanup %s resource", c.Container.Name) |
| 144 | + } |
| 145 | + } |
| 146 | + |
| 147 | + cleanupNetwork() |
| 148 | + } |
| 149 | + |
| 150 | + endpoints := make([]string, size) |
| 151 | + for i := range endpoints { |
| 152 | + endpoints[i] = fmt.Sprintf("localhost:%s", containers[i].GetPort("2379/tcp")) |
| 153 | + } |
| 154 | + |
| 155 | + client, err = v3.New(v3.Config{ |
| 156 | + Endpoints: endpoints, |
| 157 | + }) |
| 158 | + if err != nil { |
| 159 | + return nil, nil, teardown, fmt.Errorf("failed to create v3 client: %w", err) |
| 160 | + } |
| 161 | + |
| 162 | + err = pool.Retry(func() error { |
| 163 | + ctx, cancel := context.WithTimeout(context.Background(), time.Second) |
| 164 | + defer cancel() |
| 165 | + |
| 166 | + _, err = client.Get(ctx, "__startup_test") |
| 167 | + return err |
| 168 | + }) |
| 169 | + if err != nil { |
| 170 | + return nil, nil, teardown, fmt.Errorf("failed waiting for stable connection: %w", err) |
| 171 | + } |
| 172 | + |
| 173 | + return client, containers, teardown, nil |
| 174 | +} |
| 175 | + |
| 176 | +func randClusterName() (string, error) { |
| 177 | + var b [4]byte |
| 178 | + _, err := rand.Read(b[:]) |
| 179 | + if err != nil { |
| 180 | + return "", err |
| 181 | + } |
| 182 | + |
| 183 | + return fmt.Sprintf("etcd-test-%s", hex.EncodeToString(b[:])), nil |
| 184 | +} |
0 commit comments