Changes error message when using invalid `endpoint.url` #8603

lucas-a-martins · 2024-02-02T18:06:06Z

Description

When validating the endpoint.url global setting, such as when using the createKubernetesCluster API, we encounter the exception message Global setting endpoint.url has to be set to the Management Server's API endpoint. This message lacks clarity about the problem to be solved and exposes information about the environment. Upon further analysis, it was found that this same message was used across several classes, repeating the same code in each one of them.

This pull request addresses this issue by replacing the exception with a generic one that does not expose any information about the environment. Also, it introduces a more detailed and explicit message to the logs, including the current value of endpoint.url. Furthermore, a new method has been implemented to validate the endpoint.url whenever necessary.

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?

I tested by using CloudMonkey and tried to create a Kubernetes cluster. I implemented unit tests for the new method too.

Exception before changes:

(lucas) :cat: > create kubernetescluster name=test description=test zoneid=0ea94256-6969-46a8-b02e-b1604c81dd01 kubernetesversionid=ea7dc03b-40d0-4cfe-9144-4a9044cf88bd serviceofferingid=3eb8e0f1-d909-4bfe-aa55-2b9329920349 size=1
:see_no_evil: Error: (HTTP 530, error code 9999) Global setting endpoint.url has to be set to the Management Server's API end point

Exception after changes:

New exception:

(lucas) :cat: > create kubernetescluster name=test description=test zoneid=0ea94256-6969-46a8-b02e-b1604c81dd01 kubernetesversionid=ea7dc03b-40d0-4cfe-9144-4a9044cf88bd serviceofferingid=3eb8e0f1-d909-4bfe-aa55-2b9329920349 size=1
:see_no_evil: Error: (HTTP 530, error code 9999) Unable to complete this operation. Contact your cloud admin.

New log:

2024-01-31 19:16:41,219 ERROR [o.a.c.c.ApiServiceConfiguration] (qtp775386112-17:ctx-ff635773 ctx-96fc2faf) (logid:a8dc806e) Global setting endpoint.url cannot contain localhost or be blank. Current value: http://localhost:8080/client/api

sureshanaparti · 2024-02-05T12:16:57Z

@blueorangutan package

codecov · 2024-02-05T12:17:46Z

Codecov Report

❌ Patch coverage is 52.94118% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.56%. Comparing base (b99a030) to head (aaabe66).

Files with missing lines	Patch %	Lines
...bernetes/cluster/KubernetesClusterManagerImpl.java	0.00%	3 Missing ⚠️
...che/cloudstack/config/ApiServiceConfiguration.java	80.00%	2 Missing ⚠️
...loud/network/lb/LoadBalancingRulesManagerImpl.java	0.00%	2 Missing ⚠️
...r/actionworkers/KubernetesClusterActionWorker.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8603      +/-   ##
============================================
- Coverage     17.56%   17.56%   -0.01%     
  Complexity    15500    15500              
============================================
  Files          5899     5899              
  Lines        527793   527793              
  Branches      64479    64477       -2     
============================================
- Hits          92714    92711       -3     
- Misses       424653   424659       +6     
+ Partials      10426    10423       -3

