Fix terms, typos and grammar mistakes in the API, error messages, events, etc. (apache#7857)

This PR aligns the use of terminology, renaming VM / virtual machine references to 'Instance' and also capitalising the terms Templates, Network, Snapshot, User, Account in CloudStack APIs, error and log messages, events, tooltips, etc. Many typos, grammar and spelling mistakes were fixed, also terms like IPv4, VPN, VPC, etc. were properly capitalised. Some error messages were cleaned for better readability. The test cases, expecting some exception strings were adjusted accordingly.

Here is the wiki page, describing the changes in details:
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Object+Naming+and+Title+Case+Convention

---------

Co-authored-by: Manoj Kumar <manojkr.itbhu@gmail.com>
Co-authored-by: Harikrishna <harikrishna.patnala@gmail.com>

Author: 3 people

agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java

@@ -175,12 +175,12 @@ private Answer executeProxyLoadScan(final Command cmd, final long proxyVmId, fin
                 try {
                     is.close();
                 } catch (final IOException e) {
-                    logger.warn("Exception when closing , console proxy address : {}", proxyManagementIp);
+                    logger.warn("Exception when closing , console proxy address: {}", proxyManagementIp);
                     success = false;
                 }
             }
         } catch (final IOException e) {
-            logger.warn("Unable to open console proxy command port url, console proxy address : {}", proxyManagementIp);
+            logger.warn("Unable to open console proxy command port url, console proxy address: {}", proxyManagementIp);
             success = false;
         }
 

api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java

@@ -277,8 +277,8 @@ private DatadiskTO generateDiskTO(OVFFile file, OVFDisk disk, String ovfParentPa
         if (StringUtils.isNotBlank(path)) {
             File f = new File(path);
             if (!f.exists() || f.isDirectory()) {
-                logger.error("One of the attached disk or iso does not exists {}", path);
-                throw new InternalErrorException("One of the attached disk or iso as stated on OVF does not exists " + path);
+                logger.error("One of the attached disk or ISO does not exists " + path);
+                throw new InternalErrorException("One of the attached disk or ISO as stated on OVF does not exists " + path);
             }
         }
         Long capacity = disk != null ? disk._capacity : file._size;
@@ -333,7 +333,9 @@ protected List<OVFDisk> extractDisksFromOvfDocumentTree(Document doc) {
             od._controller = getControllerType(items, od._diskId);
             vd.add(od);
         }
-        logger.trace("Found {} disk definitions", vd.size());
+        if (logger.isTraceEnabled()) {
+            logger.trace(String.format("Found %d disk definitions", vd.size()));
+        }
         return vd;
     }
 
@@ -363,7 +365,9 @@ protected List<OVFFile> extractFilesFromOvfDocumentTree(File ovfFile, Document d
                 vf.add(of);
             }
         }
-        logger.trace("Found {} file definitions in {}", vf.size(), ovfFile.getPath());
+        if (logger.isTraceEnabled()) {
+            logger.trace(String.format("Found %d file definitions in %s", vf.size(), ovfFile.getPath()));
+        }
         return vf;
     }
 
