allow users to add description to private gateway

[charlesweng]

Description

Adding a description to the private gateway tab inside the Network > Vpc > Private Gateway tab. This allows for administrators to easily identify what the private gateway is used for or pertains to.

Backend functionality is also added into the NetworkVO as well as the API interface in java.

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

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

How Has This Been Tested?

This has been tested using a local machine on Ubuntu 22.04 with a simulator deployed. The project builds locally and the ui passes npm run test:unit.

[boring-cyborg]

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

• In case of a new feature add useful documentation (raise doc PR at https://github.com/apache/cloudstack-documentation)
• Be patient and persistent. It might take some time to get a review or get the final approval from the committers.
• Pay attention to the quality of your code, ensure tests are passing and your PR doesn't have conflicts.
• Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Issues, Mailing list and Slack.
• Be sure to read the CloudStack Coding Conventions.
  Apache CloudStack is a community-driven project and together we are making it better 🚀.
  In case of doubts contact the developers at:
  Mailing List: dev@cloudstack.apache.org (https://cloudstack.apache.org/mailing-lists.html)
  Slack: https://apachecloudstack.slack.com/

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 36 lines in your changes missing coverage. Please review.

Project coverage is 15.53%. Comparing base (5baac44) to head (22133d0).
Report is 15 commits behind head on main.

Files	Patch %	Lines
.../main/java/com/cloud/network/vpc/VpcGatewayVO.java	0.00%	8 Missing ⚠️
...src/main/java/com/cloud/network/dao/NetworkVO.java	0.00%	6 Missing ⚠️
...ain/java/com/cloud/network/vpc/VpcManagerImpl.java	0.00%	5 Missing ⚠️
...java/com/cloud/network/vpc/StaticRouteProfile.java	0.00%	4 Missing ⚠️
.../api/command/user/vpc/CreatePrivateGatewayCmd.java	0.00%	3 Missing ⚠️
...k/api/command/user/vpc/ListPrivateGatewaysCmd.java	0.00%	3 Missing ⚠️
...loudstack/api/response/PrivateGatewayResponse.java	0.00%	3 Missing ⚠️
...a/com/cloud/network/vpc/PrivateGatewayProfile.java	0.00%	3 Missing ⚠️
...src/main/java/com/cloud/api/ApiResponseHelper.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##               main    #9135    +/-   ##
==========================================
  Coverage     15.53%   15.53%            
- Complexity    11976    11979     +3     
==========================================
  Files          5496     5496            
  Lines        481335   481366    +31     
  Branches      58900    59768   +868     
==========================================
+ Hits          74783    74795    +12     
- Misses       398289   398303    +14     
- Partials       8263     8268     +5     

Flag	Coverage Δ
uitests	4.18% <ø> (ø)
unittests	16.31% <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.

[charlesweng]

closing, someone has already started working on this feature

[charlesweng]

Reopening - looking into this again.

[DaanHoogland]

@charlesweng , one question: in your description you speak about adding descriptions to Proutes, but in the code I only see the value object (VO) for network being changed. Can you explain what the plan is here, please?

[charlesweng]

@DaanHoogland thank you so much for responding. I added several changes in the commit - createprivatenetwork methods,*cmd.java, and many other classes. However, I may have missed something like you said. I will convert this pull request to draft and take a closer look and give you more screen shots!

[DaanHoogland]

@charlesweng , I reviewed your changes and am still a bit confused. The changes look good but they seem to add descriptions to VpcGateways and Networks but not to static routes. Is the ttile of the PR misleading or are you not done yet?

btw, you have a lint error because of an EOF not being preceeded by an EOL in the sql file.

[charlesweng]

@DaanHoogland will look into the lint errors in sql file and double check if description is needed in network, but VPCGateway description is definitely needed, thanks!

[DaanHoogland]

@DaanHoogland will look into the lint errors in sql file and double check if description is needed in network, but VPCGateway description is definitely needed, thanks!

Yes @charlesweng the VPCGateway looks good. What I wonder about is the mention of static routes in the description of this PR. I see no change for those.

[charlesweng]

@DaanHoogland took a look at the code and I think the title of the issue and the PR was misleading with the static routes as there are static routes in both the UI and the backend. Here is the change for static routes in the backend:

api/src/main/java/com/cloud/network/vpc/StaticRouteProfile.java

I still need to test and see if this branch works without UPDATE: planning to remove description in network classes only keeping in vpc classes

[DaanHoogland]

@DaanHoogland took a look at the code and I think the title of the issue and the PR was misleading with the static routes as there are static routes in both the UI and the backend. Here is the change for static routes in the backend:

api/src/main/java/com/cloud/network/vpc/StaticRouteProfile.java

I still need to test and see if this branch works without UPDATE: planning to remove description in network classes only keeping in vpc classes

thnx @charlesweng , I am marking this as draft untill you are done. You can mark it as ready at your will.