Fix: Race condition in DockerContainerTestCase (#6587) #6594
Conversation
This file contains 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
achave11-ucsc
changed the title
achave11-ucsc
force-pushed
the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
from
7e66b4f
to
35c9c8a
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #6594 +/- ##
===========================================
- Coverage 85.42% 85.41% -0.02%
===========================================
Files 155 155
Lines 20750 20760 +10
===========================================
+ Hits 17726 17732 +6
- Misses 3024 3028 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
nadove-ucsc
requested changes
Sep 25, 2024
There was a problem hiding this comment.
Cleaned up some repetitive bits by restructuring the loop
Subject: [PATCH] REVIEW
---
Index: test/docker_container_test_case.py
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/test/docker_container_test_case.py b/test/docker_container_test_case.py
--- a/test/docker_container_test_case.py (revision 35c9c8a9594d993cd3cc088fdb97ec9478efa9e2)
+++ b/test/docker_container_test_case.py (date 1727224805142)
@@ -87,34 +87,31 @@
try:
time_it = datetime.now()
container_info = cls._docker.api.inspect_container(container.id)
- network_settings = container_info['NetworkSettings']
if is_sibling: # no coverage
- container_ip = network_settings['IPAddress']
+ container_ip = container_info['NetworkSettings']['IPAddress']
assert isinstance(container_ip, str)
endpoint = (container_ip, container_port)
log.info('Launched sibling container %s from image %s, listening on %s:%i',
container.name, image, container_ip, container_port)
else:
- retries = 0
- ports = network_settings['Ports']
- while len(ports[f'{container_port}/tcp']) < 1:
- if (datetime.now() - time_it).seconds > 3:
- # Wait for the published ports of the container that's
- # supposedly running, otherwise giveup (let it fail).
- log.error('Unreachable TCP port %s for container %s',
- container_port, container.name)
+ retries, seconds = 0, 0.0
+ while True:
+ ports = container_info['NetworkSettings']['Ports'][f'{container_port}/tcp']
+ if len(ports) > 0:
break
- time.sleep(.33)
- container_info = cls._docker.api.inspect_container(container.id)
- ports = container_info['NetworkSettings']['Ports']
- retries += 1
- milisecs = (datetime.now() - time_it).microseconds / 1000
- port = one(ports[f'{container_port}/tcp'])
+ elif seconds > 3:
+ raise RuntimeError('Unreachable TCP port', container_port, container.name)
+ else:
+ time.sleep(.33)
+ container_info = cls._docker.api.inspect_container(container.id)
+ retries += 1
+ seconds = (datetime.now() - time_it).total_seconds()
+ port = one(ports)
host_ip = port['HostIp']
host_port = int(port['HostPort'])
- log.info('Launched container %s from image %s after %dms (retries %d), '
+ log.info('Launched container %s from image %s after %.3fs and %d retries, '
'with container port %s mapped to %s:%i on the host',
- container.name, image, milisecs, retries, container_port, host_ip, host_port)
+ container.name, image, seconds, retries, container_port, host_ip, host_port)
endpoint = (host_ip, host_port)
except BaseException: # no coverage
container.kill()
test/docker_container_test_case.py
Outdated
| container_info = cls._docker.api.inspect_container(container.id) | ||
| ports = container_info['NetworkSettings']['Ports'] | ||
| retries += 1 | ||
| milisecs = (datetime.now() - time_it).microseconds / 1000 |
There was a problem hiding this comment.
"milliseconds" has 2 L's
Suggested change
| milisecs = (datetime.now() - time_it).microseconds / 1000 | |
| millisecs = (datetime.now() - time_it).microseconds / 1000 |
There was a problem hiding this comment.
I don't think this is doing what you want:
>>> from datetime import timedelta
>>> timedelta(seconds=3).microseconds
0
test/docker_container_test_case.py
Outdated
Comment on lines
102
to
101
| # Wait for the published ports of the container that's | ||
| # supposedly running, otherwise giveup (let it fail). | ||
| log.error('Unreachable TCP port %s for container %s', | ||
| container_port, container.name) | ||
| break |
There was a problem hiding this comment.
Why postpone the failure? Raising an exception here makes both the source code and the resulting stack trace easier to understand.
test/docker_container_test_case.py
Outdated
| container_port, container.name) | ||
| break | ||
| time.sleep(.33) | ||
| container_info = cls._docker.api.inspect_container(container.id) |
There was a problem hiding this comment.
Is inspect_container an expensive (i.e. time-consuming) operation? If not, then it seems redundant to track both milliseconds and retries in the loop.
achave11-ucsc
force-pushed
the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
from
35c9c8a
to
5009f13
Compare
|
Requested peer review from @dsotirho-ucsc since @nadove-ucsc is now code owner / sys-admin. |
dsotirho-ucsc
requested changes
Sep 26, 2024
test/docker_container_test_case.py
Outdated
| @@ -81,22 +85,32 @@ def _create_container(cls, image: str, container_port: int, **kwargs) -> Netloc: | |||
| ports=ports, | |||
| **kwargs) | |||
| try: | |||
| time_it = datetime.now() | |||
There was a problem hiding this comment.
Suggested change
| time_it = datetime.now() | |
| start = datetime.now() |
This should be moved above the call to cls._docker.containers.run() so that even if sleep() is not called in the while loop, a time greater than 0.00 will be reported.
test/docker_container_test_case.py
Outdated
Comment on lines
97
to
99
| seconds = 0.0 | ||
| while True: | ||
| ports = container_info['NetworkSettings']['Ports'][f'{container_port}/tcp'] |
There was a problem hiding this comment.
Suggested change
| seconds = 0.0 | |
| while True: | |
| ports = container_info['NetworkSettings']['Ports'][f'{container_port}/tcp'] | |
| while True: | |
| seconds = (datetime.now() - time_it).total_seconds() | |
| ports = container_info['NetworkSettings']['Ports'][f'{container_port}/tcp'] |
Moving the time calculation to the start of the while loop will let seconds reflect the total time taken even if sleep() is not called.
test/docker_container_test_case.py
Outdated
| else: | ||
| time.sleep(.33) | ||
| container_info = cls._docker.api.inspect_container(container.id) | ||
| seconds = (datetime.now() - time_it).total_seconds() |
There was a problem hiding this comment.
Suggested change
| seconds = (datetime.now() - time_it).total_seconds() |
achave11-ucsc
force-pushed
the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
from
5009f13
to
ac51467
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
achave11-ucsc
force-pushed
the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
from
ac51467
to
841f1e6
Compare
nadove-ucsc
approved these changes
Oct 1, 2024
Security design review
|
achave11-ucsc
force-pushed
the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
from
841f1e6
to
dde1540
Compare
achave11-ucsc
added
the
sandbox
achave11-ucsc
deleted the
issues/achave11-ucsc/6587-fix-docker-img-race
branch
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.
Connected issues: #6587
Checklist
Author
developissues/<GitHub handle of author>/<issue#>-<slug>1 when the issue title describes a problem, the corresponding PR
title is
Fix:followed by the issue titleAuthor (partiality)
ptag to titles of partial commitspartialor completely resolves all connected issuespartiallabelAuthor (chains)
baseor this PR is not chained to another PRchainedor is not chained to another PRAuthor (reindex, API changes)
rtag to commit title or the changes introduced by this PR will not require reindexing of any deploymentreindex:devor the changes introduced by it will not require reindexing ofdevreindex:anvildevor the changes introduced by it will not require reindexing ofanvildevreindex:anvilprodor the changes introduced by it will not require reindexing ofanvilprodreindex:prodor the changes introduced by it will not require reindexing ofprodreindex:partialand its description documents the specific reindexing procedure fordev,anvildev,anvilprodandprodor requires a full reindex or carries none of the labelsreindex:dev,reindex:anvildev,reindex:anvilprodandreindex:prodAPIor this PR does not modify a REST APIa(A) tag to commit title for backwards (in)compatible changes or this PR does not modify a REST APIapp.pyor this PR does not modify a REST APIAuthor (upgrading deployments)
make docker_images.jsonand committed the resulting changes or this PR does not modifyazul_docker_images, or any other variables referenced in the definition of that variableutag to commit title or this PR does not require upgrading deploymentsupgradeor does not require upgrading deploymentsdeploy:sharedor does not modifydocker_images.json, and does not require deploying thesharedcomponent for any other reasondeploy:gitlabor does not require deploying thegitlabcomponentdeploy:runneror does not require deploying therunnerimageAuthor (hotfixes)
Ftag to main commit title or this PR does not include permanent fix for a temporary hotfixanvilprodandprod) have temporary hotfixes for any of the issues connected to this PRAuthor (before every review)
develop, squashed old fixupsmake requirements_updateor this PR does not modifyrequirements*.txt,common.mk,MakefileandDockerfileRtag to commit title or this PR does not modifyrequirements*.txtreqsor does not modifyrequirements*.txtmake integration_testpasses in personal deployment or this PR does not modify functionality that could affect the IT outcomePeer reviewer (after approval)
System administrator (after approval)
demoorno demono demono sandboxN reviewslabel is accurateOperator (before pushing merge the commit)
reindex:…labels andrcommit title tagno demodevelop_select dev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unusedor this PR is not labeleddeploy:shared_select dev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab applyor this PR is not labeleddeploy:gitlab_select anvildev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unusedor this PR is not labeleddeploy:shared_select anvildev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab applyor this PR is not labeleddeploy:gitlabdeploy:gitlabdeploy:gitlabSystem administrator
dev.gitlabare complete or this PR is not labeleddeploy:gitlabanvildev.gitlabare complete or this PR is not labeleddeploy:gitlabOperator (before pushing merge the commit)
_select dev.gitlab && make -C terraform/gitlab/runneror this PR is not labeleddeploy:runner_select anvildev.gitlab && make -C terraform/gitlab/runneror this PR is not labeleddeploy:runnersandboxlabel or PR is labeledno sandboxdevor PR is labeledno sandboxanvildevor PR is labeledno sandboxsandboxdeployment or PR is labeledno sandboxanvilboxdeployment or PR is labeledno sandboxsandboxdeployment or PR is labeledno sandboxanvilboxdeployment or PR is labeledno sandboxsandboxor this PR does not remove catalogs or otherwise causes unreferenced indices indevanvilboxor this PR does not remove catalogs or otherwise causes unreferenced indices inanvildevsandboxor this PR is not labeledreindex:devanvilboxor this PR is not labeledreindex:anvildevsandboxor this PR is not labeledreindex:devanvilboxor this PR is not labeledreindex:anvildevpif the PR is also labeledpartialOperator (chain shortening)
developor this PR is not labeledbasechainedlabel from the blocked PR or this PR is not labeledbasebasebaselabel from this PR or this PR is not labeledbaseOperator (after pushing the merge commit)
devanvildevdevdevanvildevanvildev_select dev.shared && make -C terraform/shared applyor this PR is not labeleddeploy:shared_select anvildev.shared && make -C terraform/shared applyor this PR is not labeleddeploy:shareddevanvildevOperator (reindex)
devor this PR is neither labeledreindex:partialnorreindex:devanvildevor this PR is neither labeledreindex:partialnorreindex:anvildevdevor this PR is neither labeledreindex:partialnorreindex:devanvildevor this PR is neither labeledreindex:partialnorreindex:anvildevdevor this PR is neither labeledreindex:partialnorreindex:devanvildevor this PR is neither labeledreindex:partialnorreindex:anvildevdevor this PR does not require reindexingdevanvildevor this PR does not require reindexinganvildevdevor this PR does not require reindexingdevanvildevor this PR does not require reindexinganvildevdevor this PR does not require reindexingdevanvildevor this PR does not require reindexinganvildevOperator
deploy:shared,deploy:gitlab,deploy:runner,API,reindex:partial,reindex:anvilprodandreindex:prodlabels to the next promotion PRs or this PR carries none of these labelsdeploy:shared,deploy:gitlab,deploy:runner,API,reindex:partial,reindex:anvilprodandreindex:prodlabels, from the description of this PR to that of the next promotion PRs or this PR carries none of these labelsShorthand for review comments
Lline is too longWline wrapping is wrongQbad quotesFother formatting problem