pre-commit upgrade codespell and fix spelling

.github/linters/codespell.txt

@@ -35,6 +35,7 @@ aqcuire
 aqcuired
 aquire
 aquiring
+assertin
 assiciate
 assigne
 assoication
@@ -65,6 +66,7 @@ bject
 boardcast
 bootstraper
 bu
+callin
 cant
 capabilites
 capablity
@@ -73,6 +75,7 @@ carrefully
 cavaet
 chaing
 checkd
+checkin
 childs
 choosen
 chould
@@ -165,6 +168,7 @@ disover
 dissapper
 dissassociated
 divice
+dockin
 doesn'
 doesnot
 doesnt
@@ -195,6 +199,7 @@ excption
 excute
 execept
 execption
+exects
 execut
 executeable
 exeeded
@@ -237,6 +242,7 @@ hanling
 happend
 hasing
 hasnt
+havin
 hda
 hostanme
 hould
@@ -325,6 +331,7 @@ nin
 nodel
 nome
 noone
+notin
 nowe
 numbe
 numer
@@ -417,6 +424,7 @@ returing
 re-use
 rever
 rocessor
+roperty
 runing
 runnign
 sate
@@ -479,6 +487,7 @@ therefor
 theres
 theses
 thi
+thirdparty
 thorugh
 throught
 ths

.pre-commit-config.yaml

@@ -63,13 +63,22 @@ repos:
         args: [--markdown-linebreak-ext=md]
         exclude: ^services/console-proxy/rdpconsole/src/test/doc/freerdp-debug-log\.txt$
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
         name: run codespell
         description: Check spelling with codespell
         args: [--ignore-words=.github/linters/codespell.txt]
-        exclude: ^ui/package\.json$|^ui/package-lock\.json$|^ui/public/js/less\.min\.js$|^ui/public/locales/.*[^n].*\.json$
+        exclude: |
+          (?x)^(
+            systemvm/agent/noVNC/app/locale/.*\.json|
+            systemvm/agent/noVNC/po/.*|
+            tools/eclipse/eclipse.epf|
+            ui/package\.json|
+            ui/package-lock\.json|
+            ui/public/js/less\.min\.js|
+            ui/public/locales/.*[^n].*\.json
+          )$
   - repo: https://github.com/pycqa/flake8
     rev: 7.0.0
     hooks:

agent/src/main/java/com/cloud/agent/properties/AgentProperties.java

