[CSTACKEX-204] Added Pool Status and config description change

Author: Gupta, Surya

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/asup/OntapAsupManager.java

@@ -328,7 +328,7 @@ private String buildHeartbeatDescription(String cloudStackVersion, String ontapV
      * mapping, disk usage, and snapshot telemetry into a single EMS message.
      *
      * <p>Example: {@code {"message":"CloudStack storage pool backed by ONTAP volume",
-     * "poolName":"...","protocol":"nfs","clusterUuid":"...","svm":"...",
+     * "poolName":"...","poolStatus":"Up","protocol":"nfs","clusterUuid":"...","svm":"...",
      * "ontapVolumeUuid":"...","rootDiskCount":12,"dataDiskCount":18,
      * "totalLogicalSizeBytes":322122547200,"multiPrimaryStoragePoolVm":false,
      * "volumeSnapshotCount":5,"vmSnapshotCount":3}}</p>
@@ -338,6 +338,8 @@ private String buildPoolDescription(StoragePoolVO pool, Map<String, String> deta
         Map<String, Object> payload = new LinkedHashMap<>();
         payload.put(OntapStorageConstants.ASUP_MESSAGE, OntapStorageConstants.ASUP_POOL_MESSAGE);
         payload.put(OntapStorageConstants.ASUP_POOL_NAME, defaultUnknown(pool.getName()));
+        payload.put(OntapStorageConstants.ASUP_POOL_STATUS,
+                pool.getStatus() == null ? OntapStorageConstants.ASUP_UNKNOWN : pool.getStatus().toString());
         payload.put(OntapStorageConstants.ASUP_PROTOCOL, defaultUnknown(details.get(OntapStorageConstants.PROTOCOL)));
         payload.put(OntapStorageConstants.ASUP_CLUSTER_UUID, defaultUnknown(clusterUuid));
         payload.put(OntapStorageConstants.ASUP_SVM, defaultUnknown(details.get(OntapStorageConstants.SVM_NAME)));

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/utils/OntapStorageConstants.java

@@ -145,6 +145,7 @@ public class OntapStorageConstants {
     public static final String ASUP_HEARTBEAT_MESSAGE = "CloudStack connected to Unified ONTAP cluster";
     public static final String ASUP_POOL_MESSAGE = "CloudStack storage pool backed by Unified ONTAP volume";
     public static final String ASUP_POOL_NAME = "poolName";
+    public static final String ASUP_POOL_STATUS = "poolStatus";
     public static final String ASUP_PROTOCOL = "protocol";
     public static final String ASUP_SVM = "svm";
     public static final String ASUP_ONTAP_VOLUME_UUID = "ontapVolumeUuid";
@@ -177,15 +178,12 @@ public class OntapStorageConstants {
      */
     public static final int ASUP_POLL_CHECK_INTERVAL_SECONDS = 7200; // 2 hours
 
-    private static final String ASUP_CONFIG_APPLY_NOTE =
-            "Takes effect immediately; no management server restart required.";
-
-    public static final String ASUP_ENABLED_DESCRIPTION = "Enable periodic ASUP (AutoSupport) telemetry push from the "
-            + "CloudStack ONTAP plugin to the ONTAP cluster. Set to true to enable or false to disable. "
-            + ASUP_CONFIG_APPLY_NOTE;
+    public static final String ASUP_ENABLED_DESCRIPTION =
+            "Set to true to enable telemetry reporting from the CloudStack ONTAP plugin, or false to disable it. "
+                    + "Changes take effect immediately and do not require a management server restart.";
     public static final String ASUP_INTERVAL_DESCRIPTION = String.format(
-            "Interval (in seconds) between periodic ASUP telemetry pushes from the CloudStack ONTAP plugin. "
-                    + "Allowed range: %d-%d. Default: %d. %s",
-            ASUP_MIN_INTERVAL_SECONDS, ASUP_MAX_INTERVAL_SECONDS, ASUP_DEFAULT_INTERVAL_SECONDS,
-            ASUP_CONFIG_APPLY_NOTE);
+            "Set the telemetry reporting interval for the CloudStack ONTAP plugin. "
+                    + "Valid values range from %d (3 hours) to %d (24 hours). Default: %d (12 hours). "
+                    + "Changes take effect immediately and do not require a management server restart.",
+            ASUP_MIN_INTERVAL_SECONDS, ASUP_MAX_INTERVAL_SECONDS, ASUP_DEFAULT_INTERVAL_SECONDS);
 }

plugins/storage/volume/ontap/src/test/java/org/apache/cloudstack/storage/asup/OntapAsupManagerTest.java

@@ -24,6 +24,7 @@
 import com.cloud.server.ManagementService;
 import com.cloud.storage.Snapshot;
 import com.cloud.storage.SnapshotVO;
+import com.cloud.storage.StoragePoolStatus;
 import com.cloud.storage.Volume;
 import com.cloud.storage.VolumeVO;
 import com.cloud.storage.dao.SnapshotDao;
@@ -104,6 +105,7 @@ void setUp() {
         pool = mock(StoragePoolVO.class);
         lenient().when(pool.getId()).thenReturn(1L);
         lenient().when(pool.getName()).thenReturn("ontap-pool-1");
+        lenient().when(pool.getStatus()).thenReturn(StoragePoolStatus.Up);
 
         poolDetails = new HashMap<>();
         poolDetails.put(OntapStorageConstants.STORAGE_IP, "192.168.1.10");
@@ -226,12 +228,30 @@ void poolMessage_containsPoolNameClusterUuidAndSnapshotKeys() {
 
         String desc = capturePoolMessage();
         assertTrue(desc.contains("ontap-pool-1"),          "should contain pool name");
+        assertTrue(desc.contains("\"poolStatus\":\"Up\""), "should contain pool status");
         assertTrue(desc.contains("cluster-uuid-1"),        "should contain cluster UUID");
         assertTrue(desc.contains("volumeSnapshotCount"), "should contain volumeSnapshotCount");
         assertTrue(desc.contains("vmSnapshotCount"),       "should contain vmSnapshotCount");
         assertTrue(desc.contains("\"multiPrimaryStoragePoolVm\":false"), "desc=" + desc);
     }
 
+    @Test
+    void poolMessage_includesMaintenanceStatus() {
+        when(pool.getStatus()).thenReturn(StoragePoolStatus.Maintenance);
+        when(storagePoolDetailsDao.listDetailsKeyPairs(1L)).thenReturn(poolDetails);
+        when(mockStrategy.getClusterInfo()).thenReturn(mockCluster);
+        when(mockStrategy.getClusterVersion(mockCluster)).thenReturn("9.17.1");
+        when(volumeDao.findNonDestroyedVolumesByPoolId(eq(1L), isNull())).thenReturn(Collections.emptyList());
+
+        try (MockedStatic<OntapStorageUtils> u = mockStatic(OntapStorageUtils.class)) {
+            u.when(() -> OntapStorageUtils.getStrategyByStoragePoolDetails(any())).thenReturn(mockStrategy);
+            asupManager.pushAsupForStoragePool(pool, new HashSet<>());
+        }
+
+        String desc = capturePoolMessage();
+        assertTrue(desc.contains("\"poolStatus\":\"Maintenance\""), "desc=" + desc);
+    }
+
     @Test
     void poolMessage_volumeSnapshots_zeroWhenNoVolumes() {
         when(storagePoolDetailsDao.listDetailsKeyPairs(1L)).thenReturn(poolDetails);