chore(e2e): run babylond in docker #52

Lazar955 · 2024-09-17T10:15:02Z

Instead of managing babylond as a process, we run it in a Docker container.
This will make e2e tests more consistent as bitcoind is also running in Docker and will enable us to run tests in parallel with t.Parallel (next PR).

References issue

Lazar955 · 2024-09-17T10:23:54Z

Makefile

@@ -50,7 +50,7 @@ test:

 test-e2e:
 	cd $(TOOLS_DIR); go install -trimpath $(BABYLON_PKG);
-	go test -race -mod=readonly -timeout=25m -v $(PACKAGES_E2E) -count=1 --tags=e2e
+	go test -race -mod=readonly --failfast -timeout=25m -v $(PACKAGES_E2E) -count=1 --tags=e2e


ensure we fail the test as soon as one of them fails, no need to waste CI

Lazar955 · 2024-09-17T10:24:36Z

e2etest/container/container.go

+				"8332/tcp":  {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"8333/tcp":  {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"28332/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"28333/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"18443/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"18444/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},


as we will be running multiple instances of both bitcoind and Babylon, ensure we use random ports so they don't clash

just curious, why would we be running multiple instances? For e2e in vigilante, a single pair of bitcoind and babylond should be enough, no?

Possibly, but I feel like e2e tests should be isolated to confirm state, rather than tests possibly conflicting with one another

This means that when we start running tests with t.Parallel() we will be spawning bitcoind and Babylon container per e2e test, this ensures that ports won't conflict. There's no need for these tests to be sequential if we can run them in parallel

Lazar955 · 2024-09-17T10:25:13Z

e2etest/test_manager.go

+	cfg.BTC.Endpoint = fmt.Sprintf("127.0.0.1:%s", bitcoind.GetPort("18443/tcp"))
+	cfg.BTC.ZmqSeqEndpoint = fmt.Sprintf("tcp:// 127.0.0.1:%s", bitcoind.GetPort("28333/tcp"))
+


obtain relevant ports, based on the mapping of internal ones

Lazar955 · 2024-09-17T10:25:31Z

e2etest/test_manager.go

 	require.NoError(t, err)

 	// create Babylon client
-	cfg.Babylon.KeyDirectory = bh.GetNodeDataDir()
+	cfg.Babylon.KeyDirectory = filepath.Join(tmpDir, "node0", "babylond")


we expose this inside of our babylon container

Lazar955 · 2024-09-17T10:25:46Z

e2etest/test_manager.go

+	cfg.Babylon.RPCAddr = fmt.Sprintf("http://localhost:%s", babylond.GetPort("26657/tcp"))
+	cfg.Babylon.GRPCAddr = fmt.Sprintf("https://localhost:%s", babylond.GetPort("9090/tcp"))
+


get the assigned ports, same as above

RafilxTenfen · 2024-09-17T18:17:58Z

e2etest/container/container.go

+			Labels: map[string]string{
+				"e2e": "babylond",
+			},
+			//User: "root:root",


remove or uncomment?

RafilxTenfen

LGTM 🎉

gitferry

Nice work! Some questions:

gitferry · 2024-09-18T02:48:52Z

e2etest/container/config.go

 }

 //nolint:deadcode
 const (
 	dockerBitcoindRepository = "lncm/bitcoind"
 	dockerBitcoindVersionTag = "v27.0"
+	dockerBabylondRepository = "babylonlabs/babylond"
+	dockerBabylondVersionTag = "8e0222804ed19b18d74d599b80baa18f05e87d8a" // this is built from commit b1e255a


so this should be manually updated to be consistent with the version in go.mod, correct? How to get the docker version?

It should be a tag, like v0.9.3, but our CI wasn't setup at the time to build for arm64. So yes, it should reflect go mod version

gitferry · 2024-09-18T02:50:25Z

e2etest/container/container.go

+	// jury
+	_, juryPK = btcec.PrivKeyFromBytes(


Suggested change

// jury

_, juryPK = btcec.PrivKeyFromBytes(

_, covenantPK = btcec.PrivKeyFromBytes(

We don't use jury any more

gitferry · 2024-09-18T02:52:28Z

e2etest/container/container.go

+				"8332/tcp":  {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"8333/tcp":  {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"28332/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"28333/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"18443/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},
+				"18444/tcp": {{HostIP: "", HostPort: strconv.Itoa(randomAvailablePort(t))}},


just curious, why would we be running multiple instances? For e2e in vigilante, a single pair of bitcoind and babylond should be enough, no?

gitferry · 2024-09-18T02:53:20Z

e2etest/container/container.go

 // ClearResources removes all outstanding Docker resources created by the Manager.
 func (m *Manager) ClearResources() error {
 	for _, resource := range m.resources {
 		if err := m.pool.Purge(resource); err != nil {
-			return err
+			continue


how do we know there's an error here?

gitferry · 2024-09-18T02:54:09Z

e2etest/test_manager.go

 	passphrase := "pass"
 	_ = btcHandler.CreateWallet("default", passphrase)

 	cfg := defaultVigilanteConfig()

+	cfg.BTC.Endpoint = fmt.Sprintf("127.0.0.1:%s", bitcoind.GetPort("18443/tcp"))
+	cfg.BTC.ZmqSeqEndpoint = fmt.Sprintf("tcp:// 127.0.0.1:%s", bitcoind.GetPort("28333/tcp"))


do we still support zmq?

Yes, depending on config

gitferry · 2024-09-18T02:56:49Z

Seems we can remove tools/?

Lazar955 added 5 commits September 16, 2024 17:53

babylond in docker for e2e

5043070

use dockerhub image, cleanup

afbff88

use random ports

01b8768

wrangling ports

4d4f9e3

rm unused code

89d4d1a

Lazar955 requested review from gitferry, SebastianElvis and RafilxTenfen September 17, 2024 10:16

rm garbage

32ca015

Lazar955 commented Sep 17, 2024

View reviewed changes

Lazar955 added 3 commits September 17, 2024 12:27

build flags

5dde9d7

chmod tmp dir

1234dee

mkdir

c588cc3

Lazar955 removed request for gitferry, SebastianElvis and RafilxTenfen September 17, 2024 13:11

Lazar955 added 8 commits September 17, 2024 16:14

help1

cc084c7

help2

df8784e

help3

8e24435

help4

ce91fe1

help5

29dfef7

help6

97a5357

better port spread

b8b1675

undo

34b22f5

Lazar955 requested review from gitferry and SebastianElvis September 17, 2024 15:46

Lazar955 requested a review from RafilxTenfen September 17, 2024 15:46

cleanup

1f87ba3

RafilxTenfen reviewed Sep 17, 2024

View reviewed changes

RafilxTenfen approved these changes Sep 17, 2024

View reviewed changes

gitferry approved these changes Sep 18, 2024

View reviewed changes

pr comments

3457e68

Lazar955 merged commit 8a4bdf5 into main Sep 18, 2024
8 checks passed

Lazar955 deleted the lazar/babylon-docker branch September 18, 2024 08:10

Lazar955 mentioned this pull request Sep 18, 2024

E2E run babylon in docker #25

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(e2e): run babylond in docker #52

chore(e2e): run babylond in docker #52

Lazar955 commented Sep 17, 2024 •

edited

Loading

Lazar955 Sep 17, 2024

Lazar955 Sep 17, 2024

gitferry Sep 18, 2024

Lazar955 Sep 18, 2024

Lazar955 Sep 18, 2024 •

edited

Loading

Lazar955 Sep 17, 2024

Lazar955 Sep 17, 2024

Lazar955 Sep 17, 2024

RafilxTenfen Sep 17, 2024

RafilxTenfen left a comment

gitferry left a comment

gitferry Sep 18, 2024

Lazar955 Sep 18, 2024

gitferry Sep 18, 2024

gitferry Sep 18, 2024

gitferry Sep 18, 2024

gitferry Sep 18, 2024

Lazar955 Sep 18, 2024

gitferry commented Sep 18, 2024

		cfg.BTC.Endpoint = fmt.Sprintf("127.0.0.1:%s", bitcoind.GetPort("18443/tcp"))
		cfg.BTC.ZmqSeqEndpoint = fmt.Sprintf("tcp:// 127.0.0.1:%s", bitcoind.GetPort("28333/tcp"))

		cfg.Babylon.RPCAddr = fmt.Sprintf("http://localhost:%s", babylond.GetPort("26657/tcp"))
		cfg.Babylon.GRPCAddr = fmt.Sprintf("https://localhost:%s", babylond.GetPort("9090/tcp"))

	// jury
	_, juryPK = btcec.PrivKeyFromBytes(
	_, covenantPK = btcec.PrivKeyFromBytes(

chore(e2e): run babylond in docker #52

chore(e2e): run babylond in docker #52

Conversation

Lazar955 commented Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lazar955 Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RafilxTenfen left a comment

Choose a reason for hiding this comment

gitferry left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gitferry commented Sep 18, 2024

Lazar955 commented Sep 17, 2024 •

edited

Loading

Lazar955 Sep 18, 2024 •

edited

Loading