Fix grammar, spelling, word casing, whitespace #9132

jbampton · 2024-05-28T11:08:33Z

Description

This PR cleans up the code base and standardizes some terms for casing.

Fixes in exception messages, log messages, code comments and more.

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

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 · 2024-05-28T11:17:22Z

Codecov Report

❌ Patch coverage is 6.25000% with 30 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.46%. Comparing base (f417c6b) to head (25603ee).
⚠️ Report is 44 commits behind head on main.

Files with missing lines	Patch %	Lines
...stack/engine/orchestration/VolumeOrchestrator.java	0.00%	2 Missing ⚠️
...command/admin/internallb/StartInternalLBVMCmd.java	0.00%	1 Missing ⚠️
.../command/admin/internallb/StopInternalLBVMCmd.java	0.00%	1 Missing ⚠️
...api/command/admin/systemvm/DestroySystemVmCmd.java	0.00%	1 Missing ⚠️
.../api/command/admin/systemvm/RebootSystemVmCmd.java	0.00%	1 Missing ⚠️
...k/api/command/admin/systemvm/ScaleSystemVMCmd.java	0.00%	1 Missing ⚠️
...k/api/command/admin/systemvm/StartSystemVMCmd.java	0.00%	1 Missing ⚠️
...ck/api/command/admin/systemvm/StopSystemVmCmd.java	0.00%	1 Missing ⚠️
...api/command/admin/systemvm/UpgradeSystemVMCmd.java	0.00%	1 Missing ⚠️
.../cloudstack/api/command/admin/vm/ExpungeVMCmd.java	0.00%	1 Missing ⚠️
... and 19 more

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #9132   +/-   ##
=========================================
  Coverage     17.46%   17.46%           
  Complexity    15516    15516           
=========================================
  Files          5913     5913           
  Lines        529385   529385           
  Branches      64679    64679           
=========================================
+ Hits          92448    92450    +2     
+ Misses       426518   426517    -1     
+ Partials      10419    10418    -1

