[14.0][FIX] cetmix_tower_server: Connection test

[ivs-cetmix]

Fix connection test function.

Summary by CodeRabbit

• Bug Fixes
  • Enhanced SSH connection handling for improved reliability and error reporting.
  • Streamlined connection method for better resource management.
  • Updated return values for connection results to reflect new success/error indicators.
  • Improved error handling with more granular control over connection testing.
• New Features
  • Introduced new parameters for SSH connection methods to enhance configurability.
  • Updated command execution methods to utilize the new SSH client handling approach.

[coderabbitai]

Walkthrough

The pull request introduces significant changes to the SSH connection handling in the CetmixTower and CxTowerServer classes. In CetmixTower, the server_check_ssh_connection method has been updated to include new parameters and altered logic for establishing connections. The SSH_CONNECTION_TIMEOUT constant has been removed from constants.py. In CxTowerServer, the _connect method has been replaced with _get_ssh_client, and the test_ssh_connection method has been refactored to improve error handling and flexibility. Additionally, updates have been made to related test methods and wizards.

Changes

File	Change Summary
cetmix_tower_server/models/cetmix_tower.py	Updated server_check_ssh_connection method signature and logic, removing timeout, adding wait_time, try_command, and try_file, and changing return structure to "exit_code".
cetmix_tower_server/models/constants.py	Removed constant SSH_CONNECTION_TIMEOUT = 408.
cetmix_tower_server/models/cx_tower_server.py	Replaced _connect method with _get_ssh_client with new parameters, refactored test_ssh_connection method to include additional parameters, and updated file handling methods to use the new SSH client method. Introduced new constant SSH_CONNECTION_ERROR.
cetmix_tower_server/tests/common.py	Renamed _connect_patch to _get_ssh_client_patch and updated references accordingly.
cetmix_tower_server/wizards/cx_tower_command_execute_wizard.py	Changed method call from server._connect to server._get_ssh_client in execute_command_in_wizard.

Possibly related PRs

• [14.0][IMP] server_check_ssh_connection: Implement SSH connection check #174: The main PR modifies the server_check_ssh_connection method in the CetmixTower class, while PR [14.0][IMP] server_check_ssh_connection: Implement SSH connection check #174 introduces a new server_check_ssh_connection method in the same class, indicating a direct relationship in terms of functionality and method signature changes.

Suggested labels

bot is merging ⏳, approved

Suggested reviewers

• Aldeigja

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35e41f4 and dc699df.

📒 Files selected for processing (2)

• cetmix_tower_server/tests/common.py (2 hunks)
• cetmix_tower_server/wizards/cx_tower_command_execute_wizard.py (1 hunks)

🔇 Additional comments (2)

cetmix_tower_server/wizards/cx_tower_command_execute_wizard.py (1)

249-249: LGTM! Method update aligns with SSH connection handling refactor.

The change from _connect to _get_ssh_client maintains the same error handling behavior while improving the clarity of the method's purpose.

Let's verify that all usages of the old method have been updated:

✅ Verification successful

Verified: SSH connection handling refactor is correctly implemented

The change from _connect to _get_ssh_client is correct. The old _connect method still exists and serves internal purposes, while _get_ssh_client is the proper public interface with enhanced error handling and configuration options.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining instances of the old _connect method
rg "_connect\(" --type py

Length of output: 254

---

Script:

#!/bin/bash
# Get the context around _connect method and its usages
rg "_connect" -B 3 -A 3 cetmix_tower_server/models/cx_tower_server.py

# Check implementation of _get_ssh_client
ast-grep --pattern 'def _get_ssh_client($$$) { $$$ }'

Length of output: 5613

---

Script:

#!/bin/bash
# Get the implementation of _get_ssh_client method
rg -B 3 -A 10 "def _get_ssh_client" cetmix_tower_server/models/cx_tower_server.py

Length of output: 594

---

Script:

#!/bin/bash
# Get more context around _get_ssh_client implementation
rg -B 3 -A 30 "def _get_ssh_client" cetmix_tower_server/models/cx_tower_server.py

Length of output: 1291

cetmix_tower_server/tests/common.py (1)

219-219: LGTM! Test mocks updated consistently with SSH connection refactor.

The changes maintain test coverage while aligning with the new SSH connection handling approach:

1. Mock method renamed from _connect_patch to _get_ssh_client_patch
2. Patch and revert method calls updated accordingly

Also applies to: 291-291, 298-298

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55e350c and ddea565.

📒 Files selected for processing (3)

• cetmix_tower_server/models/cetmix_tower.py (3 hunks)
• cetmix_tower_server/models/constants.py (0 hunks)
• cetmix_tower_server/models/cx_tower_server.py (8 hunks)

💤 Files with no reviewable changes (1)

• cetmix_tower_server/models/constants.py

🧰 Additional context used

📓 Learnings (1)

cetmix_tower_server/models/cetmix_tower.py (3)

Learnt from: nikola-vlavceski-solisa
PR: cetmix/cetmix-tower#174
File: cetmix_tower_server/models/cetmix_tower.py:108-108
Timestamp: 2025-01-08T08:47:55.632Z
Learning: The `server_check_ssh_connection` method in `cetmix_tower_server/models/cetmix_tower.py` is implemented with safe defaults (attempts=5, timeout=15) and adequate error handling, making additional parameter validation unnecessary.

Learnt from: ivs-cetmix
PR: cetmix/cetmix-tower#174
File: cetmix_tower_server/models/cetmix_tower.py:130-132
Timestamp: 2025-01-06T12:28:58.379Z
Learning: SSH credentials (username, password, and/or key) are controlled at the server level, so an additional validation in the `server_check_ssh_connection` method is not needed.

Learnt from: nikola-vlavceski-solisa
PR: cetmix/cetmix-tower#174
File: cetmix_tower_server/models/cetmix_tower.py:108-181
Timestamp: 2025-01-08T08:40:36.555Z
Learning: For the `server_check_ssh_connection` function in the CetmixTower class, focusing on critical test scenarios is considered sufficient, without the need for exhaustive testing of all possible authentication modes and error scenarios.

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test with OCB

🔇 Additional comments (1)

cetmix_tower_server/models/cetmix_tower.py (1)

Line range hint 109-167: LGTM: Updated server_check_ssh_connection method enhances functionality.

The modifications introduce additional parameters like wait_time, try_command, and try_file, providing more flexibility and control over SSH connection testing. The changes align with previous learnings and improve the robustness of the method.

[ivs-cetmix]

/ocabot rebase

[CetmixGitDrone]

@ivs-cetmix The rebase process failed, because command git rebase origin/14.0-dev failed with output:

Rebasing (1/6)
Rebasing (2/6)
Rebasing (3/6)
Rebasing (4/6)
Auto-merging cetmix_tower_server/models/cetmix_tower.py
CONFLICT (content): Merge conflict in cetmix_tower_server/models/cetmix_tower.py
error: could not apply 55e350c... [FIX] cetmix_tower_server: Connection test
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply 55e350c... [FIX] cetmix_tower_server: Connection test

[GabbasovDinar]

LGTM