feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster #3018

tomxey · 2024-10-02T14:33:30Z

Description of change

Introduce shared simulacrum cluster, to use in extended api tests.

With this PR execution of all tests in iota-indexer takes 30 seconds.

With this change the tests are using shared_test_indexer_db for tests with shared cluster, simulacrum_env_db_extended_api for extended_api tests with shared simulacrum and indexer_ingestion_tests_db for ingestion tests in iota-indexer.

Test indexer reader is always run on some free port, instead of a hardcoded one.

Simulacrum fullnode rpc api is run on free port by default, instead of hardcoded one.

In general it allows to have several simulacrum envs and indexers to be running next to each other without conflict.

Links to any relevant issues

fixes #2951

Type of change

Enhancement (a non-breaking change which adds functionality)

How the change has been tested

cargo test --profile simulator --features shared_test_runtime --test rpc-tests

cargo test --profile simulator --features pg_integration --test ingestion_tests -- --test-threads=1

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

I have followed the contribution guidelines for this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added tests that prove my fix is effective or that my feature works
I have checked that new and existing unit tests pass locally with my changes

crates/iota-indexer/tests/common/mod.rs

crates/iota-indexer/src/test_utils.rs

crates/iota-indexer/tests/common/mod.rs

sergiupopescu199

lgtm ✨

kodemartin

looks good @tomxey

Left a few comments because I think it can be simplified

kodemartin · 2024-10-23T15:10:26Z

crates/iota-indexer/tests/common/mod.rs

@@ -58,10 +63,47 @@ impl ApiTestSetup {
    }
 }

