Avoid unnecessary SSH key regeneration in developer mode

[pavanaravapalli]

Description

This PR addresses an issue #12055 where SSH keys were being unnecessarily regenerated in developer mode even when valid keys already existed on disk.

When both the public and private key files are present at the expected file paths but missing from the database, CloudStack will now reuse the existing keys on disk instead of regenerating them. The existing keys are injected into the database, ensuring consistency without overwriting the developer’s configured keys.

Impact

Prevents loss of existing SSH keys in developer environments.
Ensures smoother setup by reusing valid keys already present on disk.
No impact on normal operation or production deployments.

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)
• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Enhancement (improves an existing feature and functionality)
• Cleanup (Code refactoring and cleanup, that may add test cases)
• Build/CI
• Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

• Major
• Minor

Bug Severity

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

How Has This Been Tested?

Verified behavior in developer mode with pre-existing SSH key files but no DB entries.
Confirmed that no new keys are generated and the existing keys are properly persisted in the database.

Before Fix

After Fix

How did you try to break this feature and the system with this change?

[DaanHoogland]

clgtm

[Copilot]

Pull Request Overview

This PR aims to fix unnecessary regeneration of SSH keys in developer mode when they already exist. The change adds a conditional check to skip key generation if the key files are already present on the filesystem.

• Adds file existence check before SSH key generation
• Targets developer mode to prevent overwriting existing SSH keys
• Reduces unnecessary file system operations during startup

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The condition !privkeyfile.exists() && !pubkeyfile.exists() uses AND logic, which will prevent SSH key generation if only one of the key files exists. This could leave the system in an inconsistent state. Consider using OR logic (||) instead, or check if BOTH files exist before skipping generation:

if (privkeyfile.exists() && pubkeyfile.exists()) {
    // Both keys exist, skip generation
} else {
    // At least one key is missing, regenerate both
    Script.runSimpleBashScript("if [ -f " + privkeyfile + " ]; then rm -f " + privkeyfile + "; fi; ssh-keygen -t ecdsa -m PEM -N '' -f " + privkeyfile + " -q 2>/dev/null || ssh-keygen -t ecdsa -N '' -f " + privkeyfile + " -q");
}

This ensures that both keys are always present and consistent when the code proceeds to read them at lines 628-638.

Suggested change

	if (!privkeyfile.exists() && !pubkeyfile.exists()) {
	if (!privkeyfile.exists() || !pubkeyfile.exists()) {

[codecov]

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.56%. Comparing base (5f9e131) to head (fac6a8e).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...java/com/cloud/server/ConfigurationServerImpl.java	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12059      +/-   ##
============================================
+ Coverage     17.55%   17.56%   +0.01%     
- Complexity    15537    15538       +1     
============================================
  Files          5910     5910              
  Lines        529336   529352      +16     
  Branches      64654    64656       +2     
============================================
+ Hits          92904    92977      +73     
+ Misses       425975   425917      -58     
- Partials      10457    10458       +1     

Flag	Coverage Δ
uitests	3.58% <ø> (ø)
unittests	18.63% <0.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.