Flag	Coverage Δ
uitests	`3.58% <ø> (ø)`
unittests	`18.52% <6.25%> (+<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.

DaanHoogland

I immagine I missed a few, and in dutch (intended mistake) these would be considered shouting, but for consistency some sugestions...

api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java

...rail/src/main/java/org/apache/cloudstack/network/contrail/management/ServiceManagerImpl.java

plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java

server/src/main/java/com/cloud/network/NetworkServiceImpl.java

server/src/test/java/com/cloud/vm/UserVmManagerTest.java

github-actions · 2024-06-14T08:31:38Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

…ployVMCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Co-authored-by: dahn <daan.hoogland@gmail.com>

…ache/cloudstack/network/contrail/management/ServiceManagerImpl.java Co-authored-by: dahn <daan.hoogland@gmail.com>

…/commands/StopNetScalerVMCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Co-authored-by: dahn <daan.hoogland@gmail.com>

FelipeM525 · 2024-08-02T13:36:48Z

...rail/src/main/java/org/apache/cloudstack/network/contrail/management/ServiceManagerImpl.java

            throw new CloudRuntimeException("Insufficient capacity", ex);
        }
-        CallContext.current().setEventDetails("Vm Id: " + svm.getId());
+        CallContext.current().setEventDetails("VM ID: " + svm.getId());


Suggested change

CallContext.current().setEventDetails("VM ID: " + svm.getId());

CallContext.current().setEventDetails("VM Id: " + svm.getId());

@FelipeM525 , 'ID' is an acronym for 'identification' according to english rules it should be capatalised. Am I correct @jbampton ?

@DaanHoogland

I agree with capitalizing both letters, but, regardless of what convention we use (both capitalized or not), there should be a convention. Currently, this PR, that has a focus on fixing word casing inconsistencies, is doing the opposite, by changing some instances of Id to ID and leaving others as they are. Either all instances of the word in this PR should be ID or all should be Id.

well, agree to disagree. I am happy to conform to conventions, but these are completely unnecessary and gratuit. I am leaving this with the embedded English speaker(s) ;)

server/src/test/java/com/cloud/vm/UserVmManagerTest.java

plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java

jbampton · 2024-10-14T15:35:27Z

@blueorangutan package

blueorangutan · 2024-10-14T15:36:03Z

@jbampton 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 · 2024-10-14T16:39:47Z

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

DaanHoogland · 2024-10-23T11:58:46Z

@blueorangutan package

blueorangutan · 2024-10-23T12:00:04Z

@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 · 2024-10-23T12:49:42Z

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

tools/git/git-pr

github-actions · 2024-12-20T13:39:36Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

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

blueorangutan · 2025-09-18T22:07:10Z

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

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	`Failure`	1.17	test_kubernetes_clusters.py
test_04_autoscale_kubernetes_cluster	`Failure`	35.05	test_kubernetes_clusters.py

DaanHoogland · 2025-09-19T12:58:52Z

@daviftorres , you are right, but I think we should merge and create new PRs for any remaining issues. This has been suffering scope creep a lot so far and isn’t functionally crippled.
cc @JoaoJandre @harikrishna-patnala

github-actions · 2025-10-07T14:57:13Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

DaanHoogland · 2025-10-13T08:21:20Z

@FelipeM525 @JoaoJandre please have another look

Co-authored-by: Davi Torres <90287660+daviftorres@users.noreply.github.com>

DaanHoogland · 2025-12-12T10:19:54Z

I think we can go through with this now, further improvements can be done in separate PRs

JoaoJandre · 2025-12-12T11:11:56Z

api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java

    @Override
    public void execute() throws ConcurrentOperationException, ResourceUnavailableException {
-        CallContext.current().setEventDetails("Internal lb vm Id: " + getId());
+        CallContext.current().setEventDetails("Internal lb VM Id: " + getId());


Suggested change

CallContext.current().setEventDetails("Internal lb VM Id: " + getId());

CallContext.current().setEventDetails("Internal lb VM ID: " + getId());

JoaoJandre · 2025-12-12T11:12:03Z

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/DestroySystemVmCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

JoaoJandre · 2025-12-12T11:12:13Z

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/RebootSystemVmCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

JoaoJandre · 2025-12-12T11:12:20Z

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("SystemVm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("SystemVM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("SystemVM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("SystemVM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

JoaoJandre · 2025-12-12T11:12:28Z

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StartSystemVMCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

JoaoJandre · 2025-12-12T11:13:59Z

api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java

        UserVm result;

-        CallContext.current().setEventDetails("Vm Id: " + getEntityUuid());
+        CallContext.current().setEventDetails("VM Id: " + getEntityUuid());


Suggested change

CallContext.current().setEventDetails("VM Id: " + getEntityUuid());

CallContext.current().setEventDetails("VM ID: " + getEntityUuid());

JoaoJandre · 2025-12-12T11:14:04Z

api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId()) + " Network Id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId()) + " Network Id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId()) + " Network Id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId()) + " Network Id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()));

JoaoJandre · 2025-12-12T11:14:10Z

api/src/main/java/org/apache/cloudstack/api/command/user/iso/AttachIsoCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + getVirtualMachineId() + " ISO ID: " + getId());
+        CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " ISO ID: " + getId());


Suggested change

CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " ISO ID: " + getId());

CallContext.current().setEventDetails("VM ID: " + getVirtualMachineId() + " ISO ID: " + getId());

JoaoJandre · 2025-12-12T11:14:16Z

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ExpungeVMCmd.java

    @Override
    public void execute() throws ResourceUnavailableException, ConcurrentOperationException {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

JoaoJandre · 2025-12-12T11:14:21Z

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java

    @Override
    public void execute() {
-        CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+        CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));


Suggested change

CallContext.current().setEventDetails("VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

CallContext.current().setEventDetails("VM ID: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));

jbampton · 2025-12-12T11:24:47Z

@JoaoJandre shall we keep building for another 1.5 years and keep fixing conflicts and adding more commits and doing more reviews with further nits ? We already have 500 open issues and 200 open PRs that are not merged.

Constantly adding more is scope creep. Big PRs are harder to review and test.

JoaoJandre · 2025-12-15T11:20:07Z

@jbampton, the PR description states that: "This PR cleans up the code base and standardizes some terms for casing."

On line 106 of api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java, you changed "Vm Id" to "VM ID". However, on the rest of the changes, you changed "Vm Id" to "VM Id". This inconsistency was brough up over a year ago and still was not changed. I am not scope creeping the PR, I have only asked for a single change, one that keeps the PR consistent.

Furthermore, this PR could have been merged over a year ago, but you waited more than year to comment. The change I am asking is simple, and has been the same from the very start. You have no right to complain about the delay on the PR.

github-actions · 2025-12-22T13:28:17Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

Fix grammar, spelling, word casing, whitespace

b28eccb

boring-cyborg bot added component:api component:database component:networking component:orchestration labels May 28, 2024

DaanHoogland reviewed May 28, 2024

View reviewed changes

github-actions bot added the status:has-conflicts label Jun 14, 2024

jbampton and others added 7 commits July 10, 2024 21:05

Update api/src/main/java/org/apache/cloudstack/api/command/user/vm/De…

3574cdc

…ployVMCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Update api/src/main/java/org/apache/cloudstack/api/command/user/vm/De…

fba6bf5

…ployVMCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Update server/src/main/java/com/cloud/network/NetworkServiceImpl.java

287b40f

Co-authored-by: dahn <daan.hoogland@gmail.com>

Update server/src/test/java/com/cloud/vm/UserVmManagerTest.java

79a8b92

Co-authored-by: dahn <daan.hoogland@gmail.com>

Update plugins/network-elements/juniper-contrail/src/main/java/org/ap…

8ac51b7

…ache/cloudstack/network/contrail/management/ServiceManagerImpl.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Update plugins/network-elements/netscaler/src/main/java/com/cloud/api…

0c81a31

…/commands/StopNetScalerVMCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com>

Update server/src/test/java/com/cloud/vm/UserVmManagerTest.java

177d355

Co-authored-by: dahn <daan.hoogland@gmail.com>

FelipeM525 suggested changes Aug 2, 2024

View reviewed changes

jbampton marked this pull request as draft October 14, 2024 12:46

Merge branch 'main' into fix-spelling-grammar-case-whitespace

f104bd5

github-actions bot removed the status:has-conflicts label Oct 14, 2024

DaanHoogland reviewed Oct 24, 2024

View reviewed changes

tools/git/git-pr Show resolved Hide resolved

github-actions bot added the status:has-conflicts label Dec 20, 2024

Merge branch 'main' into fix-spelling-grammar-case-whitespace

403b87d

jbampton marked this pull request as ready for review September 18, 2025 11:39

daviftorres reviewed Sep 18, 2025

View reviewed changes