Added timeout to SSHConnector
#644
Merged
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
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## master #644 +/- ##
==========================================
- Coverage 71.44% 71.41% -0.04%
==========================================
Files 88 88
Lines 11345 11349 +4
Branches 1981 1982 +1
==========================================
- Hits 8106 8105 -1
- Misses 2785 2788 +3
- Partials 454 456 +2 ☔ View full report in Codecov by Sentry. |
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
4 times, most recently
from
6333375 to
2ba9820
Compare
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
from
2ba9820 to
e661d94
Compare
GlassOfWhiskey
requested changes
Feb 7, 2025
| raise | ||
| if isinstance(err, asyncio.TimeoutError): | ||
| raise asyncio.TimeoutError( | ||
| f"The SSH connection attempt to {self.get_hostname()} took too long." |
There was a problem hiding this comment.
Suggested change
| f"The SSH connection attempt to {self.get_hostname()} took too long." | |
| f"SSH connection to {self.get_hostname()} failed: connection timed out" |
| @@ -70,6 +70,11 @@ | |||
| "description": "Perform a strict validation of the host SSH keys (and return exception if key is not recognized as valid)", | |||
| "default": true | |||
| }, | |||
| "connectTimeout": { | |||
| "type": "integer", | |||
| "description": "Time (in seconds) to wait for establish the connection. When an attempt fails, the time to wait is increased.", | |||
There was a problem hiding this comment.
Suggested change
| "description": "Time (in seconds) to wait for establish the connection. When an attempt fails, the time to wait is increased.", | |
| "description": "Max time (in seconds) to wait for establishing an SSH connection.", |
| @@ -83,6 +83,7 @@ async def _get_connection( | |||
| port=port, | |||
| tunnel=await self._get_connection(config.tunnel), | |||
| username=config.username, | |||
| connect_timeout=config.connect_timeout * (self.connection_attempts + 1), | |||
There was a problem hiding this comment.
I think the timeout can be left constant.
Comment on lines
553
to
557
| connect_timeout=( | ||
| node["connect_timeout"] | ||
| if "connect_timeout" in node | ||
| else self.connect_timeout | ||
| ), |
There was a problem hiding this comment.
Suggested change
| connect_timeout=( | |
| node["connect_timeout"] | |
| if "connect_timeout" in node | |
| else self.connect_timeout | |
| ), | |
| connect_timeout=node.get("connect_timeout", self.connect_timeout), |
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
from
7cfc30f to
b276530
Compare
…er chooses the time to wait using the `connectTimeout` option. If the `retry` is enabled, the time to wait is increased at each attempt. Updated documentation checksum because the `connectTimeout` option was added in the `SSHConnector` schema
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
from
b276530 to
c47e722
Compare
GlassOfWhiskey
requested changes
Feb 8, 2025
| @@ -83,6 +83,7 @@ async def _get_connection( | |||
| port=port, | |||
| tunnel=await self._get_connection(config.tunnel), | |||
| username=config.username, | |||
| connect_timeout=config.connect_timeout * self.connection_attempts, | |||
There was a problem hiding this comment.
Suggested change
| connect_timeout=config.connect_timeout * self.connection_attempts, | |
| connect_timeout=config.connect_timeout, |
There was a problem hiding this comment.
I think the timeout can be left constant.
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
3 times, most recently
from
19062e9 to
6a46771
Compare
LanderOtto
force-pushed
the
feat/ssh-timeout
branch
from
6a46771 to
22aa629
Compare
GlassOfWhiskey
approved these changes
Feb 10, 2025
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.
This commit adds the timeout in the
asyncssh.connect()call. The user chooses the time to wait using theconnectTimeoutoption.Updated documentation checksum because the
connectTimeoutoption was added in theSSHConnectorschema