Export setup module under test-utils feature
#2247
Conversation
WalkthroughOhayo, sensei! The recent changes enhance the configurability and modularity of the codebase. Key modifications include the conditional instantiation of the Changes
Sequence Diagram(s)sequenceDiagram
participant A as Client
participant B as NodeService
participant C as Messaging
A->>B: Start NodeService
alt Messaging Enabled
A->>B: Create with Messaging
B->>C: Initialize Messaging
else Messaging Disabled
A->>B: Create without Messaging
end
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (5)
Files skipped from review due to trivial changes (2)
Files skipped from review as they are similar to previous changes (3)
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.github.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
crates/sozo/ops/src/tests/mod.rs (5)
1-1: Ohayo sensei! Theauthmodule cannot be made private.The
authmodule is used in multiple locations outside ofcrates/sozo/ops/src/tests/mod.rs, including:
crates/sozo/ops/src/migration/migrate.rscrates/sozo/ops/src/migration/auto_auth.rscrates/sozo/ops/src/migration/utils.rsbin/sozo/src/commands/mod.rsbin/sozo/src/commands/auth.rsMaking the
authmodule private will break these references.Analysis chain
Verify the impact of making
authmodule private.The
authmodule is now private to the current module. Ensure that no external code relies on this module being public.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify no external code relies on the `auth` module being public. # Test: Search for external usage of the `auth` module. Expect: No occurrences of external usage. rg --type rust 'auth::' --glob '!crates/sozo/ops/src/tests/mod.rs'Length of output: 3818
5-5: Ohayo, sensei!The
setupmodule is still being used extensively across multiple test files. Removing thesetupmodule declaration without addressing its usage will break these tests.
- Files impacted:
crates/sozo/ops/src/tests/auth.rscrates/sozo/ops/src/tests/migration.rscrates/sozo/ops/src/tests/utils.rscrates/sozo/ops/src/tests/model.rscrates/sozo/ops/src/tests/call.rsPlease ensure to either reintroduce the
setupmodule or refactor the tests to remove dependencies on it.Analysis chain
Verify the impact of removing the
setupmodule declaration.The
setupmodule declaration has been removed. Ensure that no external code relies on this module.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify no external code relies on the `setup` module. # Test: Search for external usage of the `setup` module. Expect: No occurrences of external usage. rg --type rust 'setup::'Length of output: 3377
4-4: Ohayo, sensei!The
modelmodule is being used in various places outside ofcrates/sozo/ops/src/tests/mod.rs. Making this module private will break these dependencies. Please consider making themodelmodule public again or refactor the code to avoid external dependencies on this module.
- External usages found:
crates/torii/libp2p/src/tests.rscrates/torii/graphql/src/tests/mod.rscrates/torii/graphql/src/schema.rscrates/sozo/ops/src/auth.rscrates/sozo/ops/src/register.rscrates/dojo-world/src/manifest/mod.rscrates/dojo-world/src/contracts/world.rscrates/dojo-world/src/contracts/model.rscrates/dojo-world/src/contracts/abi/model.rscrates/dojo-lang/src/introspect/ty.rscrates/dojo-lang/src/introspect/mod.rscrates/dojo-lang/src/introspect/layout.rscrates/dojo-lang/src/introspect/size.rscrates/dojo-bindgen/src/lib.rscrates/dojo-lang/src/plugin.rscrates/dojo-lang/src/model.rscrates/dojo-lang/src/event.rsbin/sozo/src/commands/model.rsbin/sozo/src/commands/mod.rsAnalysis chain
Verify the impact of making
modelmodule private.The
modelmodule is now private to the current module. Ensure that no external code relies on this module being public.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify no external code relies on the `model` module being public. # Test: Search for external usage of the `model` module. Expect: No occurrences of external usage. rg --type rust 'model::' --glob '!crates/sozo/ops/src/tests/mod.rs'Length of output: 21129
2-2: Ohayo sensei,Making the
callmodule private will break external references.The
callmodule is used in:
bin/sozo/src/commands/call.rsfor invoking thecallfunction.bin/sozo/src/commands/mod.rsfor importingCallArgs.Making this module private will disrupt these references and break the functionality.
Analysis chain
Verify the impact of making
callmodule private.The
callmodule is now private to the current module. Ensure that no external code relies on this module being public.
Ohayo sensei,
Verify the impact of making
callmodule private.The
callmodule is referenced inbin/sozo/src/commands. We need to ensure that making it private won't break functionality. Let's gather more information about the context of these references.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify no external code relies on the `call` module being public. # Test: Search for external usage of the `call` module. Expect: No occurrences of external usage. rg --type rust 'call::' --glob '!crates/sozo/ops/src/tests/mod.rs'Length of output: 600
Script:
#!/bin/bash # Description: Gather more detailed information about the usage context of `call` in `bin/sozo/src/commands`. # Display the lines around the usage of `call` in `bin/sozo/src/commands/mod.rs` and `bin/sozo/src/commands/call.rs`. rg --type rust -A 5 -B 5 'call::' bin/sozo/src/commands/mod.rs bin/sozo/src/commands/call.rsLength of output: 1355
3-3: Ohayo, sensei!The removal of the
pubkeyword from themigrationmodule declaration has caused issues. There are multiple external references tomigration::, which rely on the module being public. Here are some of the affected files:
crates/torii/grpc/src/server/tests/entities_test.rscrates/torii/graphql/src/tests/mod.rscrates/torii/core/src/sql_test.rscrates/dojo-world/src/utils.rscrates/sozo/ops/src/tests/model.rscrates/sozo/ops/src/tests/migration.rscrates/sozo/ops/src/test_utils/setup.rscrates/sozo/ops/src/tests/auth.rscrates/sozo/ops/src/utils.rscrates/sozo/ops/src/register.rscrates/dojo-world/src/contracts/world_test.rscrates/sozo/ops/src/migration/auto_auth.rscrates/sozo/ops/src/migration/utils.rscrates/sozo/ops/src/migration/migrate.rscrates/sozo/ops/src/migration/mod.rscrates/saya/core/src/dojo_os/mod.rscrates/sozo/ops/src/execute.rscrates/sozo/ops/src/auth.rscrates/sozo/ops/src/account.rscrates/saya/core/src/verifier/starknet.rscrates/dojo-test-utils/src/migration.rscrates/dojo-world/src/manifest/manifest_test.rsbin/sozo/tests/register_test.rsbin/sozo/src/commands/migrate.rsbin/sozo/src/commands/options/transaction.rsbin/sozo/src/commands/options/account/controller.rsYou might want to reconsider making the
migrationmodule public again to avoid these issues.Analysis chain
Verify the impact of making
migrationmodule private.The
migrationmodule is now private to the current module. Ensure that no external code relies on this module being public.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify no external code relies on the `migration` module being public. # Test: Search for external usage of the `migration` module. Expect: No occurrences of external usage. rg --type rust 'migration::' --glob '!crates/sozo/ops/src/tests/mod.rs'Length of output: 4619
There was a problem hiding this comment.
fmt and then let's merge, thanks for the refactoring here.
In-fine we will surely move the setup part into dojo-test-utils actually. As this may be re-used elsewhere too, wdyt? This also avoids the feature here and we will only use the dev dependencies without loading the final binary with test related stuff.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2247 +/- ##
==========================================
+ Coverage 70.14% 70.18% +0.03%
==========================================
Files 343 344 +1
Lines 45199 45250 +51
==========================================
+ Hits 31707 31760 +53
+ Misses 13492 13490 -2 ☔ View full report in Codecov by Sentry. |
yeah, good point. |
Summary by CodeRabbit
New Features
test_utilsmodule to improve testing capabilities with utility functions.setupmodule for streamlined test setups.Bug Fixes
Chores