+pub struct SimulacrumApiTestEnvDefinition {


I find it hard to reason about the semantics and the necessity of this type.

Why not initializing directly the InitializedSimulacrumEnv passing a Simulacrum value and not a closure that produces it?

The reason was that originally I wanted to make instances of this type global, have the initialized env also stored inside of it, and initialize env like:

let ... = env_definition_instance.get_or_init()

To better show that all the params and the env are tied together.

I lost a fight with the Rust ownership checking system and couldn't make such variable global though.

Finally I settled with approach where the coupling is 'guaranteed' by having a dedicated function for every environment. In this case this type is really not needed I think. I will proceed with removing it.

Having the closure that produces the Simulacrum value it is possible for initialization to happen only once, in case the env already exists then the closure is just not called. It seems cleaner that way.

kodemartin · 2024-10-23T15:15:17Z

crates/iota-indexer/tests/common/mod.rs

+    pub env_initializer: Box<dyn Fn() -> Simulacrum>,
+}
+
+pub struct InitializedSimulacrumEnv {


The name is a bit confusing to me. With this present it would seem plausible to me to have two setups:

ApiTestSetup -> ClusterTestSetup

SimulacrumTestSetup

Suggested change

pub struct InitializedSimulacrumEnv {

pub struct ClusterTestSetup {

I think we can rename to SimulacrumTestSetup.

This name was like this to distinguish the already Initialized env from the EnvDefinition that is yet to be initialized. But since we are removing the SimulacrumApiTestEnvDefinition type we can also rename this one to something simpler.

github-actions · 2024-10-29T09:40:12Z

This pull request has been deployed to Vercel.

Latest commit: e56aaa5

✅ Preview: https://apps-ui-qiuohxype-iota1.vercel.app

github-actions · 2024-10-29T09:40:35Z

This pull request has been deployed to Vercel.

Latest commit: e56aaa5

✅ Preview: https://iota-rebased-explorer-092603f1de8088243ccb8b861b23e-ez1hbggqy.vercel.app

github-actions · 2024-10-29T09:40:55Z

This pull request has been deployed to Vercel.

Latest commit: e56aaa5

✅ Preview: https://apps-backend-29a719c9ccbdb9b80c97b599a599d8953354da-9j454sddn.vercel.app

github-actions · 2024-10-29T09:41:16Z

This pull request has been deployed to Vercel.

Latest commit: e56aaa5

✅ Preview: https://wallet-dashboard-a225fcfa1e2f852205a61a7cd1d5d93e92-c3fbw7tnz.vercel.app

samuel-rufi · 2024-10-29T11:57:32Z

crates/iota-indexer/tests/rpc-tests/main.rs

@@ -4,7 +4,7 @@
 #[allow(dead_code)]
 #[path = "../common/mod.rs"]
 mod common;
-#[cfg(feature = "pg_integration")]
+#[cfg(feature = "shared_test_runtime")]


I think in the README.md we have some outdated instructions on how to run the tests. Could you please update them too? 🙏

Nevermind, doesn't need to be adjustment in the readme

Adjusted readme to use --test-threads=1.

…ed test cluster

…rumEnv type

github-actions · 2024-10-29T14:46:53Z

This pull request has been deployed to Vercel.

Latest commit: f796733

✅ Preview: https://apps-ui-ha2v8ohpa-iota1.vercel.app

github-actions · 2024-10-29T14:47:15Z

This pull request has been deployed to Vercel.

Latest commit: f796733

✅ Preview: https://apps-backend-29a719c9ccbdb9b80c97b599a599d8953354da-mavt18c4y.vercel.app

github-actions · 2024-10-29T14:51:15Z

This pull request has been deployed to Vercel.

Latest commit: f796733

✅ Preview: https://iota-rebased-explorer-092603f1de8088243ccb8b861b23e-nuo5y05gw.vercel.app

github-actions · 2024-10-29T14:53:00Z

This pull request has been deployed to Vercel.

Latest commit: f796733

✅ Preview: https://wallet-dashboard-a225fcfa1e2f852205a61a7cd1d5d93e92-5hxaoftzo.vercel.app

…ed test cluster (#3018) * feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster * Reuse function for finding available port/socket * Get rid of the `replace_db_name` function * Use &str instad of String for database_name where possible * Remove SimulacrumApiTestEnvDefinition type, rename InitializedSimulacrumEnv type * Fixes after rebase on recent feature branch * Update README to run tests with `--test-threads 1`

tomxey changed the base branch from develop to sc-platform/indexer-new-rpc-tests October 2, 2024 14:33

tomxey force-pushed the sc-platform/refactor-extended-api-tests-to-use-shared-runtime branch 5 times, most recently from e0539ec to 6658ad6 Compare October 10, 2024 13:57

tomxey marked this pull request as ready for review October 10, 2024 14:04

tomxey requested review from a team as code owners October 10, 2024 14:04

tomxey self-assigned this Oct 10, 2024

tomxey requested review from samuel-rufi, kodemartin and sergiupopescu199 October 10, 2024 14:05

sergiupopescu199 reviewed Oct 15, 2024

View reviewed changes

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

sergiupopescu199 reviewed Oct 15, 2024

View reviewed changes

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

sergiupopescu199 reviewed Oct 15, 2024

View reviewed changes

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

sergiupopescu199 self-requested a review October 15, 2024 10:31

sergiupopescu199 reviewed Oct 15, 2024

View reviewed changes

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

sergiupopescu199 self-requested a review October 15, 2024 10:58

sergiupopescu199 reviewed Oct 15, 2024

View reviewed changes

crates/iota-indexer/src/test_utils.rs Outdated Show resolved Hide resolved

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

crates/iota-indexer/tests/common/mod.rs Outdated Show resolved Hide resolved

tomxey requested a review from sergiupopescu199 October 16, 2024 14:13

sergiupopescu199 approved these changes Oct 17, 2024

View reviewed changes

sergiupopescu199 mentioned this pull request Oct 21, 2024

[iota-indexer]: Optimize tests #3492

Closed

alexsporn added the infrastructure Issues related to the Infrastructure Team label Oct 23, 2024

tomxey mentioned this pull request Oct 23, 2024

feat(iota-indexer): Introduce ability to create more shared test clusters #3595

Closed

6 tasks

kodemartin reviewed Oct 23, 2024

View reviewed changes

tomxey requested a review from kodemartin October 24, 2024 15:05

tomxey force-pushed the sc-platform/refactor-extended-api-tests-to-use-shared-runtime branch from 5d26c9c to c81f663 Compare October 28, 2024 11:48

tomxey requested review from a team as code owners October 28, 2024 11:48

tomxey removed request for a team October 28, 2024 15:16

tomxey marked this pull request as draft October 28, 2024 15:16

tomxey force-pushed the sc-platform/refactor-extended-api-tests-to-use-shared-runtime branch 4 times, most recently from 3e109c6 to e56aaa5 Compare October 29, 2024 09:35

tomxey marked this pull request as ready for review October 29, 2024 09:38

samuel-rufi approved these changes Oct 29, 2024

View reviewed changes

tomxey added 7 commits October 29, 2024 15:40

feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shar…

3d5c255

…ed test cluster

Reuse function for finding available port/socket

06912c8

Get rid of the replace_db_name function

cb364d5

Use &str instad of String for database_name where possible

bbcde54

Remove SimulacrumApiTestEnvDefinition type, rename InitializedSimulac…

022443f

…rumEnv type

Fixes after rebase on recent feature branch

13ae1d6

Update README to run tests with --test-threads 1

f796733

tomxey force-pushed the sc-platform/refactor-extended-api-tests-to-use-shared-runtime branch from e56aaa5 to f796733 Compare October 29, 2024 14:45

tomxey merged commit d08f374 into sc-platform/indexer-new-rpc-tests Oct 29, 2024
22 of 27 checks passed

tomxey deleted the sc-platform/refactor-extended-api-tests-to-use-shared-runtime branch October 29, 2024 14:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster #3018

feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster #3018

tomxey commented Oct 2, 2024 •

edited

Loading

sergiupopescu199 left a comment

kodemartin left a comment

kodemartin Oct 23, 2024

tomxey Oct 24, 2024 •

edited

Loading

tomxey Oct 24, 2024

kodemartin Oct 23, 2024

tomxey Oct 24, 2024

tomxey Oct 24, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

samuel-rufi Oct 29, 2024

samuel-rufi Oct 29, 2024

tomxey Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

	pub struct InitializedSimulacrumEnv {
	pub struct ClusterTestSetup {

feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster #3018

feat(iota-indexer): Refactor ExtendedApi tests in indexer to use shared test cluster #3018

Conversation

tomxey commented Oct 2, 2024 • edited Loading

Description of change

Links to any relevant issues

Type of change

How the change has been tested

Change checklist

sergiupopescu199 left a comment

Choose a reason for hiding this comment

kodemartin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomxey Oct 24, 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

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

tomxey commented Oct 2, 2024 •

edited

Loading

tomxey Oct 24, 2024 •

edited

Loading