@@ -117,7 +117,7 @@ public class AgentProperties{
 
     /**
      * Local storage path.<br>
-     * This property allows multiple values to be entered in a single String. The differente values must be separated by commas.<br>
+     * This property allows multiple values to be entered in a single String. The different values must be separated by commas.<br>
      * Data type: String.<br>
      * Default value: <code>/var/lib/libvirt/images/</code>
      */
@@ -134,7 +134,7 @@ public class AgentProperties{
 
     /**
      * MANDATORY: The UUID for the local storage pool.<br>
-     * This property allows multiple values to be entered in a single String. The differente values must be separated by commas.<br>
+     * This property allows multiple values to be entered in a single String. The different values must be separated by commas.<br>
      * Data type: String.<br>
      * Default value: <code>null</code>
      */

api/src/main/java/com/cloud/storage/Storage.java

@@ -127,7 +127,7 @@ public static enum FileSystem {
     public static enum TemplateType {
         ROUTING, // Router template
         SYSTEM, /* routing, system vm template */
-        BUILTIN, /* buildin template */
+        BUILTIN, /* builtin template */
         PERHOST, /* every host has this template, don't need to install it in secondary storage */
         USER, /* User supplied template/iso */
         VNF,    /* VNFs (virtual network functions) template */

core/src/main/java/com/cloud/storage/resource/StorageProcessor.java

@@ -21,7 +21,7 @@
 
 import org.apache.cloudstack.agent.directdownload.DirectDownloadCommand;
 import org.apache.cloudstack.storage.command.AttachCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectCommand;
 import org.apache.cloudstack.storage.command.DeleteCommand;
@@ -82,7 +82,7 @@ public interface StorageProcessor {
 
     Answer copyVolumeFromPrimaryToPrimary(CopyCommand cmd);
 
-    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplainceCommand cmd);
+    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplianceCommand cmd);
 
     public Answer syncVolumePath(SyncVolumePathCommand cmd);
 }

core/src/main/java/com/cloud/storage/resource/StorageSubsystemCommandHandlerBase.java

@@ -21,7 +21,7 @@
 
 import org.apache.cloudstack.agent.directdownload.DirectDownloadCommand;
 import org.apache.cloudstack.storage.command.AttachCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectAnswer;
 import org.apache.cloudstack.storage.command.CreateObjectCommand;
@@ -79,8 +79,8 @@
             return processor.resignature((ResignatureCommand) command);
         } else if (command instanceof DirectDownloadCommand) {
             return processor.handleDownloadTemplateToPrimaryStorage((DirectDownloadCommand) command);
-        } else if (command instanceof CheckDataStoreStoragePolicyComplainceCommand) {
-            return processor.checkDataStoreStoragePolicyCompliance((CheckDataStoreStoragePolicyComplainceCommand) command);
+        } else if (command instanceof CheckDataStoreStoragePolicyComplianceCommand) {
+            return processor.checkDataStoreStoragePolicyCompliance((CheckDataStoreStoragePolicyComplianceCommand) command);
         } else if (command instanceof SyncVolumePathCommand) {
             return processor.syncVolumePath((SyncVolumePathCommand) command);
         } else if (command instanceof QuerySnapshotZoneCopyCommand) {

core/src/main/java/org/apache/cloudstack/storage/command/CheckDataStoreStoragePolicyComplainceCommand.java → core/src/main/java/org/apache/cloudstack/storage/command/CheckDataStoreStoragePolicyComplianceCommand.java

@@ -21,12 +21,12 @@
 
 import com.cloud.agent.api.to.StorageFilerTO;
 
-public class CheckDataStoreStoragePolicyComplainceCommand extends StorageSubSystemCommand {
+public class CheckDataStoreStoragePolicyComplianceCommand extends StorageSubSystemCommand {
 
     String storagePolicyId;
     private StorageFilerTO storagePool;
 
-    public CheckDataStoreStoragePolicyComplainceCommand(String storagePolicyId, StorageFilerTO storagePool) {
+    public CheckDataStoreStoragePolicyComplianceCommand(String storagePolicyId, StorageFilerTO storagePool) {
         super();
 
         this.storagePolicyId = storagePolicyId;

engine/components-api/src/main/java/com/cloud/storage/StorageManager.java

@@ -222,7 +222,7 @@ public interface StorageManager extends StorageService {
 
     /**
      * should we execute in sequence not involving any storages?
-     * @return tru if commands should execute in sequence
+     * @return true if commands should execute in sequence
      */
     static boolean shouldExecuteInSequenceOnVmware() {
         return shouldExecuteInSequenceOnVmware(null, null);

engine/components-api/src/main/java/com/cloud/vm/snapshot/VMSnapshotManager.java

@@ -42,7 +42,7 @@ public interface VMSnapshotManager extends VMSnapshotService, Manager {
     boolean deleteAllVMSnapshots(long id, VMSnapshot.Type type);
 
     /**
-     * Sync VM snapshot state when VM snapshot in reverting or snapshoting or expunging state
+     * Sync VM snapshot state when VM snapshot in reverting or snapshotting or expunging state
      * Used for fullsync after agent connects
      *
      * @param vm, the VM in question

engine/storage/src/main/java/org/apache/cloudstack/storage/allocator/AbstractStoragePoolAllocator.java

@@ -356,7 +356,7 @@
                     return false;
                 }
             } catch (StorageUnavailableException e) {
-                logger.warn(String.format("Could not verify storage policy complaince against storage pool %s due to exception %s", pool.getUuid(), e.getMessage()));
+                logger.warn(String.format("Could not verify storage policy compliance against storage pool %s due to exception %s", pool.getUuid(), e.getMessage()));
                 return false;
             }
         }

plugins/hypervisors/hyperv/DotNet/ServerResource/WmiWrappers/ROOT.virtualization.v2.Msvm_EthernetSwitchPort.cs

@@ -1267,8 +1267,8 @@ public bool IsVMQOffloadUsageNull {
 
         [Browsable(true)]
         [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
-        [Description("The current VMQ offloading usage on this port. The usage is the amount of VMQ res" +
-            "ources in use on the port.")]
+        [Description("The current VMQ offloading usage on this port. The usage is the amount of VMQ " +
+            "resources in use on the port.")]
         [TypeConverter(typeof(WMIValueTypeConverter))]
         public uint VMQOffloadUsage {
             get {

plugins/hypervisors/hyperv/DotNet/ServerResource/WmiWrappers/ROOT.virtualization.v2.Msvm_ExternalEthernetPort.cs

@@ -618,10 +618,9 @@ public bool IsIsBoundNull {
 
         [Browsable(true)]
         [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
-        [Description("If this property is true, then this Ethernet port can be connected to the switche" +
-            "s and thus can provide connectivity to virtual machine. If this property is fals" +
-            "e, then this Ethernet is not being used by the virtual machine networking archit" +
-            "ecture.")]
+        [Description("If this property is true, then this Ethernet port can be connected to the switches" +
+            " and thus can provide connectivity to virtual machine. If this property is false" +
+            ", then this Ethernet is not being used by the virtual machine networking architecture.")]
         [TypeConverter(typeof(WMIValueTypeConverter))]
         public bool IsBound {
             get {

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/storage/KVMStorageProcessor.java

@@ -50,7 +50,7 @@
 import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotInfo;
 import org.apache.cloudstack.storage.command.AttachAnswer;
 import org.apache.cloudstack.storage.command.AttachCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.CopyCmdAnswer;
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectAnswer;
@@ -2629,8 +2629,8 @@
     }
 
     @Override
-    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplainceCommand cmd) {
-        logger.info("'CheckDataStoreStoragePolicyComplainceCommand' not currently applicable for KVMStorageProcessor");
+    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplianceCommand cmd) {
+        logger.info("'CheckDataStoreStoragePolicyComplianceCommand' not currently applicable for KVMStorageProcessor");
         return new Answer(cmd,false,"Not currently applicable for KVMStorageProcessor");
     }
 

plugins/hypervisors/ovm3/src/main/java/com/cloud/hypervisor/ovm3/resources/Ovm3StorageProcessor.java

@@ -24,7 +24,7 @@
 import org.apache.cloudstack.agent.directdownload.DirectDownloadCommand;
 import org.apache.cloudstack.storage.command.AttachAnswer;
 import org.apache.cloudstack.storage.command.AttachCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.CopyCmdAnswer;
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectAnswer;
@@ -830,8 +830,8 @@
     }
 
     @Override
-    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplainceCommand cmd) {
-        logger.info("'CheckDataStoreStoragePolicyComplainceCommand' not applicable used for Ovm3StorageProcessor");
+    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplianceCommand cmd) {
+        logger.info("'CheckDataStoreStoragePolicyComplianceCommand' not applicable used for Ovm3StorageProcessor");
         return new Answer(cmd,false,"Not applicable used for Ovm3StorageProcessor");
     }
 

plugins/hypervisors/simulator/src/main/java/com/cloud/resource/SimulatorStorageProcessor.java

@@ -32,7 +32,7 @@
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectAnswer;
 import org.apache.cloudstack.storage.command.CreateObjectCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.DeleteCommand;
 import org.apache.cloudstack.storage.command.DettachAnswer;
 import org.apache.cloudstack.storage.command.DettachCommand;
@@ -274,7 +274,7 @@ public Answer copyVolumeFromPrimaryToPrimary(CopyCommand cmd) {
     }
 
     @Override
-    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplainceCommand cmd) {
+    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplianceCommand cmd) {
         return new Answer(cmd, true, null);
     }
 

plugins/hypervisors/vmware/src/main/java/com/cloud/hypervisor/vmware/manager/VmwareManagerImpl.java

@@ -62,7 +62,7 @@
 import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
 import org.apache.cloudstack.framework.jobs.impl.AsyncJobManagerImpl;
 import org.apache.cloudstack.management.ManagementServerHost;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao;
 import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;
 import org.apache.cloudstack.utils.identity.ManagementServerNode;
@@ -1572,7 +1572,7 @@
                 continue;
             }
             Collections.shuffle(hostIds);
-            CheckDataStoreStoragePolicyComplainceCommand command = new CheckDataStoreStoragePolicyComplainceCommand(storagePolicy.getPolicyId(), storageFilerTO);
+            CheckDataStoreStoragePolicyComplianceCommand command = new CheckDataStoreStoragePolicyComplianceCommand(storagePolicy.getPolicyId(), storageFilerTO);
             long targetHostId = hypervisorGuruManager.getGuruProcessedCommandTargetHost(hostIds.get(0), command);
             try {
                 Answer answer = _agentMgr.send(targetHostId, command);

plugins/hypervisors/vmware/src/main/java/com/cloud/hypervisor/vmware/resource/VmwareResource.java

@@ -4522,7 +4522,7 @@
                     vmMo.mountToolsInstaller();
                     logger.debug(String.format("Successfully re-mounted vmware tools installer for :[%s].", cmd.getVmName()));
                 } catch (Exception e) {
-                    logger.error(String.format("Unabled to re-mount vmware tools installer for: [%s].", cmd.getVmName()), e);
+                    logger.error(String.format("Unable to re-mount vmware tools installer for: [%s].", cmd.getVmName()), e);
                 }
             }
         }
@@ -6977,7 +6977,7 @@
         if (s_serviceContext.get() != null) {
             context = s_serviceContext.get();
             String poolKey = VmwareContextPool.composePoolKey(_vCenterAddress, _username);
-            // Before re-using the thread local context, ensure it corresponds to the right vCenter API session and that it is valid to make calls.
+            // Before reusing the thread local context, ensure it corresponds to the right vCenter API session and that it is valid to make calls.
             if (context.getPoolKey().equals(poolKey)) {
                 if (context.validate()) {
                     if (logger.isTraceEnabled()) {

plugins/hypervisors/vmware/src/main/java/com/cloud/storage/resource/VmwareStorageProcessor.java

@@ -37,7 +37,7 @@
 import org.apache.cloudstack.agent.directdownload.DirectDownloadCommand;
 import org.apache.cloudstack.storage.command.AttachAnswer;
 import org.apache.cloudstack.storage.command.AttachCommand;
-import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplainceCommand;
+import org.apache.cloudstack.storage.command.CheckDataStoreStoragePolicyComplianceCommand;
 import org.apache.cloudstack.storage.command.CopyCmdAnswer;
 import org.apache.cloudstack.storage.command.CopyCommand;
 import org.apache.cloudstack.storage.command.CreateObjectAnswer;
@@ -997,11 +997,11 @@
                                                           long wait, String nfsVersion) throws Exception {
         String volumeFolder;
         String volumeName;
-        String sufix = ".ova";
+        String suffix = ".ova";
         int index = srcVolumePath.lastIndexOf(File.separator);
-        if (srcVolumePath.endsWith(sufix)) {
+        if (srcVolumePath.endsWith(suffix)) {
             volumeFolder = srcVolumePath.substring(0, index);
-            volumeName = srcVolumePath.substring(index + 1).replace(sufix, "");
+            volumeName = srcVolumePath.substring(index + 1).replace(suffix, "");
         } else {
             volumeFolder = srcVolumePath;
             volumeName = srcVolumePath.substring(index + 1);
@@ -3775,7 +3775,7 @@
     }
 
     @Override
-    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplainceCommand cmd) {
+    public Answer checkDataStoreStoragePolicyCompliance(CheckDataStoreStoragePolicyComplianceCommand cmd) {
         String primaryStorageNameLabel = cmd.getStoragePool().getUuid();
         String storagePolicyId = cmd.getStoragePolicyId();
         VmwareContext context = hostService.getServiceContext(cmd);
@@ -3789,16 +3789,16 @@
             }
 
             DatastoreMO primaryDsMo = new DatastoreMO(hyperHost.getContext(), morPrimaryDs);
-            boolean isDatastoreStoragePolicyComplaint = primaryDsMo.isDatastoreStoragePolicyComplaint(storagePolicyId);
+            boolean isDatastoreStoragePolicyCompliant = primaryDsMo.isDatastoreStoragePolicyCompliant(storagePolicyId);
 
-            String failedMessage = String.format("DataStore %s is not complaince with storage policy id %s", primaryStorageNameLabel, storagePolicyId);
-            if (!isDatastoreStoragePolicyComplaint)
-                return new Answer(cmd, isDatastoreStoragePolicyComplaint, failedMessage);
+            String failedMessage = String.format("DataStore %s is not compliant with storage policy id %s", primaryStorageNameLabel, storagePolicyId);
+            if (!isDatastoreStoragePolicyCompliant)
+                return new Answer(cmd, isDatastoreStoragePolicyCompliant, failedMessage);
             else
-                return new Answer(cmd, isDatastoreStoragePolicyComplaint, null);
+                return new Answer(cmd, isDatastoreStoragePolicyCompliant, null);
         } catch (Throwable e) {
             hostService.createLogMessageException(e, cmd);
-            String details = String.format("Exception while checking if datastore [%s] is storage policy [%s] complaince due to: [%s]", primaryStorageNameLabel, storagePolicyId, VmwareHelper.getExceptionMessage(e));
+            String details = String.format("Exception while checking if datastore [%s] is storage policy [%s] compliant due to: [%s]", primaryStorageNameLabel, storagePolicyId, VmwareHelper.getExceptionMessage(e));
             return new Answer(cmd, false, details);
         }
     }

plugins/hypervisors/xenserver/src/main/java/com/cloud/hypervisor/xenserver/resource/CitrixResourceBase.java

@@ -3770,7 +3770,7 @@ protected List<SR> getAllLocalSrForType(Connection conn, SRType srType) throws X
                 Host host = pbd.getHost(conn);
                 if (!isRefNull(host) && StringUtils.equals(host.getUuid(conn), _host.getUuid())) {
                     if (!pbd.getCurrentlyAttached(conn)) {
-                        logger.debug(String.format("PBD [%s] of local SR [%s] was unplugged, pluggin it now", pbd.getUuid(conn), srRec.uuid));
+                        logger.debug(String.format("PBD [%s] of local SR [%s] was unplugged, plugging it in now", pbd.getUuid(conn), srRec.uuid));
                         pbd.plug(conn);
                     }
                     logger.debug("Scanning local SR: " + srRec.uuid);