CSTACKEX-46 added valiodation for lun name

Author: Gupta, Surya

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/driver/OntapPrimaryDatastoreDriver.java

@@ -107,11 +107,15 @@ public void createAsync(DataStore dataStore, DataObject dataObject, AsyncComplet
         if (callback == null) {
             throw new InvalidParameterValueException("createAsync: callback should not be null");
         }
+        if(!isValidName(dataObject.getName())) {
+            errMsg = "createAsync: Invalid dataObject name [" + dataObject.getName() + "]. It must start with a letter and can only contain letters, digits, and underscores, and be up to 200 characters long.";
+            s_logger.error(errMsg);
+            throw new InvalidParameterValueException(errMsg);
+        }
         try {
             s_logger.info("createAsync: Started for data store name [{}] and data object name [{}] of type [{}]", dataStore.getName(), dataObject.getName(), dataObject.getType());
-
             StoragePoolVO storagePool = storagePoolDao.findById(dataStore.getId());
-            if(storagePool == null) {
+            if (storagePool == null) {
                 s_logger.error("createCloudStackVolume : Storage Pool not found for id: " + dataStore.getId());
                 throw new CloudRuntimeException("createCloudStackVolume : Storage Pool not found for id: " + dataStore.getId());
             }
@@ -133,6 +137,16 @@ public void createAsync(DataStore dataStore, DataObject dataObject, AsyncComplet
         }
     }
 
+    public  boolean isValidName(String name) {
+        // Check for null and length constraint first
+        if (name == null || name.length() > 200) {
+            return false;
+        }
+        // Regex: Starts with a letter, followed by letters, digits, or underscores
+        String regex = "^[a-zA-Z][a-zA-Z0-9_]*$";
+        return name.matches(regex);
+    }
+
     private String createCloudStackVolumeForTypeVolume(StoragePoolVO storagePool, VolumeInfo volumeInfo) {
         Map<String, String> details = storagePoolDetailsDao.listDetailsKeyPairs(storagePool.getId());
         StorageStrategy storageStrategy = Utility.getStrategyByStoragePoolDetails(details);
@@ -218,7 +232,7 @@ public boolean grantAccess(DataObject dataObject, Host host, DataStore dataStore
         }
         try {
             StoragePoolVO storagePool = storagePoolDao.findById(dataStore.getId());
-            if(storagePool == null) {
+            if (storagePool == null) {
                 s_logger.error("grantAccess : Storage Pool not found for id: " + dataStore.getId());
                 throw new CloudRuntimeException("grantAccess : Storage Pool not found for id: " + dataStore.getId());
             }
@@ -229,7 +243,7 @@ public boolean grantAccess(DataObject dataObject, Host host, DataStore dataStore
 
             if (dataObject.getType() == DataObjectType.VOLUME) {
                 VolumeVO volumeVO = volumeDao.findById(dataObject.getId());
-                if(volumeVO == null) {
+                if (volumeVO == null) {
                     s_logger.error("grantAccess : Cloud Stack Volume not found for id: " + dataObject.getId());
                     throw new CloudRuntimeException("grantAccess : Cloud Stack Volume not found for id: " + dataObject.getId());
                 }
@@ -252,12 +266,12 @@ private void grantAccessForVolume(StoragePoolVO storagePool, VolumeVO volumeVO,
         //TODO- verify scopeId DatacenterId is zoneId
         long scopeId = (storagePool.getScope() == ScopeType.CLUSTER) ? host.getClusterId() : host.getDataCenterId();
 
-        if(ProtocolType.ISCSI.name().equalsIgnoreCase(details.get(Constants.PROTOCOL))) {
+        if (ProtocolType.ISCSI.name().equalsIgnoreCase(details.get(Constants.PROTOCOL))) {
             String accessGroupName = Utility.getIgroupName(svmName, scopeId);
             CloudStackVolume cloudStackVolume = getCloudStackVolumeByName(storageStrategy, svmName, volumeVO.getPath());
             s_logger.info("grantAccessForVolume: Retrieved LUN [{}] details for volume [{}]", cloudStackVolume.getLun().getName(), volumeVO.getName());
             AccessGroup accessGroup = getAccessGroupByName(storageStrategy, svmName, accessGroupName);
-            if(!hostInitiatorFoundInIgroup(host.getStorageUrl(), accessGroup.getIgroup())) {
+            if (!hostInitiatorFoundInIgroup(host.getStorageUrl(), accessGroup.getIgroup())) {
                 s_logger.error("grantAccess: initiator [{}] is not present in iGroup [{}]", host.getStorageUrl(), accessGroupName);
                 throw new CloudRuntimeException("grantAccess: initiator [" + host.getStorageUrl() + "] is not present in iGroup [" + accessGroupName + "]");
             }
@@ -297,7 +311,7 @@ public void revokeAccess(DataObject dataObject, Host host, DataStore dataStore)
         }
         try {
             StoragePoolVO storagePool = storagePoolDao.findById(dataStore.getId());
-            if(storagePool == null) {
+            if (storagePool == null) {
                 s_logger.error("revokeAccess : Storage Pool not found for id: " + dataStore.getId());
                 throw new CloudRuntimeException("revokeAccess : Storage Pool not found for id: " + dataStore.getId());
             }
@@ -308,7 +322,7 @@ public void revokeAccess(DataObject dataObject, Host host, DataStore dataStore)
 
             if (dataObject.getType() == DataObjectType.VOLUME) {
                 VolumeVO volumeVO = volumeDao.findById(dataObject.getId());
-                if(volumeVO == null) {
+                if (volumeVO == null) {
                     s_logger.error("revokeAccess : Cloud Stack Volume not found for id: " + dataObject.getId());
                     throw new CloudRuntimeException("revokeAccess : Cloud Stack Volume not found for id: " + dataObject.getId());
                 }
@@ -329,12 +343,12 @@ private void revokeAccessForVolume(StoragePoolVO storagePool, VolumeVO volumeVO,
         String svmName = details.get(Constants.SVM_NAME);
         long scopeId = (storagePool.getScope() == ScopeType.CLUSTER) ? host.getClusterId() : host.getDataCenterId();
 
-        if(ProtocolType.ISCSI.name().equalsIgnoreCase(details.get(Constants.PROTOCOL))) {
+        if (ProtocolType.ISCSI.name().equalsIgnoreCase(details.get(Constants.PROTOCOL))) {
             String accessGroupName = Utility.getIgroupName(svmName, scopeId);
             CloudStackVolume cloudStackVolume = getCloudStackVolumeByName(storageStrategy, svmName, volumeVO.getPath());
             AccessGroup accessGroup = getAccessGroupByName(storageStrategy, svmName, accessGroupName);
             //TODO check if initiator does exits in igroup, will throw the error ?
-            if(!hostInitiatorFoundInIgroup(host.getStorageUrl(), accessGroup.getIgroup())) {
+            if (!hostInitiatorFoundInIgroup(host.getStorageUrl(), accessGroup.getIgroup())) {
                 s_logger.error("revokeAccessForVolume: initiator [{}] is not present in iGroup [{}]", host.getStorageUrl(), accessGroupName);
                 return;
             }
@@ -352,7 +366,7 @@ private CloudStackVolume getCloudStackVolumeByName(StorageStrategy storageStrate
         getCloudStackVolumeMap.put(Constants.NAME, cloudStackVolumeName);
         getCloudStackVolumeMap.put(Constants.SVM_DOT_NAME, svmName);
         CloudStackVolume cloudStackVolume = storageStrategy.getCloudStackVolume(getCloudStackVolumeMap);
-        if(cloudStackVolume == null || cloudStackVolume.getLun() == null || cloudStackVolume.getLun().getName() == null) {
+        if (cloudStackVolume == null || cloudStackVolume.getLun() == null || cloudStackVolume.getLun().getName() == null) {
             s_logger.error("getCloudStackVolumeByName: Failed to get LUN details [{}]", cloudStackVolumeName);
             throw new CloudRuntimeException("getCloudStackVolumeByName: Failed to get LUN [" + cloudStackVolumeName + "]");
         }

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/lifecycle/OntapPrimaryDatastoreLifecycle.java

@@ -261,7 +261,7 @@ public boolean attachCluster(DataStore dataStore, ClusterScope scope) {
         }
         List<String> hostsIdentifier = new ArrayList<>();
         StoragePoolVO storagePool = storagePoolDao.findById(dataStore.getId());
-        if(storagePool == null) {
+        if (storagePool == null) {
             s_logger.error("attachCluster : Storage Pool not found for id: " + dataStore.getId());
             throw new CloudRuntimeException("attachCluster : Storage Pool not found for id: " + dataStore.getId());
         }
@@ -317,7 +317,7 @@ public boolean attachZone(DataStore dataStore, ZoneScope scope, Hypervisor.Hyper
         }
         List<String> hostsIdentifier = new ArrayList<>();
         StoragePoolVO storagePool = storagePoolDao.findById(dataStore.getId());
-        if(storagePool == null) {
+        if (storagePool == null) {
             s_logger.error("attachZone : Storage Pool not found for id: " + dataStore.getId());
             throw new CloudRuntimeException("attachZone : Storage Pool not found for id: " + dataStore.getId());
         }

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/service/UnifiedSANStrategy.java

@@ -212,7 +212,6 @@ public AccessGroup getAccessGroup(Map<String, String> values) {
     public void enableLogicalAccess(Map<String, String> values) {
         s_logger.info("enableLogicalAccess : Create LunMap");
         s_logger.debug("enableLogicalAccess : Creating LunMap with values {} ", values);
-        LunMap lunMapRequest = new LunMap();
         String svmName = values.get(Constants.SVM_DOT_NAME);
         String lunName = values.get(Constants.LUN_DOT_NAME);
         String igroupName = values.get(Constants.IGROUP_DOT_NAME);
@@ -224,6 +223,10 @@ public void enableLogicalAccess(Map<String, String> values) {
             // Get AuthHeader
             String authHeader = Utility.generateAuthHeader(storage.getUsername(), storage.getPassword());
             // Create LunMap
+            LunMap lunMapRequest = new LunMap();
+            lunMapRequest.getSvm().setName(svmName);
+            lunMapRequest.getLun().setName(lunName);
+            lunMapRequest.getIgroup().setName(igroupName);
             OntapResponse<LunMap> createdLunMap = sanFeignClient.createLunMap(authHeader, true, lunMapRequest);
             if (createdLunMap == null || createdLunMap.getRecords() == null || createdLunMap.getRecords().size() == 0) {
                 s_logger.error("enableLogicalAccess: LunMap failed for Lun: {} and igroup: {}", lunName, igroupName);
@@ -233,7 +236,7 @@ public void enableLogicalAccess(Map<String, String> values) {
             s_logger.debug("enableLogicalAccess: LunMap created successfully, LunMap: {}", lunMap);
             s_logger.info("enableLogicalAccess: LunMap created successfully.");
         } catch (Exception e) {
-            s_logger.error("Exception occurred while creating LunMap: {}, Exception: {}", e.getMessage(), e);
+            s_logger.error("Exception occurred while creating LunMap, Exception: {}", e);
             throw new CloudRuntimeException("Failed to create LunMap: " + e.getMessage());
         }
     }
@@ -254,7 +257,7 @@ public void disableLogicalAccess(Map<String, String> values) {
             sanFeignClient.deleteLunMap(authHeader, lunUUID, igroupUUID);
             s_logger.info("disableLogicalAccess: LunMap deleted successfully.");
         } catch (Exception e) {
-            s_logger.error("Exception occurred while deleting LunMap: {}, Exception: {}", e.getMessage(), e);
+            s_logger.error("Exception occurred while deleting LunMap, Exception: {}", e);
             throw new CloudRuntimeException("Failed to delete LunMap: " + e.getMessage());
         }
     }