refactor: change test setup to use external mock servers without docker #477
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates the testing infrastructure to connect to externally managed mock servers instead of managing them internally via Docker. This change simplifies the test setup, improves consistency with the Python SDK, and allows for more flexible mock server configurations. The mock servers are now started and stopped separately, either via GitHub Actions in CI or manually for local development. The test framework connects to these servers using environment variables.
Refactors the test setup to leverage the algokit-polytest action for managing mock servers, providing a more robust and maintainable solution for integration tests. This change: - Updates the PR workflow to include the `decoupling-bun-mock-server` branch - Removes the local mock server start script - Uses the `algokit-polytest` action to start the mock servers - Adds a `--silent` flag to the test command to reduce output verbosity - Updates testing package to leverage default ports This ensures a consistent mock server environment and simplifies the setup process.
aorumbayev
force-pushed
the
decoupling-bun-mock-server
branch
from
691c9cc to
a1559d0
Compare
aorumbayev
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the test infrastructure from Docker-based mock servers to externally managed mock servers. The change removes local Docker container management logic in favor of relying on GitHub Actions (in CI) or manually started mock servers (for local development). This simplifies the test setup by delegating server lifecycle management to the algokit-polytest project.
- Replaced Docker-based mock server management with external server connections via environment variables
- Updated CI workflow to use dedicated GitHub Actions for starting mock servers
- Revised documentation to guide developers on starting mock servers locally using algokit-polytest scripts
Reviewed changes
Copilot reviewed 6 out of 67 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
packages/testing/src/mockServer.ts |
Removed Docker container management code; replaced startMockServer with simpler getMockServer that reads from environment variables |
packages/testing/src/index.ts |
Updated exports to remove Docker-specific functions and export new checkServerHealth function |
packages/testing/src/globalSetup.ts |
Simplified setup/teardown logic to connect/disconnect rather than start/stop containers |
packages/algod_client/tests/*.test.ts |
Added numerous new test files with placeholder implementations |
packages/algod_client/tests/__snapshots__/*.snap |
Added snapshot files for new test cases |
package.json |
Removed mock-server:start-algod script |
package-lock.json |
Added peer: true flags to various dependencies |
README.md |
Updated documentation with instructions for using external mock servers locally |
.github/workflows/pr.yml |
Restructured workflow to use algokit-polytest GitHub Actions for mock server management |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
aorumbayev
force-pushed
the
decoupling-bun-mock-server
branch
from
774021d to
5935c9a
Compare
Co-authored-by: Copilot <[email protected]>
aorumbayev
force-pushed
the
decoupling-bun-mock-server
branch
from
5935c9a to
db3c908
Compare
aorumbayev
commented
Dec 8, 2025
neilcampbell
approved these changes
Dec 9, 2025
|
|
||
| **Local development:** | ||
|
|
||
| 1. Clone algokit-polytest and start the mock servers: |
Contributor
There was a problem hiding this comment.
Wouldn't you have the polytest repo locally when after running npm run polytest:validate-algod. Maybe it's better to document the flow using npm run commands.
README.md
Outdated
| git clone https://github.com/algorandfoundation/algokit-polytest.git | ||
|
|
||
| # Start all mock servers (recommended) | ||
| cd algokit-polytest/resources/mock-server |
Contributor
There was a problem hiding this comment.
I think it makes sense to have an npm run command for this.
|
|
||
| 2. Set environment variables and run tests: | ||
|
|
||
| ```bash |
Contributor
There was a problem hiding this comment.
Probably need to add where these should be configured.
README.md
Outdated
| ./scripts/stop_all_servers.sh | ||
| ``` | ||
|
|
||
| | Environment Variable | Description | Default Port | |
Contributor
There was a problem hiding this comment.
The env info is probably better placed in step 2
Contributor
|
🎉 This PR is included in version 10.0.0-alpha.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes