make sure virtual machine params exist by DaanHoogland · Pull Request #12771 · apache/cloudstack

DaanHoogland · 2026-03-09T11:49:52Z

Description

This PR...

Fixes: #11941

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

Screenshots (if appropriate):

How Has This Been Tested?

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

codecov · 2026-03-09T11:58:16Z

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.61%. Comparing base (5caf6cd) to head (242b743).
⚠️ Report is 17 commits behind head on 4.22.

Files with missing lines	Patch %	Lines
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.22   #12771   +/-   ##
=========================================
  Coverage     17.60%   17.61%           
- Complexity    15659    15665    +6     
=========================================
  Files          5917     5917           
  Lines        531394   531395    +1     
  Branches      64970    64967    -3     
=========================================
+ Hits          93575    93595   +20     
+ Misses       427269   427245   -24     
- Partials      10550    10555    +5

Flag	Coverage Δ
uitests	`3.70% <ø> (-0.01%)`	⬇️
unittests	`18.68% <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.

Copilot

Pull request overview

This PR aims to ensure the VM start/deploy parameter map is always initialized (non-null) during UserVmManagerImpl.startVirtualMachine, addressing failures when parameters are expected to exist (notably in password-enabled template flows, per #11941).

Changes:

Initialize params as a new HashMap<> instead of null when starting a VM.

Comments suppressed due to low confidence (2)

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java:5803

Initializing params as an empty HashMap changes behavior: createParameterInParameterMap only copies parameterMap (i.e., additionalParams) into params when params == null. With this change, when vm.isUpdateParameters() is true, params will end up containing only the explicitly added entries (e.g., VmPassword), and will no longer include other additionalParams such as UEFI boot options (UefiFlag/BootType/BootMode) or ConsiderLastHost, which are expected downstream (e.g., logged/used during start). Consider initializing params as a copy of additionalParams (or adjusting createParameterInParameterMap to always merge parameterMap) so all start parameters are preserved while still guaranteeing params is non-null.

        // Set parameters
        Map<VirtualMachineProfile.Param, Object> params = new HashMap<>();
        if (vm.isUpdateParameters()) {
            _vmDao.loadDetails(vm);

            String password = getCurrentVmPasswordOrDefineNewPassword(String.valueOf(additionalParams.getOrDefault(VirtualMachineProfile.Param.VmPassword, "")), vm, template);

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java:5803

This change alters how the start parameter map is built; please add/adjust a unit test to assert the returned params is non-null and still includes entries from additionalParams (e.g., UEFI/boot mode params or ConsiderLastHost) when vm.isUpdateParameters() is true, to prevent regressions in the start/deploy flow.

        // Set parameters
        Map<VirtualMachineProfile.Param, Object> params = new HashMap<>();
        if (vm.isUpdateParameters()) {
            _vmDao.loadDetails(vm);

            String password = getCurrentVmPasswordOrDefineNewPassword(String.valueOf(additionalParams.getOrDefault(VirtualMachineProfile.Param.VmPassword, "")), vm, template);

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

weizhouapache

code lgtm

DaanHoogland · 2026-03-09T14:51:25Z

@blueorangutan package

blueorangutan · 2026-03-09T14:52:05Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-09T15:48:15Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✖️ debian ✔️ suse15. SL-JID 17046

weizhouapache · 2026-03-09T15:59:48Z

@blueorangutan package

blueorangutan · 2026-03-09T16:02:05Z

@weizhouapache a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-09T17:23:52Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17051

weizhouapache · 2026-03-09T18:16:25Z

@blueorangutan test

blueorangutan · 2026-03-09T18:18:03Z

@weizhouapache a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2026-03-10T09:22:43Z

[SF] Trillian test result (tid-15583)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 51642 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12771-t15583-kvm-ol8.zip
Smoke tests completed. 146 look OK, 3 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.11	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	3.73	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	46.37	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	46.38	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	27.24	test_snapshots.py
test_01_snapshot_usage	`Error`	25.61	test_usage.py
test_01_vpn_usage	`Error`	1.08	test_usage.py

kiranchavala

@DaanHoogland the issue is still present

Create a vm from a password enabled template (
Log in successfully with password set by cloudstack
Take a backup of the vm
Launch a vm from the back up in the same network or another network
Unable to login to the vm with password from step 2

sureshanaparti · 2026-03-12T06:29:26Z

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java

+    /**
+     * Create or overwrite a parameter in the list
+     * @param params the list of parameters
+     * @param parameter the parameter to creat/overwrite


Suggested change

* @param parameter the parameter to creat/overwrite

* @param parameter the parameter to create/overwrite

weizhouapache · 2026-03-12T07:38:45Z

@DaanHoogland the issue is still present

Create a vm from a password enabled template (

Log in successfully with password set by cloudstack

Take a backup of the vm

Launch a vm from the back up in the same network or another network

Unable to login to the vm with password from step 2

thanks @kiranchavala

it looks like the original issue (null pointer exception in #11941) has been fixed. now the issue is that the vm password has been changed.

I am ok that the password is reset for the new VM created from backup if the template is password enabled, similar to reinstalling VM which reset vm password too. but we need to display the password in the API response and on UI.

should ACS create the vm with a new password, or keep the original password from backup ?
what are your opinions @DaanHoogland @abh1sar @shwstppr @kiranchavala @yadvr ?

kiranchavala · 2026-03-12T10:59:07Z

@DaanHoogland the issue is still present

Create a vm from a password enabled template (

Log in successfully with password set by cloudstack

Take a backup of the vm

Launch a vm from the back up in the same network or another network

Unable to login to the vm with password from step 2

thanks @kiranchavala

it looks like the original issue (null pointer exception in #11941) has been fixed. now the issue is that the vm password has been changed.

I am ok that the password is reset for the new VM created from backup if the template is password enabled, similar to reinstalling VM which reset vm password too. but we need to display the password in the API response and on UI.

should ACS create the vm with a new password, or keep the original password from backup ? what are your opinions @DaanHoogland @abh1sar @shwstppr @kiranchavala @yadvr ?

I am fine with any of the options

Keeping the same password for the vm created from backup
Or generating a new password for the vm created from backup

make sure virtual machine params exist

ffa8928

DaanHoogland changed the base branch from main to 4.22 March 9, 2026 11:50

DaanHoogland added this to the 4.22.1 milestone Mar 9, 2026

DaanHoogland requested review from Copilot and weizhouapache March 9, 2026 11:53

Copilot started reviewing on behalf of DaanHoogland March 9, 2026 11:54 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

cleanup

242b743

weizhouapache approved these changes Mar 9, 2026

View reviewed changes

DaanHoogland added status:needs-testing ready-for-testing labels Mar 10, 2026

kiranchavala self-assigned this Mar 10, 2026

kiranchavala reviewed Mar 12, 2026

View reviewed changes

kiranchavala added status:needs-testing and removed status:needs-testing ready-for-testing labels Mar 12, 2026

sureshanaparti reviewed Mar 12, 2026

View reviewed changes

	* @param parameter the parameter to creat/overwrite
	* @param parameter the parameter to create/overwrite

Conversation

DaanHoogland commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

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

Uh oh!

codecov bot commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 9, 2026

Uh oh!

weizhouapache commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 9, 2026

Uh oh!

weizhouapache commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 9, 2026

Uh oh!

blueorangutan commented Mar 10, 2026

Uh oh!

kiranchavala left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Mar 12, 2026

Uh oh!

kiranchavala commented Mar 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

DaanHoogland commented Mar 9, 2026 •

edited

Loading

codecov bot commented Mar 9, 2026 •

edited

Loading