Flag	Coverage Δ
uitests	`3.59% <ø> (ø)`
unittests	`18.63% <52.94%> (-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.

weizhouapache · 2024-02-05T18:57:41Z

@blueorangutan package

blueorangutan · 2024-02-05T18:58:03Z

@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 · 2024-02-05T20:19:15Z

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

DaanHoogland · 2024-02-06T10:23:53Z

@blueorangutan test

blueorangutan · 2024-02-06T10:26:03Z

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

DaanHoogland

clgtm

weizhouapache

overall code lgtm
left 2 minor comments

api/src/main/java/org/apache/cloudstack/config/ApiServiceConfiguration.java

lucas-a-martins · 2024-02-06T19:04:14Z

@weizhouapache, thanks for your review. I've made changes to incorporate your suggestions in the latest commit (4cf74fc), so if you could provide another review, I would greatly appreciate it!

weizhouapache · 2024-02-06T19:18:56Z

@blueorangutan package

blueorangutan · 2024-02-06T19:20:03Z

@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.

weizhouapache · 2024-02-06T19:24:38Z

@weizhouapache, thanks you for your review. I've made changes to incorporate your suggestions in the latest commit (4cf74fc), so if you could provide another review, I would greatly appreciate it!

@lucas-a-martins
thanks for the update
Looks good

blueorangutan · 2024-02-06T20:21:15Z

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

blueorangutan · 2024-02-07T00:24:35Z

[SF] Trillian test result (tid-9096)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 48814 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8603-t9096-kvm-centos7.zip
Smoke tests completed. 122 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

JoaoJandre · 2024-02-08T14:14:10Z

Hey, @lucas-a-martins please change your logger imports to use log4j2

DaanHoogland · 2024-02-09T15:51:09Z

@lucas-a-martins do you want to target this for 4.20?

if so see Changes error message when using invalid endpoint.url #8603 (comment)
if no we can retarget it.

lucas-a-martins · 2024-02-09T17:36:04Z

@lucas-a-martins do you want to target this for 4.20?

@DaanHoogland I do. I'm just testing the code with log4j2.

api/src/main/java/org/apache/cloudstack/config/ApiServiceConfiguration.java

weizhouapache · 2024-02-16T18:04:23Z

@blueorangutan package

blueorangutan · 2024-02-16T18:06:03Z

@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 · 2024-02-16T19:15:06Z

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

DaanHoogland · 2024-02-19T09:25:48Z

@blueorangutan test

blueorangutan · 2024-02-19T09:26:03Z

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

blueorangutan · 2024-02-19T21:45:01Z

[SF] Trillian test result (tid-9288)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 42901 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8603-t9288-kvm-centos7.zip
Smoke tests completed. 129 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

DaanHoogland · 2025-10-10T08:22:13Z

@lucas-a-martins this was tested ok (#8603 (review)) and has enough reviews, but also conflicts. Can you resolve those?

…guration.java Co-authored-by: Daniel Augusto Veronezi Salvador <[email protected]>

erikbocks · 2025-10-10T12:46:25Z

@DaanHoogland I have rebased the branch and resolved the conflicts. Is there anything else that has to be done?

DaanHoogland · 2025-10-10T15:14:51Z

@DaanHoogland I have rebased the branch and resolved the conflicts. Is there anything else that has to be done?

I’ll rerun regression tests.

DaanHoogland · 2025-10-10T15:15:00Z

@blueorangutan package

blueorangutan · 2025-10-10T15:16: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 · 2025-10-10T17:30:21Z

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

blueorangutan · 2025-10-13T09:41:40Z

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

DaanHoogland · 2025-10-13T09:48:00Z

@blueorangutan test

blueorangutan · 2025-10-13T09:50:06Z

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

blueorangutan · 2025-10-13T10:25:32Z

[SF] Trillian Build Failed (tid-14647)

rosi-shapeblue · 2025-10-13T13:53:52Z

@blueorangutan test

blueorangutan · 2025-10-13T13:56:04Z

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

blueorangutan · 2025-10-14T06:54:07Z

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

Test	Result	Time (s)	Test File
test_02_enableHumanReadableLogs	`Error`	0.36	test_human_readable_logs.py

boring-cyborg bot added component:api component:kubernetes component:networking labels Feb 2, 2024

DaanHoogland approved these changes Feb 6, 2024

View reviewed changes

DaanHoogland added the status:needs-testing label Feb 6, 2024

weizhouapache reviewed Feb 6, 2024

View reviewed changes

api/src/main/java/org/apache/cloudstack/config/ApiServiceConfiguration.java Show resolved Hide resolved

api/src/main/java/org/apache/cloudstack/config/ApiServiceConfiguration.java Outdated Show resolved Hide resolved

rohityadavcloud added this to the 4.20.0.0 milestone Feb 13, 2024

GutoVeronezi reviewed Feb 15, 2024

View reviewed changes

api/src/main/java/org/apache/cloudstack/config/ApiServiceConfiguration.java Outdated Show resolved Hide resolved

rosi-shapeblue removed the status:needs-testing label Jul 31, 2025

weizhouapache modified the milestones: 4.21.0, 4.22.0 Aug 29, 2025

sureshanaparti added this to Apache CloudStack 4.22.0 Aug 29, 2025

sureshanaparti removed this from Apache CloudStack 4.21.0 Aug 29, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.0 Aug 29, 2025

lucas.martins.scclouds and others added 9 commits October 10, 2025 09:17

Fix validate endpoint url message

c60a59a

Fix message and log error

307b1c0

Using new get

b7af464

Implement unit tests

be294f1

Add license

51d38da

Add newline at end of file

711ee4f

Optimize imports and add containsAny (Wei suggestions)

f21b00d

Change to log4j2

035fbf4

Update api/src/main/java/org/apache/cloudstack/config/ApiServiceConfi…

aaabe66

…guration.java Co-authored-by: Daniel Augusto Veronezi Salvador <[email protected]>

erik-bock-silva force-pushed the fix-endpoint-url-message branch from 6b86329 to aaabe66 Compare October 10, 2025 12:40

github-actions bot removed the status:has-conflicts label Oct 10, 2025

Changes error message when using invalid endpoint.url #8603

Are you sure you want to change the base?

Changes error message when using invalid endpoint.url #8603

Uh oh!

Conversation

lucas-a-martins commented Feb 2, 2024

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

sureshanaparti commented Feb 5, 2024

Uh oh!

codecov bot commented Feb 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

weizhouapache commented Feb 5, 2024

Uh oh!

blueorangutan commented Feb 5, 2024

Uh oh!

blueorangutan commented Feb 5, 2024

Uh oh!

DaanHoogland commented Feb 6, 2024

Uh oh!

blueorangutan commented Feb 6, 2024

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lucas-a-martins commented Feb 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weizhouapache commented Feb 6, 2024

Uh oh!

blueorangutan commented Feb 6, 2024

Uh oh!

weizhouapache commented Feb 6, 2024

Uh oh!

blueorangutan commented Feb 6, 2024

Uh oh!

blueorangutan commented Feb 7, 2024

Uh oh!

JoaoJandre commented Feb 8, 2024

Uh oh!

DaanHoogland commented Feb 9, 2024

Uh oh!

lucas-a-martins commented Feb 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

weizhouapache commented Feb 16, 2024

Uh oh!

blueorangutan commented Feb 16, 2024

Uh oh!

blueorangutan commented Feb 16, 2024

Uh oh!

DaanHoogland commented Feb 19, 2024

Uh oh!

blueorangutan commented Feb 19, 2024

Uh oh!

blueorangutan commented Feb 19, 2024

Uh oh!

DaanHoogland commented Oct 10, 2025

Uh oh!

erikbocks commented Oct 10, 2025

Uh oh!

DaanHoogland commented Oct 10, 2025

Uh oh!

DaanHoogland commented Oct 10, 2025

Uh oh!

blueorangutan commented Oct 10, 2025

Changes error message when using invalid `endpoint.url` #8603

Changes error message when using invalid `endpoint.url` #8603

codecov bot commented Feb 5, 2024 •

edited

Loading

lucas-a-martins commented Feb 6, 2024 •

edited

Loading

lucas-a-martins commented Feb 9, 2024 •

edited

Loading