feat: migrate to testcontainers #161

itegulov · 2023-05-15T06:01:20Z

This PR migrates integration tests to testcontainer-rs, which grants us the following benefits:

Containers are now destroyed deterministically, no need to clean them up manually
Proper wait conditions for when containers are up and ready to receive requests (i.e. no more random sleeps throughout the code and this should prevent test behaving erratically in slower/more constrained environments)
Sandbox is now dockerized too, hopefully no more host communication discrepancy between Macos & Linux. See feat: add dockerfile near-sandbox#59
Running the entire test suite takes 65s down from 130s on my machine
Introduced a new CLI utility that sets up the entire environment except for leader node which gives you an option to debug your code interactively without having to rebuild the docker image after every change

volovyks · 2023-05-17T18:30:11Z

integration-tests/Cargo.toml

 near-crypto = "0.16.1"
-once_cell = "1"
+near-units = "0.2.0"


Once we agreed that this dependency is to havy and can be replaced with something way smaller or just 2 helper functions. Is it necessary to have it?

It only depends on num-format and regex according to cratesio. Not sure why you think it is too heavy, I don't remember this conversation.

volovyks · 2023-05-17T18:30:51Z

integration-tests/Cargo.toml

 serde = "1"
 serde_json = "1"
+testcontainers = { version = "0.14", features = ["experimental"] }


Isn't it a dev dep?

I am also using testcontainers for that CLI I mentioned in the README

volovyks · 2023-05-17T18:32:45Z

integration-tests/tests/mpc/positive.rs

@@ -51,7 +46,6 @@ async fn test_trio() -> anyhow::Result<()> {
    .await
 }

-// TODO: write a test with real token


I guess this TODO is not done :/ But ok, we have an issue for it.

Yeah, I just moved this TODO to a different place

volovyks · 2023-05-17T18:39:33Z

integration-tests/README.md

+Running integration tests requires you to have relayer and sandbox docker images present on your machine:
+
+```BASH
+docker pull ghcr.io/near/pagoda-relayer-rs-fastauth


Should we add this tome kind of setup.sh script?

we can probably do some cargo xtask to automate some of this

#92 introduces a Justfile that we could extend to include an init recipie.

volovyks · 2023-05-17T18:42:13Z

integration-tests/README.md

+You can pass environment variable `TESTCONTAINERS=keep` to keep all of the docker containers. For example:
+
+```bash
+$ TESTCONTAINERS=keep cargo test -p mpc-recovery-integration-tests


How it plays with docker build . -t near/mpc-recovery? What is getting build and what is skipped?

The behavior is the same as it was before. Tests do not build containers, they assume those already exist and are available. So every time you change the code, you have to rebuild the image via docker build . -t near/mpc-recovery.

volovyks · 2023-05-17T18:45:32Z

integration-tests/README.md

+We have a CLI tool that can instantiate a short-lived development environment that has everything except for the leader node set up. You can then seamlessly plug in your own leader node instance that you have set up manually (the tool gives you a CLI command to use as a starting point, but you can attach debugger, enable extra logs etc). Try it out now (sets up 3 signer nodes):
+
+```bash
+$ cargo run -p mpc-recovery-integration-tests -- test-leader 3


It's a bit unclear what is the flow here. SHould I start all the env and then manually setup the leader node? How to rebuild and restart it?

Yes, running this command will create a test env for you and give you an example command on setting up the leader that communicates with this env. The flow is the same as it would be with any conventional Rust application: you run cargo run, you change code, you stop the server via ctrl+c, you run the server again with cargo run.

volovyks

Looks really awesome! And it should solve a lot of inconsistencies with our tests.
Some of the development flaws were not clear for me, maybe we should extend the README a bit.
I wander if we can use this cool CLI to setup the testing env instead of runing scripts manually.

ChaoticTempest · 2023-05-17T01:58:07Z

integration-tests/Cargo.toml

-bollard = "0.14"
+bollard = "0.11"


huh version downgrade seems weird. Anything particular with this one?

Looks like it's to avoid version duplication as testcontainers requires 0.11.x.

testcontainers is using an older version of bollard unfortunately

ChaoticTempest · 2023-05-17T20:27:54Z

integration-tests/README.md

+Running integration tests requires you to have relayer and sandbox docker images present on your machine:
+
+```BASH
+docker pull ghcr.io/near/pagoda-relayer-rs-fastauth


we can probably do some cargo xtask to automate some of this

integration-tests/src/lib.rs

miraclx · 2023-05-17T21:18:00Z

integration-tests/src/main.rs

+            println!();
+            println!("Press any button to exit and destroy all containers...");
+
+            while stdin().read(&mut [0]).await? == 0 {}


neat one liner 👍🏽

itegulov added 12 commits May 11, 2023 18:48

migrate to testcontainers

4be07d5

use proper wait conditions

6a6e6bd

use dockerized sandbox

4ad9076

appease clippy

b432c39

use git workspaces

44ec940

move generic implementations to src

0d4d5d6

use curl-based healthcheck for leader/signer nodes

9a90c7b

parallelize container initialization

e198076

add a helpful cli tool to run all env dependencies

3dc03c8

write a README

f89ce82

appease clippy

fd1b7ad

pull sandbox docker image

adf9de5

itegulov requested review from ChaoticTempest, volovyks and miraclx May 17, 2023 08:55

itegulov marked this pull request as ready for review May 17, 2023 08:55

itegulov mentioned this pull request May 17, 2023

feat: drop containers synchronously #153

Closed

volovyks reviewed May 17, 2023

View reviewed changes

volovyks approved these changes May 17, 2023

View reviewed changes

ChaoticTempest approved these changes May 17, 2023

View reviewed changes

miraclx approved these changes May 17, 2023

View reviewed changes

update workspaces

04c36a4

itegulov merged commit 8fc28c8 into develop May 18, 2023

itegulov deleted the daniyar/testcontainers branch July 20, 2023 05:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate to testcontainers #161

feat: migrate to testcontainers #161

itegulov commented May 15, 2023 •

edited

Loading

volovyks May 17, 2023

itegulov May 17, 2023

volovyks May 17, 2023

itegulov May 17, 2023

volovyks May 17, 2023

itegulov May 17, 2023

volovyks May 17, 2023

ChaoticTempest May 17, 2023

miraclx May 17, 2023

volovyks May 17, 2023

itegulov May 17, 2023

volovyks May 17, 2023

itegulov May 17, 2023

volovyks left a comment

ChaoticTempest May 17, 2023

miraclx May 17, 2023

itegulov May 17, 2023

ChaoticTempest May 17, 2023

miraclx May 17, 2023

		bollard = "0.14"
		bollard = "0.11"

feat: migrate to testcontainers #161

feat: migrate to testcontainers #161

Conversation

itegulov commented May 15, 2023 • 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

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

volovyks 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

itegulov commented May 15, 2023 •

edited

Loading