docs: Add a more advance usecase documentation for ServerContainer#688
Merged
alexanderankin merged 5 commits intotestcontainers:mainfrom Aug 18, 2024
Merged
Conversation
Contributor
Author
|
Strange, this is working locally |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #688 +/- ##
=======================================
Coverage ? 78.07%
=======================================
Files ? 12
Lines ? 602
Branches ? 89
=======================================
Hits ? 470
Misses ? 106
Partials ? 26 ☔ View full report in Codecov by Sentry. |
Contributor
Author
|
ok, seems like redis is removed on |
alexanderankin
approved these changes
Aug 18, 2024
Member
alexanderankin
left a comment
alexanderankin
left a comment
There was a problem hiding this comment.
surprised it works (which network does it use? host network, like via host.docker.internal?
Contributor
Author
|
You are absolutely right, it doesn't... I lost all fait in the doctests :) |
Contributor
Author
|
ok so the fix is up and as I don't trust the doctests, I recreated a local test: from testcontainers.redis import RedisContainer
from testcontainers.generic import ServerContainer
from testcontainers.core.image import DockerImage
with RedisContainer() as redis:
redis_container_port = redis.port
redis_container_ip_address = redis.get_docker_client().bridge_ip(redis._container.id)
print(f"-> Redis avilable @ {redis_container_ip_address}:{redis_container_port}")
with DockerImage(path="./modules/generic/tests/samples/advance_1", tag="advance-1:latest") as image:
web_server = ServerContainer(port=80, image=image)
web_server.with_env(key="REDIS_HOST", value=redis_container_ip_address)
web_server.with_env(key="REDIS_PORT", value=redis_container_port)
with web_server:
web_server_port = web_server.get_exposed_port(web_server.internal_port)
web_server.host = web_server.get_container_host_ip()
print(f"--> Web server avilable @ {web_server.host}:{web_server_port}")
web_server.get_api_url = lambda: web_server._create_connection_url()
client = web_server.get_client()
response = client.get("/")
assert response.status_code == 200, "Server request failed"
assert response.json() == {"status": "ok"}
test_data = {"key": "test_key", "value": "test_value"}
response = client.post("/set", params=test_data)
assert response.status_code == 200, "Failed to set data"
response = client.get(f"/get/{test_data['key']}")
assert response.status_code == 200, "Failed to get data"
assert response.json() == {test_data["key"]: test_data["value"]}Running poetry run pytest ./test.py -vsResult =================================================== test session starts ====================================================
platform linux -- Python 3.10.12, pytest-7.4.3, pluggy-1.4.0 -- /home/roy/.cache/pypoetry/virtualenvs/testcontainers-48VuS9Sz-py3.10/bin/python
cachedir: .pytest_cache
rootdir: /home/roy/projects/testcontainers-python
configfile: pyproject.toml
plugins: mock-3.14.0, anyio-4.3.0, asyncio-0.23.5, cov-4.1.0
asyncio: mode=strict
collecting ... Pulling image testcontainers/ryuk:0.8.1
--------------------------------------------------- live log collection ----------------------------------------------------
INFO testcontainers.core.container:container.py:90 Pulling image testcontainers/ryuk:0.8.1
Container started: 851fdcaadda9
INFO testcontainers.core.container:container.py:117 Container started: 851fdcaadda9
Waiting for container <Container: 851fdcaadda9> with image testcontainers/ryuk:0.8.1 to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: 851fdcaadda9> with image testcontainers/ryuk:0.8.1 to be ready ...
Pulling image redis:latest
INFO testcontainers.core.container:container.py:90 Pulling image redis:latest
Container started: d938296091ad
INFO testcontainers.core.container:container.py:117 Container started: d938296091ad
Waiting for container <Container: d938296091ad> with image redis:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: d938296091ad> with image redis:latest to be ready ...
Waiting for container <Container: d938296091ad> with image redis:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: d938296091ad> with image redis:latest to be ready ...
-> Redis avilable @ 172.17.0.3:6379
Building image from ./modules/generic/tests/samples/advance_1
INFO testcontainers.core.image:image.py:53 Building image from ./modules/generic/tests/samples/advance_1
Built image 1b97cc837982 with tag advance-1:latest
INFO testcontainers.core.image:image.py:58 Built image 1b97cc837982 with tag advance-1:latest
Pulling image advance-1:latest
INFO testcontainers.core.container:container.py:90 Pulling image advance-1:latest
Container started: ed8396337ade
INFO testcontainers.core.container:container.py:117 Container started: ed8396337ade
Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
--> Web server avilable @ localhost:33243
Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO testcontainers.core.waiting_utils:waiting_utils.py:52 Waiting for container <Container: ed8396337ade> with image advance-1:latest to be ready ...
INFO httpx:_client.py:1026 HTTP Request: GET http://localhost:33243/ "HTTP/1.1 200 OK"
INFO httpx:_client.py:1026 HTTP Request: POST http://localhost:33243/set?key=test_key&value=test_value "HTTP/1.1 200 OK"
INFO httpx:_client.py:1026 HTTP Request: GET http://localhost:33243/get/test_key "HTTP/1.1 200 OK"
Removing image 1b97cc837982
INFO testcontainers.core.image:image.py:78 Removing image 1b97cc837982
collected 0 items
================================================== no tests ran in 29.74s ================================================== |
Contributor
Author
|
Now with the |
Contributor
Author
|
Hope this will help #670 |
Member
|
yes i normally duplicate all doctests as regular tests for better IDE experience |
alexanderankin
pushed a commit
that referenced
this pull request
Sep 3, 2024
🤖 I have created a release *beep* *boop* --- ## [4.8.1](testcontainers-v4.8.0...testcontainers-v4.8.1) (2024-08-18) ### Bug Fixes * **generic:** Update the FastAPI install on genric module doctest samples ([#686](#686)) ([5216b02](5216b02)) * **mssql:** use glob to find mssql-tools folder since it moves ([#685](#685)) ([4912725](4912725)), closes [#666](#666) * wait_for_logs can now fail early when the container stops ([#682](#682)) ([925329d](925329d)) ### Documentation * Add a more advance usecase documentation for ServerContainer ([#688](#688)) ([2cf5a9f](2cf5a9f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Expanding the docs for using the ServerContainer with an example involving FastAPI container that is using Redis container.