@@ -517,7 +521,9 @@ OVFFile getFileDefinitionFromDiskDefinition(String fileRef, List<OVFFile> files)
 
     public List<OVFNetworkTO> getNetPrerequisitesFromDocument(Document doc) throws InternalErrorException {
         if (doc == null) {
-            logger.trace("No document to parse; returning no prerequisite networks");
+            if (logger.isTraceEnabled()) {
+                logger.trace("No document to parse; returning no prerequisite Networks");
+            }
             return Collections.emptyList();
         }
 
@@ -533,15 +539,19 @@ public List<OVFNetworkTO> getNetPrerequisitesFromDocument(Document doc) throws I
     private void matchNicsToNets(Map<String, OVFNetworkTO> nets, Node systemElement) {
         final DocumentTraversal traversal = (DocumentTraversal) systemElement;
         final NodeIterator iterator = traversal.createNodeIterator(systemElement, NodeFilter.SHOW_ELEMENT, null, true);
-        logger.trace("Starting out with {} network-prerequisites, parsing hardware", nets.size());
+        if (logger.isTraceEnabled()) {
+            logger.trace(String.format("Starting out with %d network-prerequisites, parsing hardware",nets.size()));
+        }
         int nicCount = 0;
         for (Node n = iterator.nextNode(); n != null; n = iterator.nextNode()) {
             final Element e = (Element) n;
             if ("rasd:Connection".equals(e.getTagName())) {
                 nicCount++;
                 String name = e.getTextContent(); // should be in our nets
                 if(nets.get(name) == null) {
-                    logger.info("Found a nic definition without a network definition by name {}, adding it to the list.", name);
+                    if(logger.isInfoEnabled()) {
+                        logger.info(String.format("Found a NIC definition without a Network definition by name %s, adding it to the list.", name));
+                    }
                     nets.put(name, new OVFNetworkTO());
                 }
                 OVFNetworkTO thisNet = nets.get(name);
@@ -550,7 +560,9 @@ private void matchNicsToNets(Map<String, OVFNetworkTO> nets, Node systemElement)
                 }
             }
         }
-        logger.trace("Ending up with {} network-prerequisites, parsed {} nics", nets.size(), nicCount);
+        if (logger.isTraceEnabled()) {
+            logger.trace(String.format("Ending up with %d network-prerequisites, parsed %d NICs", nets.size(), nicCount));
+        }
     }
 
     /**
@@ -617,7 +629,9 @@ private Map<String, OVFNetworkTO> getNetworksFromDocumentTree(Document doc) {
 
             nets.put(networkName,network);
         }
-        logger.trace("Found {} networks in template", nets.size());
+        if (logger.isTraceEnabled()) {
+            logger.trace(String.format("Found %d Networks in Template", nets.size()));
+        }
         return nets;
     }
 

api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java

@@ -35,10 +35,10 @@ public class ListRecurringSnapshotScheduleCmd extends BaseListCmd {
     //////////////// API parameters /////////////////////
     /////////////////////////////////////////////////////
 
-    @Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "lists recurring snapshots by snapshot policy ID")
+    @Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "Lists recurring Snapshots by Snapshot policy ID")
     private Long snapshotPolicyId;
 
-    @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "list recurring snapshots by volume ID")
+    @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "List recurring Snapshots by volume ID")
     private Long volumeId;
 
     /////////////////////////////////////////////////////

api/src/main/java/com/cloud/network/Ipv6Service.java

@@ -45,7 +45,7 @@ public interface Ipv6Service extends PluggableService, Configurable {
     static final ConfigKey<Boolean> Ipv6OfferingCreationEnabled = new ConfigKey<Boolean>("Advanced", Boolean.class,
             "ipv6.offering.enabled",
             "false",
-            "Indicates whether creation of IPv6 network/VPC offering is enabled or not.",
+            "Indicates whether creation of IPv6 Network/VPC offering is enabled or not.",
             true);
 
     static final ConfigKey<Integer> Ipv6PrefixSubnetCleanupInterval = new ConfigKey<Integer>("Advanced", Integer.class,

api/src/main/java/com/cloud/network/Network.java

@@ -325,9 +325,9 @@ enum Event {
 
     public enum State {
 
-        Allocated("Indicates the network configuration is in allocated but not setup"), Setup("Indicates the network configuration is setup"), Implementing(
-                "Indicates the network configuration is being implemented"), Implemented("Indicates the network configuration is in use"), Shutdown(
-                "Indicates the network configuration is being destroyed"), Destroy("Indicates that the network is destroyed");
+        Allocated("Indicates the Network configuration is in allocated but not setup"), Setup("Indicates the Network configuration is setup"), Implementing(
+                "Indicates the Network configuration is being implemented"), Implemented("Indicates the Network configuration is in use"), Shutdown(
+                "Indicates the Network configuration is being destroyed"), Destroy("Indicates that the Network is destroyed");
 
         protected static final StateMachine2<State, Network.Event, Network> s_fsm = new StateMachine2<State, Network.Event, Network>();
 

api/src/main/java/com/cloud/network/NetworkService.java

@@ -81,7 +81,7 @@ public interface NetworkService {
             true, ConfigKey.Scope.Zone);
 
     public static final ConfigKey<Boolean> AllowUsersToSpecifyVRMtu = new ConfigKey<>("Advanced", Boolean.class,
-            "allow.end.users.to.specify.vr.mtu", "false", "Allow end users to specify VR MTU",
+            "allow.end.users.to.specify.vr.mtu", "false", "Allow end Users to specify VR MTU",
             true, ConfigKey.Scope.Zone);
 
     List<? extends Network> getIsolatedNetworksOwnedByAccountInZone(long zoneId, Account owner);

api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java

@@ -43,7 +43,7 @@ public static State fromValue(String state) {
             } else if (state.equalsIgnoreCase("scaling")) {
                 return SCALING;
             } else {
-                throw new IllegalArgumentException("Unexpected AutoScale VM group state : " + state);
+                throw new IllegalArgumentException("Unexpected AutoScale Instance group state : " + state);
             }
         }
     }

api/src/main/java/com/cloud/user/ResourceLimitService.java

@@ -34,7 +34,7 @@
 public interface ResourceLimitService {
 
     static final ConfigKey<Long> MaxAccountSecondaryStorage = new ConfigKey<>("Account Defaults", Long.class, "max.account.secondary.storage", "400",
-            "The default maximum secondary storage space (in GiB) that can be used for an account", false);
+            "The default maximum secondary storage space (in GiB) that can be used for an Account", false);
     static final ConfigKey<Long> MaxProjectSecondaryStorage = new ConfigKey<>("Project Defaults", Long.class, "max.project.secondary.storage", "400",
             "The default maximum secondary storage space (in GiB) that can be used for a project", false);
     static final ConfigKey<Long> ResourceCountCheckInterval = new ConfigKey<>("Advanced", Long.class, "resourcecount.check.interval", "300",

api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java

@@ -29,10 +29,9 @@
 public interface VMSnapshot extends ControlledEntity, Identity, InternalIdentity, StateObject<VMSnapshot.State> {
 
     enum State {
-        Allocated("The VM snapshot is allocated but has not been created yet."), Creating("The VM snapshot is being created."), Ready(
-                "The VM snapshot is ready to be used."), Reverting("The VM snapshot is being used to revert"), Expunging("The volume is being expunging"), Removed(
-                "The volume is destroyed, and can't be recovered."), Error("The volume is in error state, and can't be recovered"),
-        Hidden("The VM snapshot is hidden from the user and cannot be recovered.");
+        Allocated("The Instance Snapshot is allocated but has not been created yet."), Creating("The Instance Snapshot is being created."), Ready(
+                "The Instance Snapshot is ready to be used."), Reverting("The Instance Snapshot is being used to revert"), Expunging("The volume is being expunging"), Removed(
+                "The volume is destroyed, and can't be recovered."), Error("The volume is in error state, and can't be recovered");
 
         String _description;
 

api/src/main/java/org/apache/cloudstack/acl/RoleType.java

@@ -132,10 +132,10 @@ public static Set<RoleType> fromCombinedMask(int combinedMask) {
      * */
     public static Account.Type getAccountTypeByRole(final Role role, final Account.Type defautAccountType) {
         if (role != null) {
-            LOGGER.debug("Role [{}] is not null; therefore, we use its account type [{}].", role, defautAccountType);
+            LOGGER.debug(String.format("Role [%s] is not null; therefore, we use its Account type [%s].", role, defautAccountType));
             return role.getRoleType().getAccountType();
         }
-        LOGGER.debug("Role is null; therefore, we use the default account type [{}] value.", defautAccountType);
+        LOGGER.debug(String.format("Role is null; therefore, we use the default Account type [%s] value.", defautAccountType));
         return defautAccountType;
     }
 }